27.5. カスタム通知の作成

• メッセージは常に文字列のみであり、一行だけです。改行はサポートされていません。

• メッセージ本文は、ディクショナリーまたはテキストのブロックのいずれかです。

  • Webhook と PagerDuty のメッセージ本文はディクショナリー定義を使用します。これらのデフォルトのメッセージ本文は {{ job_metadata }} です。そのまま使用することも、独自のディクショナリーを提供することもできます。

  • メールのメッセージ本文には、テキストのブロックまたは複数行の文字列が使用されます。デフォルトのメッセージ本文は次のとおりです。

    {{ job_friendly_name }} #{{ job.id }} had status {{ job.status }}, view details at {{ url }} {{ job_metadata }}

    このテキストは、{{ job_metadata }} を残したまま編集することも、{{ job_metadata }} をドロップすることもできます。本文はテキストのブロックであるため、任意の文字列を使用できます。{{ job_metadata }} は、実行中のジョブを説明するフィールドを含むディクショナリーとしてレンダリングされます。いずれの場合も、{{ job_metadata }} には次のフィールドが含まれます。

    • id
    • name
    • url
    • created_by
    • started
    • finished
    • status

    • traceback

      注記

      {{ job_metadata }} 内の個々のフィールドをクエリーすることはできません。通知テンプレートで {{ job_metadata }} を使用すると、すべてのデータが返されます。

      結果のディクショナリーは次のようになります。

      {"id": 18,
       "name": "Project - Space Procedures",
       "url": "https://host/#/jobs/project/18",
       "created_by": "admin",
       "started": "2019-10-26T00:20:45.139356+00:00",
       "finished": "2019-10-26T00:20:55.769713+00:00",
       "status": "successful",
       "traceback": ""
      }

      {{ job_metadata }} がジョブでレンダリングされる場合、次の追加フィールドが含まれます。

    • inventory
    • project
    • Playbook
    • credential
    • limit
    • extra_vars

    • hosts

      結果のディクショナリーは次のようになります。

      {"id": 12,
       "name": "JobTemplate - Launch Rockets",
       "url": "https://host/#/jobs/playbook/12",
       "created_by": "admin",
       "started": "2019-10-26T00:02:07.943774+00:00",
       "finished": null,
       "status": "running",
       "traceback": "",
       "inventory": "Inventory - Fleet",
       "project": "Project - Space Procedures",
       "playbook": "launch.yml",
       "credential": "Credential - Mission Control",
       "limit": "",
       "extra_vars": "{}",
       "hosts": {}
      }

      {{ job_metadata }} がワークフロージョブでレンダリングされる場合、次の追加フィールドが含まれます。

    • body (これはワークフロージョブ内のノードを列挙し、各ノードに関連付けられたジョブの説明を含みます)

      結果のディクショナリーは次のようになります。

      {"id": 14,
       "name": "Workflow Job Template - Launch Mars Mission",
       "url": "https://host/#/workflows/14",
       "created_by": "admin",
       "started": "2019-10-26T00:11:04.554468+00:00",
       "finished": "2019-10-26T00:11:24.249899+00:00",
       "status": "successful",
       "traceback": "",
       "body": "Workflow job summary:
      
               node #1 spawns job #15, \"Assemble Fleet JT\", which finished with status successful.
               node #2 spawns job #16, \"Mission Start approval node\", which finished with status successful.\n
               node #3 spawns job #17, \"Deploy Fleet\", which finished with status successful."
      }

関連情報

• 詳細は、 Jinja2 での変数の使用 を参照してください。
• Automation Controller には、正しいデータを取得してメッセージを表示する、有効な構文が必要です。サポート対象の属性のリストと適切な構文構造については、カスタム通知でサポートされる属性 セクションを参照してください。