POST /api/job_invocations { "job_invocation": { "feature": "remote_execution_feature_1", "host_ids": [ "host7" ] } } 201 { "id": 6, "description": "Job template 4 with inputs Template input 1=\"''\"", "job_category": "Job name 4", "targeting_id": 7, "status": 3, "start_at": "2024-02-22 18:13:32 UTC", "status_label": "running", "ssh_user": null, "time_to_pickup": null, "dynflow_task": { "id": "473e63f0-e24e-458e-a690-0c5225c5bd93", "state": "planned" }, "template_id": 1007981717, "template_name": "Job template 4", "effective_user": "root", "succeeded": "N/A", "failed": "N/A", "pending": "N/A", "total": 1, "missing": 0, "targeting": { "bookmark_id": null, "search_query": "name ^ (host7)", "targeting_type": "static_query", "user_id": 135138680, "randomized_ordering": null, "hosts": [ { "name": "host7", "id": 10, "display_name": "host7" } ] }, "task": { "id": "473e63f0-e24e-458e-a690-0c5225c5bd93", "state": "planned" } }
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
job_invocation
required |
Validations:
|
job_invocation[job_template_id]
optional , nil allowed |
The job template to use, parameter is required unless feature was specified Validations:
|
job_invocation[targeting_type]
required |
Invocation type, one of {“static_query”=>“Static Query”, “dynamic_query”=>“Dynamic Query”} Validations:
|
job_invocation[randomized_ordering]
optional , nil allowed |
Execute the jobs on hosts in randomized order Validations:
|
job_invocation[inputs]
optional , nil allowed |
Inputs to use Validations:
|
job_invocation[ssh]
optional , nil allowed |
SSH provider specific options Validations:
|
job_invocation[ssh][effective_user]
optional , nil allowed |
What user should be used to run the script (using sudo-like mechanisms). Defaults to a template parameter or global setting. Validations:
|
job_invocation[ssh][effective_user_password]
optional , nil allowed |
Set password for effective user (using sudo-like mechanisms) Validations:
|
job_invocation[ssh_user]
optional , nil allowed |
Set SSH user Validations:
|
job_invocation[password]
optional , nil allowed |
Set SSH password Validations:
|
job_invocation[key_passphrase]
optional , nil allowed |
Set SSH key passphrase Validations:
|
job_invocation[recurrence]
optional , nil allowed |
Create a recurring job Validations:
|
job_invocation[recurrence][cron_line]
optional , nil allowed |
How often the job should occur, in the cron format Validations:
|
job_invocation[recurrence][max_iteration]
optional , nil allowed |
Repeat a maximum of N times Validations:
|
job_invocation[recurrence][end_time]
optional , nil allowed |
Perform no more executions after this time Validations:
|
job_invocation[recurrence][purpose]
optional , nil allowed |
Designation of a special purpose Validations:
|
job_invocation[scheduling]
optional , nil allowed |
Schedule the job to start at a later time Validations:
|
job_invocation[scheduling][start_at]
optional , nil allowed |
Schedule the job for a future time Validations:
|
job_invocation[scheduling][start_before]
optional , nil allowed |
Indicates that the action should be cancelled if it cannot be started before this time. Validations:
|
job_invocation[concurrency_control]
optional , nil allowed |
Control concurrency level and distribution over time Validations:
|
job_invocation[concurrency_control][concurrency_level]
optional , nil allowed |
Run at most N tasks at a time Validations:
|
job_invocation[bookmark_id]
optional , nil allowed |
Validations:
|
job_invocation[search_query]
optional , nil allowed |
Validations:
|
job_invocation[description_format]
optional , nil allowed |
Override the description format from the template for this invocation only Validations:
|
job_invocation[execution_timeout_interval]
optional , nil allowed |
Override the timeout interval from the template for this invocation only Validations:
|
job_invocation[feature]
optional , nil allowed |
Remote execution feature label that should be triggered, job template assigned to this feature will be used Validations:
|
job_invocation[time_to_pickup]
optional , nil allowed |
Override the global time to pickup interval for this invocation only Validations:
|