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 Scriptscm
: Sourced from a Projectec2
: Amazon EC2gce
: Google Compute Engineazure_rm
: Microsoft Azure Resource Managervmware
: VMware vCentersatellite6
: Red Hat Satellite 6openstack
: OpenStackrhv
: Red Hat Virtualizationcontroller
: Red Hat Ansible Automation Platforminsights
: Red Hat Insights
source_path
: (string)source_vars
: Inventory source variables in YAML or JSON format. (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
: 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)
last_job_run
: (datetime)last_job_failed
: (boolean)next_job_run
: (datetime)status
: (choice)new
: Newpending
: Pendingwaiting
: Waitingrunning
: Runningsuccessful
: Successfulfailed
: Failederror
: Errorcanceled
: Cancelednever updated
: Never Updatednone
: 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)update_on_project_update
: (boolean)last_update_failed
: (boolean)last_updated
: (datetime)
Request
Supported Media Types
- application/json
Path Parameters
Query Parameters
-
search: string
A search term.