ジョブ・テンプレートの更新
put
/api/v2/job_templates/{id}/
このリソースに対してPUTまたはPATCHリクエストを行って、このジョブ・テンプレートを更新します。 次のフィールドを変更できます。
name
: このジョブ・テンプレートの名前。(文字列、必須)description
: このジョブ・テンプレートのオプションの説明。(文字列、デフォルト=""
)job_type
: (選択)run
: 実行(デフォルト)check
: チェック
inventory
: (id、デフォルト=``)project
: (id、デフォルト=``)playbook
: (文字列、デフォルト=""
)scm_branch
: ジョブ実行で使用するブランチ。 空白の場合に使用されるプロジェクトのデフォルト。 プロジェクトのallow_overrideフィールドがtrueに設定されている場合にのみ許可されます。(文字列、デフォルト=""
)forks
: (整数、デフォルト=0
)limit
: (文字列、デフォルト=""
)verbosity
: (選択)0
: 0 (標準) (デフォルト)1
: 1 (詳細)2
: 2 (より詳細)3
: 3 (デバッグ)4
: 4 (接続デバッグ)5
: 5 (WinRMデバッグ)
extra_vars
: (json、デフォルト=``)job_tags
: (文字列、デフォルト=""
)force_handlers
: (ブール、デフォルト=False
)skip_tags
: (文字列、デフォルト=""
)start_at_task
: (文字列、デフォルト=""
)timeout
: タスクが取り消されるまでの実行時間(秒)。(整数、デフォルト=0
)-
use_fact_cache
: 有効にすると、サービスはAnsibleファクト・キャッシュ・プラグインとして機能します。プレイブック実行の最後にファクトを永続化し、Ansibleで使用するファクトをキャッシュします。(ブール、デフォルト=False
) -
execution_environment
: 実行に使用されるコンテナ・イメージ。(id、デフォルト=``) host_config_key
: (文字列、デフォルト=""
)ask_scm_branch_on_launch
: (ブール、デフォルト=False
)ask_diff_mode_on_launch
: (ブール、デフォルト=False
)ask_variables_on_launch
: (ブール、デフォルト=False
)ask_limit_on_launch
: (ブール、デフォルト=False
)ask_tags_on_launch
: (ブール、デフォルト=False
)ask_skip_tags_on_launch
: (ブール、デフォルト=False
)ask_job_type_on_launch
: (ブール、デフォルト=False
)ask_verbosity_on_launch
: (ブール、デフォルト=False
)ask_inventory_on_launch
: (ブール、デフォルト=False
)ask_credential_on_launch
: (ブール、デフォルト=False
)survey_enabled
: (ブール、デフォルト=False
)become_enabled
: (ブール、デフォルト=False
)diff_mode
: 有効にすると、ホスト上のテンプレート化されたファイルに加えられたテキストの変更が標準出力に表示されます(ブール、デフォルト=False
)-
allow_simultaneous
: (ブール、デフォルト=False
) -
job_slice_count
: 実行時にスライスするジョブの数。 値が1より大きい場合は、ジョブ・テンプレートによってワークフローが起動されます。(整数、デフォルト=1
) webhook_service
: Webフック・リクエストを受け入れるサービス(選択)""
: ---------github
: GitHubgitlab
: GitLab
webhook_credential
: サービスAPIにステータスをポスト・バックするための個人アクセス・トークン(id、デフォルト=``)
PUTリクエストの場合は、リクエストにすべてのフィールドを含めます。
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
問合せパラメータ
- search(オプション): 文字列
検索条件。
ルート・スキーマ : schema
例:
{
"allow_simultaneous":false,
"ask_credential_on_launch":true,
"ask_diff_mode_on_launch":false,
"ask_inventory_on_launch":false,
"ask_job_type_on_launch":false,
"ask_limit_on_launch":false,
"ask_scm_branch_on_launch":false,
"ask_skip_tags_on_launch":false,
"ask_tags_on_launch":false,
"ask_variables_on_launch":false,
"ask_verbosity_on_launch":false,
"become_enabled":false,
"created":"2018-02-01T08:00:00.000000Z",
"custom_virtualenv":null,
"description":"",
"diff_mode":false,
"execution_environment":null,
"extra_vars":"",
"force_handlers":false,
"forks":0,
"host_config_key":"",
"id":1,
"inventory":1,
"job_slice_count":1,
"job_tags":"",
"job_type":"run",
"last_job_failed":false,
"last_job_run":null,
"limit":"",
"modified":"2018-02-01T08:00:00.000000Z",
"name":"test-job_template",
"next_job_run":null,
"organization":1,
"playbook":"helloworld.yml",
"project":2,
"related":{
"access_list":"/api/v2/job_templates/1/access_list/",
"activity_stream":"/api/v2/job_templates/1/activity_stream/",
"copy":"/api/v2/job_templates/1/copy/",
"credentials":"/api/v2/job_templates/1/credentials/",
"instance_groups":"/api/v2/job_templates/1/instance_groups/",
"inventory":"/api/v2/inventories/1/",
"jobs":"/api/v2/job_templates/1/jobs/",
"labels":"/api/v2/job_templates/1/labels/",
"launch":"/api/v2/job_templates/1/launch/",
"notification_templates_error":"/api/v2/job_templates/1/notification_templates_error/",
"notification_templates_started":"/api/v2/job_templates/1/notification_templates_started/",
"notification_templates_success":"/api/v2/job_templates/1/notification_templates_success/",
"object_roles":"/api/v2/job_templates/1/object_roles/",
"organization":"/api/v2/organizations/1/",
"project":"/api/v2/projects/2/",
"schedules":"/api/v2/job_templates/1/schedules/",
"slice_workflow_jobs":"/api/v2/job_templates/1/slice_workflow_jobs/",
"survey_spec":"/api/v2/job_templates/1/survey_spec/",
"webhook_key":"/api/v2/job_templates/1/webhook_key/",
"webhook_receiver":""
},
"scm_branch":"",
"skip_tags":"",
"start_at_task":"",
"status":"never updated",
"summary_fields":{
"credentials":[
{
"cloud":false,
"description":"",
"id":2,
"kind":"vault",
"name":"second-vault"
},
{
"cloud":false,
"description":"",
"id":1,
"kind":"vault",
"name":"test-cred"
}
],
"inventory":{
"description":"",
"has_active_failures":false,
"has_inventory_sources":false,
"hosts_with_active_failures":0,
"id":1,
"inventory_sources_with_failures":0,
"kind":"",
"name":"test-inv",
"organization_id":1,
"total_groups":0,
"total_hosts":0,
"total_inventory_sources":0
},
"labels":{
"count":0,
"results":[
]
},
"object_roles":{
"admin_role":{
"description":"Can manage all aspects of the job template",
"id":2,
"name":"Admin"
},
"execute_role":{
"description":"May run the job template",
"id":3,
"name":"Execute"
},
"read_role":{
"description":"May view settings for the job template",
"id":4,
"name":"Read"
}
},
"organization":{
"description":"test-org-desc",
"id":1,
"name":"test-org"
},
"project":{
"allow_override":false,
"description":"test-proj-desc",
"id":2,
"name":"test-proj",
"scm_type":"git",
"status":"never updated"
},
"recent_jobs":[
],
"user_capabilities":{
"copy":true,
"delete":true,
"edit":true,
"schedule":true,
"start":true
}
},
"survey_enabled":false,
"timeout":0,
"type":"job_template",
"url":"/api/v2/job_templates/1/",
"use_fact_cache":false,
"verbosity":0,
"webhook_credential":null,
"webhook_service":""
}
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
レスポンスの例(application/json)
{
"allow_simultaneous":false,
"ask_credential_on_launch":true,
"ask_diff_mode_on_launch":false,
"ask_inventory_on_launch":false,
"ask_job_type_on_launch":false,
"ask_limit_on_launch":false,
"ask_scm_branch_on_launch":false,
"ask_skip_tags_on_launch":false,
"ask_tags_on_launch":false,
"ask_variables_on_launch":false,
"ask_verbosity_on_launch":false,
"become_enabled":false,
"created":"2018-02-01T08:00:00.000000Z",
"custom_virtualenv":null,
"description":"",
"diff_mode":false,
"execution_environment":null,
"extra_vars":"",
"force_handlers":false,
"forks":0,
"host_config_key":"",
"id":1,
"inventory":1,
"job_slice_count":1,
"job_tags":"",
"job_type":"run",
"last_job_failed":false,
"last_job_run":null,
"limit":"",
"modified":"2018-02-01T08:00:00.000000Z",
"name":"test-job_template",
"next_job_run":null,
"organization":1,
"playbook":"helloworld.yml",
"project":2,
"related":{
"access_list":"/api/v2/job_templates/1/access_list/",
"activity_stream":"/api/v2/job_templates/1/activity_stream/",
"copy":"/api/v2/job_templates/1/copy/",
"credentials":"/api/v2/job_templates/1/credentials/",
"instance_groups":"/api/v2/job_templates/1/instance_groups/",
"inventory":"/api/v2/inventories/1/",
"jobs":"/api/v2/job_templates/1/jobs/",
"labels":"/api/v2/job_templates/1/labels/",
"launch":"/api/v2/job_templates/1/launch/",
"notification_templates_error":"/api/v2/job_templates/1/notification_templates_error/",
"notification_templates_started":"/api/v2/job_templates/1/notification_templates_started/",
"notification_templates_success":"/api/v2/job_templates/1/notification_templates_success/",
"object_roles":"/api/v2/job_templates/1/object_roles/",
"organization":"/api/v2/organizations/1/",
"project":"/api/v2/projects/2/",
"schedules":"/api/v2/job_templates/1/schedules/",
"slice_workflow_jobs":"/api/v2/job_templates/1/slice_workflow_jobs/",
"survey_spec":"/api/v2/job_templates/1/survey_spec/",
"webhook_key":"/api/v2/job_templates/1/webhook_key/",
"webhook_receiver":""
},
"scm_branch":"",
"skip_tags":"",
"start_at_task":"",
"status":"never updated",
"summary_fields":{
"credentials":[
{
"cloud":false,
"description":"",
"id":2,
"kind":"vault",
"name":"second-vault"
},
{
"cloud":false,
"description":"",
"id":1,
"kind":"vault",
"name":"test-cred"
}
],
"inventory":{
"description":"",
"has_active_failures":false,
"has_inventory_sources":false,
"hosts_with_active_failures":0,
"id":1,
"inventory_sources_with_failures":0,
"kind":"",
"name":"test-inv",
"organization_id":1,
"total_groups":0,
"total_hosts":0,
"total_inventory_sources":0
},
"labels":{
"count":0,
"results":[
]
},
"object_roles":{
"admin_role":{
"description":"Can manage all aspects of the job template",
"id":2,
"name":"Admin"
},
"execute_role":{
"description":"May run the job template",
"id":3,
"name":"Execute"
},
"read_role":{
"description":"May view settings for the job template",
"id":4,
"name":"Read"
}
},
"organization":{
"description":"test-org-desc",
"id":1,
"name":"test-org"
},
"project":{
"allow_override":false,
"description":"test-proj-desc",
"id":2,
"name":"test-proj",
"scm_type":"git",
"status":"never updated"
},
"recent_jobs":[
],
"user_capabilities":{
"copy":true,
"delete":true,
"edit":true,
"schedule":true,
"start":true
}
},
"survey_enabled":false,
"timeout":0,
"type":"job_template",
"url":"/api/v2/job_templates/1/",
"use_fact_cache":false,
"verbosity":0,
"webhook_credential":null,
"webhook_service":""
}