プレイブック定義言語🔗
テンプレート定義には、自動化ワークフローのすべての詳細、メタデータ、入力、およびタスクが含まれます。サポートされている各フィールドについて、このページで説明します。
ヒント
テンプレート内で利用可能なテンプレート変数は以下の通りです：
${TDR.API}— TaegisのAPI URL${TDR.URL}— TaegisのポータルURL${TDR.tenant}— プレイブック実行時のテナントID${TDR.user}— プレイブックをトリガーしたユーザーID
テンプレートフィールド🔗
以下のフィールドがサポートされています。
kind🔗
このフィールドは、定義ファイルの種類を定義するために使用されます。プレイブックテンプレートの場合、この値は常に Playbook である必要があります。
デフォルト/推奨値: Playbook
データ型: string
name🔗
このフィールドはテンプレートの名前を定義します。テンプレート名は、特定のテナント内で一意でなければなりません。Taegis プレフィックスで始まるテンプレート名はグローバルであり、Secureworksのみが追加できます。テンプレート名にはスペースやアンダースコア（_）およびピリオド（.）以外の特殊文字を含めないでください。
デフォルト/推奨値: n/a
データ型: string
title🔗
このフィールドは、このテンプレートをXDR UIで表示する際に表示される値を定義します。このフィールドにはスペースやその他の特殊文字を含めることができます。
デフォルト/推奨値: n/a
データ型: string
description🔗
このフィールドはテンプレートの説明に使用されます。これはドキュメント用のフィールドではなく、テンプレートの目的を明確に示す1～2文の短い説明です。
デフォルト/推奨値: テンプレートの目的を明確に示す1～2文
データ型: string
tenantId🔗
このオプションフィールドには、XDR テナントIDが文字列として含まれます。
デフォルト/推奨値: n/a
データ型: string
version🔗
このオプションフィールドはセマンティックバージョン番号（MAJOR.MINOR.PATCH）です。詳細は Semantic Versioning 2.0.0 を参照してください。このフィールドが省略された場合、バージョンは draft として設定されます。
注意
本番環境でドラフトを使用することは強く推奨されません。
デフォルト/推奨値: n/a
データ型: セマンティックバージョン番号
inputs🔗
このフィールドでは、プレイブックが正しく動作するために必要な入力をテンプレート作成者が定義できます。値は入力の構造を定義するJSONスキーマです。
デフォルト/推奨値: n/a
データ型: string（JSONスキーマ）
outputs🔗
このフィールドでは、プレイブックが生成する出力をテンプレート作成者が定義できます。値は出力の構造を定義するJSONスキーマです。
デフォルト/推奨値: n/a
データ型: string（JSONスキーマ）
tags🔗
このフィールドは、テンプレートに関連付けられたラベルのコレクション/リストです。タグは現在XDR UIで表示または検索できませんが、将来的にテンプレートライブラリのグループ化/フィルタリング/検索をサポートするために公開される可能性があります。
デフォルト/推奨値: 現時点ではUIサポートがないため空リスト（[]）
データ型: 文字列のリスト/配列
connectorCategories🔗
このフィールドは、テンプレートに関連付けられた事前定義済みカテゴリのコレクション/リストです。カテゴリは現在XDR UIで表示または検索できませんが、将来的にテンプレートライブラリのグループ化/フィルタリング/検索をサポートするために公開される可能性があります。
デフォルト/推奨値: 現時点ではUIサポートがないため空リスト（[]）
データ型: 文字列のリスト/配列
connectors🔗
このフィールドは、このテンプレートが必要とするコネクターのコレクション/リストです。
デフォルト/推奨値: n/a
データ型: 文字列のリスト/配列
implements🔗
このオプションフィールドは、このテンプレートが実装するインターフェースを定義する文字列です。この値を定義すると、このテンプレートはアクティビティとなります。implementsの値は、interface_name:version の形式でフルインターフェース名とバージョンを指定してください。
デフォルト/推奨値: n/a
データ型: 文字列のリスト/配列
interfaces🔗
このオプションフィールドは、このテンプレートが必要とするインターフェース（アクティビティ）のコレクション/リストです。インターフェースの値は、interface_name:version の形式でフルインターフェース名とバージョンを指定してください。
デフォルト/推奨値: n/a
データ型: 文字列のリスト/配列
dsl🔗
このフィールドは、自動化ワークフローのドメイン固有言語を定義するオブジェクト/マップです。このフィールドは、name、description、tasks、outputsの4つのフィールドで構成されます。
デフォルト/推奨値: n/a
データ型: オブジェクト/マップ
以下のフィールドは dsl のパラメータを定義します。
name🔗
このフィールドはdslの名前であり、テンプレートの名前と一致させる必要があります。XDR UIでは表示/使用されません。
デフォルト/推奨値: テンプレートと同じ名前
データ型: string
description🔗
このフィールドはdslの説明です。このフィールドはテンプレートの説明と一致させる必要があり、XDR UIでは表示/使用されません。
デフォルト/推奨値: テンプレートと同じ説明
データ型: string
tasks🔗
このフィールドは、テンプレートを構成するステップのリスト/配列です。このフィールドは、ワークフローを個々のステップとして定義します。各タスクを構成するフィールドの詳細は プレイブックタスクの操作 で説明しています。
デフォルト/推奨値: n/a
データ型: リスト/配列
outputs🔗
このフィールドでは、自動化ワークフローの出力値をテンプレート作成者が定義できます。出力の構造は、テンプレートで定義されたJSONスキーマと一致させてください。
デフォルト/推奨値: outputsのJSONスキーマと一致させる
データ型: オブジェクト/マップ