Retrieve an Ad Hoc Command
get
/api/v2/ad_hoc_commands/{id}/
Make GET request to this resource to retrieve a single ad hoc command record containing the following fields:
id: Database ID for this ad hoc command. (integer)type: Data type for this ad hoc command. (choice)url: URL for this ad hoc command. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this ad hoc command was created. (datetime)modified: Timestamp when this ad hoc command was last modified. (datetime)name: Name of this ad hoc command. (string)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Update
status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: Canceled
execution_environment: The container image to be used for execution. (id)failed: (boolean)started: The date and time the job was queued for starting. (datetime)finished: The date and time the job finished execution. (datetime)canceled_on: The date and time when the cancel request was sent. (datetime)elapsed: Elapsed time in seconds that the job ran. (decimal)job_args: (string)job_cwd: (string)job_env: (json)job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)execution_node: The node the job executed on. (string)controller_node: The instance that managed the execution environment. (string)result_traceback: (string)event_processing_finished: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)launched_by: (field)work_unit_id: The Receptor work unit ID associated with this job. (string)job_type: (choice)run: Runcheck: Check
inventory: (id)limit: (string)credential: (id)module_name: (choice)commandshellyumaptapt_keyapt_repositoryapt_rpmservicegroupusermountpingselinuxsetupwin_pingwin_servicewin_updateswin_groupwin_user
module_args: (string)forks: (integer)verbosity: (choice)0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)
extra_vars: (string)become_enabled: (boolean)diff_mode: (boolean)host_status_counts: Playbook stats from the Ansible playbook_on_stats event. (json)
Request
Supported Media Types
- application/json
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
Root Schema : AdHocCommandDetail
Type:
Show Source
object-
become_enabled:
boolean
Title:
Become enabled -
canceled_on:
string(date-time)
Title:
Canceled onRead Only:trueThe date and time when the cancel request was sent. -
controller_node:
string
Title:
Controller nodeRead Only:trueMinimum Length:1The instance that managed the execution environment. -
created:
string
Title:
CreatedRead Only:true -
credential:
integer
Title:
Credential -
diff_mode:
boolean
Title:
Diff mode -
elapsed:
string(decimal)
Title:
ElapsedRead Only:trueElapsed time in seconds that the job ran. -
event_processing_finished:
boolean
Title:
Event processing finishedRead Only:trueIndicates whether all of the events generated by this unified job have been saved to the database. -
execution_environment:
integer
Title:
Execution environmentThe container image to be used for execution. -
execution_node:
string
Title:
Execution nodeRead Only:trueMinimum Length:1The node the job executed on. -
extra_vars:
string
Title:
Extra vars -
failed:
boolean
Title:
FailedRead Only:true -
finished:
string(date-time)
Title:
FinishedRead Only:trueThe date and time the job finished execution. -
forks:
integer
Title:
ForksMinimum Value:0 -
host_status_counts:
object Host status counts
Title:
Host status countsRead Only:truePlaybook stats from the Ansible playbook_on_stats event. -
id:
integer
Title:
IDRead Only:true -
inventory:
integer
Title:
Inventory -
job_args:
string
Title:
Job argsRead Only:trueMinimum Length:1 -
job_cwd:
string
Title:
Job cwdRead Only:trueMinimum Length:1 -
job_env:
object Job env
Title:
Job envRead Only:true -
job_explanation:
string
Title:
Job explanationRead Only:trueMinimum Length:1A status field to indicate the state of the job if it wasn't able to run and capture stdout -
job_type:
string
Title:
Job typeDefault Value:runAllowed Values:[ "run", "check" ] -
launch_type:
string
Title:
Launch typeRead Only:trueAllowed Values:[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ] -
launched_by:
string
Title:
Launched byRead Only:true -
limit:
string
Title:
Limit -
modified:
string
Title:
ModifiedRead Only:true -
module_args:
string
Title:
Module args -
module_name:
string
Title:
Module nameDefault Value:commandAllowed 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:
NameRead Only:trueMinimum Length:1 - related: string
-
result_traceback:
string
Title:
Result tracebackRead Only:trueMinimum Length:1 -
started:
string(date-time)
Title:
StartedRead Only:trueThe date and time the job was queued for starting. -
status:
string
Title:
StatusRead Only:trueAllowed Values:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ] -
summary_fields:
string
Title:
Summary fieldsRead Only:true -
type:
string
Title:
TypeRead Only:true -
url:
string
Title:
UrlRead Only:true -
verbosity:
integer
Title:
VerbosityAllowed Values:[ "0", "1", "2", "3", "4", "5" ] -
work_unit_id:
string
Title:
Work unit idRead Only:trueMinimum Length:1The Receptor work unit ID associated with this job.
Nested Schema : Host status counts
Type:
objectTitle:
Host status countsRead Only:
truePlaybook stats from the Ansible playbook_on_stats event.
Nested Schema : Job env
Type:
objectTitle:
Job envRead Only:
true