1. Oracle Linux Automation Manager CLI and API Reference Guide
  2. Tasks
  3. Inventories

List Inventory Sources for an Inventory

get

/api/v2/inventories/{id}/inventory_sources/

Make a GET request to this resource to retrieve a list of inventory sources associated with the selected inventory.

The resulting data structure contains:

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

The count field indicates the total number of inventory sources found for the given query. The next and previous fields provides links to additional results if there are more than will fit on a single page. The results list contains zero or more inventory source records.

Results

Each inventory source data structure includes 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)

Sorting

To specify that inventory sources are returned in a particular order, use the order_by query string parameter on the GET request.

?order_by=name

Prefix the field name with a dash - to sort in reverse:

?order_by=-name

Multiple sorting fields may be specified by separating the field names with a comma ,:

?order_by=name,some_other_field

Pagination

Use the page_size query string parameter to change the number of results returned for each request. Use the page query string parameter to retrieve a particular page of results.

?page_size=100&page=2

The previous and next links returned with the results will set these query string parameters automatically.

Searching

Use the search query string parameter to perform a case-insensitive search within all designated text fields of a model.

?search=findme

(Added in Ansible Tower 3.1.0) Search across related fields:

?related__search=findme

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : results
Type: array
Show Source
Nested Schema : InventorySource
Type: object
Show Source
Back to Top