GET /api/job_invocations
ジョブ呼び出しを一覧表示

パラメーター

パラメーター名 記述
location_id
任意

要求に現在のロケーションコンテキストを設定します

Validations:

  • Must be a Integer

organization_id
任意

要求に現在の組織コンテキストを設定します

Validations:

  • Must be a Integer

search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

フィールドと順序のソート (例: ‘id DESC’)

Validations:

  • Must be a String

page
任意

1 から始まるページ番号

Validations:

  • Must be a number.

per_page
任意

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.


GET /api/job_invocations/:id
ジョブ呼び出しを表示

パラメーター

パラメーター名 記述
location_id
任意

要求に現在のロケーションコンテキストを設定します

Validations:

  • Must be a Integer

organization_id
任意

要求に現在の組織コンテキストを設定します

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

host_status
任意

Show Job status for the hosts

Validations:

  • Must be one of: true, false, 1, 0.


POST /api/job_invocations
ジョブ呼び出しを作成

パラメーター

パラメーター名 記述
location_id
任意

要求に現在のロケーションコンテキストを設定します

Validations:

  • Must be a Integer

organization_id
任意

要求に現在の組織コンテキストを設定します

Validations:

  • Must be a Integer

job_invocation
必須

Validations:

  • Must be a Hash

job_invocation[job_template_id]
任意 , nil可

使用するジョブテンプレート。機能が指定されていなければ、パラメーターが必要になります

Validations:

  • Must be a String

job_invocation[targeting_type]
必須

Invocation type, one of {“static_query”=>“Static Query”, “dynamic_query”=>“Dynamic Query”}

Validations:

  • Must be a String

job_invocation[randomized_ordering]
任意 , nil可

Execute the jobs on hosts in randomized order

Validations:

  • Must be one of: true, false, 1, 0.

job_invocation[inputs]
任意 , nil可

使用する入力

Validations:

  • Must be a Hash

job_invocation[ssh]
任意 , nil可

SSH プロバイダー固有オプション

Validations:

  • Must be a Hash

job_invocation[ssh][effective_user]
任意 , nil可

スクリプトを実行するために使用するユーザー (sudo と同様のメカニズムを使用)。デフォルト値は、テンプレートパラメーターまたはグローバル設定です。

Validations:

  • Must be a String

job_invocation[recurrence]
任意 , nil可

繰り返しジョブを作成

Validations:

  • Must be a Hash

job_invocation[recurrence][cron_line]
任意 , nil可

ジョブを実行する頻度 (cron 形式)

Validations:

  • Must be a String

job_invocation[recurrence][max_iteration]
任意 , nil可

最大 N 回繰り返す

Validations:

  • Must be a number.

job_invocation[recurrence][end_time]
任意 , nil可

これ以降実行しない

Validations:

  • Must be a DateTime

job_invocation[scheduling]
任意 , nil可

後で開始するジョブをスケジュール

Validations:

  • Must be a Hash

job_invocation[scheduling][start_at]
任意 , nil可

将来のジョブをスケジュール

Validations:

  • Must be a DateTime

job_invocation[scheduling][start_before]
任意 , nil可

アクションはこの時刻よりも前に開始できない場合にキャンセルされることを示しています。

Validations:

  • Must be a DateTime

job_invocation[concurrency_control]
任意 , nil可

同時実行レベルと分散を制御

Validations:

  • Must be a Hash

job_invocation[concurrency_control][time_span]
任意 , nil可

N 秒間にわたってタスクを分散

Validations:

  • Must be a Integer

job_invocation[concurrency_control][concurrency_level]
任意 , nil可

一度に最大 N タスクを実行

Validations:

  • Must be a Integer

job_invocation[bookmark_id]
任意 , nil可

Validations:

  • Must be a Integer

job_invocation[search_query]
任意 , nil可

Validations:

  • Must be a String

job_invocation[description_format]
任意 , nil可

この呼び出しに対してのみテンプレートから説明形式を上書き

Validations:

  • Must be a String

job_invocation[execution_timeout_interval]
任意 , nil可

この呼び出しに対してのみテンプレートのタイムアウト間隔を上書き

Validations:

  • Must be a Integer

job_invocation[feature]
任意 , nil可

トリガーされるリモート実行機能ラベル。この機能に割り当てられたジョブテンプレートが使用されます

Validations:

  • Must be a String


GET /api/job_invocations/:id/hosts/:host_id
ホストの出力を取得

パラメーター

パラメーター名 記述
location_id
任意

要求に現在のロケーションコンテキストを設定します

Validations:

  • Must be a Integer

organization_id
任意

要求に現在の組織コンテキストを設定します

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

host_id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

since
任意

Validations:

  • Must be a String


GET /api/job_invocations/:id/hosts/:host_id/raw
Get raw output for a host

パラメーター

パラメーター名 記述
location_id
任意

要求に現在のロケーションコンテキストを設定します

Validations:

  • Must be a Integer

organization_id
任意

要求に現在の組織コンテキストを設定します

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

host_id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/job_invocations/:id/cancel
ジョブ呼び出しをキャンセル

パラメーター

パラメーター名 記述
location_id
任意

要求に現在のロケーションコンテキストを設定します

Validations:

  • Must be a Integer

organization_id
任意

要求に現在の組織コンテキストを設定します

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

force
任意

Validations:

  • Must be one of: true, false, 1, 0.


POST /api/job_invocations/:id/rerun
失敗したホストでのジョブの再実行

パラメーター

パラメーター名 記述
location_id
任意

要求に現在のロケーションコンテキストを設定します

Validations:

  • Must be a Integer

organization_id
任意

要求に現在の組織コンテキストを設定します

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

failed_only
任意

Validations:

  • Must be one of: true, false, 1, 0.