【Ansible Tower／AWX】ジョブ環境変数一覧

Ansible AWX（Tower）のジョブ実行時に定義される「ジョブ環境変数」の一覧です。
また、実際に取得される値の例なども記載しています。

マジック変数については、こちらをご覧ください↓↓

ここでは、Ansibleのマジック変数やその他の特別な変数を記載したいと思います。コマンドラインでのAnsible以外に、AWX、Ansible Towerでも使用出来る(専用)の変数なども合わせて記載しています。また、実際に取得される値の例なども記載しています。

リンク

tower_job_id

実行したジョブのID

awx_job_id でも同様の情報を取得することが出来ます。

プレイブックの記述例

- name: tower_job_id
  debug:
    var: tower_job_id

実行結果

“tower_job_id”: 721

実行結果の詳細

{
    "tower_job_id": 721,
    "_ansible_verbose_always": true,
    "_ansible_no_log": false,
    "changed": false
}

tower_job_launch_type

ジョブがどのように実行されたか

awx_job_launch_type でも同様の情報を取得することが出来ます。

プレイブックの記述例

- name: tower_job_launch_type
  debug:
    var: tower_job_launch_type

実行結果

“tower_job_launch_type”: “relaunch”

実行結果は下記の値が返ってきます。

manual：手動で実行
relaunch：再起動で実行
callback：ホストコールバックで実行
scheduled：スケジュールで実行
dependency：別のジョブの依存関係として実行
workflow：ワークフロージョブから実行
sync：プロジェクトの同期から実行
scm：インベントリSCMの同期から実行

実行結果の詳細

{
    "tower_job_launch_type": "relaunch",
    "_ansible_verbose_always": true,
    "_ansible_no_log": false,
    "changed": false
}

tower_job_template_id

実行したジョブテンプレートのID

awx_job_template_id でも同様の情報を取得することが出来ます。

プレイブックの記述例

- name: tower_job_template_id
  debug:
    var: tower_job_template_id

実行結果

“tower_job_template_id”: 30

実行結果の詳細

{
    "tower_job_template_id": 30,
    "_ansible_verbose_always": true,
    "_ansible_no_log": false,
    "changed": false
}

tower_job_template_name

実行したジョブテンプレートの名前

awx_job_template_name でも同様の情報を取得することが出来ます。

プレイブックの記述例

- name: tower_job_template_name
  debug:
    var: tower_job_template_name

実行結果

“tower_job_template_name”: “Sample Template”

実行結果の詳細

{
    "tower_job_template_name": "Sample Template",
    "_ansible_verbose_always": true,
    "_ansible_no_log": false,
    "changed": false
}

tower_project_revision

ジョブが使用するソースツリーのリビジョン識別子

awx_project_revision でも同様の情報を取得することが出来ます。

scm_revision でも同様の情報を取得出来るようですが、実行結果が「”scm_revision”: “VARIABLE IS NOT DEFINED!: ‘scm_revision’ is undefined”」となっており、他の変数と異なることから、値が正しく格納されていないようです。

プレイブックの記述例

- name: tower_project_revision
  debug:
    var: tower_project_revision

値を取得出来る環境が無いため、実行結果がブランクになっています。

実行結果

“tower_project_revision”: “”

実行結果の詳細

{
    "tower_project_revision": "",
    "_ansible_verbose_always": true,
    "_ansible_no_log": false,
    "changed": false
}

tower_user_email

ジョブを実行したユーザーのメールアドレス

awx_user_email でも同様の情報を取得することが出来ます。
コールバックまたはスケジュールされたジョブでは使用出来ません。

プレイブックの記述例

- name: tower_user_email
  debug:
    var: tower_user_email

実行結果

“tower_user_email”: “awx@localhost”

実行結果の詳細

{
    "tower_user_email": "awx@localhost",
    "_ansible_verbose_always": true,
    "_ansible_no_log": false,
    "changed": false
}

tower_user_first_name

ジョブを実行したユーザーの名前

awx_user_first_name でも同様の情報を取得することが出来ます。
コールバックまたはスケジュールされたジョブでは使用出来ません。

プレイブックの記述例

- name: tower_user_first_name
  debug:
    var: tower_user_first_name

実行結果

“tower_user_first_name”: “太郎”

実行結果の詳細

{
    "tower_user_first_name": "太郎",
    "_ansible_verbose_always": true,
    "_ansible_no_log": false,
    "changed": false
}

tower_user_id

ジョブを実行したユーザーのID

awx_user_id でも同様の情報を取得することが出来ます。
コールバックまたはスケジュールされたジョブでは使用出来ません。

プレイブックの記述例

- name: tower_user_id
  debug:
    var: tower_user_id

実行結果

“tower_user_id”: 2

実行結果の詳細

{
    "tower_user_id": 2,
    "_ansible_verbose_always": true,
    "_ansible_no_log": false,
    "changed": false
}

tower_user_last_name

ジョブを実行したユーザーの苗字

awx_user_last_name でも同様の情報を取得することが出来ます。
コールバックまたはスケジュールされたジョブでは使用出来ません。

プレイブックの記述例

- name: tower_user_last_name
  debug:
    var: tower_user_last_name

実行結果

“tower_user_last_name”: “山田”

実行結果の詳細

{
    "tower_user_last_name": "山田",
    "_ansible_verbose_always": true,
    "_ansible_no_log": false,
    "changed": false
}

tower_user_name

ジョブを実行したユーザー名

awx_user_name でも同様の情報を取得することが出来ます。
コールバックまたはスケジュールされたジョブでは使用出来ません。

プレイブックの記述例

- name: tower_user_name
  debug:
    var: tower_user_name

実行結果

“tower_user_name”: “tyamada”

実行結果の詳細

{
    "tower_user_name": "tyamada",
    "_ansible_verbose_always": true,
    "_ansible_no_log": false,
    "changed": false
}

tower_schedule_id

ジョブを実行したスケジュールのID

awx_schedule_id でも同様の情報を取得することが出来ます。

プレイブックの記述例

- name: tower_schedule_id
  debug:
    var: tower_schedule_id

手動実行の場合は変数は定義されないようです。

実行結果（手動実行の場合）

“tower_schedule_id”: “VARIABLE IS NOT DEFINED!: ‘tower_schedule_id’ is undefined”

実行結果の詳細（手動実行の場合）

{
    "tower_schedule_id": "VARIABLE IS NOT DEFINED!: 'tower_schedule_id' is undefined",
    "_ansible_verbose_always": true,
    "_ansible_no_log": false,
    "changed": false
}

tower_schedule_name

ジョブを実行したスケジュールの名前

awx_schedule_name でも同様の情報を取得することが出来ます。

プレイブックの記述例

- name: tower_schedule_name
  debug:
    var: tower_schedule_name

手動実行の場合は変数は定義されないようです。

実行結果（手動実行の場合）

“tower_schedule_name”: “VARIABLE IS NOT DEFINED!: ‘tower_schedule_name’ is undefined”

実行結果の詳細（手動実行の場合）

{
    "tower_schedule_name": "VARIABLE IS NOT DEFINED!: 'tower_schedule_name' is undefined",
    "_ansible_verbose_always": true,
    "_ansible_no_log": false,
    "changed": false
}

tower_workflow_job_id

ジョブを実行したワークフロージョブのID

awx_workflow_job_id でも同様の情報を取得することが出来ます。

プレイブックの記述例

- name: tower_workflow_job_id
  debug:
    var: tower_workflow_job_id

手動実行の場合は変数は定義されないようです。

実行結果（手動実行の場合）

“tower_workflow_job_id”: “VARIABLE IS NOT DEFINED!: ‘tower_workflow_job_id’ is undefined”

実行結果の詳細（手動実行の場合）

{
    "tower_workflow_job_id": "VARIABLE IS NOT DEFINED!: 'tower_workflow_job_id' is undefined",
    "_ansible_verbose_always": true,
    "_ansible_no_log": false,
    "changed": false
}

tower_workflow_job_name

ジョブを実行したワークフロージョブの名前

awx_workflow_job_name でも同様の情報を取得することが出来ます。

プレイブックの記述例

- name: tower_workflow_job_name
  debug:
    var: tower_workflow_job_name

手動実行の場合は変数は定義されないようです。

実行結果（手動実行の場合）

“tower_workflow_job_name”: “VARIABLE IS NOT DEFINED!: ‘tower_workflow_job_name’ is undefined”

実行結果の詳細（手動実行の場合）

{
    "tower_workflow_job_name": "VARIABLE IS NOT DEFINED!: 'tower_workflow_job_name' is undefined",
    "_ansible_verbose_always": true,
    "_ansible_no_log": false,
    "changed": false
}

tower_inventory_id

実行したジョブが使用するインベントリのID

awx_inventory_id でも同様の情報を取得することが出来ます。

プレイブックの記述例

- name: tower_inventory_id
  debug:
    var: tower_inventory_id

実行結果（手動実行の場合）

“tower_inventory_id”: 4

実行結果の詳細（手動実行の場合）

{
    "tower_inventory_id": 4,
    "_ansible_verbose_always": true,
    "_ansible_no_log": false,
    "changed": false
}

tower_inventory_name

実行したジョブが使用するインベントリのID

awx_inventory_name でも同様の情報を取得することが出来ます。

プレイブックの記述例

- name: tower_inventory_name
  debug:
    var: tower_inventory_name

実行結果（手動実行の場合）

“tower_inventory_name”: “Sample Server Inventory”

実行結果の詳細（手動実行の場合）

{
    "tower_inventory_name": "Sample Server Inventory",
    "_ansible_verbose_always": true,
    "_ansible_no_log": false,
    "changed": false
}

マジック変数については、こちらをご覧ください↓↓

【Ansible Tower／AWX】マジック変数やその他の特別な変数

リンク