インベントリのジョブ・テンプレートのリスト
get
/api/v2/inventories/{id}/job_templates/
このリソースに対してGETリクエストを行って、選択したインベントリに関連付けられたジョブ・テンプレートのリストを取得します。
結果のデータ構造には次が含まれます。
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
count
フィールドは、対象となる問合せで見つかったジョブ・テンプレートの合計数を示します。 next
フィールドとprevious
フィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。 results
リストには、0個以上のジョブ・テンプレート・レコードが含まれます。
結果
それぞれのジョブ・テンプレートのデータ構造には次のフィールドが含まれます。
id
: このジョブ・テンプレートのデータベースID。(整数)type
: このジョブ・テンプレートのデータ型。(選択)url
: このジョブ・テンプレートのURL。(文字列)related
: 関連リソースのURLを含むデータ構造。(オブジェクト)summary_fields
: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)created
: このジョブ・テンプレートが作成されたときのタイムスタンプ。(日時)modified
: このジョブ・テンプレートが最後に変更されたときのタイムスタンプ。(日時)name
: このジョブ・テンプレートの名前。(文字列)description
: このジョブ・テンプレートのオプションの説明。(文字列)job_type
: (選択)run
: 実行check
: チェック
inventory
: (id)project
: (id)playbook
: (文字列)scm_branch
: ジョブ実行で使用するブランチ。 空白の場合に使用されるプロジェクトのデフォルト。 プロジェクトのallow_overrideフィールドがtrueに設定されている場合にのみ許可されます。(文字列)forks
: (整数)limit
: (文字列)verbosity
: (選択)0
: 0 (標準)1
: 1 (詳細)2
: 2 (より詳細)3
: 3 (デバッグ)4
: 4 (接続デバッグ)5
: 5 (WinRMデバッグ)
extra_vars
: (json)job_tags
: (文字列)force_handlers
: (ブール)skip_tags
: (文字列)start_at_task
: (文字列)timeout
: タスクが取り消されるまでの実行時間(秒)。(整数)use_fact_cache
: 有効にすると、サービスはAnsibleファクト・キャッシュ・プラグインとして機能します。プレイブック実行の最後にファクトを永続化し、Ansibleで使用するファクトをキャッシュします。(ブール)organization
: このテンプレートへのアクセス権を決定するために使用される組織。(id)last_job_run
: (日時)last_job_failed
: (ブール)next_job_run
: (日時)status
: (選択)new
: 新規pending
: 保留中waiting
: 待機中running
: 実行中successful
: 成功failed
: 失敗error
: エラーcanceled
: 取消し済never updated
: 更新なし
execution_environment
: 実行に使用されるコンテナ・イメージ。(id)host_config_key
: (文字列)ask_scm_branch_on_launch
: (ブール)ask_diff_mode_on_launch
: (ブール)ask_variables_on_launch
: (ブール)ask_limit_on_launch
: (ブール)ask_tags_on_launch
: (ブール)ask_skip_tags_on_launch
: (ブール)ask_job_type_on_launch
: (ブール)ask_verbosity_on_launch
: (ブール)ask_inventory_on_launch
: (ブール)ask_credential_on_launch
: (ブール)ask_execution_environment_on_launch
: (boolean)ask_labels_on_launch
: (boolean)ask_forks_on_launch
: (boolean)ask_job_slice_count_on_launch
: (boolean)ask_timeout_on_launch
: (boolean)ask_instance_groups_on_launch
: (boolean)survey_enabled
: (ブール)become_enabled
: (ブール)diff_mode
: 有効にすると、ホスト上のテンプレート化されたファイルに加えられたテキストの変更が標準出力に表示されます(ブール)allow_simultaneous
: (ブール)custom_virtualenv
: 使用するカスタムPython virtualenvを含むローカルの絶対ファイル・パス(文字列)job_slice_count
: 実行時にスライスするジョブの数。 値が1より大きい場合は、ジョブ・テンプレートによってワークフローが起動されます。(整数)webhook_service
: Webフック・リクエストを受け入れるサービス(選択)""
: ---------github
: GitHubgitlab
: GitLabbitbucket_dc
: BitBucket DataCenter
webhook_credential
: サービスAPIにステータスをポスト・バックするための個人アクセス・トークン(id)prevent_instance_group_fallback
: 有効にすると、ジョブ・テンプレートによって、実行する優先インスタンス・グループのリストに在庫または組織インスタンス・グループを追加できなくなります。この設定が有効で、空のリストを指定した場合、グローバル・インスタンス・グループが適用されます。(ブール)
ソート
ジョブ・テンプレートが特定の順序で返されるように指定するには、GETリクエストでorder_by
問合せ文字列パラメータを使用します。
?order_by=name
フィールド名の先頭にダッシュ-
を付けると逆の順序でソートされます。
?order_by=-name
フィールド名をカンマ,
で区切ると、複数のソート・フィールドを指定できます。
?order_by=name,some_other_field
ページ区切り
リクエストごとに返される結果の数を変更するには、page_size
問合せ文字列パラメータを使用します。 特定のページの結果を取得するには、page
問合せ文字列パラメータを使用します。
?page_size=100&page=2
結果で返されるprevious
リンクおよびnext
リンクは、これらの問合せ文字列パラメータを自動的に設定します。
検索
モデルのすべての指定テキスト・フィールド内で大/小文字を区別しない検索を実行するには、search
問合せ文字列パラメータを使用します。
?search=findme
(Ansible Tower 3.1.0で追加)関連フィールド全体を検索します。
?related__search=findme
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
問合せパラメータ
- page: integer
ページ区切りが設定された結果セット内のページ番号。
- page_size: integer
ページごとに返す結果の数。
- search: string
検索条件。
レスポンス
サポートされているメディア・タイプ
- 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フック・リクエストを受け入れるサービス