Oracle Linux Automation Manager CLI and API Reference Guide

Retrieve an Inventory Source

get

/api/v2/inventory_sources/{id}/

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

id: Database ID for this inventory source. (integer)
type: Data type for this inventory source. (choice)
url: URL for this inventory source. (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 source was created. (datetime)
modified: Timestamp when this inventory source was last modified. (datetime)
name: Name of this inventory source. (string)
description: Optional description of this inventory source. (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: Local absolute file path containing a custom Python virtualenv to use (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)
last_job_run: (datetime)
last_job_failed: (boolean)
next_job_run: (datetime)
status: (choice)
- new: New
- pending: Pending
- waiting: Waiting
- running: Running
- successful: Successful
- failed: Failed
- error: Error
- canceled: Canceled
- never updated: Never Updated
- none: No External Source
execution_environment: The container image to be used for execution. (id)
inventory: (id)
update_on_launch: (boolean)
update_cache_timeout: (integer)
source_project: Project containing inventory file used as source. (id)
last_update_failed: (boolean)
last_updated: (datetime)

Request

Supported Media Types

application/json

Path Parameters

id(required): string

Response

Supported Media Types

application/json

200 Response

Root Schema : InventorySource

Type: object

Show Source

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

Minimum Length: 1

Local absolute file path containing a custom Python virtualenv to use
description: string

Title: Description
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)
execution_environment: integer

Title: Execution environment

The container image to be used for 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
inventory(required): integer

Title: Inventory
last_job_failed: boolean

Title: Last job failed

Read Only: true
last_job_run: string(date-time)

Title: Last job run

Read Only: true
last_update_failed: boolean

Title: Last update failed

Read Only: true
last_updated: string(date-time)

Title: Last updated

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
next_job_run: string(date-time)

Title: Next job run

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
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.
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

Project containing inventory file used as source.
source_vars: string

Title: Source vars

Inventory source variables in YAML or JSON format.
status: string

Title: Status

Read Only: true

Allowed Values: [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "none" ]
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
update_cache_timeout: integer

Title: Update cache timeout

Minimum Value: 0
update_on_launch: boolean

Title: Update on launch
url: string

Title: Url

Read Only: true
verbosity: integer

Title: Verbosity

Default Value: 1

Allowed Values: [ "0", "1", "2" ]

{
    "properties":{
        "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":{
            "description":"Local absolute file path containing a custom Python virtualenv to use",
            "minLength":"1",
            "readOnly":true,
            "title":"Custom virtualenv",
            "type":"string",
            "x-nullable":true
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "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
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "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"
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "last_job_failed":{
            "readOnly":true,
            "title":"Last job failed",
            "type":"boolean"
        },
        "last_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Last job run",
            "type":"string",
            "x-nullable":true
        },
        "last_update_failed":{
            "readOnly":true,
            "title":"Last update failed",
            "type":"boolean"
        },
        "last_updated":{
            "format":"date-time",
            "readOnly":true,
            "title":"Last updated",
            "type":"string"
        },
        "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
        },
        "next_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Next job run",
            "type":"string",
            "x-nullable":true
        },
        "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"
        },
        "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
        },
        "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":"Project containing inventory file used as source.",
            "title":"Source project",
            "type":"string",
            "x-nullable":true
        },
        "source_vars":{
            "description":"Inventory source variables in YAML or JSON format.",
            "title":"Source vars",
            "type":"string",
            "x-nullable":true
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled",
                "never updated",
                "none"
            ],
            "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"
        },
        "update_cache_timeout":{
            "minimum":"0",
            "title":"Update cache timeout",
            "type":"integer"
        },
        "update_on_launch":{
            "title":"Update on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "verbosity":{
            "default":"1",
            "enum":[
                "0",
                "1",
                "2"
            ],
            "title":"Verbosity",
            "type":"integer"
        }
    },
    "required":[
        "name",
        "inventory"
    ],
    "type":"object"
}