ジョブ・テンプレートの起動
get
/api/v2/job_templates/{id}/launch/
このリソースに対してGETリクエストを行って、job_templateを起動できるかどうか、およびjob_templateを起動するためにパスワードが必要かどうかを判断します。 レスポンスには次のフィールドが含まれます。
ask_variables_on_launch
: 起動時に変数の指定を求めるようにjob_templateが構成されているかどうかを示すフラグ(ブール、読取り専用)ask_tags_on_launch
: 起動時にタグの指定を求めるようにjob_templateが構成されているかどうかを示すフラグ(ブール、読取り専用)ask_skip_tags_on_launch
: 起動時にskip_tagsの指定を求めるようにjob_templateが構成されているかどうかを示すフラグ(ブール、読取り専用)ask_job_type_on_launch
: 起動時にjob_typeの指定を求めるようにjob_templateが構成されているかどうかを示すフラグ(ブール、読取り専用)ask_limit_on_launch
: 起動時に制限の指定を求めるようにjob_templateが構成されているかどうかを示すフラグ(ブール、読取り専用)ask_inventory_on_launch
: 起動時にインベントリの指定を求めるようにjob_templateが構成されているかどうかを示すフラグ(ブール、読取り専用)ask_credential_on_launch
: 起動時に資格証明の指定を求めるようにjob_templateが構成されているかどうかを示すフラグ(ブール、読取り専用)can_start_without_user_input
: ユーザー入力なしでjob_templateを起動できるかどうかを示すフラグ(ブール、読取り専用)passwords_needed_to_start
: job_templateを起動するために必要なパスワード名(配列、読取り専用)variables_needed_to_start
: job_templateを起動するために必要な必須変数名(配列、読取り専用)survey_enabled
: 有効なサーベイがjob_templateにあるかどうかを示すフラグ(ブール、読取り専用)inventory_needed_to_start
: ジョブ・テンプレートに関連付けられたインベントリが存在することを示すフラグ。 ない場合は、ジョブの起動時に指定する必要があります(ブール、読取り専用)
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
先頭に戻る
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
ルート・スキーマ : JobLaunch
型:
ソースを表示
object
- ask_credential_on_launch: boolean
タイトル:
Ask credential on launch
読取り専用:true
- ask_diff_mode_on_launch: boolean
タイトル:
Ask diff mode on launch
読取り専用:true
- ask_execution_environment_on_launch: boolean
タイトル:
Ask execution environment on launch
読取り専用:true
- ask_forks_on_launch: boolean
タイトル:
Ask forks on launch
読取り専用:true
- ask_instance_groups_on_launch: boolean
タイトル:
Ask instance groups on launch
読取り専用:true
- ask_inventory_on_launch: boolean
タイトル:
Ask inventory on launch
読取り専用:true
- ask_job_slice_count_on_launch: boolean
タイトル:
Ask job slice count on launch
読取り専用:true
- ask_job_type_on_launch: boolean
タイトル:
Ask job type on launch
読取り専用:true
- ask_labels_on_launch: boolean
タイトル:
Ask labels on launch
読取り専用:true
- ask_limit_on_launch: boolean
タイトル:
Ask limit on launch
読取り専用:true
- ask_scm_branch_on_launch: boolean
タイトル:
Ask scm branch on launch
読取り専用:true
- ask_skip_tags_on_launch: boolean
タイトル:
Ask skip tags on launch
読取り専用:true
- ask_tags_on_launch: boolean
タイトル:
Ask tags on launch
読取り専用:true
- ask_timeout_on_launch: boolean
タイトル:
Ask timeout on launch
読取り専用:true
- ask_variables_on_launch: boolean
タイトル:
Ask variables on launch
読取り専用:true
- ask_verbosity_on_launch: boolean
タイトル:
Ask verbosity on launch
読取り専用:true
- can_start_without_user_input: boolean
タイトル:
Can start without user input
読取り専用:true
- credential_needed_to_start: string
タイトル:
Credential needed to start
読取り専用:true
- credential_passwords: string
タイトル:
Credential passwords
- credentials: array credentials
一意のアイテムが必要:
true
- defaults: string
タイトル:
Defaults
読取り専用:true
- diff_mode: boolean
タイトル:
Diff mode
- execution_environment: integer
タイトル:
Execution environment
- extra_vars: object Extra vars
タイトル:
Extra vars
- forks: integer
タイトル:
Forks
最小値:0
- instance_groups: array instance_groups
一意のアイテムが必要:
true
- inventory: integer
タイトル:
Inventory
- inventory_needed_to_start: string
タイトル:
Inventory needed to start
読取り専用:true
- job_slice_count: integer
タイトル:
Job slice count
最小値:0
- job_tags: string
タイトル:
Job tags
- job_template_data: string
タイトル:
Job template data
読取り専用:true
- job_type: string
タイトル:
Job type
指定できる値:[ "run", "check" ]
- labels: array labels
一意のアイテムが必要:
true
- limit: string
タイトル:
Limit
- passwords_needed_to_start: string
タイトル:
Passwords needed to start
読取り専用:true
- scm_branch: string
タイトル:
Scm branch
- skip_tags: string
タイトル:
Skip tags
- survey_enabled: string
タイトル:
Survey enabled
読取り専用:true
- timeout: integer
タイトル:
Timeout
- variables_needed_to_start: string
タイトル:
Variables needed to start
読取り専用:true
- verbosity: integer
タイトル:
Verbosity
指定できる値:[ "0", "1", "2", "3", "4", "5" ]
ネストされたスキーマ : 追加バー
型:
object
タイトル:
Extra vars