Jump to

• Request
• Response

Retrieve an Inventory Update

get

/api/v2/inventory_updates/{id}/

Make GET request to this resource to retrieve a single inventory update record containing the following fields:

• id: Database ID for this inventory update. (integer)
• type: Data type for this inventory update. (choice)
• url: URL for this inventory update. (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 inventory update was created. (datetime)
• modified: Timestamp when this inventory update was last modified. (datetime)
• name: Name of this inventory update. (string)
• description: Optional description of this inventory update. (string)
• source: (choice)
  • file: File, Directory or Script
  • constructed: Template additional groups and hostvars at runtime
  • scm: Sourced from a Project
  • ec2: Amazon EC2
  • gce: Google Compute Engine
  • azure_rm: Microsoft Azure Resource Manager
  • vmware: VMware vCenter
  • satellite6: Red Hat Satellite 6
  • openstack: OpenStack
  • rhv: Red Hat Virtualization
  • controller: Red Hat Ansible Automation Platform
  • insights: Red Hat Insights
• source_path: (string)
• source_vars: Inventory source variables in YAML or JSON format. (string)
• scm_branch: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)
• credential: Cloud credential to use for inventory updates. (integer)
• enabled_var: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)
• enabled_value: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)
• host_filter: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)
• overwrite: Overwrite local groups and hosts from remote inventory source. (boolean)
• overwrite_vars: Overwrite local variables from remote inventory source. (boolean)
• custom_virtualenv: (string)
• timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
• verbosity: (choice)
  • 0: 0 (WARNING)
  • 1: 1 (INFO)
  • 2: 2 (DEBUG)
• limit: Enter host, group or pattern match (string)
• unified_job_template: (id)
• 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)
• inventory: (id)
• inventory_source: (id)
• license_error: (boolean)
• org_host_limit_error: (boolean)
• source_project_update: Inventory files from this Project Update were used for the inventory update. (id)
• instance_group: The Instance group the job was run under (id)
• scm_revision: The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm (string)
• source_project: The project used for this job. (field)

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : InventoryUpdateDetail

Type: object

Show Source

• 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

  Minimum Value: 1

  Cloud credential to use for inventory updates.
• custom_virtualenv: string
  Title: Custom virtualenv

  Read Only: true
• description: string
  Title: Description
• elapsed: string(decimal)
  Title: Elapsed

  Read Only: true

  Elapsed time in seconds that the job ran.
• enabled_value: string
  Title: Enabled value

  Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled
• enabled_var: string
  Title: Enabled var

  Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default)
• event_processing_finished: boolean
  Title: Event processing finished

  Read Only: true

  Indicates whether all of the events generated by this unified job have been saved to the database.
• 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.
• failed: boolean
  Title: Failed

  Read Only: true
• finished: string(date-time)
  Title: Finished

  Read Only: true

  The date and time the job finished execution.
• host_filter: string
  Title: Host filter

  This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.
• id: integer
  Title: ID

  Read Only: true
• instance_group: integer
  Title: Instance group

  The Instance group the job was run under
• inventory: integer
  Title: Inventory
• inventory_source: string
  Title: Inventory source

  Read Only: true
• job_args: string
  Title: Job args

  Read Only: true

  Minimum Length: 1
• job_cwd: string
  Title: Job cwd

  Read Only: true

  Minimum Length: 1
• job_env: object job_env
  Title: job_env

  Read Only: true
• 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
• 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
• license_error: boolean
  Title: License error

  Read Only: true
• limit: string
  Title: Limit

  Enter host, group or pattern match
• modified: string
  Title: Modified

  Read Only: true
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 512
• org_host_limit_error: boolean
  Title: Org host limit error

  Read Only: true
• overwrite: boolean
  Title: Overwrite

  Overwrite local groups and hosts from remote inventory source.
• overwrite_vars: boolean
  Title: Overwrite vars

  Overwrite local variables from remote inventory source.
• related: string
  Title: Related

  Read Only: true
• result_traceback: string
  Title: Result traceback

  Read Only: true

  Minimum Length: 1
• scm_branch: string
  Title: Scm branch

  Maximum Length: 1024

  Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true.
• scm_revision: string
  Title: SCM Revision

  Read Only: true

  Minimum Length: 1

  The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm
• source: string
  Title: Source

  Allowed Values: [ "file", "constructed", "scm", "ec2", "gce", "azure_rm", "vmware", "satellite6", "openstack", "rhv", "controller", "insights" ]
• source_path: string
  Title: Source path

  Maximum Length: 1024
• source_project: string
  Title: Source project

  Read Only: true

  The project used for this job.
• source_project_update: string
  Title: Source project update

  Inventory files from this Project Update were used for the inventory update.
• source_vars: string
  Title: Source vars

  Inventory source variables in YAML or JSON format.
• 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
• timeout: integer
  Title: Timeout

  The amount of time (in seconds) to run before the task is canceled.
• type: string
  Title: Type

  Read Only: true
• unified_job_template: string
  Title: unified job template

  Read Only: true
• url: string
  Title: Url

  Read Only: true
• verbosity: integer
  Title: Verbosity

  Default Value: 1

  Allowed Values: [ "0", "1", "2" ]
• work_unit_id: string
  Title: Work unit id

  Read Only: true

  Minimum Length: 1

  The Receptor work unit ID associated with this job.

{
    "properties":{
        "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":{
            "description":"Cloud credential to use for inventory updates.",
            "minimum":"1",
            "title":"Credential",
            "type":"integer",
            "x-nullable":true
        },
        "custom_virtualenv":{
            "readOnly":true,
            "title":"Custom virtualenv",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "elapsed":{
            "description":"Elapsed time in seconds that the job ran.",
            "format":"decimal",
            "readOnly":true,
            "title":"Elapsed",
            "type":"string"
        },
        "enabled_value":{
            "description":"Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var=\"status.power_state\"and enabled_value=\"powered_on\" with host variables:{   \"status\": {     \"power_state\": \"powered_on\",     \"created\": \"2018-02-01T08:00:00.000000Z:00\",     \"healthy\": true    },    \"name\": \"foobar\",    \"ip_address\": \"192.168.2.1\"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled",
            "title":"Enabled value",
            "type":"string",
            "x-nullable":true
        },
        "enabled_var":{
            "description":"Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as \"foo.bar\", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get(\"foo\", {}).get(\"bar\", default)",
            "title":"Enabled var",
            "type":"string",
            "x-nullable":true
        },
        "event_processing_finished":{
            "description":"Indicates whether all of the events generated by this unified job have been saved to the database.",
            "readOnly":true,
            "title":"Event processing finished",
            "type":"boolean"
        },
        "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"
        },
        "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
        },
        "host_filter":{
            "description":"This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.",
            "title":"Host filter",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "instance_group":{
            "description":"The Instance group the job was run under",
            "title":"Instance group",
            "type":"integer",
            "x-nullable":true
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "inventory_source":{
            "readOnly":true,
            "title":"Inventory source",
            "type":"string"
        },
        "job_args":{
            "minLength":"1",
            "readOnly":true,
            "title":"Job args",
            "type":"string"
        },
        "job_cwd":{
            "minLength":"1",
            "readOnly":true,
            "title":"Job cwd",
            "type":"string"
        },
        "job_env":{
            "readOnly":true,
            "title":"job_env",
            "type":"object"
        },
        "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"
        },
        "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"
        },
        "license_error":{
            "readOnly":true,
            "title":"License error",
            "type":"boolean"
        },
        "limit":{
            "description":"Enter host, group or pattern match",
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "org_host_limit_error":{
            "readOnly":true,
            "title":"Org host limit error",
            "type":"boolean"
        },
        "overwrite":{
            "description":"Overwrite local groups and hosts from remote inventory source.",
            "title":"Overwrite",
            "type":"boolean",
            "x-nullable":true
        },
        "overwrite_vars":{
            "description":"Overwrite local variables from remote inventory source.",
            "title":"Overwrite vars",
            "type":"boolean",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "result_traceback":{
            "minLength":"1",
            "readOnly":true,
            "title":"Result traceback",
            "type":"string"
        },
        "scm_branch":{
            "description":"Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true.",
            "maxLength":"1024",
            "title":"Scm branch",
            "type":"string",
            "x-nullable":true
        },
        "scm_revision":{
            "description":"The SCM Revision from the Project used for this inventory update.  Only applicable to inventories source from scm",
            "minLength":"1",
            "readOnly":true,
            "title":"SCM Revision",
            "type":"string"
        },
        "source":{
            "enum":[
                "file",
                "constructed",
                "scm",
                "ec2",
                "gce",
                "azure_rm",
                "vmware",
                "satellite6",
                "openstack",
                "rhv",
                "controller",
                "insights"
            ],
            "title":"Source",
            "type":"string",
            "x-nullable":true
        },
        "source_path":{
            "maxLength":"1024",
            "title":"Source path",
            "type":"string",
            "x-nullable":true
        },
        "source_project":{
            "description":"The project used for this job.",
            "readOnly":true,
            "title":"Source project",
            "type":"string"
        },
        "source_project_update":{
            "description":"Inventory files from this Project Update were used for the inventory update.",
            "title":"Source project update",
            "type":"string",
            "x-nullable":true
        },
        "source_vars":{
            "description":"Inventory source variables in YAML or JSON format.",
            "title":"Source vars",
            "type":"string",
            "x-nullable":true
        },
        "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"
        },
        "timeout":{
            "description":"The amount of time (in seconds) to run before the task is canceled.",
            "title":"Timeout",
            "type":"integer"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "unified_job_template":{
            "readOnly":true,
            "title":"unified job template",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "verbosity":{
            "default":"1",
            "enum":[
                "0",
                "1",
                "2"
            ],
            "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
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

Nested Schema : job_env

Type: object

Title: job_env

Read Only: true

Back to Top