hosts#
usage: awx hosts [-h] action ...
positional arguments:
action
list
create
get
modify
delete
options:
-h, --help show this help message and exit
awx hosts: the following arguments are required: action
hosts list#
usage: awx hosts list [-h] [--all] [--order_by ORDER_BY] [-f {json,yaml,jq,human}] [--filter TEXT] [--conf.color BOOLEAN] [-v] [--type {host}] [--created CREATED]
[--modified MODIFIED] [--name TEXT] [--description TEXT] [--inventory ID] [--enabled BOOLEAN] [--instance_id TEXT] [--variables JSON/YAML]
[--last_job ID] [--last_job_host_summary ID] [--ansible_facts_modified ANSIBLE_FACTS_MODIFIED]
options:
-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 {host} only list hosts with the specified type
--created CREATED only list hosts with the specified created
--modified MODIFIED only list hosts with the specified modified
--name TEXT only list hosts with the specified name
--description TEXT only list hosts with the specified description
--inventory ID only list hosts with the specified inventory
--enabled BOOLEAN only list hosts with the specified enabled
--instance_id TEXT only list hosts with the specified instance_id
--variables JSON/YAML
only list hosts with the specified variables
--last_job ID only list hosts with the specified last_job
--last_job_host_summary ID
only list hosts with the specified last_job_host_summary
--ansible_facts_modified ANSIBLE_FACTS_MODIFIED
only list hosts with the specified ansible_facts_modified
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
hosts create#
usage: awx hosts create [-h] --name TEXT [--description TEXT] --inventory ID [--enabled BOOLEAN] [--instance_id TEXT] [--variables JSON/YAML]
required arguments:
--name TEXT Name of this host.
--inventory ID the ID of the associated inventory
options:
-h, --help show this help message and exit
--description TEXT Optional description of this host.
--enabled BOOLEAN Is this host online and available for running jobs?
--instance_id TEXT The value used by the remote inventory source to uniquely identify the host
--variables JSON/YAML
Host variables in JSON or YAML format. You can optionally specify a file path e.g., @path/to/file.yml
awx hosts create: the following arguments are required: --name, --inventory
hosts get#
usage: awx hosts 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
options:
-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 hosts get: the following arguments are required: id
hosts modify#
usage: awx hosts modify [-h] id
positional arguments:
id the ID (or unique name) of the resource
options:
-h, --help show this help message and exit
awx hosts modify: the following arguments are required: id
hosts delete#
usage: awx hosts delete [-h] id
positional arguments:
id the ID (or unique name) of the resource
options:
-h, --help show this help message and exit
awx hosts delete: the following arguments are required: id