instance_groups#
usage: awx instance_groups [-h] action ...
positional arguments:
action
list
create
get
modify
delete
options:
-h, --help show this help message and exit
awx instance_groups: the following arguments are required: action
instance_groups list#
usage: awx instance_groups list [-h] [--all] [--order_by ORDER_BY] [-f {json,yaml,jq,human}] [--filter TEXT] [--conf.color BOOLEAN] [-v] [--type {instance_group}]
[--name TEXT] [--created CREATED] [--modified MODIFIED] [--max_concurrent_jobs INTEGER] [--max_forks INTEGER]
[--is_container_group BOOLEAN] [--credential ID] [--policy_instance_percentage INTEGER] [--policy_instance_minimum INTEGER]
[--policy_instance_list JSON/YAML] [--pod_spec_override TEXT]
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 {instance_group}
only list instance_groups with the specified type
--name TEXT only list instance_groups with the specified name
--created CREATED only list instance_groups with the specified created
--modified MODIFIED only list instance_groups with the specified modified
--max_concurrent_jobs INTEGER
only list instance_groups with the specified max_concurrent_jobs
--max_forks INTEGER only list instance_groups with the specified max_forks
--is_container_group BOOLEAN
only list instance_groups with the specified is_container_group
--credential ID only list instance_groups with the specified credential
--policy_instance_percentage INTEGER
only list instance_groups with the specified policy_instance_percentage
--policy_instance_minimum INTEGER
only list instance_groups with the specified policy_instance_minimum
--policy_instance_list JSON/YAML
only list instance_groups with the specified policy_instance_list
--pod_spec_override TEXT
only list instance_groups with the specified pod_spec_override
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
instance_groups create#
usage: awx instance_groups create [-h] --name TEXT [--max_concurrent_jobs INTEGER] [--max_forks INTEGER] [--is_container_group BOOLEAN] [--credential ID]
[--policy_instance_percentage INTEGER] [--policy_instance_minimum INTEGER] [--policy_instance_list JSON/YAML]
[--pod_spec_override TEXT]
required arguments:
--name TEXT Name of this instance group.
options:
-h, --help show this help message and exit
--max_concurrent_jobs INTEGER
Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced.
--max_forks INTEGER Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced.
--is_container_group BOOLEAN
Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster.
--credential ID the ID of the associated credential
--policy_instance_percentage INTEGER
Minimum percentage of all instances that will be automatically assigned to this group when new instances come online.
--policy_instance_minimum INTEGER
Static minimum number of Instances that will be automatically assign to this group when new instances come online.
--policy_instance_list JSON/YAML
List of exact-match Instances that will be assigned to this group You can optionally specify a file path e.g., @path/to/file.yml
--pod_spec_override TEXT
awx instance_groups create: the following arguments are required: --name
instance_groups get#
usage: awx instance_groups 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 instance_groups get: the following arguments are required: id
instance_groups modify#
usage: awx instance_groups modify [-h] id
positional arguments:
id the ID (or unique name) of the resource
options:
-h, --help show this help message and exit
awx instance_groups modify: the following arguments are required: id
instance_groups delete#
usage: awx instance_groups delete [-h] id
positional arguments:
id the ID (or unique name) of the resource
options:
-h, --help show this help message and exit
awx instance_groups delete: the following arguments are required: id