ジョブ・テンプレートの更新
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
)ask_execution_environment_on_launch
: (ブール、デフォルト=False
)ask_labels_on_launch
: (ブール、デフォルト=False
)ask_forks_on_launch
: (ブール、デフォルト=False
)ask_job_slice_count_on_launch
: (ブール、デフォルト=False
)ask_timeout_on_launch
: (ブール、デフォルト=False
)ask_instance_groups_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
: GitLabbitbucket_dc
: BitBucket DataCenter
webhook_credential
: サービスAPIにステータスをポスト・バックするための個人アクセス・トークン(id、デフォルト=``)prevent_instance_group_fallback
: 有効にすると、ジョブ・テンプレートによって、実行する優先インスタンス・グループのリストに在庫または組織インスタンス・グループを追加できなくなります。この設定が有効で、空のリストを指定した場合、グローバル・インスタンス・グループが適用されます。(ブール、デフォルト=False
)
PUTリクエストの場合は、リクエストにすべてのフィールドを含めます。
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
ルート・スキーマ : JobTemplate
型:
ソースを表示
object
- allow_simultaneous: boolean
タイトル:
Allow simultaneous
- ask_credential_on_launch: boolean
タイトル:
Ask credential on launch
- ask_diff_mode_on_launch: boolean
タイトル:
Ask diff mode on launch
- ask_execution_environment_on_launch: boolean
タイトル:
Ask execution environment on launch
- ask_forks_on_launch: boolean
タイトル:
Ask forks on launch
- ask_instance_groups_on_launch: boolean
タイトル:
Ask instance groups on launch
- ask_inventory_on_launch: boolean
タイトル:
Ask inventory on launch
- ask_job_slice_count_on_launch: boolean
タイトル:
Ask job slice count on launch
- ask_job_type_on_launch: boolean
タイトル:
Ask job type on launch
- ask_labels_on_launch: boolean
タイトル:
Ask labels on launch
- ask_limit_on_launch: boolean
タイトル:
Ask limit on launch
- ask_scm_branch_on_launch: boolean
タイトル:
Ask scm branch on launch
- ask_skip_tags_on_launch: boolean
タイトル:
Ask skip tags on launch
- ask_tags_on_launch: boolean
タイトル:
Ask tags on launch
- ask_timeout_on_launch: boolean
タイトル:
Ask timeout on launch
- ask_variables_on_launch: boolean
タイトル:
Ask variables on launch
- ask_verbosity_on_launch: boolean
タイトル:
Ask verbosity on launch
- become_enabled: boolean
タイトル:
Become enabled
- created: string
タイトル:
Created
読取り専用:true
- custom_virtualenv: string
タイトル:
Custom virtualenv
読取り専用:true
最小長:1
使用するカスタムPython virtualenvを含むローカル絶対ファイル・パス - description: string
タイトル:
Description
- diff_mode: boolean
タイトル:
Diff mode
有効にすると、ホスト上のテンプレート化されたファイルに対して行われたテキスト変更が標準出力に表示されます - execution_environment: integer
タイトル:
Execution environment
実行に使用するコンテナ・イメージ。 - extra_vars: string
タイトル:
Extra vars
- force_handlers: boolean
タイトル:
Force handlers
- forks: integer
タイトル:
Forks
最小値:0
- host_config_key: string
タイトル:
Host config key
最大長:1024
- id: integer
タイトル:
ID
読取り専用:true
- inventory: integer
タイトル:
Inventory
- job_slice_count: integer
タイトル:
Job slice count
最小値:0
デフォルト値:1
実行時にスライスするジョブの数。 値が1より大きい場合、ジョブ・テンプレートでワークフローが起動されます。 - job_tags: string
タイトル:
Job tags
- job_type: string
タイトル:
Job type
デフォルト値:run
指定できる値:[ "run", "check" ]
- last_job_failed: boolean
タイトル:
Last job failed
読取り専用:true
- last_job_run: string(date-time)
タイトル:
Last job run
読取り専用:true
- limit: string
タイトル:
Limit
- modified: string
タイトル:
Modified
読取り専用:true
- name(required): string
タイトル:
Name
最小長:1
最大長:512
- next_job_run: string(date-time)
タイトル:
Next job run
読取り専用:true
- organization: integer
タイトル:
Organization
読取り専用:true
このテンプレートへのアクセスを決定するために使用される組織。 - playbook: string
タイトル:
Playbook
最大長:1024
- prevent_instance_group_fallback: boolean
タイトル:
Prevent instance group fallback
有効にすると、ジョブ・テンプレートによって、実行する優先インスタンス・グループのリストに在庫または組織インスタンス・グループを追加できなくなります。この設定が有効で、空のリストを指定した場合、グローバル・インスタンス・グループが適用されます。 - project: string
タイトル:
Project
- related: string
- scm_branch: string
タイトル:
Scm branch
最大長:1024
ジョブ実行で使用するブランチ。 空白の場合に使用されるプロジェクトのデフォルト。 プロジェクトのallow_overrideフィールドがtrueに設定されている場合にのみ許可されます。 - skip_tags: string
タイトル:
Skip tags
最大長:1024
- start_at_task: string
タイトル:
Start at task
最大長:1024
- status: string
タイトル:
Status
読取り専用:true
指定できる値:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated" ]
- summary_fields: string
タイトル:
Summary fields
読取り専用:true
- survey_enabled: boolean
タイトル:
Survey enabled
- timeout: integer
タイトル:
Timeout
タスクが取り消されるまでに実行される時間(秒)。 - type: string
タイトル:
Type
読取り専用:true
- url: string
タイトル:
Url
読取り専用:true
- use_fact_cache: boolean
タイトル:
Use fact cache
有効にすると、サービスはAnsibleファクト・キャッシュ・プラグインとして機能します。プレイブック実行の最後にファクトを永続化し、Ansibleで使用するファクトをキャッシュします。 - verbosity: integer
タイトル:
Verbosity
指定できる値:[ "0", "1", "2", "3", "4", "5" ]
- webhook_credential: integer
タイトル:
Webhook credential
サービスAPIにステータスを転記するための個人アクセス・トークン - webhook_service: string
タイトル:
Webhook service
指定できる値:[ "github", "gitlab", "bitbucket_dc" ]
webフック・リクエストを受け入れるサービス
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
ルート・スキーマ : JobTemplate
型:
ソースを表示
object
- allow_simultaneous: boolean
タイトル:
Allow simultaneous
- ask_credential_on_launch: boolean
タイトル:
Ask credential on launch
- ask_diff_mode_on_launch: boolean
タイトル:
Ask diff mode on launch
- ask_execution_environment_on_launch: boolean
タイトル:
Ask execution environment on launch
- ask_forks_on_launch: boolean
タイトル:
Ask forks on launch
- ask_instance_groups_on_launch: boolean
タイトル:
Ask instance groups on launch
- ask_inventory_on_launch: boolean
タイトル:
Ask inventory on launch
- ask_job_slice_count_on_launch: boolean
タイトル:
Ask job slice count on launch
- ask_job_type_on_launch: boolean
タイトル:
Ask job type on launch
- ask_labels_on_launch: boolean
タイトル:
Ask labels on launch
- ask_limit_on_launch: boolean
タイトル:
Ask limit on launch
- ask_scm_branch_on_launch: boolean
タイトル:
Ask scm branch on launch
- ask_skip_tags_on_launch: boolean
タイトル:
Ask skip tags on launch
- ask_tags_on_launch: boolean
タイトル:
Ask tags on launch
- ask_timeout_on_launch: boolean
タイトル:
Ask timeout on launch
- ask_variables_on_launch: boolean
タイトル:
Ask variables on launch
- ask_verbosity_on_launch: boolean
タイトル:
Ask verbosity on launch
- become_enabled: boolean
タイトル:
Become enabled
- created: string
タイトル:
Created
読取り専用:true
- custom_virtualenv: string
タイトル:
Custom virtualenv
読取り専用:true
最小長:1
使用するカスタムPython virtualenvを含むローカル絶対ファイル・パス - description: string
タイトル:
Description
- diff_mode: boolean
タイトル:
Diff mode
有効にすると、ホスト上のテンプレート化されたファイルに対して行われたテキスト変更が標準出力に表示されます - execution_environment: integer
タイトル:
Execution environment
実行に使用するコンテナ・イメージ。 - extra_vars: string
タイトル:
Extra vars
- force_handlers: boolean
タイトル:
Force handlers
- forks: integer
タイトル:
Forks
最小値:0
- host_config_key: string
タイトル:
Host config key
最大長:1024
- id: integer
タイトル:
ID
読取り専用:true
- inventory: integer
タイトル:
Inventory
- job_slice_count: integer
タイトル:
Job slice count
最小値:0
デフォルト値:1
実行時にスライスするジョブの数。 値が1より大きい場合、ジョブ・テンプレートでワークフローが起動されます。 - job_tags: string
タイトル:
Job tags
- job_type: string
タイトル:
Job type
デフォルト値:run
指定できる値:[ "run", "check" ]
- last_job_failed: boolean
タイトル:
Last job failed
読取り専用:true
- last_job_run: string(date-time)
タイトル:
Last job run
読取り専用:true
- limit: string
タイトル:
Limit
- modified: string
タイトル:
Modified
読取り専用:true
- name(required): string
タイトル:
Name
最小長:1
最大長:512
- next_job_run: string(date-time)
タイトル:
Next job run
読取り専用:true
- organization: integer
タイトル:
Organization
読取り専用:true
このテンプレートへのアクセスを決定するために使用される組織。 - playbook: string
タイトル:
Playbook
最大長:1024
- prevent_instance_group_fallback: boolean
タイトル:
Prevent instance group fallback
有効にすると、ジョブ・テンプレートによって、実行する優先インスタンス・グループのリストに在庫または組織インスタンス・グループを追加できなくなります。この設定が有効で、空のリストを指定した場合、グローバル・インスタンス・グループが適用されます。 - project: string
タイトル:
Project
- related: string
- scm_branch: string
タイトル:
Scm branch
最大長:1024
ジョブ実行で使用するブランチ。 空白の場合に使用されるプロジェクトのデフォルト。 プロジェクトのallow_overrideフィールドがtrueに設定されている場合にのみ許可されます。 - skip_tags: string
タイトル:
Skip tags
最大長:1024
- start_at_task: string
タイトル:
Start at task
最大長:1024
- status: string
タイトル:
Status
読取り専用:true
指定できる値:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated" ]
- summary_fields: string
タイトル:
Summary fields
読取り専用:true
- survey_enabled: boolean
タイトル:
Survey enabled
- timeout: integer
タイトル:
Timeout
タスクが取り消されるまでに実行される時間(秒)。 - type: string
タイトル:
Type
読取り専用:true
- url: string
タイトル:
Url
読取り専用:true
- use_fact_cache: boolean
タイトル:
Use fact cache
有効にすると、サービスはAnsibleファクト・キャッシュ・プラグインとして機能します。プレイブック実行の最後にファクトを永続化し、Ansibleで使用するファクトをキャッシュします。 - verbosity: integer
タイトル:
Verbosity
指定できる値:[ "0", "1", "2", "3", "4", "5" ]
- webhook_credential: integer
タイトル:
Webhook credential
サービスAPIにステータスを転記するための個人アクセス・トークン - webhook_service: string
タイトル:
Webhook service
指定できる値:[ "github", "gitlab", "bitbucket_dc" ]
webフック・リクエストを受け入れるサービス