bulk#
usage: awx bulk [-h] action ...
positional arguments:
action
list
get
job_launch
host_create
host_delete
optional arguments:
-h, --help show this help message and exit
awx bulk: the following arguments are required: action
bulk list#
usage: awx bulk list [-h] [--all] [--order_by ORDER_BY]
[-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
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
(,)
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
bulk get#
usage: awx bulk 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 bulk get: the following arguments are required: id
bulk job_launch#
usage: awx bulk job_launch [-h] [--monitor] [--action-timeout ACTION_TIMEOUT]
[--wait] [--interval INTERVAL] [--name TEXT] --jobs
JOBS [--description TEXT] [--extra_vars JSON/YAML]
[--organization ID] [--inventory ID] [--limit TEXT]
[--scm_branch TEXT] [--skip_tags TEXT]
[--job_tags TEXT]
required arguments:
--jobs JOBS List of jobs to be launched, JSON. e.g.
[{"unified_job_template": 7}, {"unified_job_template":
10}]
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
--name TEXT Name of this workflow job.
--description TEXT Optional description of this workflow job.
--extra_vars JSON/YAML
a JSON or YAML string. You can optionally specify a
file path e.g., @path/to/file.yml
--organization ID Inherit permissions from this organization. If not
provided, a organization the user is a member of will
be selected automatically.
--inventory ID the ID of the associated inventory
--limit TEXT
--scm_branch TEXT
--skip_tags TEXT
--job_tags TEXT
awx bulk job_launch: the following arguments are required: --jobs
bulk host_create#
usage: awx bulk host_create [-h] --inventory ID --hosts HOSTS
required arguments:
--inventory ID Primary Key ID of inventory to add hosts to.
--hosts HOSTS List of hosts to be created, JSON. e.g. [{"name":
"example.com"}, {"name": "127.0.0.1"}]
optional arguments:
-h, --help show this help message and exit
awx bulk host_create: the following arguments are required: --inventory, --hosts
bulk host_delete#
usage: awx bulk host_delete [-h] --hosts HOSTS
required arguments:
--hosts HOSTS List of hosts ids to be deleted, e.g. [105, 130, 131, 200]
optional arguments:
-h, --help show this help message and exit
awx bulk host_delete: the following arguments are required: --hosts