Create an Ad Hoc Command
post
/api/v2/ad_hoc_commands/
Make a POST request to this resource with the following ad hoc command fields to create a new ad hoc command:
-
execution_environment
: The container image to be used for execution. (id, default=``) -
job_type
: (choice)run
: Run (default)check
: Check
inventory
: (id, default=``)limit
: (string, default=""
)credential
: (id, default=``)module_name
: (choice)command
(default)shell
yum
apt
apt_key
apt_repository
apt_rpm
service
group
user
mount
ping
selinux
setup
win_ping
win_service
win_updates
win_group
win_user
module_args
: (string, default=""
)forks
: (integer, default=0
)verbosity
: (choice)0
: 0 (Normal) (default)1
: 1 (Verbose)2
: 2 (More Verbose)3
: 3 (Debug)4
: 4 (Connection Debug)5
: 5 (WinRM Debug)
extra_vars
: (string, default=""
)become_enabled
: (boolean, default=False
)diff_mode
: (boolean, default=False
)
Request
Supported Media Types
- application/json
Root Schema : AdHocCommandList
Type:
Show Source
object
-
become_enabled:
boolean
Title:
Become enabled
-
canceled_on:
string(date-time)
Title:
Canceled on
Read Only:true
The date and time when the cancel request was sent. -
controller_node:
string
Title:
Controller node
Read Only:true
Minimum Length:1
The instance that managed the execution environment. -
created:
string
Title:
Created
Read Only:true
-
credential:
integer
Title:
Credential
-
diff_mode:
boolean
Title:
Diff mode
-
elapsed:
string(decimal)
Title:
Elapsed
Read Only:true
Elapsed time in seconds that the job ran. -
execution_environment:
integer
Title:
Execution environment
The container image to be used for execution. -
execution_node:
string
Title:
Execution node
Read Only:true
Minimum Length:1
The node the job executed on. -
extra_vars:
string
Title:
Extra vars
-
failed:
boolean
Title:
Failed
Read Only:true
-
finished:
string(date-time)
Title:
Finished
Read Only:true
The date and time the job finished execution. -
forks:
integer
Title:
Forks
Minimum Value:0
-
id:
integer
Title:
ID
Read Only:true
-
inventory:
integer
Title:
Inventory
-
job_explanation:
string
Title:
Job explanation
Read Only:true
Minimum Length:1
A status field to indicate the state of the job if it wasn't able to run and capture stdout -
job_type:
string
Title:
Job type
Default Value:run
Allowed Values:[ "run", "check" ]
-
launch_type:
string
Title:
Launch type
Read Only:true
Allowed Values:[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ]
-
launched_by:
string
Title:
Launched by
Read Only:true
-
limit:
string
Title:
Limit
-
modified:
string
Title:
Modified
Read Only:true
-
module_args:
string
Title:
Module args
-
module_name:
string
Title:
Module name
Default Value:command
Allowed Values:[ "command", "shell", "yum", "apt", "apt_key", "apt_repository", "apt_rpm", "service", "group", "user", "mount", "ping", "selinux", "setup", "win_ping", "win_service", "win_updates", "win_group", "win_user" ]
-
name:
string
Title:
Name
Read Only:true
Minimum Length:1
- related: string
-
started:
string(date-time)
Title:
Started
Read Only:true
The date and time the job was queued for starting. -
status:
string
Title:
Status
Read Only:true
Allowed Values:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ]
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
-
verbosity:
integer
Title:
Verbosity
Allowed Values:[ "0", "1", "2", "3", "4", "5" ]
-
work_unit_id:
string
Title:
Work unit id
Read Only:true
Minimum Length:1
The Receptor work unit ID associated with this job.
Response
Supported Media Types
- application/json
201 Response
Root Schema : AdHocCommandList
Type:
Show Source
object
-
become_enabled:
boolean
Title:
Become enabled
-
canceled_on:
string(date-time)
Title:
Canceled on
Read Only:true
The date and time when the cancel request was sent. -
controller_node:
string
Title:
Controller node
Read Only:true
Minimum Length:1
The instance that managed the execution environment. -
created:
string
Title:
Created
Read Only:true
-
credential:
integer
Title:
Credential
-
diff_mode:
boolean
Title:
Diff mode
-
elapsed:
string(decimal)
Title:
Elapsed
Read Only:true
Elapsed time in seconds that the job ran. -
execution_environment:
integer
Title:
Execution environment
The container image to be used for execution. -
execution_node:
string
Title:
Execution node
Read Only:true
Minimum Length:1
The node the job executed on. -
extra_vars:
string
Title:
Extra vars
-
failed:
boolean
Title:
Failed
Read Only:true
-
finished:
string(date-time)
Title:
Finished
Read Only:true
The date and time the job finished execution. -
forks:
integer
Title:
Forks
Minimum Value:0
-
id:
integer
Title:
ID
Read Only:true
-
inventory:
integer
Title:
Inventory
-
job_explanation:
string
Title:
Job explanation
Read Only:true
Minimum Length:1
A status field to indicate the state of the job if it wasn't able to run and capture stdout -
job_type:
string
Title:
Job type
Default Value:run
Allowed Values:[ "run", "check" ]
-
launch_type:
string
Title:
Launch type
Read Only:true
Allowed Values:[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ]
-
launched_by:
string
Title:
Launched by
Read Only:true
-
limit:
string
Title:
Limit
-
modified:
string
Title:
Modified
Read Only:true
-
module_args:
string
Title:
Module args
-
module_name:
string
Title:
Module name
Default Value:command
Allowed Values:[ "command", "shell", "yum", "apt", "apt_key", "apt_repository", "apt_rpm", "service", "group", "user", "mount", "ping", "selinux", "setup", "win_ping", "win_service", "win_updates", "win_group", "win_user" ]
-
name:
string
Title:
Name
Read Only:true
Minimum Length:1
- related: string
-
started:
string(date-time)
Title:
Started
Read Only:true
The date and time the job was queued for starting. -
status:
string
Title:
Status
Read Only:true
Allowed Values:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ]
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
-
verbosity:
integer
Title:
Verbosity
Allowed Values:[ "0", "1", "2", "3", "4", "5" ]
-
work_unit_id:
string
Title:
Work unit id
Read Only:true
Minimum Length:1
The Receptor work unit ID associated with this job.