1. Oracle Linux Automation Manager CLI and API Reference Guide 2.1
  2. Tasks
  3. Ad Hoc Commands

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: Manual
    • relaunch: Relaunch
    • callback: Callback
    • scheduled: Scheduled
    • dependency: Dependency
    • workflow: Workflow
    • webhook: Webhook
    • sync: Sync
    • scm: SCM Update
  • status: (choice)
    • new: New
    • pending: Pending
    • waiting: Waiting
    • running: Running
    • successful: Successful
    • failed: Failed
    • error: Error
    • canceled: 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: Run
    • check: Check
  • inventory: (id)
  • limit: (string)
  • credential: (id)
  • module_name: (choice)
    • 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
  • 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: A count of hosts uniquely assigned to each status. (field)

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Body
Example Response (application/json)
{
    "become_enabled":false,
    "canceled_on":null,
    "controller_node":"",
    "created":"2018-02-01T08:00:00.000000Z",
    "credential":null,
    "diff_mode":false,
    "elapsed":"0",
    "event_processing_finished":false,
    "execution_environment":null,
    "execution_node":"",
    "extra_vars":"",
    "failed":false,
    "finished":null,
    "forks":"0",
    "host_status_counts":{
    },
    "id":"4",
    "inventory":"1",
    "job_args":"",
    "job_cwd":"",
    "job_env":{
    },
    "job_explanation":"",
    "job_type":"run",
    "launch_type":"manual",
    "launched_by":{
    },
    "limit":"",
    "modified":"2018-02-01T08:00:00.000000Z",
    "module_args":"",
    "module_name":"",
    "name":"",
    "related":{
        "activity_stream":"/api/v2/ad_hoc_commands/4/activity_stream/",
        "cancel":"/api/v2/ad_hoc_commands/4/cancel/",
        "events":"/api/v2/ad_hoc_commands/4/events/",
        "inventory":"/api/v2/inventories/1/",
        "notifications":"/api/v2/ad_hoc_commands/4/notifications/",
        "relaunch":"/api/v2/ad_hoc_commands/4/relaunch/",
        "stdout":"/api/v2/ad_hoc_commands/4/stdout/"
    },
    "result_traceback":"",
    "started":null,
    "status":"new",
    "summary_fields":{
        "inventory":{
            "description":"",
            "has_active_failures":false,
            "has_inventory_sources":true,
            "hosts_with_active_failures":"0",
            "id":"1",
            "inventory_sources_with_failures":"0",
            "kind":"",
            "name":"test-inv",
            "organization_id":"1",
            "total_groups":"0",
            "total_hosts":"0",
            "total_inventory_sources":"1"
        },
        "user_capabilities":{
            "delete":true,
            "start":true
        }
    },
    "type":"ad_hoc_command",
    "url":"/api/v2/ad_hoc_commands/4/",
    "verbosity":"0",
    "work_unit_id":null
}
Back to Top