組織のジョブ・テンプレートの作成
post
/api/v2/organizations/{id}/job_templates/
次のジョブ・テンプレート・フィールドを指定してこのリソースに対してPOSTリクエストを行って、この組織に関連付けられた新しいジョブ・テンプレートを作成します。
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、デフォルト=``)
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
ルート・スキーマ : schema
型:
ソースを表示
object
- allow_simultaneous(オプション): ブール
- ask_credential_on_launch(オプション): ブール
- ask_diff_mode_on_launch(オプション): ブール
- ask_inventory_on_launch(オプション): ブール
- ask_job_type_on_launch(オプション): ブール
- ask_limit_on_launch(オプション): ブール
- ask_scm_branch_on_launch(オプション): ブール
- ask_skip_tags_on_launch(オプション): ブール
- ask_tags_on_launch(オプション): ブール
- ask_variables_on_launch(オプション): ブール
- ask_verbosity_on_launch(オプション): ブール
- become_enabled(オプション): ブール
- description(オプション): 文字列
- diff_mode(オプション): ブール
有効にすると、ホスト上のテンプレート化されたファイルに加えられたテキストの変更が標準出力に表示されます
- execution_environment(オプション): 整数
実行に使用するコンテナ・イメージ。
- extra_vars(オプション): 文字列
- force_handlers(オプション): ブール
- forks(オプション): 整数
- host_config_key(オプション): 文字列
- inventory(オプション): 整数
- job_slice_count(オプション): 整数
実行時にスライスするジョブの数。 値が1より大きい場合は、ジョブ・テンプレートによってワークフローが起動されます。
- job_tags(オプション): 文字列
- job_type(オプション): 文字列
- limit(オプション): 文字列
- name: 文字列
- playbook(オプション): 文字列
- project(オプション): 文字列
- scm_branch(オプション): 文字列
ジョブ実行で使用するブランチ。 空白の場合に使用されるプロジェクトのデフォルト。 プロジェクトのallow_overrideフィールドがtrueに設定されている場合にのみ許可されます。
- skip_tags(オプション): 文字列
- start_at_task(オプション): 文字列
- survey_enabled(オプション): ブール
- timeout(オプション): 整数
タスクが取り消されるまでの実行時間(秒)。
- use_fact_cache(オプション): ブール
有効にすると、サービスはAnsibleファクト・キャッシュ・プラグインとして機能します。プレイブック実行の最後にファクトを永続化し、Ansibleで使用するファクトをキャッシュします。
- verbosity(オプション): 文字列
- webhook_credential(オプション): 整数
サービスAPIにステータスをポスト・バックするための個人アクセス・トークン
- webhook_service(オプション): 文字列
Webフック・リクエストの受入れ元となるサービス