inventory#
usage: awx inventory [-h] action ...
positional arguments:
action
list
create
get
modify
delete
optional arguments:
-h, --help show this help message and exit
awx inventory: the following arguments are required: action
inventory list#
usage: awx inventory list [-h] [--all] [--order_by ORDER_BY]
[-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v] [--type {inventory}]
[--created CREATED] [--modified MODIFIED]
[--name TEXT] [--description TEXT]
[--organization ID] [--kind {,smart,constructed}]
[--host_filter TEXT] [--variables JSON/YAML]
[--has_active_failures BOOLEAN]
[--total_hosts INTEGER]
[--hosts_with_active_failures INTEGER]
[--total_groups INTEGER]
[--has_inventory_sources BOOLEAN]
[--total_inventory_sources INTEGER]
[--inventory_sources_with_failures INTEGER]
[--pending_deletion BOOLEAN]
[--prevent_instance_group_fallback BOOLEAN]
optional arguments:
-h, --help show this help message and exit
--all fetch all pages of content from the API when returning
results (instead of just the first page)
--order_by ORDER_BY order results by given field name, prefix the field
name with a dash (-) to sort in reverse eg
--order_by='-name',multiple sorting fields may be
specified by separating the field names with a comma
(,)
--type {inventory} only list inventory with the specified type
--created CREATED only list inventory with the specified created
--modified MODIFIED only list inventory with the specified modified
--name TEXT only list inventory with the specified name
--description TEXT only list inventory with the specified description
--organization ID only list inventory with the specified organization
--kind {,smart,constructed}
only list inventory with the specified kind
--host_filter TEXT only list inventory with the specified host_filter
--variables JSON/YAML
only list inventory with the specified variables
--has_active_failures BOOLEAN
only list inventory with the specified
has_active_failures
--total_hosts INTEGER
only list inventory with the specified total_hosts
--hosts_with_active_failures INTEGER
only list inventory with the specified
hosts_with_active_failures
--total_groups INTEGER
only list inventory with the specified total_groups
--has_inventory_sources BOOLEAN
only list inventory with the specified
has_inventory_sources
--total_inventory_sources INTEGER
only list inventory with the specified
total_inventory_sources
--inventory_sources_with_failures INTEGER
only list inventory with the specified
inventory_sources_with_failures
--pending_deletion BOOLEAN
only list inventory with the specified
pending_deletion
--prevent_instance_group_fallback BOOLEAN
only list inventory with the specified
prevent_instance_group_fallback
input/output formatting:
-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}
specify a format for the input and output
--filter TEXT specify an output filter (only valid with jq or human
format)
--conf.color BOOLEAN Display colorized output. Defaults to True
-v, --verbose print debug-level logs, including requests made
inventory create#
usage: awx inventory create [-h] --name TEXT [--description TEXT]
--organization ID [--kind {,smart,constructed}]
[--host_filter TEXT] [--variables JSON/YAML]
[--prevent_instance_group_fallback BOOLEAN]
required arguments:
--name TEXT Name of this inventory.
--organization ID Organization containing this inventory.
optional arguments:
-h, --help show this help message and exit
--description TEXT Optional description of this inventory.
--kind {,smart,constructed}
Kind of inventory being represented.
--host_filter TEXT Filter that will be applied to the hosts of this
inventory.
--variables JSON/YAML
Inventory variables in JSON or YAML format. You can
optionally specify a file path e.g., @path/to/file.yml
--prevent_instance_group_fallback BOOLEAN
If enabled, the inventory will prevent adding any
organization instance groups to the list of preferred
instances groups to run associated job templates on.If
this setting is enabled and you provided an empty
list, the global instance groups will be applied.
awx inventory create: the following arguments are required: --name, --organization
inventory get#
usage: awx inventory get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
positional arguments:
id the ID (or unique name) of the resource
optional arguments:
-h, --help show this help message and exit
input/output formatting:
-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}
specify a format for the input and output
--filter TEXT specify an output filter (only valid with jq or human
format)
--conf.color BOOLEAN Display colorized output. Defaults to True
-v, --verbose print debug-level logs, including requests made
awx inventory get: the following arguments are required: id
inventory modify#
usage: awx inventory modify [-h] id
positional arguments:
id the ID (or unique name) of the resource
optional arguments:
-h, --help show this help message and exit
awx inventory modify: the following arguments are required: id
inventory delete#
usage: awx inventory delete [-h] id
positional arguments:
id the ID (or unique name) of the resource
optional arguments:
-h, --help show this help message and exit
awx inventory delete: the following arguments are required: id