inventory_sources#
usage: awx inventory_sources [-h] action ...
positional arguments:
action
create
list
get
modify
delete
update
associate
disassociate
optional arguments:
-h, --help show this help message and exit
awx inventory_sources: the following arguments are required: action
inventory_sources create#
usage: awx inventory_sources create [-h] --name TEXT [--description TEXT]
[--source {file,constructed,scm,ec2,gce,azure_rm,vmware,satellite6,openstack,rhv,controller,insights,terraform,openshift_virtualization}]
[--source_path TEXT] [--source_vars TEXT]
[--scm_branch TEXT] [--credential INTEGER]
[--enabled_var TEXT]
[--enabled_value TEXT]
[--host_filter TEXT] [--overwrite BOOLEAN]
[--overwrite_vars BOOLEAN]
[--timeout INTEGER] [--verbosity {0,1,2}]
[--limit TEXT]
[--execution_environment ID] --inventory
ID [--update_on_launch BOOLEAN]
[--update_cache_timeout INTEGER]
[--source_project ID]
required arguments:
--name TEXT Name of this inventory source.
--inventory ID the ID of the associated inventory
optional arguments:
-h, --help show this help message and exit
--description TEXT Optional description of this inventory source.
--source {file,constructed,scm,ec2,gce,azure_rm,vmware,satellite6,openstack,rhv,controller,insights,terraform,openshift_virtualization}
--source_path TEXT
--source_vars TEXT Inventory source variables in YAML or JSON format.
--scm_branch TEXT Inventory source SCM branch. Project default used if
blank. Only allowed if project allow_override field is
set to true.
--credential INTEGER Cloud credential to use for inventory updates.
--enabled_var TEXT 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)
--enabled_value TEXT 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":
"2020-08-04T18:13:04+00: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
--host_filter TEXT This field is deprecated and will be removed in a
future release. Regex where only matching hosts will
be imported.
--overwrite BOOLEAN Overwrite local groups and hosts from remote inventory
source.
--overwrite_vars BOOLEAN
Overwrite local variables from remote inventory
source.
--timeout INTEGER The amount of time (in seconds) to run before the task
is canceled.
--verbosity {0,1,2}
--limit TEXT Enter host, group or pattern match
--execution_environment ID
The container image to be used for execution.
--update_on_launch BOOLEAN
--update_cache_timeout INTEGER
--source_project ID Project containing inventory file used as source.
awx inventory_sources create: the following arguments are required: --name, --inventory
inventory_sources list#
usage: awx inventory_sources list [-h] [--all] [--order_by ORDER_BY]
[-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
[--type {inventory_source}]
[--created CREATED] [--modified MODIFIED]
[--name TEXT] [--description TEXT]
[--source {file,constructed,scm,ec2,gce,azure_rm,vmware,satellite6,openstack,rhv,controller,insights,terraform,openshift_virtualization}]
[--source_path TEXT] [--source_vars TEXT]
[--scm_branch TEXT] [--enabled_var TEXT]
[--enabled_value TEXT] [--host_filter TEXT]
[--overwrite BOOLEAN]
[--overwrite_vars BOOLEAN]
[--custom_virtualenv TEXT]
[--timeout INTEGER] [--verbosity {0,1,2}]
[--limit TEXT] [--last_job_run LAST_JOB_RUN]
[--last_job_failed BOOLEAN]
[--next_job_run NEXT_JOB_RUN]
[--status {new,pending,waiting,running,successful,failed,error,canceled,never updated,none}]
[--execution_environment ID]
[--inventory ID]
[--update_on_launch BOOLEAN]
[--update_cache_timeout INTEGER]
[--source_project ID]
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_source}
only list inventory_sources with the specified type
--created CREATED only list inventory_sources with the specified created
--modified MODIFIED only list inventory_sources with the specified
modified
--name TEXT only list inventory_sources with the specified name
--description TEXT only list inventory_sources with the specified
description
--source {file,constructed,scm,ec2,gce,azure_rm,vmware,satellite6,openstack,rhv,controller,insights,terraform,openshift_virtualization}
only list inventory_sources with the specified source
--source_path TEXT only list inventory_sources with the specified
source_path
--source_vars TEXT only list inventory_sources with the specified
source_vars
--scm_branch TEXT only list inventory_sources with the specified
scm_branch
--enabled_var TEXT only list inventory_sources with the specified
enabled_var
--enabled_value TEXT only list inventory_sources with the specified
enabled_value
--host_filter TEXT only list inventory_sources with the specified
host_filter
--overwrite BOOLEAN only list inventory_sources with the specified
overwrite
--overwrite_vars BOOLEAN
only list inventory_sources with the specified
overwrite_vars
--custom_virtualenv TEXT
only list inventory_sources with the specified
custom_virtualenv
--timeout INTEGER only list inventory_sources with the specified timeout
--verbosity {0,1,2} only list inventory_sources with the specified
verbosity
--limit TEXT only list inventory_sources with the specified limit
--last_job_run LAST_JOB_RUN
only list inventory_sources with the specified
last_job_run
--last_job_failed BOOLEAN
only list inventory_sources with the specified
last_job_failed
--next_job_run NEXT_JOB_RUN
only list inventory_sources with the specified
next_job_run
--status {new,pending,waiting,running,successful,failed,error,canceled,never updated,none}
only list inventory_sources with the specified status
--execution_environment ID
only list inventory_sources with the specified
execution_environment
--inventory ID only list inventory_sources with the specified
inventory
--update_on_launch BOOLEAN
only list inventory_sources with the specified
update_on_launch
--update_cache_timeout INTEGER
only list inventory_sources with the specified
update_cache_timeout
--source_project ID only list inventory_sources with the specified
source_project
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_sources get#
usage: awx inventory_sources 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_sources get: the following arguments are required: id
inventory_sources modify#
usage: awx inventory_sources 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_sources modify: the following arguments are required: id
inventory_sources delete#
usage: awx inventory_sources 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_sources delete: the following arguments are required: id
inventory_sources update#
usage: awx inventory_sources update [-h] [--monitor]
[--action-timeout ACTION_TIMEOUT] [--wait]
[--interval INTERVAL]
id
positional arguments:
id
optional arguments:
-h, --help show this help message and exit
--monitor If set, prints stdout of the launched job until it
finishes.
--action-timeout ACTION_TIMEOUT
If set with --monitor or --wait, time out waiting on
job completion.
--wait If set, waits until the launched job finishes.
--interval INTERVAL If set with --monitor or --wait, amount of time to
wait in seconds between api calls. Minimum value is
2.5 seconds to avoid overwhelming the api
awx inventory_sources update: the following arguments are required: id
inventory_sources associate#
usage: awx inventory_sources associate [-h]
(--start_notification | --success_notification | --failure_notification )
id
positional arguments:
id
optional arguments:
-h, --help show this help message and exit
--start_notification
The ID (or name) of the notification_template to
associate
--success_notification
The ID (or name) of the notification_template to
associate
--failure_notification
The ID (or name) of the notification_template to
associate
awx inventory_sources associate: the following arguments are required: id
inventory_sources disassociate#
usage: awx inventory_sources disassociate [-h]
(--start_notification | --success_notification | --failure_notification )
id
positional arguments:
id
optional arguments:
-h, --help show this help message and exit
--start_notification
The ID (or name) of the notification_template to
disassociate
--success_notification
The ID (or name) of the notification_template to
disassociate
--failure_notification
The ID (or name) of the notification_template to
disassociate
awx inventory_sources disassociate: the following arguments are required: id