イベント ポリシー ファイルのアーカイブ
概要 イベントポリシーを設定して、関連ファイルを事前に定義されたアーカイブサイトにアップロードします。
イベント ポリシー ファイルのアーカイブの概要
さまざまなタイプのファイルは、イベントの診断やネットワーク問題のトラブルシューティングに役立ちます。イベント ポリシー アクションによって出力ファイルが生成されると、後で分析できるようにファイルをアーカイブできます。同様に、システム ログ ファイル、コア ファイル、構成ファイルなどのシステム ファイルを、イベント発生時からアーカイブすることができます。
イベントが発生した場合、関連するファイルを特定の場所にアップロードして分析できます。イベント・ポリシーからファイルをアーカイブするには、ファイルがアップロードされるアーカイブ・サイトを指定して、1 つ以上の 宛先 を構成します。その後、イベント ポリシー内で構成された宛先を参照します。イベント ポリシーは、トリガーすると、指定されたアーカイブ サイトにファイルをアップロードします。
イベント ポリシー アーカイブ操作の転送遅延を設定できます。転送遅延により、1 つ以上のファイルをアップロードする前にイベント プロセス(イベント)が待機する秒数を指定できます。転送遅延により、アップロードが開始される前に、コア ファイルなどの大きなファイルが完全に生成されるようになります。
転送遅延を宛先およびイベント ポリシー アクションに関連付けることができます。転送遅延を宛先に関連付ける場合、転送遅延は、その宛先を使用するすべてのファイル アップロード アクションに適用されます。また、イベントポリシーアクションに転送遅延を割り当てることもできます。例えば、同じ宛先を使用する複数のイベント・ポリシー・アクションがあり、これらのイベント・ポリシー・アクションの一部では転送遅延が必要であり、その他のイベント・ポリシー・アクションでは転送遅延を必要としません。宛先に転送遅延を設定し、イベント ポリシー アクションに転送遅延も設定した場合、結果として生じる転送遅延は 2 つの遅延の合計になります。
ネットワークの一時的な問題により、ファイルアップロード操作が失敗する可能性があります。何らかの理由でアップロードが失敗した場合、デフォルトでは、イベントポリシーはアップロードを再試行しません。ただし、最初のアップロードが失敗した場合は、指定された回数ファイルアップロード操作を再試行するようにイベントポリシーを設定できます。また、再試行の間隔を設定することもできます。
イベント ポリシー ファイルアーカイブの宛先を定義する
イベントが発生した場合、関連するファイルを特定の場所にアップロードして分析できます。イベント・ポリシーからファイルをアーカイブするには、まず、ファイルがアップロードされるアーカイブ・サイトを指定する 1 つ以上の 宛先 を構成する必要があります。その後、イベント ポリシー内で構成された宛先を参照します。
宛先アーカイブ サイトを定義するには、 階層レベルで ステートメントを[edit event-options]含destinationsめます。
[edit event-options]
destinations {
destination-name {
archive-sites {
url <password password>;
}
transfer-delay seconds;
}
}
各宛先に対して、ファイルがアップロードされる実際のサイトである1つ以上のアーカイブサイトURIを設定します。ある宛先に複数のアーカイブ・サイトURIを指定した場合、デバイスはファイルをリスト内の最初のアーカイブ・サイトに転送しようとし、前のサイトへの転送が失敗した場合にのみ後続のアーカイブ・サイトのみを使用します。アーカイブ サイトでログインするための認証が必要な場合は、そのサイトのプレーンテキスト パスワードを構成できます。デバイスは、パスワードを暗号化された値として設定データベースに保存します。
アーカイブサイトのURIは、ファイルURI、アクティブまたはパッシブFTP URI、セキュアFTP(SFTP)URI、またはセキュアコピー(SCP)URIです。ローカル デバイス ディレクトリもサポートされます(/ var/tmp など)。アーカイブ サイトの URI を指定する場合、URI の末尾にスラッシュ(/)を追加しないでください。
-
ファイル:<//host>/path
-
ftp://username@host:<ポート>urlパス
-
pasvftp://username@host:<ポート>urlパス
-
sftp://username@host:<ポート>urlパス
-
scp://username@host:<ポート>urlパス
-
<path>/<ファイル名>
また、各宛先の転送遅延を定義することもできます。転送遅延とは、1 つ以上のファイルを宛先にアップロードするまでにイベント プロセス(イベントが発生)が待機する秒数です。転送遅延により、アップロードが開始される前に、コア ファイルなどの大きなファイルが完全に生成されるようになります。
イベント ポリシーがファイルをアップロードできる宛先アーカイブ サイトを定義するには、
イベントポリシーを設定してファイルをアップロードする
イベント・ポリシーを構成して、既存のシステム・ファイルをアップロードしたり、呼び出されたイベント・スクリプトまたは操作コマンドから生成された出力ファイルをイベント発生時にアップロードしたりできます。デバイスは、そのイベントポリシーアクションに設定された ステートメントで destination 参照されている場所にファイルをアップロードします。階層レベルで設定された宛先名を指定する [edit event-options destinations] 必要があります。
以下の例では、特定のファイルを既存の宛先にアップロードするためのさまざまなイベント ポリシー アクションを設定しています。また、各イベントポリシーに対して、適切なイベントを設定し、その他の必要なステートメントを含める必要があります。
システム ファイルのアップロード
イベントポリシーを設定して、設定した宛先にシステムファイルをアップロードするには:
-
イベントポリシーアクションを
upload設定し、アップロードするファイルと宛先サイトを指定します。複数の
uploadステートメントを含めることができ、 ステートメントではfilenameファイル名グロブリングを使用して複数のファイルを指定できます。[edit event-options policy policy-name then] user@host# set upload filename (filename | committed) destination destination-name
以下のイベントポリシーアクションは、コミットされた設定ファイルをアップロードし、 /var/log ディレクトリに格納されているすべてのファイルをアップロードし、「メッセージ」という文字列で開始します。
[edit event-options policy policy1 then] user@host# set upload filename committed destination mgmt-archives user@host# set upload filename /var/log/messages* destination mgmt-archives
- (オプション)「ファイルをアップロードする前に遅延を設定する」および「ファイルアップロードアクションを再試行するようにイベントポリシーを設定する」に記載されている転送遅延または再試行オプションを設定する
コマンド出力ファイルのアップロード
イベント ポリシーには、イベントに応答してコマンドを execute-commands 実行し、コマンド出力をファイルに書き込むイベント ポリシー アクションを含めることができます。コマンド出力ファイルを設定した宛先にアップロードするイベントポリシーを設定するには:
-
execute-commandsイベントポリシーアクションで、宛先を設定します。[edit event-options policy policy-name then] user@host# set execute-commands destination destination-name
例えば：
[edit event-options policy policy1 then] user@host# set execute-commands destination mgmt-archives
-
出力ファイルのファイル名に含まれる記述的な文字列を定義します。
[edit event-options policy policy-name then] user@host# set execute-commands output-filename string
例えば：
[edit event-options policy policy1 then] user@host# set execute-commands output-filename intf-info
- (オプション)「ファイルをアップロードする前に遅延を設定する」および「ファイルアップロードアクションを再試行するようにイベントポリシーを設定する」に記載されている転送遅延または再試行オプションを設定する
イベント スクリプト出力ファイルのアップロード
イベント ポリシーがイベントに応答してイベント スクリプトを実行すると、イベント スクリプトはファイルに出力を書き込むことができます。生成された出力ファイルを設定された宛先にアップロードするイベントポリシーを設定するには:
-
event-scriptイベントポリシーアクションで、宛先を設定します。[edit event-options policy policy-name then] user@host# set event-script filename destination destination-name
例えば：
[edit event-options policy policy1 then] user@host# set event-script get-intf-info destination mgmt-archives
-
出力ファイルのファイル名に含まれる記述的な文字列を定義します。
[edit event-options policy policy-name then] user@host# set event-script filename output-filename string
例えば：
[edit event-options policy policy1 then] user@host# set event-script get-intf-info output-filename intf-info
- (オプション)「ファイルをアップロードする前に遅延を設定する」および「ファイルアップロードアクションを再試行するようにイベントポリシーを設定する」に記載されている転送遅延または再試行オプションを設定する
アップロードしたファイルのファイル名
イベントポリシーアクションがファイルをアップロードすると、アップロードされた各ファイルのファイル名にホスト名とタイムスタンプが含まれており、一意であることを確認します。ファイル名は、Junos OSソフトウェアのバージョンによって異なります。Junos OS リリース 14.1R3 以降、ファイル名の命名規則は次のとおりです。
hostname_YYYYMMDD_HHMMSS_output-filename_index-number
以前のリリースでは、ファイル名の命名規則は次のとおりです。
hostname_output-filename_YYYYMMDD_HHMMSS_index-number
文字列は output-filename 、既存のファイルの名前、またはそのイベントポリシーアクションに output-filename 設定されたステートメントの値のいずれかです。1秒の期間にイベントポリシーを複数回トリガーする場合、デバイスは各ファイル名にインデックス番号を追加して、ファイル名がまだ一意であることを確認します。インデックス番号の範囲は001~999です。
例えば、Junos OSリリース21.1R1を実行しているデバイスr1で と設定rpd-messagesされたイベントポリシーアクションoutput-filenameがあるとします。イベント ポリシーが 1 秒間に 3 回トリガーした場合、ファイル名は次のようになります。
-
r1_20210623_132333_rpdメッセージ
-
r1_20210623_132333_rpd-messages_001
-
r1_20210623_132333_rpd-messages_002
ファイルをアップロードする前に遅延を設定する
イベント・ポリシーを構成して、既存のシステム・ファイルをアップロードしたり、呼び出されたイベント・スクリプトまたは操作コマンドから生成された出力ファイルをイベント発生時にアップロードしたりできます。イベントポリシーのアップロード操作では、転送遅延を設定して、1つ以上のファイルをアップロードする前にイベントプロセス(イベントが発生)が待機する秒数を指定できます。転送遅延を設定することで、アップロードが開始される前に、コア ファイルなどの大きなファイルが完全に生成されるようにすることができます。
転送遅延を宛先およびイベント ポリシー アクションに関連付けることができます。転送遅延を宛先に関連付ける場合、転送遅延は、その宛先を使用するすべてのファイル アップロード アクションに適用されます。また、イベントポリシーアクションに転送遅延を割り当てることもできます。例えば、同じ宛先を使用する複数のイベント・ポリシー・アクションがあり、これらのイベント・ポリシー・アクションの一部では転送遅延が必要であり、その他のイベント・ポリシー・アクションでは転送遅延を必要としません。
階層レベルで [edit event-options destinations destination-name] 宛先の転送遅延を設定し、イベント ポリシー アクションに転送遅延を設定した場合、その結果の転送遅延は 2 つの遅延の合計になります。
Total transfer delay = transfer-delay (destination) + transfer-delay (event-policy-action)
宛先の転送遅延を設定するには:
[edit event-options destinations destination-name] user@host# set transfer-delay seconds
例えば、以下の構成では、mgmt-アーカイブの宛先に転送遅延を 5 秒に設定しています。
[edit event-options destinations mgmt-archives] user@host# set transfer-delay 5
特定のイベントポリシーアクションに対する転送遅延を設定するには、以下を行います。
-
適切なイベント ポリシーアクション階層で、遅延を秒単位で設定します。
[edit event-options policy policy-name then] user@host# set event-script filename destination destination-name transfer-delay seconds
[edit event-options policy policy-name then] user@host# set execute-commands destination destination-name transfer-delay seconds
[edit event-options policy policy-name then] user@host# set upload filename (filename | committed) destination destination-name transfer-delay seconds
例えば：
[edit event-options policy policy1 then] user@host# set event-script get-intf-info.py destination mgmt-archives transfer-delay 5
[edit event-options policy policy2 then] user@host# set execute-commands destination mgmt-archives transfer-delay 7
[edit event-options policy policy3 then] user@host# set upload filename committed destination mgmt-archives transfer-delay 3
次の例では、some-dest宛先はイベント ポリシーと policy2. の両方で共通ですpolicy1。転送遅延が 2 秒の場合は、宛先に関連付some-destけされ、両方のイベント ポリシーの出力ファイルを宛先にアップロードするのに適用されます。
[edit event-options]
policy policy1 {
events e1;
then {
execute-commands {
commands {
"show version";
}
output-filename command-output;
destination some-dest;
}
}
policy policy2 {
events e2;
then {
event-script bar.xsl {
output-filename event-script-output;
destination some-dest;
}
}
}
destinations {
some-dest {
transfer-delay 2;
archive-sites {
"scp://robot@my.big.com/foo/moo" password "$9$wisoGDjqfQnHqIclMN-HqmP5F"; ## SECRET-DATA
"scp://robot@my.little.com/foo/moo" password "$9$uova0RSrlMXNbKMDkPQ9CKM8Lxd"; ## SECRET-DATA
}
}
}
ファイルアップロードアクションを再試行するようにイベントポリシーを設定する
イベント・ポリシーを構成して、既存のシステム・ファイルをアップロードしたり、呼び出されたイベント・スクリプトまたは操作コマンドから生成された出力ファイルをイベント発生時にアップロードしたりできます。ネットワークの一時的な問題により、ファイルアップロード操作が失敗する可能性があります。何らかの理由でアップロードが失敗した場合、デフォルトでは、イベントポリシーはアップロードを再試行しません。ただし、ファイルアップロード操作を再試行するようにイベントポリシーを設定することはできます。
特定のイベントポリシーアクションに対して、ファイルアップロード再試行オプションを設定します。再試行オプションを設定するには、 および retry-interval ステートメントをretry-count含めます。
retry-count number retry-interval seconds;
どこ：
-
retry-count— アップロードに失敗した場合、ポリシーがアップロード操作を再試行する回数。ステートメントのretry-countデフォルト値は0で、最大は10です。 -
retry-interval— 各アップロード試行の間の秒数。
特定のイベント・ポリシー・アクションに対してファイル・アップロード操作を再試行するようにイベント・ポリシーを構成するには、以下を行います。
retry-countイベントポリシーアクションdestinationの ステートメントに および retry-interval ステートメントを含めます。
[edit event-options policy policy-name then] user@host# set event-script filename destination destination-name retry-count number retry-interval seconds
[edit event-options policy policy-name then] user@host# set execute-commands destination destination-name retry-count number retry-interval seconds
[edit event-options policy policy-name then] user@host# set upload filename (filename | committed) destination destination-name retry-count number retry-interval seconds
例えば：
[edit event-options policy policy1 then] user@host# set event-script get-intf-info.py destination mgmt-archives retry-count 5 retry-interval 3
[edit event-options policy policy2 then] user@host# set execute-commands destination mgmt-archives retry-count 10 retry-interval 4
[edit event-options policy policy3 then] user@host# set upload filename committed destination mgmt-archives retry-count 2 retry-interval 10