constructed_inventory#
usage: awx constructed_inventory [-h] action ...
positional arguments:
action
create
list
get
modify
delete
optional arguments:
-h, --help show this help message and exit
awx constructed_inventory: the following arguments are required: action
constructed_inventory create#
usage: awx constructed_inventory create [-h] --name TEXT [--description TEXT]
--organization ID
[--variables JSON/YAML]
[--prevent_instance_group_fallback BOOLEAN]
[--source_vars TEXT]
[--update_cache_timeout INTEGER]
[--limit TEXT] [--verbosity INTEGER]
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.
--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.
--source_vars TEXT The source_vars for the related auto-created inventory
source, special to constructed inventory.
--update_cache_timeout INTEGER
The cache timeout for the related auto-created
inventory source, special to constructed inventory
--limit TEXT The limit to restrict the returned hosts for the
related auto-created inventory source, special to
constructed inventory.
--verbosity INTEGER The verbosity level for the related auto-created
inventory source, special to constructed inventory
awx constructed_inventory create: the following arguments are required: --name, --organization
constructed_inventory list#
usage: awx constructed_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}]
[--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 constructed_inventory with the specified
type
--created CREATED only list constructed_inventory with the specified
created
--modified MODIFIED only list constructed_inventory with the specified
modified
--name TEXT only list constructed_inventory with the specified
name
--description TEXT only list constructed_inventory with the specified
description
--organization ID only list constructed_inventory with the specified
organization
--kind {,smart,constructed}
only list constructed_inventory with the specified
kind
--variables JSON/YAML
only list constructed_inventory with the specified
variables
--has_active_failures BOOLEAN
only list constructed_inventory with the specified
has_active_failures
--total_hosts INTEGER
only list constructed_inventory with the specified
total_hosts
--hosts_with_active_failures INTEGER
only list constructed_inventory with the specified
hosts_with_active_failures
--total_groups INTEGER
only list constructed_inventory with the specified
total_groups
--has_inventory_sources BOOLEAN
only list constructed_inventory with the specified
has_inventory_sources
--total_inventory_sources INTEGER
only list constructed_inventory with the specified
total_inventory_sources
--inventory_sources_with_failures INTEGER
only list constructed_inventory with the specified
inventory_sources_with_failures
--pending_deletion BOOLEAN
only list constructed_inventory with the specified
pending_deletion
--prevent_instance_group_fallback BOOLEAN
only list constructed_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
constructed_inventory get#
usage: awx constructed_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 constructed_inventory get: the following arguments are required: id
constructed_inventory modify#
usage: awx constructed_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 constructed_inventory modify: the following arguments are required: id
constructed_inventory delete#
usage: awx constructed_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 constructed_inventory delete: the following arguments are required: id