Playbook

Playbookの概要

Playbook機能は、複数のジョブやコマンドの実行結果を組み合わせて、一連のタスクを自動化できる機能です。従来のジョブ機能は、showコマンドの実行などの一方向の処理フローで完結していましたが、Playbookでは、showコマンドの実行結果に基づいて条件分岐を行い、追加のコマンドを実行したり、メール通知を送信したりすることができます。これによって、より複雑な業務フローを自動化し、効率的な運用を実現できます。

Playbookノード

Playbookでは、アクションを表す「ノード」と呼ばれるボックスを線でつなげて、一連のタスクを構築します。Playbookで使用するノードの種類とその説明を、次の表に示します。

ノードアイコン	ノードラベル	説明
	And	aとbの両方の入力信号が受信された後、処理が進行します。各入力から受信した情報は、ノードの右側にあるaとbそれぞれから次のノードに送信されます。
	デバイスバックアップ	デバイスのバックアップを実行し、バックアップの結果（「変更あり」、「変更なし」、「失敗」、「スキップ」）に基づいて処理を分岐します
	チャットアプリ(ウェブフック)	前のノードから実行結果を受信後、その内容をウェブフック経由で指定されたチャットアプリに送信します。通知内容はコマンドの結果ではなく、実行結果の要約です。サポートされているチャットアプリは、「Microsoft Teams / Slack / Mattermost / WebEx / LINE WORKS」です。
	コンプライアンス違反	コンプライアンス違反が発生したデバイスに関する情報を次のノードに送信します。
	デバイス別マージ	デバイスごとに出力を一つにまとめます
	デバイス検索	Playbook開始時に、検索条件に一致したデバイスに関する情報を次のノードに送信します。検索方法には、「全てのデバイス」、「検索」、「静的リスト」の3つがあります。
	メール	Playbookの実行結果をメールで送信します。メールの内容は、コンテンツおよびコンテンツ制限のプルダウンで変更することができます。
	インシデン	監視中に違反が発生したデバイスのインシデント情報を次のノードに送信します。インシデント情報を受信したノードは、そこからデバイス情報を取得します。
	コンフィグ読み込み	最新のバックアップコンフィギュレーションを読み込みます
	メモ	Playbook画面にメモを保存します。一連のタスクにメモを追加し、その内容を次のノードに送信できます。また、このメモはPlaybookの内容を把握する際にも役立ちます。
	コンプライアンス違反検出	コンプライアンス違反としてデバイスのステータスを更新します。このノードを使用するとデバイスプロパティのコンプライアンスタブにコンプライアンス違反として登録されます。
	正規表現一致	前のノードから受信した出力結果に対して、正規表現を用いた文字列検索を実行します。検索結果が正規表現にマッチしたかどうかに応じて、処理を分岐させることができます。また、「Partial Match」オプションを有効にすることで、部分一致の検索も可能です。
	ルールセット	前のノードから受信したコマンドの実行結果などのテキストデータを、指定されたルールセットに従って評価し、その結果を次のノードに送信します。
	コマンド実行	前のノードから受信した対象デバイスの情報をもとに、指定されたコマンドを実行し、その結果を次のノードに送信します。
	コマンド実行（自動リトライ付き）	前のノードから受信した対象デバイスの情報をもとに、指定されたコマンドを、指定回数実行します。リトライは、「Delay between tries in milliseconds:」で指定されたミリ秒間隔で、指定された回数行われます。
	スケジュール	Playbookを自動的に実行するようにスケジュールします。このノードは次のノードに接続されていなくても、有効に設定されていれば実行されます。
	変数の設定	変数を設定し、次のノードへ指定した値を送信します。
	スリープ	指定されたミリ秒数だけ、入力の送信を遅延させます。
	SSH実行	成されたコンテンツは間違っている可能性があります。
	Csvへ変換	成されたコンテンツは間違っている可能性があります。
	Jsonへ変換	成されたコンテンツは間違っている可能性があります。
	ファイルアップロード	前のノードから受信した対象デバイスにファイルを送信します。サポートされているプロトコルは、FTP/TFTP/SCPです。

Playbookの管理

Playbookを管理する方法について説明します。ここでは、新しいPlaybookの作成から、既存のPlaybookの編集、削除方法について説明します。

Playbookの追加

［Playbook］タブを開きます。
［追加］をクリックします。

{width=“5.735433070866142in” height=“1.8284416010498687in”}

名前欄に作成するPlaybookの名前を入力します。説明欄の入力は任意です。

{width=“3.0256649168853893in” height=“1.9683541119860017in”}

［OK］をクリックします。
画面右側のリストから構成するノードを選択し、左側の表示領域にドラッグ・アンド・ドロップして追加します。

{width=“5.735433070866142in” height=“2.272752624671916in”}

Note:

検索ボックスを使用することで、ノード一覧に表示されるノードをノード名で絞り込むことが可能です。

ドラッグ操作でノード間を接続します。

編集が完了したら、［Playbookを保存する］ボタンをクリックします。

Note:

Playbookの設定に無効な設定がないか、以下のアイコンをクリックして確認できます。

＜無効な設定がある場合＞

無効な設定がある箇所はテーブル形式で表示され、修正が必要な箇所は赤色でハイライトされます

＜無効な設定がない場合＞

「すべてのテストが合格しました」というメッセージが表示されます。

Playbookの編集

［Playbook］タブを開きます。
編集するPlaybookを選択してダブルクリックするか、［編集］ボタンをクリックします。

{width=“5.735433070866142in” height=“1.4877055993000874in”}

［Playbookの詳細を編集する］をクリックすると、Playbookの名前や説明を編集できます。

{width=“3.937007874015748in” height=“1.278513779527559in”}

編集が完了したら、［Playbookを保存する］ボタンをクリックします。

Playbookの削除

［Playbook］タブを開きます。
削除するPlaybookを選択し、［削除］ボタンをクリックします。

確認メッセージが表示されたら、［OK］をクリックします。

{width=“1.968503937007874in” height=“0.8291765091863517in”}

一覧からPlaybookが削除されます。

Playbookのエクスポート

［Playbook］タブを開きます。
エクスポートするPlaybookを選択してダブルクリックするか、［編集］ボタンをクリックします。
［Playbookをエクスポート］ボタンをクリックします。

{width=“5.708661417322834in” height=“2.7822845581802276in”}

ファイルをダウンロードします。

ファイルは、JSONファイル形式で出力されます。

{width=“4.597762467191601in” height=“2.1502777777777777in”}

Playbookのインポート

［Playbook］タブを開きます。
［インポート］ボタンをクリックします。

インポートするファイルを選択し、開きます。

インポートが完了すると、一覧に追加されます。

{width=“5.708661417322834in” height=“2.7822845581802276in”}

Paybookのカテゴリ

Playbook のカテゴリ機能は、Playbook を管理する際の利便性を向上させます。

カスタムカテゴリの作成・編集
Playbook 一覧でのカラータグによるラベル付け
1つの Playbook 内での複数カテゴリ作成

Playbookカテゴリの作成

[Playbook］タブを開きます。
"Playbook"タイトルの横にある{width=“0.2847222222222222in” height=“0.1875in”}ボタンをクリックすると「カテゴリ一覧」ウィンドウが開きます。{width=“5.2090551181102365in” height=“0.9688976377952756in”}
{width=“0.23402777777777778in” height=“0.2152777777777778in”}ボタンをクリックすると「カテゴリを追加」ウィンドウが開きます。

{width=“4.017322834645669in” height=“2.9755905511811025in”}

{width=“0.975in” height=“0.19652777777777777in”}ボタンをクリックしてカテゴリ用のSVG形式のアイコン画像選択します。
カテゴリ名を入力します。
[OK]ボタンをクリックし、続けて[閉じる]ボタンをクリックします

Playbookカテゴリの編集

"Playbook"タイトルの横にある{width=“0.2847222222222222in” height=“0.1875in”} ボタンをクリックし「カテゴリ一覧」ウィンドウを開きます。
「カテゴリ一覧」ウィンドウでカテゴリ名をクリックします。
{width=“0.22152777777777777in” height=“0.20277777777777778in”} ボタンをクリックし「カテゴリを編集」ウィンドウを開きます。

{width=“2.5783464566929135in” height=“1.9114173228346456in”}

編集が完了したら、[OK]をクリックします。

Playbookカテゴリの削除

"Playbook"タイトルの横にある{width=“0.2847222222222222in” height=“0.1875in”} ボタンをクリックし「カテゴリ一覧」ウィンドウを開きます。
「カテゴリ一覧」ウィンドウでカテゴリ名をクリックします。
ボタンをクリックすると「カテゴリを削除」ウィンドウが開きます。