Ansibleジョブテンプレートをリリースします

このページでは、ワークフロー自動化アクションカタログで利用可能なansible.job.launchアクションのリファレンスを提供します。このアクションを使用して、ワークフローステップからAnsible Automation プラットフォーム（Automation Controller）ジョブテンプレートをリリースします。

前提条件については、Ansibleジョブアクションをご覧ください。

Ansibleジョブテンプレートをリリースします

アクション識別子はansible.job.launchです。

Ansible Automation Platform（Automation Controller）のジョブテンプレートをリリースし、作成されたジョブを返します。成功すると、ジョブが終了状態になるまでポーリングするためにansible.job.getStatusで使用できるジョブidを返します。エンドポイントはPOST https://{host}/api/controller/v2/job_templates/{jobTemplateId}/launch/です。

次の表は、このアクションで利用可能なすべての入力フィールドについて説明しています。

入力	タイプ	説明	例
ホスト	弦	必須。スキームを含まない、Automation Controllerのホスト名（およびオプションのポート）。	`${{ :secrets:host }}`
authToken	弦	必須。 OAuth2トークンは `Authorization: Bearer <token>` として送信されます。書き込みスコープを使用して、 Automation Controller > Users > Tokens で作成します。	`${{ :secrets:ansibleControllerToken }}`
jobTemplateId	Int	必須。リリースするジョブテンプレートの数値ID。	`42`
extraVars	地図	オプション。 `extra_vars` として渡される追加変数。テンプレートで `ask_variables_on_launch` が有効になっている必要があります。	`{"target_env": "staging", "app_version": "1.2.3"}`
リミット	弦	オプション。 `limit` として渡されるAnsibleホストパターン。 `ask_limit_on_launch` が必要です。	`web-servers`
インベントリは	弦	オプション。テンプレートのデフォルトを上書きする数値インベントリID。 `ask_inventory_on_launch` が必要です。	`7`
jobTags	弦	オプション。 `job_tags` として渡されるカンマ区切りのタグ。 `ask_tags_on_launch` が必要です。	`deploy,restart`
skipTags	弦	オプション。 `skip_tags` として渡される、スキップするカンマ区切りのタグです。 `ask_skip_tags_on_launch` が必要です。	`notifications`
selectors	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "jobId", "expression": ".id"}, {"name": "status", "expression": ".status"}]`

次の表は、このアクションによって返されるすべての出力フィールドについて説明しています。

出力	タイプ	説明
success	ブール値	`true` 成功時は、失敗時は `false` 。
response	オブジェクト	作成されたジョブ・オブジェクト。ステータスをポーリングするには、`ansible.job.getStatus` とともに `id` フィールドを使用してください。 `{ "id": 128, "status": "pending", "job_template": 42, "url": "/api/controller/v2/jobs/128/" }`
errorMessage	弦	失敗時のエラーメッセージ。成功した場合は `null` 。

出力

タイプ

説明

success

ブール値

true

成功時は、失敗時は

false

。

response

オブジェクト

作成されたジョブ・オブジェクト。ステータスをポーリングするには、ansible.job.getStatus とともに id フィールドを使用してください。

{
  "id": 128,
  "status": "pending",
  "job_template": 42,
  "url": "/api/controller/v2/jobs/128/"
}

errorMessage

弦

失敗時のエラーメッセージ。成功した場合は

null

。

次の例では、Ansibleジョブテンプレートをリリースし、ポーリング用にジョブIDを取得します。

ワークフローの例
`name: launch-ansible-remediation description: Launch an Ansible job template to remediate an incident steps: - name: launch_job type: action action: ansible.job.launch version: 1 inputs: host: ${{ :secrets:host }} authToken: ${{ :secrets:ansibleControllerToken }} jobTemplateId: "42" extraVars: target_env: staging app_version: "1.2.3" selectors: - name: jobId expression: ".id" next: end`

ワークフローの例

name: launch-ansible-remediation
description: Launch an Ansible job template to remediate an incident
steps:
  - name: launch_job
    type: action
    action: ansible.job.launch
    version: 1
    inputs:
      host: ${{ :secrets:host }}
      authToken: ${{ :secrets:ansibleControllerToken }}
      jobTemplateId: "42"
      extraVars:
        target_env: staging
        app_version: "1.2.3"
      selectors:
        - name: jobId
          expression: ".id"
    next: end

この機械翻訳は、参考として提供されています。

Ansibleジョブテンプレートをリリースします

Ansibleジョブテンプレートをリリースします.css-21sua1{background:none;border:none;width:0;padding:0;}

Ansibleジョブテンプレートをリリースします