Jump to

• Request
• Response

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

Body ()

Root Schema : AdHocCommandList

Type: object

Show Source

• 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
  Title: Related

  Read Only: true
• 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.

{
    "properties":{
        "become_enabled":{
            "title":"Become enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "canceled_on":{
            "description":"The date and time when the cancel request was sent.",
            "format":"date-time",
            "readOnly":true,
            "title":"Canceled on",
            "type":"string",
            "x-nullable":true
        },
        "controller_node":{
            "description":"The instance that managed the execution environment.",
            "minLength":"1",
            "readOnly":true,
            "title":"Controller node",
            "type":"string"
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credential":{
            "title":"Credential",
            "type":"integer",
            "x-nullable":true
        },
        "diff_mode":{
            "title":"Diff mode",
            "type":"boolean",
            "x-nullable":true
        },
        "elapsed":{
            "description":"Elapsed time in seconds that the job ran.",
            "format":"decimal",
            "readOnly":true,
            "title":"Elapsed",
            "type":"string"
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "execution_node":{
            "description":"The node the job executed on.",
            "minLength":"1",
            "readOnly":true,
            "title":"Execution node",
            "type":"string"
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"string",
            "x-nullable":true
        },
        "failed":{
            "readOnly":true,
            "title":"Failed",
            "type":"boolean"
        },
        "finished":{
            "description":"The date and time the job finished execution.",
            "format":"date-time",
            "readOnly":true,
            "title":"Finished",
            "type":"string",
            "x-nullable":true
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "job_explanation":{
            "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout",
            "minLength":"1",
            "readOnly":true,
            "title":"Job explanation",
            "type":"string"
        },
        "job_type":{
            "default":"run",
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "type":"string",
            "x-nullable":true
        },
        "launch_type":{
            "enum":[
                "manual",
                "relaunch",
                "callback",
                "scheduled",
                "dependency",
                "workflow",
                "webhook",
                "sync",
                "scm"
            ],
            "readOnly":true,
            "title":"Launch type",
            "type":"string"
        },
        "launched_by":{
            "readOnly":true,
            "title":"Launched by",
            "type":"string"
        },
        "limit":{
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "module_args":{
            "title":"Module args",
            "type":"string",
            "x-nullable":true
        },
        "module_name":{
            "default":"command",
            "enum":[
                "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"
            ],
            "title":"Module name",
            "type":"string"
        },
        "name":{
            "minLength":"1",
            "readOnly":true,
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "started":{
            "description":"The date and time the job was queued for starting.",
            "format":"date-time",
            "readOnly":true,
            "title":"Started",
            "type":"string",
            "x-nullable":true
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "title":"Verbosity",
            "type":"integer"
        },
        "work_unit_id":{
            "description":"The Receptor work unit ID associated with this job.",
            "minLength":"1",
            "readOnly":true,
            "title":"Work unit id",
            "type":"string",
            "x-nullable":true
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Body ()

Root Schema : AdHocCommandList

Type: object

Show Source

• 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
  Title: Related

  Read Only: true
• 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.

{
    "properties":{
        "become_enabled":{
            "title":"Become enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "canceled_on":{
            "description":"The date and time when the cancel request was sent.",
            "format":"date-time",
            "readOnly":true,
            "title":"Canceled on",
            "type":"string",
            "x-nullable":true
        },
        "controller_node":{
            "description":"The instance that managed the execution environment.",
            "minLength":"1",
            "readOnly":true,
            "title":"Controller node",
            "type":"string"
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credential":{
            "title":"Credential",
            "type":"integer",
            "x-nullable":true
        },
        "diff_mode":{
            "title":"Diff mode",
            "type":"boolean",
            "x-nullable":true
        },
        "elapsed":{
            "description":"Elapsed time in seconds that the job ran.",
            "format":"decimal",
            "readOnly":true,
            "title":"Elapsed",
            "type":"string"
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "execution_node":{
            "description":"The node the job executed on.",
            "minLength":"1",
            "readOnly":true,
            "title":"Execution node",
            "type":"string"
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"string",
            "x-nullable":true
        },
        "failed":{
            "readOnly":true,
            "title":"Failed",
            "type":"boolean"
        },
        "finished":{
            "description":"The date and time the job finished execution.",
            "format":"date-time",
            "readOnly":true,
            "title":"Finished",
            "type":"string",
            "x-nullable":true
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "job_explanation":{
            "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout",
            "minLength":"1",
            "readOnly":true,
            "title":"Job explanation",
            "type":"string"
        },
        "job_type":{
            "default":"run",
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "type":"string",
            "x-nullable":true
        },
        "launch_type":{
            "enum":[
                "manual",
                "relaunch",
                "callback",
                "scheduled",
                "dependency",
                "workflow",
                "webhook",
                "sync",
                "scm"
            ],
            "readOnly":true,
            "title":"Launch type",
            "type":"string"
        },
        "launched_by":{
            "readOnly":true,
            "title":"Launched by",
            "type":"string"
        },
        "limit":{
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "module_args":{
            "title":"Module args",
            "type":"string",
            "x-nullable":true
        },
        "module_name":{
            "default":"command",
            "enum":[
                "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"
            ],
            "title":"Module name",
            "type":"string"
        },
        "name":{
            "minLength":"1",
            "readOnly":true,
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "started":{
            "description":"The date and time the job was queued for starting.",
            "format":"date-time",
            "readOnly":true,
            "title":"Started",
            "type":"string",
            "x-nullable":true
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "title":"Verbosity",
            "type":"integer"
        },
        "work_unit_id":{
            "description":"The Receptor work unit ID associated with this job.",
            "minLength":"1",
            "readOnly":true,
            "title":"Work unit id",
            "type":"string",
            "x-nullable":true
        }
    },
    "type":"object"
}

Back to Top