このページでは、ワークフロー自動化アクションカタログで利用可能なansible.job.getStatusアクションのリファレンスを提供します。このアクションを使用して、ansible.job.launchによって作成されたジョブが終了状態になるまでポーリングします。
前提条件については、Ansibleジョブアクションをご覧ください。
Ansibleジョブのステータスを取得する
アクション識別子はansible.job.getStatusです。
Automation Controllerジョブのステータスと詳細を取得します。ジョブのステータスは、終了状態(successful、failed、error、またはcanceled)に達する前に、pendingからwaiting、runningへと進行します。エンドポイントはGET https://{host}/api/controller/v2/jobs/{jobId}/です。
次の表は、このアクションで利用可能なすべての入力フィールドについて説明しています。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
ホスト | 弦 | 必須。 スキームを含まない、Automation Controllerのホスト名(およびオプションのポート)。 |
|
authToken | 弦 | 必須。 OAuth2 トークンは
として送信されます。 |
|
jobId | Int | 必須。 ポーリングする数値のジョブID。通常は、
によって返される
です。 |
|
selectors | リスト | オプション。 アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションによって返されるすべての出力フィールドについて説明しています。
出力 | タイプ | 説明 |
|---|---|---|
success | ブール値 |
成功時は、失敗時は
。 |
response | オブジェクト | Automation Controller APIからのジョブの詳細。 |
errorMessage | 弦 | 失敗時のエラーメッセージ。成功した場合は
。 |
以下の例では、Ansibleジョブをポーリングし、結果に基づいて分岐します。
ワークフローの例 |
|---|
|