Ansible プレイブックで Python で Junos Snapshot Administrator(JSNAPy)を使用する

juniper.device.jsnapyモジュールを使用すると、次のようなJSNAPy機能をAnsibleプレイブック内から実行できます。

• ランタイム環境スナップショットのキャプチャーと保存

• 2 つのスナップショットの比較

• スナップショットをキャプチャしてすぐに評価する

モジュールでは、 action 引数と、 config_file または test_files のいずれかの引数を指定する必要があります。 action 引数は、実行するJSNAPyアクションを指定します。 表 2 は、有効な action 値と同等の JSNAPy コマンドの概要を示しています。

表 2: jsnapy アクションの引数値

action 値	形容	同等のJSNAPyコマンド
check	指定されたテスト ケースに基づいて 2 つの既存のスナップショットを比較するか、テスト ケースが指定されていない場合は、スナップショットをノードごとに比較します。	jsnapy --check
snap_post	特定のデバイスで変更を行った後、テストファイルで指定されたコマンドまたはRPCのスナップショットを作成します。	jsnapy --snap
snap_pre	特定のデバイスに変更を加える前に、テストファイルで指定されたコマンドまたはRPCのスナップショットを撮ります。	jsnapy --snap
snapcheck	テストファイルで指定されたコマンドまたはRPCのスナップショットを取得し、テストケースで事前定義された条件に対してスナップショットを即座に評価します。	jsnapy --snapcheck

コマンドラインでJSNAPyを実行すると、JSNAPyは構成ファイルの hosts セクションで指定されたホストで要求されたアクションを実行します。対照的に、Ansibleモジュールは、Ansibleプレイブックで指定されたホストで要求されたアクションを実行します。その結果、モジュールは hosts セクションを無視して構成ファイルを参照するか、1 つ以上のテスト ファイルを直接参照できます。

したがって、juniper.device.jsnapy モジュールでは、action 引数に加えて、特定のアクションに使用する JSNAPy 構成ファイル または JSNAPy テスト ファイルを指定するために、config_file 引数または test_files 引数も必要です。 表 3 は、config_file 引数と test_files 引数の概要を示しています。

表3:jsnapyファイル引数

モジュール引数	価値	追加情報
config_file	JSNAPy 構成ファイルへの絶対または相対ファイル パス。	パスが相対パスの場合、モジュールは、次の場所にある構成ファイルを、指定された順序でチェックします。 Ansible Playbook ディレクトリー dir 引数ディレクトリ (指定されている場合) /etc/jsnapy/testfiles ディレクトリ ( dir 引数が省略された場合のみ) 構成ファイルが相対ファイル パスを使用してテスト ファイルを参照する場合、モジュールは最初にプレイブック ディレクトリ内のテスト ファイルを確認し、次にデフォルトの testfiles ディレクトリ内のテスト ファイルを確認します。これは JSNAPy リリースと環境によって異なります。
test_files	JSNAPy テスト ファイルへの絶対または相対ファイル パス。これは、単一のファイルパスまたはファイルパスのリストにすることができます。	相対パスを指定するテスト ファイルごとに、モジュールは、次の場所と指定された順序でファイルを確認します。 Ansible Playbook ディレクトリー dir 引数ディレクトリ (指定されている場合) /etc/jsnapy/testfiles ディレクトリ ( dir 引数が省略された場合のみ)

config_file 引数と test_files 引数には、絶対ファイルパスまたは相対ファイルパスを指定できます。相対ファイル パスを使用する場合は、オプションで dir モジュール引数を含めて、ファイルが存在するディレクトリを指定できます。config_file または test_files 引数が相対ファイルパスを使用する場合、モジュールは、dir 引数が存在する場合でも、最初に Ansible Playbook ディレクトリー内のファイルをチェックします。ファイルがプレイブックディレクトリに存在しない場合、モジュールはdir引数ディレクトリ(指定されている場合)または/etc/jsnapy/testfilesディレクトリ(dir引数が省略されている場合)をチェックインします。ファイルが見つからない場合、Playbook はエラーメッセージを生成します。

dir パラメーターを含めると、モジュールは指定された config_file または test_files 引数についてのみその場所をチェックすることに注意してください。したがって、構成ファイルを指定しても、モジュールは、構成ファイル内で指定したテスト・ファイルのdir・ディレクトリーをチェックしません。構成ファイルがテストファイルの相対パスを参照する場合、モジュールは Playbook ディレクトリとデフォルトの testfiles ディレクトリでのみテストファイルをチェックします。

~/jsnapy/testfilesディレクトリにあり、複数のJSNAPyテストファイルを参照する次のJSNAPy構成ファイルjsnapy_config_base_tests.yamlがあるとします。

次のサンプルプレイブックは、jsnapy_config_base_tests.yaml構成ファイル内の各テストファイルに対してsnap_preアクションを実行します。構成ファイルがプレイブック ディレクトリに存在しない場合、モジュールは dir ディレクトリ(この場合は ~/jsnapy/testfiles)でファイルを確認します。構成ファイルは、テスト ファイルの相対パスを使用します。その結果、モジュールは最初に Playbook ディレクトリ内のテストファイルをチェックし、次にデフォルトの testfiles ディレクトリ内のテストファイルをチェックします。

または、 jsnapy モジュールは test_files パラメーターを使用して、使用する個々のテスト ファイルを指定することもできます。次のプレイブックは、前のプレイブックの例と同じテストを実行します。この場合、モジュールは最初に Playbook ディレクトリ内のテストファイルをチェックし、次に dir ディレクトリ内のテストファイルをチェックします。

手記：

Python リリース 1.3.0 の Junos Snapshot Administrator 以降、設定ファイルとテスト ファイルのデフォルトの場所は ~/jsnapy/testfiles です。ただし、仮想環境内またはそれ以前のリリースのデフォルトの場所は /etc/jsnapy/testfiles です。

モジュールは、モジュールが hosts セクションを含む構成ファイルを参照している場合でも、Ansible Playbook で指定されたホストで要求されたアクションを実行します。エラーが発生し、JSNAPy テストの実行に失敗した場合、モジュールは失敗を報告します。1 つ以上の JSNAPy テストが失敗した場合は、失敗は報告 されません 。JSNAPy テスト結果を確認するには、モジュールの応答を登録し、 ansible.builtin.assert モジュールを使用して応答の予期される結果を確認します。

PythonのJunos Snapshot Administratorは、デフォルトでその操作に関する情報を /var/log/jsnapy/jsnapy.log ファイルに記録します。 juniper.device.jsnapy モジュールには、オプションで logfile 引数を含めることができ、特定のタスクの情報が記録される Ansible 制御ノード上の書き込み可能なファイルへのパスを指定します。Ansible の verbosity level と debug オプションによって、ファイルに記録される情報のレベルが決まります。デフォルトでは、重大度レベルが WARNING 以上のメッセージのみがログに記録されます。重大度レベル INFO または重大度レベル DEBUG 以上のメッセージをログに記録するには、 -v または -vv コマンドラインオプションを使用して Playbook をそれぞれ実行します。

AnsibleプレイブックでJSNAPyテストを実行するときに、失敗したJSNAPyテストの情報を保存または要約できます。詳細については、 失敗した JSNAPy テストの確認を参照してください。

JSNAPy を使用すると、変更前後の Junos デバイスのランタイム環境スナップショットをキャプチャし、スナップショットを比較して、予想される変更を検証したり、予期しない問題を特定できます。 juniper.device.jsnapy モジュールを使用すると、Ansible プレイブックの一部として JSNAPy スナップショットを作成して比較できます。モジュールは、各ホストの各スナップショットを、所定のファイル名を使用して、デフォルトのJSNAPyスナップショットディレクトリ内の個別のファイルに保存します。出力ファイルの詳細については、「 jsnapy モジュールの出力について」を参照してください。

変更を行う前に 1 つ以上のデバイスのベースライン スナップショットを取得するには、モジュールの action 引数を snap_pre に設定し、構成ファイル または 1 つ以上のテスト ファイルを指定します。

次のプレイブックは、Ansibleインベントリグループ内の各デバイスのPREスナップショットを保存します。タスクは ~/jsnapy/testfiles ディレクトリの jsnapy_config_base_tests.yaml 構成ファイルを参照し、プレイブック ディレクトリの jsnapy_tests.log ファイルにメッセージを記録します。

変更の実行後に 1 つ以上のデバイスのスナップショットを取得するには、モジュールの action 引数を snap_post に設定し、構成ファイル または 1 つ以上のテスト ファイルを指定します。

次のプレイブックは、Ansibleインベントリグループ内の各デバイスのPOSTスナップショットを保存します。タスクは、~/jsnapy/testfilesディレクトリ内の同じjsnapy_config_base_tests.yaml構成ファイルを参照し、プレイブックディレクトリ内のjsnapy_tests.logファイルにメッセージを記録します。

jsnapy モジュールが snap_pre アクションまたは snap_post アクションを実行すると、それぞれ「PRE」または「POST」タグを含む自動生成されたファイル名を使用して、各ホストの各スナップショットが個別のファイルに保存されます。PRE スナップショットとPOSTスナップショットを比較して、更新プログラムをすばやく確認したり、変更によって発生した可能性のある問題を特定したりするには、モジュールの action 引数を check に設定し、スナップショットの作成に使用されたのと同じ構成ファイルまたはテスト ファイルを指定します。

モジュールが check アクションを実行すると、JSNAPy は各デバイスの各テストの PRE スナップショットと POST スナップショットを比較し、テスト ファイルの tests: セクションで定義された基準に照らして評価します。テスト ファイルにテスト ケースが定義されていない場合、JSNAPy は代わりにスナップショットをノードごとに比較します。テスト結果を確認するには、モジュールの応答を登録し、 ansible.builtin.assert モジュールを使用して応答で期待される結果を確認します。

次のプレイブックは、Ansibleインベントリグループ内のすべてのデバイスについて、以前に実行された snap_pre および snap_post アクションに対して取得されたスナップショットを比較します。結果は、構成ファイルで参照されているテスト ファイルの基準を使用して評価されます。プレイブックは、モジュールの応答を「test_result」として登録し、 ansible.builtin.assert モジュールを使用して、指定されたデバイスですべてのテストに合格したことを確認します。

プレイブックを実行すると、アサーションによってテストに失敗したデバイスがすぐに特定されます。

JSNAPy を使用すると、JSNAPy テスト ファイルで指定されたコマンドまたは RPC のスナップショットを作成し、テスト ケースで事前定義された基準に対してスナップショットを即座に評価できます。 juniper.device.jsnapy モジュールを使用すると、Ansible プレイブックの一部として JSNAPy snapcheck 操作を実行できます。

スナップショットを取得し、テスト ファイルの tests: セクションにある定義済みの条件セットに基づいてすぐに評価するには、モジュールの action 引数を snapcheck に設定し、構成ファイル または 1 つ以上のテスト ファイルを指定します。テスト結果を確認するには、モジュールの応答を登録し、 ansible.builtin.assert モジュールを使用して応答で期待される結果を確認します。

たとえば、次のプレイブックは、Ansibleインベントリグループ内のデバイスごとに、テストファイル内のコマンドまたはRPCごとに個別のスナップショットを保存し、モジュールの応答を登録し、 ansible.builtin.assert モジュールを使用して、テストファイルで定義されたすべてのテストがそのデバイスで合格したことを確認します。

Junosデバイスに対してJSNAPyテストを実行する場合は、 jsnapy モジュールの応答を登録し、 ansible.builtin.assert モジュールを使用して passPercentage が100であることを確認することで、すべてのJSNAPyテストに合格したかどうかをすばやく検証できます。ただし、1 つ以上のテストが失敗した場合、出力が広範囲に及ぶと、失敗したテストを特定して抽出することが困難な場合があります。

juniper.device.jsnapy モジュールには、失敗した JSNAPy テストを表示するための次のオプションが用意されています。

• jsnapy callback plugin:プレイブックの出力後に、失敗した JSNAPy テストの概要を出力します。

• dest_dir module 引数:失敗した JSNAPy テストを指定されたディレクトリ内のファイルに書き込みます。

jsnapyコールバック プラグインを使用すると、失敗した JSNAPy テストの情報を簡単に抽出して要約できます。jsnapyコールバック プラグインを有効にし、JSNAPy テストを含むプレイブックを実行すると、プラグインはプレイブックのPLAY RECAP後に失敗した JSNAPy テストの情報を要約します。

jsnapyコールバックプラグインはデフォルトで無効になっています。jsnapyコールバックプラグインを有効にするには、callback_whitelist = jsnapyステートメントをAnsible構成ファイルに追加します。

jsnapyコールバック プラグインを有効にしてプレイブックを実行すると、プラグインは失敗した JSNAPy テストを人間が判読できる形式で要約します。例えば：

juniper.device リリース 1.0.6 以降、juniper.device.jsnapy モジュールは dest_dir 引数もサポートしています。dest_dir 引数は、テスト条件に対してスナップショットを評価するcheckおよびsnapcheck操作に含めることができます。check または snapcheck 操作を実行し、dest_dir 引数を含めると、モジュールは、指定されたホストの失敗した各 JSNAPy テストを、指定された出力ディレクトリ内のファイルに書き込みます。

たとえば、次の Playbook について考えてみます。

Playbook を実行すると、モジュールは、指定されたホストで失敗したテストごとに dest_dir ディレクトリにファイルを生成します。たとえば、次のファイルは、ホスト r1 および r3 で失敗した bgp_neighbor テストと bgp_summary テストに対して生成されます。