Reference Guide¶

This is an exhaustive guide of every available command in the awx CLI tool.

The commands and parameters documented here can (and will) vary based on a variety of factors, such as the AWX API version, AWX settings, and access level of the authenticated user. For the most accurate view of available commands, invoke the awx CLI using the –help flag.

usage: awx [--help] [--version] [--conf.host https://example.awx.org]
           [--conf.token TEXT] [--conf.username TEXT] [--conf.password TEXT]
           [-k] [-f {json,yaml,jq,human}] [--filter TEXT]
           [--conf.color BOOLEAN] [-v]
           resource ...

--help¶: prints usage information for the awx tool

--version¶: display awx CLI version

--conf.host <https://example.awx.org>¶

--conf.token <text>¶: an OAuth2.0 token (get one by using awx login)

--conf.username <text>¶

--conf.password <text>¶

-k, --conf.insecure¶: Allow insecure server connections when using SSL

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 activity_stream¶

usage: awx activity_stream [-h] action ...

-h, --help¶: show this help message and exit

awx activity_stream get¶

usage: awx activity_stream get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                               [--conf.color BOOLEAN] [-v]
                               id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 activity_stream list¶

usage: awx activity_stream list [-h] [--all] [-f {json,yaml,jq,human}]
                                [--filter TEXT] [--conf.color BOOLEAN] [-v]
                                [--type {activity_stream}]
                                [--timestamp TIMESTAMP]
                                [--operation {create,update,delete,associate,disassociate}]
                                [--changes JSON/YAML] [--object1 TEXT]
                                [--object2 TEXT] [--action_node TEXT]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {activity_stream}¶: only list activity_stream with the specified type

--timestamp <timestamp>¶: only list activity_stream with the specified timestamp

--operation {create,update,delete,associate,disassociate}¶: only list activity_stream with the specified operation

--changes <json/yaml>¶: only list activity_stream with the specified changes

--object1 <text>¶: only list activity_stream with the specified object1

--object2 <text>¶: only list activity_stream with the specified object2

--action_node <text>¶: only list activity_stream with the specified action_node

awx ad_hoc_commands¶

usage: awx ad_hoc_commands [-h] action ...

-h, --help¶: show this help message and exit

awx ad_hoc_commands create¶

usage: awx ad_hoc_commands create [-h] [--monitor] [--timeout TIMEOUT]
                                  [--wait] [--job_type {run,check}]
                                  --inventory ID [--limit TEXT] --credential
                                  ID
                                  [--module_name {command,shell,yum,apt,apt_key,apt_repository,apt_rpm,service,group,user,mount,ping,selinux,setup,win_ping,win_service,win_updates,win_group,win_user}]
                                  [--module_args TEXT] [--forks INTEGER]
                                  [--verbosity {0,1,2,3,4,5}]
                                  [--extra_vars TEXT]
                                  [--become_enabled BOOLEAN]
                                  [--diff_mode BOOLEAN]

-h, --help¶: show this help message and exit

--monitor¶: If set, prints stdout of the launched job until it finishes.

--timeout <timeout>¶: If set with –monitor or –wait, time out waiting on job completion.

--wait¶: If set, waits until the launched job finishes.

--job_type {run,check}¶

--inventory <id>¶: the ID of the associated inventory

--limit <text>¶

--credential <id>¶: the ID of the associated credential

--module_name {command,shell,yum,apt,apt_key,apt_repository,apt_rpm,service,group,user,mount,ping,selinux,setup,win_ping,win_service,win_updates,win_group,win_user}¶

--module_args <text>¶

--forks <integer>¶

--verbosity {0,1,2,3,4,5}¶

--extra_vars <text>¶

--become_enabled <boolean>¶

--diff_mode <boolean>¶

awx ad_hoc_commands delete¶

usage: awx ad_hoc_commands delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx ad_hoc_commands get¶

usage: awx ad_hoc_commands get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                               [--conf.color BOOLEAN] [-v]
                               id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 ad_hoc_commands list¶

usage: awx ad_hoc_commands list [-h] [--all] [-f {json,yaml,jq,human}]
                                [--filter TEXT] [--conf.color BOOLEAN] [-v]
                                [--type {ad_hoc_command}] [--created CREATED]
                                [--modified MODIFIED] [--name TEXT]
                                [--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}]
                                [--status {new,pending,waiting,running,successful,failed,error,canceled}]
                                [--failed BOOLEAN] [--started STARTED]
                                [--finished FINISHED]
                                [--canceled_on CANCELED_ON]
                                [--elapsed ELAPSED] [--job_explanation TEXT]
                                [--execution_node TEXT]
                                [--controller_node TEXT]
                                [--job_type {run,check}] [--inventory ID]
                                [--limit TEXT] [--credential ID]
                                [--module_name {command,shell,yum,apt,apt_key,apt_repository,apt_rpm,service,group,user,mount,ping,selinux,setup,win_ping,win_service,win_updates,win_group,win_user}]
                                [--module_args TEXT] [--forks INTEGER]
                                [--verbosity {0,1,2,3,4,5}]
                                [--extra_vars TEXT] [--become_enabled BOOLEAN]
                                [--diff_mode BOOLEAN]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {ad_hoc_command}¶: only list ad_hoc_commands with the specified type

--created <created>¶: only list ad_hoc_commands with the specified created

--modified <modified>¶: only list ad_hoc_commands with the specified modified

--name <text>¶: only list ad_hoc_commands with the specified name

--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}¶: only list ad_hoc_commands with the specified launch_type

--status {new,pending,waiting,running,successful,failed,error,canceled}¶: only list ad_hoc_commands with the specified status

--failed <boolean>¶: only list ad_hoc_commands with the specified failed

--started <started>¶: only list ad_hoc_commands with the specified started

--finished <finished>¶: only list ad_hoc_commands with the specified finished

--canceled_on <canceled_on>¶: only list ad_hoc_commands with the specified canceled_on

--elapsed <elapsed>¶: only list ad_hoc_commands with the specified elapsed

--job_explanation <text>¶: only list ad_hoc_commands with the specified job_explanation

--execution_node <text>¶: only list ad_hoc_commands with the specified execution_node

--controller_node <text>¶: only list ad_hoc_commands with the specified controller_node

--job_type {run,check}¶: only list ad_hoc_commands with the specified job_type

--inventory <id>¶: only list ad_hoc_commands with the specified inventory

--limit <text>¶: only list ad_hoc_commands with the specified limit

--credential <id>¶: only list ad_hoc_commands with the specified credential

--module_name {command,shell,yum,apt,apt_key,apt_repository,apt_rpm,service,group,user,mount,ping,selinux,setup,win_ping,win_service,win_updates,win_group,win_user}¶: only list ad_hoc_commands with the specified module_name

--module_args <text>¶: only list ad_hoc_commands with the specified module_args

--forks <integer>¶: only list ad_hoc_commands with the specified forks

--verbosity {0,1,2,3,4,5}¶: only list ad_hoc_commands with the specified verbosity

--extra_vars <text>¶: only list ad_hoc_commands with the specified extra_vars

--become_enabled <boolean>¶: only list ad_hoc_commands with the specified become_enabled

--diff_mode <boolean>¶: only list ad_hoc_commands with the specified diff_mode

awx ad_hoc_commands stdout¶

usage: awx ad_hoc_commands stdout [-h] id

id¶

-h, --help¶: show this help message and exit

awx applications¶

usage: awx applications [-h] action ...

-h, --help¶: show this help message and exit

awx applications create¶

usage: awx applications create [-h] --name TEXT [--description TEXT]
                               --client_type {confidential,public}
                               [--redirect_uris TEXT]
                               --authorization_grant_type
                               {authorization-code,password}
                               [--skip_authorization BOOLEAN] --organization
                               ID

-h, --help¶: show this help message and exit

--name <text>¶: Name of this application.

--description <text>¶: Optional description of this application.

--client_type {confidential,public}¶: Set to Public or Confidential depending on how secure the client device is.

--redirect_uris <text>¶: Allowed URIs list, space separated

--authorization_grant_type {authorization-code,password}¶: The Grant type the user must use for acquire tokens for this application.

--skip_authorization <boolean>¶: Set True to skip authorization step for completely trusted applications.

--organization <id>¶: Organization containing this application.

awx applications delete¶

usage: awx applications delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx applications get¶

usage: awx applications get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                            [--conf.color BOOLEAN] [-v]
                            id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 applications list¶

usage: awx applications list [-h] [--all] [-f {json,yaml,jq,human}]
                             [--filter TEXT] [--conf.color BOOLEAN] [-v]
                             [--type {o_auth2_application}]
                             [--created CREATED] [--name TEXT]
                             [--description TEXT] [--client_id TEXT]
                             [--client_secret TEXT]
                             [--client_type {confidential,public}]
                             [--redirect_uris TEXT]
                             [--authorization_grant_type {authorization-code,password}]
                             [--skip_authorization BOOLEAN]
                             [--organization ID]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {o_auth2_application}¶: only list applications with the specified type

--created <created>¶: only list applications with the specified created

--name <text>¶: only list applications with the specified name

--description <text>¶: only list applications with the specified description

--client_id <text>¶: only list applications with the specified client_id

--client_secret <text>¶: only list applications with the specified client_secret

--client_type {confidential,public}¶: only list applications with the specified client_type

--redirect_uris <text>¶: only list applications with the specified redirect_uris

--authorization_grant_type {authorization-code,password}¶: only list applications with the specified authorization_grant_type

--skip_authorization <boolean>¶: only list applications with the specified skip_authorization

--organization <id>¶: only list applications with the specified organization

awx applications modify¶

usage: awx applications modify [-h] [--name TEXT] [--description TEXT]
                               [--client_type {confidential,public}]
                               [--redirect_uris TEXT]
                               [--authorization_grant_type {authorization-code,password}]
                               [--skip_authorization BOOLEAN]
                               [--organization ID]
                               id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--name <text>¶: Name of this application.

--description <text>¶: Optional description of this application.

--client_type {confidential,public}¶: Set to Public or Confidential depending on how secure the client device is.

--redirect_uris <text>¶: Allowed URIs list, space separated

--authorization_grant_type {authorization-code,password}¶: The Grant type the user must use for acquire tokens for this application.

--skip_authorization <boolean>¶: Set True to skip authorization step for completely trusted applications.

--organization <id>¶: Organization containing this application.

awx config¶

usage: awx config [-h]

-h, --help¶: show this help message and exit

awx credential_input_sources¶

usage: awx credential_input_sources [-h] action ...

-h, --help¶: show this help message and exit

awx credential_input_sources create¶

usage: awx credential_input_sources create [-h] [--description TEXT]
                                           --input_field_name TEXT
                                           [--metadata JSON/YAML]
                                           --target_credential ID
                                           --source_credential ID

-h, --help¶: show this help message and exit

--description <text>¶: Optional description of this credential input source.

--input_field_name <text>¶

--metadata <json/yaml>¶: a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml

--target_credential <id>¶: the ID of the associated target_credential

--source_credential <id>¶: the ID of the associated source_credential

awx credential_input_sources delete¶

usage: awx credential_input_sources delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx credential_input_sources get¶

usage: awx credential_input_sources get [-h] [-f {json,yaml,jq,human}]
                                        [--filter TEXT] [--conf.color BOOLEAN]
                                        [-v]
                                        id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 credential_input_sources list¶

usage: awx credential_input_sources list [-h] [--all]
                                         [-f {json,yaml,jq,human}]
                                         [--filter TEXT]
                                         [--conf.color BOOLEAN] [-v]
                                         [--type {credential_input_source}]
                                         [--created CREATED]
                                         [--modified MODIFIED]
                                         [--description TEXT]
                                         [--input_field_name TEXT]
                                         [--metadata JSON/YAML]
                                         [--target_credential ID]
                                         [--source_credential ID]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {credential_input_source}¶: only list credential_input_sources with the specified type

--created <created>¶: only list credential_input_sources with the specified created

--modified <modified>¶: only list credential_input_sources with the specified modified

--description <text>¶: only list credential_input_sources with the specified description

--input_field_name <text>¶: only list credential_input_sources with the specified input_field_name

--metadata <json/yaml>¶: only list credential_input_sources with the specified metadata

--target_credential <id>¶: only list credential_input_sources with the specified target_credential

--source_credential <id>¶: only list credential_input_sources with the specified source_credential

awx credential_input_sources modify¶

usage: awx credential_input_sources modify [-h] [--description TEXT]
                                           [--input_field_name TEXT]
                                           [--metadata JSON/YAML]
                                           [--target_credential ID]
                                           [--source_credential ID]
                                           id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--description <text>¶: Optional description of this credential input source.

--input_field_name <text>¶

--metadata <json/yaml>¶: a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml

--target_credential <id>¶: the ID of the associated target_credential

--source_credential <id>¶: the ID of the associated source_credential

awx credential_types¶

usage: awx credential_types [-h] action ...

-h, --help¶: show this help message and exit

awx credential_types create¶

usage: awx credential_types create [-h] --name TEXT [--description TEXT]
                                   --kind {net,cloud} [--inputs JSON/YAML]
                                   [--injectors JSON/YAML]

-h, --help¶: show this help message and exit

--name <text>¶: Name of this credential type.

--description <text>¶: Optional description of this credential type.

--kind {net,cloud}¶

--inputs <json/yaml>¶: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. You can optionally specify a file path e.g., @path/to/file.yml

--injectors <json/yaml>¶: Enter injectors using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. You can optionally specify a file path e.g., @path/to/file.yml

awx credential_types delete¶

usage: awx credential_types delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx credential_types get¶

usage: awx credential_types get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                                [--conf.color BOOLEAN] [-v]
                                id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 credential_types list¶

usage: awx credential_types list [-h] [--all] [-f {json,yaml,jq,human}]
                                 [--filter TEXT] [--conf.color BOOLEAN] [-v]
                                 [--type {credential_type}]
                                 [--created CREATED] [--modified MODIFIED]
                                 [--name TEXT] [--description TEXT]
                                 [--kind {ssh,vault,net,scm,cloud,token,insights,external,kubernetes}]
                                 [--namespace TEXT]
                                 [--managed_by_tower BOOLEAN]
                                 [--inputs JSON/YAML] [--injectors JSON/YAML]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {credential_type}¶: only list credential_types with the specified type

--created <created>¶: only list credential_types with the specified created

--modified <modified>¶: only list credential_types with the specified modified

--name <text>¶: only list credential_types with the specified name

--description <text>¶: only list credential_types with the specified description

--kind {ssh,vault,net,scm,cloud,token,insights,external,kubernetes}¶: only list credential_types with the specified kind

--namespace <text>¶: only list credential_types with the specified namespace

--managed_by_tower <boolean>¶: only list credential_types with the specified managed_by_tower

--inputs <json/yaml>¶: only list credential_types with the specified inputs

--injectors <json/yaml>¶: only list credential_types with the specified injectors

awx credential_types modify¶

usage: awx credential_types modify [-h] [--name TEXT] [--description TEXT]
                                   [--kind {net,cloud}] [--inputs JSON/YAML]
                                   [--injectors JSON/YAML]
                                   id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--name <text>¶: Name of this credential type.

--description <text>¶: Optional description of this credential type.

--kind {net,cloud}¶

--inputs <json/yaml>¶: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. You can optionally specify a file path e.g., @path/to/file.yml

--injectors <json/yaml>¶: Enter injectors using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. You can optionally specify a file path e.g., @path/to/file.yml

awx credentials¶

usage: awx credentials [-h] action ...

-h, --help¶: show this help message and exit

awx credentials create¶

usage: awx credentials create [-h] --name TEXT [--description TEXT]
                              [--organization ID] --credential_type ID
                              [--inputs JSON/YAML] [--user ID] [--team ID]

-h, --help¶: show this help message and exit

--name <text>¶: Name of this credential.

--description <text>¶: Optional description of this credential.

--organization <id>¶: Inherit permissions from organization roles. If provided on creation, do not give either user or team.

--credential_type <id>¶: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type.

--inputs <json/yaml>¶: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. You can optionally specify a file path e.g., @path/to/file.yml

--user <id>¶: Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation.

--team <id>¶: Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation.

awx credentials delete¶

usage: awx credentials delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx credentials get¶

usage: awx credentials get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                           [--conf.color BOOLEAN] [-v]
                           id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 credentials list¶

usage: awx credentials list [-h] [--all] [-f {json,yaml,jq,human}]
                            [--filter TEXT] [--conf.color BOOLEAN] [-v]
                            [--type {credential}] [--created CREATED]
                            [--modified MODIFIED] [--name TEXT]
                            [--description TEXT] [--organization ID]
                            [--credential_type ID] [--inputs JSON/YAML]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {credential}¶: only list credentials with the specified type

--created <created>¶: only list credentials with the specified created

--modified <modified>¶: only list credentials with the specified modified

--name <text>¶: only list credentials with the specified name

--description <text>¶: only list credentials with the specified description

--organization <id>¶: only list credentials with the specified organization

--credential_type <id>¶: only list credentials with the specified credential_type

--inputs <json/yaml>¶: only list credentials with the specified inputs

awx credentials modify¶

usage: awx credentials modify [-h] [--name TEXT] [--description TEXT]
                              [--organization ID] [--credential_type ID]
                              [--inputs JSON/YAML] [--user ID] [--team ID]
                              id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--name <text>¶: Name of this credential.

--description <text>¶: Optional description of this credential.

--organization <id>¶: Inherit permissions from organization roles. If provided on creation, do not give either user or team.

--credential_type <id>¶: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type.

--inputs <json/yaml>¶: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. You can optionally specify a file path e.g., @path/to/file.yml

--user <id>¶: Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation.

--team <id>¶: Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation.

awx groups¶

usage: awx groups [-h] action ...

-h, --help¶: show this help message and exit

awx groups create¶

usage: awx groups create [-h] --name TEXT [--description TEXT] --inventory ID
                         [--variables JSON/YAML]

-h, --help¶: show this help message and exit

--name <text>¶: Name of this group.

--description <text>¶: Optional description of this group.

--inventory <id>¶: the ID of the associated inventory

--variables <json/yaml>¶: Group variables in JSON or YAML format. You can optionally specify a file path e.g., @path/to/file.yml

awx groups delete¶

usage: awx groups delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx groups get¶

usage: awx groups get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                      [--conf.color BOOLEAN] [-v]
                      id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 groups list¶

usage: awx groups list [-h] [--all] [-f {json,yaml,jq,human}] [--filter TEXT]
                       [--conf.color BOOLEAN] [-v] [--type {group}]
                       [--created CREATED] [--modified MODIFIED] [--name TEXT]
                       [--description TEXT] [--inventory ID]
                       [--variables JSON/YAML]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {group}¶: only list groups with the specified type

--created <created>¶: only list groups with the specified created

--modified <modified>¶: only list groups with the specified modified

--name <text>¶: only list groups with the specified name

--description <text>¶: only list groups with the specified description

--inventory <id>¶: only list groups with the specified inventory

--variables <json/yaml>¶: only list groups with the specified variables

awx groups modify¶

usage: awx groups modify [-h] [--name TEXT] [--description TEXT]
                         [--inventory ID] [--variables JSON/YAML]
                         id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--name <text>¶: Name of this group.

--description <text>¶: Optional description of this group.

--inventory <id>¶: the ID of the associated inventory

--variables <json/yaml>¶: Group variables in JSON or YAML format. You can optionally specify a file path e.g., @path/to/file.yml

awx hosts¶

usage: awx hosts [-h] action ...

-h, --help¶: show this help message and exit

awx hosts create¶

usage: awx hosts create [-h] --name TEXT [--description TEXT] --inventory ID
                        [--enabled BOOLEAN] [--instance_id TEXT]
                        [--variables JSON/YAML]

-h, --help¶: show this help message and exit

--name <text>¶: Name of this host.

--description <text>¶: Optional description of this host.

--inventory <id>¶: the ID of the associated inventory

--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 delete¶

usage: awx hosts delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx hosts get¶

usage: awx hosts get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                     [--conf.color BOOLEAN] [-v]
                     id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 list¶

usage: awx hosts list [-h] [--all] [-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] [--insights_system_id TEXT]
                      [--ansible_facts_modified ANSIBLE_FACTS_MODIFIED]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--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

--insights_system_id <text>¶: only list hosts with the specified insights_system_id

--ansible_facts_modified <ansible_facts_modified>¶: only list hosts with the specified ansible_facts_modified

awx hosts modify¶

usage: awx hosts modify [-h] [--name TEXT] [--description TEXT]
                        [--inventory ID] [--enabled BOOLEAN]
                        [--instance_id TEXT] [--variables JSON/YAML]
                        id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--name <text>¶: Name of this host.

--description <text>¶: Optional description of this host.

--inventory <id>¶: the ID of the associated inventory

--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 instance_groups¶

usage: awx instance_groups [-h] action ...

-h, --help¶: show this help message and exit

awx instance_groups create¶

usage: awx instance_groups create [-h] --name TEXT [--credential ID]
                                  [--policy_instance_percentage INTEGER]
                                  [--policy_instance_minimum INTEGER]
                                  [--policy_instance_list JSON/YAML]
                                  [--pod_spec_override TEXT]

-h, --help¶: show this help message and exit

--name <text>¶: Name of this instance group.

--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 delete¶

usage: awx instance_groups delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx instance_groups get¶

usage: awx instance_groups get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                               [--conf.color BOOLEAN] [-v]
                               id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 list¶

usage: awx instance_groups list [-h] [--all] [-f {json,yaml,jq,human}]
                                [--filter TEXT] [--conf.color BOOLEAN] [-v]
                                [--type {instance_group}] [--name TEXT]
                                [--created CREATED] [--modified MODIFIED]
                                [--controller ID] [--credential ID]
                                [--policy_instance_percentage INTEGER]
                                [--policy_instance_minimum INTEGER]
                                [--policy_instance_list JSON/YAML]
                                [--pod_spec_override TEXT]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--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

--controller <id>¶: only list instance_groups with the specified controller

--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

awx instance_groups modify¶

usage: awx instance_groups modify [-h] [--name TEXT] [--credential ID]
                                  [--policy_instance_percentage INTEGER]
                                  [--policy_instance_minimum INTEGER]
                                  [--policy_instance_list JSON/YAML]
                                  [--pod_spec_override TEXT]
                                  id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--name <text>¶: Name of this instance group.

--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 instances¶

usage: awx instances [-h] action ...

-h, --help¶: show this help message and exit

awx instances get¶

usage: awx instances get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                         [--conf.color BOOLEAN] [-v]
                         id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 instances list¶

usage: awx instances list [-h] [--all] [-f {json,yaml,jq,human}]
                          [--filter TEXT] [--conf.color BOOLEAN] [-v]
                          [--type {instance}] [--uuid TEXT] [--hostname TEXT]
                          [--created CREATED] [--modified MODIFIED]
                          [--capacity_adjustment CAPACITY_ADJUSTMENT]
                          [--version TEXT] [--capacity INTEGER]
                          [--cpu INTEGER] [--memory INTEGER]
                          [--cpu_capacity INTEGER] [--mem_capacity INTEGER]
                          [--enabled BOOLEAN] [--managed_by_policy BOOLEAN]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {instance}¶: only list instances with the specified type

--uuid <text>¶: only list instances with the specified uuid

--hostname <text>¶: only list instances with the specified hostname

--created <created>¶: only list instances with the specified created

--modified <modified>¶: only list instances with the specified modified

--capacity_adjustment <capacity_adjustment>¶: only list instances with the specified capacity_adjustment

--version <text>¶: only list instances with the specified version

--capacity <integer>¶: only list instances with the specified capacity

--cpu <integer>¶: only list instances with the specified cpu

--memory <integer>¶: only list instances with the specified memory

--cpu_capacity <integer>¶: only list instances with the specified cpu_capacity

--mem_capacity <integer>¶: only list instances with the specified mem_capacity

--enabled <boolean>¶: only list instances with the specified enabled

--managed_by_policy <boolean>¶: only list instances with the specified managed_by_policy

awx instances modify¶

usage: awx instances modify [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx inventory¶

usage: awx inventory [-h] action ...

-h, --help¶: show this help message and exit

awx inventory create¶

usage: awx inventory create [-h] --name TEXT [--description TEXT]
                            --organization ID [--kind {,smart}]
                            [--host_filter TEXT] [--variables JSON/YAML]
                            [--insights_credential ID]

-h, --help¶: show this help message and exit

--name <text>¶: Name of this inventory.

--description <text>¶: Optional description of this inventory.

--organization <id>¶: Organization containing this inventory.

--kind {,smart}¶: Kind of inventory being represented.

--host_filter <text>¶: Filter that will be applied to the hosts 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

--insights_credential <id>¶: Credentials to be used by hosts belonging to this inventory when accessing Red Hat Insights API.

awx inventory delete¶

usage: awx inventory delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx inventory get¶

usage: awx inventory get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                         [--conf.color BOOLEAN] [-v]
                         id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 list¶

usage: awx inventory list [-h] [--all] [-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}] [--host_filter TEXT]
                          [--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]
                          [--insights_credential ID]
                          [--pending_deletion BOOLEAN]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {inventory}¶: only list inventory with the specified type

--created <created>¶: only list inventory with the specified created

--modified <modified>¶: only list inventory with the specified modified

--name <text>¶: only list inventory with the specified name

--description <text>¶: only list inventory with the specified description

--organization <id>¶: only list inventory with the specified organization

--kind {,smart}¶: only list inventory with the specified kind

--host_filter <text>¶: only list inventory with the specified host_filter

--variables <json/yaml>¶: only list inventory with the specified variables

--has_active_failures <boolean>¶: only list inventory with the specified has_active_failures

--total_hosts <integer>¶: only list inventory with the specified total_hosts

--hosts_with_active_failures <integer>¶: only list inventory with the specified hosts_with_active_failures

--total_groups <integer>¶: only list inventory with the specified total_groups

--has_inventory_sources <boolean>¶: only list inventory with the specified has_inventory_sources

--total_inventory_sources <integer>¶: only list inventory with the specified total_inventory_sources

--inventory_sources_with_failures <integer>¶: only list inventory with the specified inventory_sources_with_failures

--insights_credential <id>¶: only list inventory with the specified insights_credential

--pending_deletion <boolean>¶: only list inventory with the specified pending_deletion

awx inventory modify¶

usage: awx inventory modify [-h] [--name TEXT] [--description TEXT]
                            [--organization ID] [--kind {,smart}]
                            [--host_filter TEXT] [--variables JSON/YAML]
                            [--insights_credential ID]
                            id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--name <text>¶: Name of this inventory.

--description <text>¶: Optional description of this inventory.

--organization <id>¶: Organization containing this inventory.

--kind {,smart}¶: Kind of inventory being represented.

--host_filter <text>¶: Filter that will be applied to the hosts 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

--insights_credential <id>¶: Credentials to be used by hosts belonging to this inventory when accessing Red Hat Insights API.

awx inventory_scripts¶

This resource has been deprecated and will be removed in a future release.

usage: awx inventory_scripts [-h] action ...

-h, --help¶: show this help message and exit

awx inventory_scripts create¶

usage: awx inventory_scripts create [-h] --name TEXT [--description TEXT]
                                    --script TEXT --organization ID

-h, --help¶: show this help message and exit

--name <text>¶: Name of this custom inventory script.

--description <text>¶: Optional description of this custom inventory script.

--script <text>¶

--organization <id>¶: Organization owning this inventory script

awx inventory_scripts delete¶

usage: awx inventory_scripts delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx inventory_scripts get¶

usage: awx inventory_scripts get [-h] [-f {json,yaml,jq,human}]
                                 [--filter TEXT] [--conf.color BOOLEAN] [-v]
                                 id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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_scripts list¶

usage: awx inventory_scripts list [-h] [--all] [-f {json,yaml,jq,human}]
                                  [--filter TEXT] [--conf.color BOOLEAN] [-v]
                                  [--type {custom_inventory_script}]
                                  [--created CREATED] [--modified MODIFIED]
                                  [--name TEXT] [--description TEXT]
                                  [--script TEXT] [--organization ID]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {custom_inventory_script}¶: only list inventory_scripts with the specified type

--created <created>¶: only list inventory_scripts with the specified created

--modified <modified>¶: only list inventory_scripts with the specified modified

--name <text>¶: only list inventory_scripts with the specified name

--description <text>¶: only list inventory_scripts with the specified description

--script <text>¶: only list inventory_scripts with the specified script

--organization <id>¶: only list inventory_scripts with the specified organization

awx inventory_scripts modify¶

usage: awx inventory_scripts modify [-h] [--name TEXT] [--description TEXT]
                                    [--script TEXT] [--organization ID]
                                    id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--name <text>¶: Name of this custom inventory script.

--description <text>¶: Optional description of this custom inventory script.

--script <text>¶

--organization <id>¶: Organization owning this inventory script

awx inventory_sources¶

usage: awx inventory_sources [-h] action ...

-h, --help¶: show this help message and exit

awx inventory_sources associate¶

usage: awx inventory_sources associate [-h]
                                       (--start_notification  | --success_notification  | --failure_notification )
                                       id

id¶

-h, --help¶: show this help message and exit

--start_notification <start_notification>¶: The ID (or name) of the notification_template to associate

--success_notification <success_notification>¶: The ID (or name) of the notification_template to associate

--failure_notification <failure_notification>¶: The ID (or name) of the notification_template to associate

awx inventory_sources create¶

usage: awx inventory_sources create [-h] --name TEXT [--description TEXT]
                                    [--source {file,scm,ec2,gce,azure_rm,vmware,satellite6,cloudforms,openstack,rhv,tower,custom}]
                                    [--source_path TEXT] [--source_script ID]
                                    [--source_vars TEXT]
                                    [--credential INTEGER]
                                    [--source_regions TEXT]
                                    [--instance_filters TEXT]
                                    [--group_by TEXT] [--overwrite BOOLEAN]
                                    [--overwrite_vars BOOLEAN]
                                    [--custom_virtualenv TEXT]
                                    [--timeout INTEGER] [--verbosity {0,1,2}]
                                    --inventory ID
                                    [--update_on_launch BOOLEAN]
                                    [--update_cache_timeout INTEGER]
                                    [--source_project ID]
                                    [--update_on_project_update BOOLEAN]

-h, --help¶: show this help message and exit

--name <text>¶: Name of this inventory source.

--description <text>¶: Optional description of this inventory source.

--source {file,scm,ec2,gce,azure_rm,vmware,satellite6,cloudforms,openstack,rhv,tower,custom}¶

--source_path <text>¶

--source_script <id>¶: the ID of the associated source_script

--source_vars <text>¶: Inventory source variables in YAML or JSON format.

--credential <integer>¶: Cloud credential to use for inventory updates.

--source_regions <text>¶

--instance_filters <text>¶: Comma-separated list of filter expressions (EC2 only). Hosts are imported when ANY of the filters match.

--group_by <text>¶: Limit groups automatically created from inventory source (EC2 only).

--overwrite <boolean>¶: Overwrite local groups and hosts from remote inventory source.

--overwrite_vars <boolean>¶: Overwrite local variables from remote inventory source.

--custom_virtualenv <text>¶: Local absolute file path containing a custom Python virtualenv to use

--timeout <integer>¶: The amount of time (in seconds) to run before the task is canceled.

--verbosity {0,1,2}¶

--inventory <id>¶: the ID of the associated inventory

--update_on_launch <boolean>¶

--update_cache_timeout <integer>¶

--source_project <id>¶: Project containing inventory file used as source.

--update_on_project_update <boolean>¶

awx inventory_sources delete¶

usage: awx inventory_sources delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx inventory_sources disassociate¶

usage: awx inventory_sources disassociate [-h]
                                          (--start_notification  | --success_notification  | --failure_notification )
                                          id

id¶

-h, --help¶: show this help message and exit

--start_notification <start_notification>¶: The ID (or name) of the notification_template to disassociate

--success_notification <success_notification>¶: The ID (or name) of the notification_template to disassociate

--failure_notification <failure_notification>¶: The ID (or name) of the notification_template to disassociate

awx inventory_sources get¶

usage: awx inventory_sources get [-h] [-f {json,yaml,jq,human}]
                                 [--filter TEXT] [--conf.color BOOLEAN] [-v]
                                 id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 list¶

usage: awx inventory_sources list [-h] [--all] [-f {json,yaml,jq,human}]
                                  [--filter TEXT] [--conf.color BOOLEAN] [-v]
                                  [--type {inventory_source}]
                                  [--created CREATED] [--modified MODIFIED]
                                  [--name TEXT] [--description TEXT]
                                  [--source {file,scm,ec2,gce,azure_rm,vmware,satellite6,cloudforms,openstack,rhv,tower,custom}]
                                  [--source_path TEXT] [--source_script ID]
                                  [--source_vars TEXT] [--source_regions TEXT]
                                  [--instance_filters TEXT] [--group_by TEXT]
                                  [--overwrite BOOLEAN]
                                  [--overwrite_vars BOOLEAN]
                                  [--custom_virtualenv TEXT]
                                  [--timeout INTEGER] [--verbosity {0,1,2}]
                                  [--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}]
                                  [--inventory ID]
                                  [--update_on_launch BOOLEAN]
                                  [--update_cache_timeout INTEGER]
                                  [--source_project ID]
                                  [--update_on_project_update BOOLEAN]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--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,scm,ec2,gce,azure_rm,vmware,satellite6,cloudforms,openstack,rhv,tower,custom}¶: only list inventory_sources with the specified source

--source_path <text>¶: only list inventory_sources with the specified source_path

--source_script <id>¶: only list inventory_sources with the specified source_script

--source_vars <text>¶: only list inventory_sources with the specified source_vars

--source_regions <text>¶: only list inventory_sources with the specified source_regions

--instance_filters <text>¶: only list inventory_sources with the specified instance_filters

--group_by <text>¶: only list inventory_sources with the specified group_by

--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

--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

--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

--update_on_project_update <boolean>¶: only list inventory_sources with the specified update_on_project_update

awx inventory_sources modify¶

usage: awx inventory_sources modify [-h] [--name TEXT] [--description TEXT]
                                    [--source {file,scm,ec2,gce,azure_rm,vmware,satellite6,cloudforms,openstack,rhv,tower,custom}]
                                    [--source_path TEXT] [--source_script ID]
                                    [--source_vars TEXT]
                                    [--credential INTEGER]
                                    [--source_regions TEXT]
                                    [--instance_filters TEXT]
                                    [--group_by TEXT] [--overwrite BOOLEAN]
                                    [--overwrite_vars BOOLEAN]
                                    [--custom_virtualenv TEXT]
                                    [--timeout INTEGER] [--verbosity {0,1,2}]
                                    [--inventory ID]
                                    [--update_on_launch BOOLEAN]
                                    [--update_cache_timeout INTEGER]
                                    [--source_project ID]
                                    [--update_on_project_update BOOLEAN]
                                    id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--name <text>¶: Name of this inventory source.

--description <text>¶: Optional description of this inventory source.

--source {file,scm,ec2,gce,azure_rm,vmware,satellite6,cloudforms,openstack,rhv,tower,custom}¶

--source_path <text>¶

--source_script <id>¶: the ID of the associated source_script

--source_vars <text>¶: Inventory source variables in YAML or JSON format.

--credential <integer>¶: Cloud credential to use for inventory updates.

--source_regions <text>¶

--instance_filters <text>¶: Comma-separated list of filter expressions (EC2 only). Hosts are imported when ANY of the filters match.

--group_by <text>¶: Limit groups automatically created from inventory source (EC2 only).

--overwrite <boolean>¶: Overwrite local groups and hosts from remote inventory source.

--overwrite_vars <boolean>¶: Overwrite local variables from remote inventory source.

--custom_virtualenv <text>¶: Local absolute file path containing a custom Python virtualenv to use

--timeout <integer>¶: The amount of time (in seconds) to run before the task is canceled.

--verbosity {0,1,2}¶

--inventory <id>¶: the ID of the associated inventory

--update_on_launch <boolean>¶

--update_cache_timeout <integer>¶

--source_project <id>¶: Project containing inventory file used as source.

--update_on_project_update <boolean>¶

awx inventory_sources update¶

usage: awx inventory_sources update [-h] [--monitor] [--timeout TIMEOUT]
                                    [--wait]
                                    id

id¶

-h, --help¶: show this help message and exit

--monitor¶: If set, prints stdout of the launched job until it finishes.

--timeout <timeout>¶: If set with –monitor or –wait, time out waiting on job completion.

--wait¶: If set, waits until the launched job finishes.

awx inventory_updates¶

usage: awx inventory_updates [-h] action ...

-h, --help¶: show this help message and exit

awx inventory_updates delete¶

usage: awx inventory_updates delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx inventory_updates get¶

usage: awx inventory_updates get [-h] [-f {json,yaml,jq,human}]
                                 [--filter TEXT] [--conf.color BOOLEAN] [-v]
                                 id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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_updates list¶

usage: awx inventory_updates list [-h] [--all] [-f {json,yaml,jq,human}]
                                  [--filter TEXT] [--conf.color BOOLEAN] [-v]
                                  [--type {inventory_update}]
                                  [--created CREATED] [--modified MODIFIED]
                                  [--name TEXT] [--description TEXT]
                                  [--unified_job_template ID]
                                  [--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}]
                                  [--status {new,pending,waiting,running,successful,failed,error,canceled}]
                                  [--failed BOOLEAN] [--started STARTED]
                                  [--finished FINISHED]
                                  [--canceled_on CANCELED_ON]
                                  [--elapsed ELAPSED] [--job_explanation TEXT]
                                  [--execution_node TEXT]
                                  [--source {file,scm,ec2,gce,azure_rm,vmware,satellite6,cloudforms,openstack,rhv,tower,custom}]
                                  [--source_path TEXT] [--source_script ID]
                                  [--source_vars TEXT] [--source_regions TEXT]
                                  [--instance_filters TEXT] [--group_by TEXT]
                                  [--overwrite BOOLEAN]
                                  [--overwrite_vars BOOLEAN]
                                  [--custom_virtualenv TEXT]
                                  [--timeout INTEGER] [--verbosity {0,1,2}]
                                  [--inventory ID] [--inventory_source ID]
                                  [--license_error BOOLEAN]
                                  [--org_host_limit_error BOOLEAN]
                                  [--source_project_update ID]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {inventory_update}¶: only list inventory_updates with the specified type

--created <created>¶: only list inventory_updates with the specified created

--modified <modified>¶: only list inventory_updates with the specified modified

--name <text>¶: only list inventory_updates with the specified name

--description <text>¶: only list inventory_updates with the specified description

--unified_job_template <id>¶: only list inventory_updates with the specified unified_job_template

--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}¶: only list inventory_updates with the specified launch_type

--status {new,pending,waiting,running,successful,failed,error,canceled}¶: only list inventory_updates with the specified status

--failed <boolean>¶: only list inventory_updates with the specified failed

--started <started>¶: only list inventory_updates with the specified started

--finished <finished>¶: only list inventory_updates with the specified finished

--canceled_on <canceled_on>¶: only list inventory_updates with the specified canceled_on

--elapsed <elapsed>¶: only list inventory_updates with the specified elapsed

--job_explanation <text>¶: only list inventory_updates with the specified job_explanation

--execution_node <text>¶: only list inventory_updates with the specified execution_node

--source {file,scm,ec2,gce,azure_rm,vmware,satellite6,cloudforms,openstack,rhv,tower,custom}¶: only list inventory_updates with the specified source

--source_path <text>¶: only list inventory_updates with the specified source_path

--source_script <id>¶: only list inventory_updates with the specified source_script

--source_vars <text>¶: only list inventory_updates with the specified source_vars

--source_regions <text>¶: only list inventory_updates with the specified source_regions

--instance_filters <text>¶: only list inventory_updates with the specified instance_filters

--group_by <text>¶: only list inventory_updates with the specified group_by

--overwrite <boolean>¶: only list inventory_updates with the specified overwrite

--overwrite_vars <boolean>¶: only list inventory_updates with the specified overwrite_vars

--custom_virtualenv <text>¶: only list inventory_updates with the specified custom_virtualenv

--timeout <integer>¶: only list inventory_updates with the specified timeout

--verbosity {0,1,2}¶: only list inventory_updates with the specified verbosity

--inventory <id>¶: only list inventory_updates with the specified inventory

--inventory_source <id>¶: only list inventory_updates with the specified inventory_source

--license_error <boolean>¶: only list inventory_updates with the specified license_error

--org_host_limit_error <boolean>¶: only list inventory_updates with the specified org_host_limit_error

--source_project_update <id>¶: only list inventory_updates with the specified source_project_update

awx inventory_updates stdout¶

usage: awx inventory_updates stdout [-h] id

id¶

-h, --help¶: show this help message and exit

awx job_events¶

usage: awx job_events [-h] action ...

-h, --help¶: show this help message and exit

awx job_events get¶

usage: awx job_events get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                          [--conf.color BOOLEAN] [-v]
                          id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 job_events list¶

usage: awx job_events list [-h] [--all] [-f {json,yaml,jq,human}]
                           [--filter TEXT] [--conf.color BOOLEAN] [-v]
                           [--type {job_event}] [--created CREATED]
                           [--modified MODIFIED] [--job ID]
                           [--event {runner_on_failed,runner_on_start,runner_on_ok,runner_on_error,runner_on_skipped,runner_on_unreachable,runner_on_no_hosts,runner_on_async_poll,runner_on_async_ok,runner_on_async_failed,runner_item_on_ok,runner_item_on_failed,runner_item_on_skipped,runner_retry,runner_on_file_diff,playbook_on_start,playbook_on_notify,playbook_on_include,playbook_on_no_hosts_matched,playbook_on_no_hosts_remaining,playbook_on_task_start,playbook_on_vars_prompt,playbook_on_setup,playbook_on_import_for_host,playbook_on_not_import_for_host,playbook_on_play_start,playbook_on_stats,debug,verbose,deprecated,warning,system_warning,error}]
                           [--counter INTEGER] [--event_data JSON/YAML]
                           [--failed BOOLEAN] [--changed BOOLEAN]
                           [--uuid TEXT] [--parent_uuid TEXT] [--host ID]
                           [--host_name TEXT] [--playbook TEXT] [--play TEXT]
                           [--task TEXT] [--role TEXT] [--stdout TEXT]
                           [--start_line INTEGER] [--end_line INTEGER]
                           [--verbosity INTEGER]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {job_event}¶: only list job_events with the specified type

--created <created>¶: only list job_events with the specified created

--modified <modified>¶: only list job_events with the specified modified

--job <id>¶: only list job_events with the specified job

--event {runner_on_failed,runner_on_start,runner_on_ok,runner_on_error,runner_on_skipped,runner_on_unreachable,runner_on_no_hosts,runner_on_async_poll,runner_on_async_ok,runner_on_async_failed,runner_item_on_ok,runner_item_on_failed,runner_item_on_skipped,runner_retry,runner_on_file_diff,playbook_on_start,playbook_on_notify,playbook_on_include,playbook_on_no_hosts_matched,playbook_on_no_hosts_remaining,playbook_on_task_start,playbook_on_vars_prompt,playbook_on_setup,playbook_on_import_for_host,playbook_on_not_import_for_host,playbook_on_play_start,playbook_on_stats,debug,verbose,deprecated,warning,system_warning,error}¶: only list job_events with the specified event

--counter <integer>¶: only list job_events with the specified counter

--event_data <json/yaml>¶: only list job_events with the specified event_data

--failed <boolean>¶: only list job_events with the specified failed

--changed <boolean>¶: only list job_events with the specified changed

--uuid <text>¶: only list job_events with the specified uuid

--parent_uuid <text>¶: only list job_events with the specified parent_uuid

--host <id>¶: only list job_events with the specified host

--host_name <text>¶: only list job_events with the specified host_name

--playbook <text>¶: only list job_events with the specified playbook

--play <text>¶: only list job_events with the specified play

--task <text>¶: only list job_events with the specified task

--role <text>¶: only list job_events with the specified role

--stdout <text>¶: only list job_events with the specified stdout

--start_line <integer>¶: only list job_events with the specified start_line

--end_line <integer>¶: only list job_events with the specified end_line

--verbosity <integer>¶: only list job_events with the specified verbosity

awx job_templates¶

usage: awx job_templates [-h] action ...

-h, --help¶: show this help message and exit

awx job_templates associate¶

usage: awx job_templates associate [-h]
                                   (--start_notification  | --success_notification  | --failure_notification  | --credential )
                                   id

id¶

-h, --help¶: show this help message and exit

--start_notification <start_notification>¶: The ID (or name) of the notification_template to associate

--success_notification <success_notification>¶: The ID (or name) of the notification_template to associate

--failure_notification <failure_notification>¶: The ID (or name) of the notification_template to associate

--credential <credential>¶: The ID (or name) of the credential to associate

awx job_templates create¶

usage: awx job_templates create [-h] --name TEXT [--description TEXT]
                                [--job_type {run,check}] [--inventory ID]
                                --project ID --playbook TEXT
                                [--scm_branch TEXT] [--forks INTEGER]
                                [--limit TEXT] [--verbosity {0,1,2,3,4,5}]
                                [--extra_vars JSON/YAML] [--job_tags TEXT]
                                [--force_handlers BOOLEAN] [--skip_tags TEXT]
                                [--start_at_task TEXT] [--timeout INTEGER]
                                [--use_fact_cache BOOLEAN]
                                [--host_config_key TEXT]
                                [--ask_scm_branch_on_launch BOOLEAN]
                                [--ask_diff_mode_on_launch BOOLEAN]
                                [--ask_variables_on_launch BOOLEAN]
                                [--ask_limit_on_launch BOOLEAN]
                                [--ask_tags_on_launch BOOLEAN]
                                [--ask_skip_tags_on_launch BOOLEAN]
                                [--ask_job_type_on_launch BOOLEAN]
                                [--ask_verbosity_on_launch BOOLEAN]
                                [--ask_inventory_on_launch BOOLEAN]
                                [--ask_credential_on_launch BOOLEAN]
                                [--survey_enabled BOOLEAN]
                                [--become_enabled BOOLEAN]
                                [--diff_mode BOOLEAN]
                                [--allow_simultaneous BOOLEAN]
                                [--custom_virtualenv TEXT]
                                [--job_slice_count INTEGER]
                                [--webhook_service {,github,gitlab}]
                                [--webhook_credential ID]

-h, --help¶: show this help message and exit

--name <text>¶: Name of this job template.

--description <text>¶: Optional description of this job template.

--job_type {run,check}¶

--inventory <id>¶: the ID of the associated inventory

--project <id>¶: the ID of the associated project

--playbook <text>¶

--scm_branch <text>¶: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.

--forks <integer>¶

--limit <text>¶

--verbosity {0,1,2,3,4,5}¶

--extra_vars <json/yaml>¶: a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml

--job_tags <text>¶

--force_handlers <boolean>¶

--skip_tags <text>¶

--start_at_task <text>¶

--timeout <integer>¶: The amount of time (in seconds) to run before the task is canceled.

--use_fact_cache <boolean>¶: If enabled, Tower will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.

--host_config_key <text>¶

--ask_scm_branch_on_launch <boolean>¶

--ask_diff_mode_on_launch <boolean>¶

--ask_variables_on_launch <boolean>¶

--ask_limit_on_launch <boolean>¶

--ask_tags_on_launch <boolean>¶

--ask_skip_tags_on_launch <boolean>¶

--ask_job_type_on_launch <boolean>¶

--ask_verbosity_on_launch <boolean>¶

--ask_inventory_on_launch <boolean>¶

--ask_credential_on_launch <boolean>¶

--survey_enabled <boolean>¶

--become_enabled <boolean>¶

--diff_mode <boolean>¶: If enabled, textual changes made to any templated files on the host are shown in the standard output

--allow_simultaneous <boolean>¶

--custom_virtualenv <text>¶: Local absolute file path containing a custom Python virtualenv to use

--job_slice_count <integer>¶: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1.

--webhook_service {,github,gitlab}¶: Service that webhook requests will be accepted from

--webhook_credential <id>¶: Personal Access Token for posting back the status to the service API

awx job_templates delete¶

usage: awx job_templates delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx job_templates disassociate¶

usage: awx job_templates disassociate [-h]
                                      (--start_notification  | --success_notification  | --failure_notification  | --credential )
                                      id

id¶

-h, --help¶: show this help message and exit

--start_notification <start_notification>¶: The ID (or name) of the notification_template to disassociate

--success_notification <success_notification>¶: The ID (or name) of the notification_template to disassociate

--failure_notification <failure_notification>¶: The ID (or name) of the notification_template to disassociate

--credential <credential>¶: The ID (or name) of the credential to disassociate

awx job_templates get¶

usage: awx job_templates get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                             [--conf.color BOOLEAN] [-v]
                             id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 job_templates launch¶

usage: awx job_templates launch [-h] [--monitor] [--timeout TIMEOUT] [--wait]
                                [--extra_vars JSON/YAML] [--inventory ID]
                                [--scm_branch TEXT] [--limit TEXT]
                                [--job_tags TEXT] [--skip_tags TEXT]
                                [--job_type {run,check}]
                                [--verbosity {0,1,2,3,4,5}]
                                [--diff_mode BOOLEAN]
                                [--credentials [ID, ID, ...]]
                                [--credential_passwords JSON/YAML]
                                id

id¶

-h, --help¶: show this help message and exit

--monitor¶: If set, prints stdout of the launched job until it finishes.

--timeout <timeout>¶: If set with –monitor or –wait, time out waiting on job completion.

--wait¶: If set, waits until the launched job finishes.

--extra_vars <json/yaml>¶: a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml

--inventory <id>¶: the ID of the associated inventory

--scm_branch <text>¶

--limit <text>¶

--job_tags <text>¶

--skip_tags <text>¶

--job_type {run,check}¶

--verbosity {0,1,2,3,4,5}¶

--diff_mode <boolean>¶

--credentials <[id, id, ...]>¶: a list of comma-delimited credentials to associate (IDs or unique names)

--credential_passwords <json/yaml>¶: a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml

awx job_templates list¶

usage: awx job_templates list [-h] [--all] [-f {json,yaml,jq,human}]
                              [--filter TEXT] [--conf.color BOOLEAN] [-v]
                              [--type {job_template}] [--created CREATED]
                              [--modified MODIFIED] [--name TEXT]
                              [--description TEXT] [--job_type {run,check}]
                              [--inventory ID] [--project ID]
                              [--playbook TEXT] [--scm_branch TEXT]
                              [--forks INTEGER] [--limit TEXT]
                              [--verbosity {0,1,2,3,4,5}]
                              [--extra_vars JSON/YAML] [--job_tags TEXT]
                              [--force_handlers BOOLEAN] [--skip_tags TEXT]
                              [--start_at_task TEXT] [--timeout INTEGER]
                              [--use_fact_cache BOOLEAN] [--organization ID]
                              [--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}]
                              [--host_config_key TEXT]
                              [--ask_scm_branch_on_launch BOOLEAN]
                              [--ask_diff_mode_on_launch BOOLEAN]
                              [--ask_variables_on_launch BOOLEAN]
                              [--ask_limit_on_launch BOOLEAN]
                              [--ask_tags_on_launch BOOLEAN]
                              [--ask_skip_tags_on_launch BOOLEAN]
                              [--ask_job_type_on_launch BOOLEAN]
                              [--ask_verbosity_on_launch BOOLEAN]
                              [--ask_inventory_on_launch BOOLEAN]
                              [--ask_credential_on_launch BOOLEAN]
                              [--survey_enabled BOOLEAN]
                              [--become_enabled BOOLEAN] [--diff_mode BOOLEAN]
                              [--allow_simultaneous BOOLEAN]
                              [--custom_virtualenv TEXT]
                              [--job_slice_count INTEGER]
                              [--webhook_service {,github,gitlab}]
                              [--webhook_credential ID]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {job_template}¶: only list job_templates with the specified type

--created <created>¶: only list job_templates with the specified created

--modified <modified>¶: only list job_templates with the specified modified

--name <text>¶: only list job_templates with the specified name

--description <text>¶: only list job_templates with the specified description

--job_type {run,check}¶: only list job_templates with the specified job_type

--inventory <id>¶: only list job_templates with the specified inventory

--project <id>¶: only list job_templates with the specified project

--playbook <text>¶: only list job_templates with the specified playbook

--scm_branch <text>¶: only list job_templates with the specified scm_branch

--forks <integer>¶: only list job_templates with the specified forks

--limit <text>¶: only list job_templates with the specified limit

--verbosity {0,1,2,3,4,5}¶: only list job_templates with the specified verbosity

--extra_vars <json/yaml>¶: only list job_templates with the specified extra_vars

--job_tags <text>¶: only list job_templates with the specified job_tags

--force_handlers <boolean>¶: only list job_templates with the specified force_handlers

--skip_tags <text>¶: only list job_templates with the specified skip_tags

--start_at_task <text>¶: only list job_templates with the specified start_at_task

--timeout <integer>¶: only list job_templates with the specified timeout

--use_fact_cache <boolean>¶: only list job_templates with the specified use_fact_cache

--organization <id>¶: only list job_templates with the specified organization

--last_job_run <last_job_run>¶: only list job_templates with the specified last_job_run

--last_job_failed <boolean>¶: only list job_templates with the specified last_job_failed

--next_job_run <next_job_run>¶: only list job_templates with the specified next_job_run

--status {new,pending,waiting,running,successful,failed,error,canceled,never updated}¶: only list job_templates with the specified status

--host_config_key <text>¶: only list job_templates with the specified host_config_key

--ask_scm_branch_on_launch <boolean>¶: only list job_templates with the specified ask_scm_branch_on_launch

--ask_diff_mode_on_launch <boolean>¶: only list job_templates with the specified ask_diff_mode_on_launch

--ask_variables_on_launch <boolean>¶: only list job_templates with the specified ask_variables_on_launch

--ask_limit_on_launch <boolean>¶: only list job_templates with the specified ask_limit_on_launch

--ask_tags_on_launch <boolean>¶: only list job_templates with the specified ask_tags_on_launch

--ask_skip_tags_on_launch <boolean>¶: only list job_templates with the specified ask_skip_tags_on_launch

--ask_job_type_on_launch <boolean>¶: only list job_templates with the specified ask_job_type_on_launch

--ask_verbosity_on_launch <boolean>¶: only list job_templates with the specified ask_verbosity_on_launch

--ask_inventory_on_launch <boolean>¶: only list job_templates with the specified ask_inventory_on_launch

--ask_credential_on_launch <boolean>¶: only list job_templates with the specified ask_credential_on_launch

--survey_enabled <boolean>¶: only list job_templates with the specified survey_enabled

--become_enabled <boolean>¶: only list job_templates with the specified become_enabled

--diff_mode <boolean>¶: only list job_templates with the specified diff_mode

--allow_simultaneous <boolean>¶: only list job_templates with the specified allow_simultaneous

--custom_virtualenv <text>¶: only list job_templates with the specified custom_virtualenv

--job_slice_count <integer>¶: only list job_templates with the specified job_slice_count

--webhook_service {,github,gitlab}¶: only list job_templates with the specified webhook_service

--webhook_credential <id>¶: only list job_templates with the specified webhook_credential

awx job_templates modify¶

usage: awx job_templates modify [-h] [--name TEXT] [--description TEXT]
                                [--job_type {run,check}] [--inventory ID]
                                [--project ID] [--playbook TEXT]
                                [--scm_branch TEXT] [--forks INTEGER]
                                [--limit TEXT] [--verbosity {0,1,2,3,4,5}]
                                [--extra_vars JSON/YAML] [--job_tags TEXT]
                                [--force_handlers BOOLEAN] [--skip_tags TEXT]
                                [--start_at_task TEXT] [--timeout INTEGER]
                                [--use_fact_cache BOOLEAN]
                                [--host_config_key TEXT]
                                [--ask_scm_branch_on_launch BOOLEAN]
                                [--ask_diff_mode_on_launch BOOLEAN]
                                [--ask_variables_on_launch BOOLEAN]
                                [--ask_limit_on_launch BOOLEAN]
                                [--ask_tags_on_launch BOOLEAN]
                                [--ask_skip_tags_on_launch BOOLEAN]
                                [--ask_job_type_on_launch BOOLEAN]
                                [--ask_verbosity_on_launch BOOLEAN]
                                [--ask_inventory_on_launch BOOLEAN]
                                [--ask_credential_on_launch BOOLEAN]
                                [--survey_enabled BOOLEAN]
                                [--become_enabled BOOLEAN]
                                [--diff_mode BOOLEAN]
                                [--allow_simultaneous BOOLEAN]
                                [--custom_virtualenv TEXT]
                                [--job_slice_count INTEGER]
                                [--webhook_service {,github,gitlab}]
                                [--webhook_credential ID]
                                id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--name <text>¶: Name of this job template.

--description <text>¶: Optional description of this job template.

--job_type {run,check}¶

--inventory <id>¶: the ID of the associated inventory

--project <id>¶: the ID of the associated project

--playbook <text>¶

--scm_branch <text>¶: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.

--forks <integer>¶

--limit <text>¶

--verbosity {0,1,2,3,4,5}¶

--extra_vars <json/yaml>¶: a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml

--job_tags <text>¶

--force_handlers <boolean>¶

--skip_tags <text>¶

--start_at_task <text>¶

--timeout <integer>¶: The amount of time (in seconds) to run before the task is canceled.

--use_fact_cache <boolean>¶: If enabled, Tower will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.

--host_config_key <text>¶

--ask_scm_branch_on_launch <boolean>¶

--ask_diff_mode_on_launch <boolean>¶

--ask_variables_on_launch <boolean>¶

--ask_limit_on_launch <boolean>¶

--ask_tags_on_launch <boolean>¶

--ask_skip_tags_on_launch <boolean>¶

--ask_job_type_on_launch <boolean>¶

--ask_verbosity_on_launch <boolean>¶

--ask_inventory_on_launch <boolean>¶

--ask_credential_on_launch <boolean>¶

--survey_enabled <boolean>¶

--become_enabled <boolean>¶

--diff_mode <boolean>¶: If enabled, textual changes made to any templated files on the host are shown in the standard output

--allow_simultaneous <boolean>¶

--custom_virtualenv <text>¶: Local absolute file path containing a custom Python virtualenv to use

--job_slice_count <integer>¶: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1.

--webhook_service {,github,gitlab}¶: Service that webhook requests will be accepted from

--webhook_credential <id>¶: Personal Access Token for posting back the status to the service API

awx jobs¶

usage: awx jobs [-h] action ...

-h, --help¶: show this help message and exit

awx jobs delete¶

usage: awx jobs delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx jobs get¶

usage: awx jobs get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                    [--conf.color BOOLEAN] [-v]
                    id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 jobs list¶

usage: awx jobs list [-h] [--all] [-f {json,yaml,jq,human}] [--filter TEXT]
                     [--conf.color BOOLEAN] [-v] [--type {job}]
                     [--created CREATED] [--modified MODIFIED] [--name TEXT]
                     [--description TEXT] [--unified_job_template ID]
                     [--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}]
                     [--status {new,pending,waiting,running,successful,failed,error,canceled}]
                     [--failed BOOLEAN] [--started STARTED]
                     [--finished FINISHED] [--canceled_on CANCELED_ON]
                     [--elapsed ELAPSED] [--job_explanation TEXT]
                     [--execution_node TEXT] [--controller_node TEXT]
                     [--job_type {run,check,scan}] [--inventory ID]
                     [--project ID] [--playbook TEXT] [--scm_branch TEXT]
                     [--forks INTEGER] [--limit TEXT]
                     [--verbosity {0,1,2,3,4,5}] [--extra_vars JSON/YAML]
                     [--job_tags TEXT] [--force_handlers BOOLEAN]
                     [--skip_tags TEXT] [--start_at_task TEXT]
                     [--timeout INTEGER] [--use_fact_cache BOOLEAN]
                     [--organization ID] [--job_template ID]
                     [--allow_simultaneous BOOLEAN] [--artifacts JSON/YAML]
                     [--scm_revision TEXT] [--instance_group ID]
                     [--diff_mode BOOLEAN] [--job_slice_number INTEGER]
                     [--job_slice_count INTEGER]
                     [--webhook_service {,github,gitlab}]
                     [--webhook_credential ID] [--webhook_guid TEXT]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {job}¶: only list jobs with the specified type

--created <created>¶: only list jobs with the specified created

--modified <modified>¶: only list jobs with the specified modified

--name <text>¶: only list jobs with the specified name

--description <text>¶: only list jobs with the specified description

--unified_job_template <id>¶: only list jobs with the specified unified_job_template

--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}¶: only list jobs with the specified launch_type

--status {new,pending,waiting,running,successful,failed,error,canceled}¶: only list jobs with the specified status

--failed <boolean>¶: only list jobs with the specified failed

--started <started>¶: only list jobs with the specified started

--finished <finished>¶: only list jobs with the specified finished

--canceled_on <canceled_on>¶: only list jobs with the specified canceled_on

--elapsed <elapsed>¶: only list jobs with the specified elapsed

--job_explanation <text>¶: only list jobs with the specified job_explanation

--execution_node <text>¶: only list jobs with the specified execution_node

--controller_node <text>¶: only list jobs with the specified controller_node

--job_type {run,check,scan}¶: only list jobs with the specified job_type

--inventory <id>¶: only list jobs with the specified inventory

--project <id>¶: only list jobs with the specified project

--playbook <text>¶: only list jobs with the specified playbook

--scm_branch <text>¶: only list jobs with the specified scm_branch

--forks <integer>¶: only list jobs with the specified forks

--limit <text>¶: only list jobs with the specified limit

--verbosity {0,1,2,3,4,5}¶: only list jobs with the specified verbosity

--extra_vars <json/yaml>¶: only list jobs with the specified extra_vars

--job_tags <text>¶: only list jobs with the specified job_tags

--force_handlers <boolean>¶: only list jobs with the specified force_handlers

--skip_tags <text>¶: only list jobs with the specified skip_tags

--start_at_task <text>¶: only list jobs with the specified start_at_task

--timeout <integer>¶: only list jobs with the specified timeout

--use_fact_cache <boolean>¶: only list jobs with the specified use_fact_cache

--organization <id>¶: only list jobs with the specified organization

--job_template <id>¶: only list jobs with the specified job_template

--allow_simultaneous <boolean>¶: only list jobs with the specified allow_simultaneous

--artifacts <json/yaml>¶: only list jobs with the specified artifacts

--scm_revision <text>¶: only list jobs with the specified scm_revision

--instance_group <id>¶: only list jobs with the specified instance_group

--diff_mode <boolean>¶: only list jobs with the specified diff_mode

--job_slice_number <integer>¶: only list jobs with the specified job_slice_number

--job_slice_count <integer>¶: only list jobs with the specified job_slice_count

--webhook_service {,github,gitlab}¶: only list jobs with the specified webhook_service

--webhook_credential <id>¶: only list jobs with the specified webhook_credential

--webhook_guid <text>¶: only list jobs with the specified webhook_guid

awx jobs stdout¶

usage: awx jobs stdout [-h] id

id¶

-h, --help¶: show this help message and exit

awx labels¶

usage: awx labels [-h] action ...

-h, --help¶: show this help message and exit

awx labels create¶

usage: awx labels create [-h] --name TEXT --organization ID

-h, --help¶: show this help message and exit

--name <text>¶: Name of this label.

--organization <id>¶: Organization this label belongs to.

awx labels get¶

usage: awx labels get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                      [--conf.color BOOLEAN] [-v]
                      id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 labels list¶

usage: awx labels list [-h] [--all] [-f {json,yaml,jq,human}] [--filter TEXT]
                       [--conf.color BOOLEAN] [-v] [--type {label}]
                       [--created CREATED] [--modified MODIFIED] [--name TEXT]
                       [--organization ID]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {label}¶: only list labels with the specified type

--created <created>¶: only list labels with the specified created

--modified <modified>¶: only list labels with the specified modified

--name <text>¶: only list labels with the specified name

--organization <id>¶: only list labels with the specified organization

awx labels modify¶

usage: awx labels modify [-h] [--name TEXT] [--organization ID] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--name <text>¶: Name of this label.

--organization <id>¶: Organization this label belongs to.

awx me¶

usage: awx me [-h]

-h, --help¶: show this help message and exit

awx metrics¶

usage: awx metrics [-h]

-h, --help¶: show this help message and exit

awx notification_templates¶

usage: awx notification_templates [-h] action ...

-h, --help¶: show this help message and exit

awx notification_templates create¶

usage: awx notification_templates create [-h] --name TEXT [--description TEXT]
                                         --organization ID --notification_type
                                         {email,grafana,hipchat,irc,mattermost,pagerduty,rocketchat,slack,twilio,webhook}
                                         [--notification_configuration JSON/YAML]
                                         [--messages JSON/YAML]

-h, --help¶: show this help message and exit

--name <text>¶: Name of this notification template.

--description <text>¶: Optional description of this notification template.

--organization <id>¶: the ID of the associated organization

--notification_type {email,grafana,hipchat,irc,mattermost,pagerduty,rocketchat,slack,twilio,webhook}¶

--notification_configuration <json/yaml>¶: a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml

--messages <json/yaml>¶: Optional custom messages for notification template. You can optionally specify a file path e.g., @path/to/file.yml

awx notification_templates delete¶

usage: awx notification_templates delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx notification_templates get¶

usage: awx notification_templates get [-h] [-f {json,yaml,jq,human}]
                                      [--filter TEXT] [--conf.color BOOLEAN]
                                      [-v]
                                      id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 notification_templates list¶

usage: awx notification_templates list [-h] [--all] [-f {json,yaml,jq,human}]
                                       [--filter TEXT] [--conf.color BOOLEAN]
                                       [-v] [--type {notification_template}]
                                       [--created CREATED]
                                       [--modified MODIFIED] [--name TEXT]
                                       [--description TEXT]
                                       [--organization ID]
                                       [--notification_type {email,grafana,hipchat,irc,mattermost,pagerduty,rocketchat,slack,twilio,webhook}]
                                       [--notification_configuration JSON/YAML]
                                       [--messages JSON/YAML]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {notification_template}¶: only list notification_templates with the specified type

--created <created>¶: only list notification_templates with the specified created

--modified <modified>¶: only list notification_templates with the specified modified

--name <text>¶: only list notification_templates with the specified name

--description <text>¶: only list notification_templates with the specified description

--organization <id>¶: only list notification_templates with the specified organization

--notification_type {email,grafana,hipchat,irc,mattermost,pagerduty,rocketchat,slack,twilio,webhook}¶: only list notification_templates with the specified notification_type

--notification_configuration <json/yaml>¶: only list notification_templates with the specified notification_configuration

--messages <json/yaml>¶: only list notification_templates with the specified messages

awx notification_templates modify¶

usage: awx notification_templates modify [-h] [--name TEXT]
                                         [--description TEXT]
                                         [--organization ID]
                                         [--notification_type {email,grafana,hipchat,irc,mattermost,pagerduty,rocketchat,slack,twilio,webhook}]
                                         [--notification_configuration JSON/YAML]
                                         [--messages JSON/YAML]
                                         id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--name <text>¶: Name of this notification template.

--description <text>¶: Optional description of this notification template.

--organization <id>¶: the ID of the associated organization

--notification_type {email,grafana,hipchat,irc,mattermost,pagerduty,rocketchat,slack,twilio,webhook}¶

--notification_configuration <json/yaml>¶: a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml

--messages <json/yaml>¶: Optional custom messages for notification template. You can optionally specify a file path e.g., @path/to/file.yml

awx notifications¶

usage: awx notifications [-h] action ...

-h, --help¶: show this help message and exit

awx notifications get¶

usage: awx notifications get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                             [--conf.color BOOLEAN] [-v]
                             id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 notifications list¶

usage: awx notifications list [-h] [--all] [-f {json,yaml,jq,human}]
                              [--filter TEXT] [--conf.color BOOLEAN] [-v]
                              [--type {notification}] [--created CREATED]
                              [--modified MODIFIED]
                              [--notification_template ID] [--error TEXT]
                              [--status {pending,successful,failed}]
                              [--notifications_sent INTEGER]
                              [--notification_type {email,grafana,hipchat,irc,mattermost,pagerduty,rocketchat,slack,twilio,webhook}]
                              [--recipients TEXT] [--subject TEXT]
                              [--body JSON/YAML]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {notification}¶: only list notifications with the specified type

--created <created>¶: only list notifications with the specified created

--modified <modified>¶: only list notifications with the specified modified

--notification_template <id>¶: only list notifications with the specified notification_template

--error <text>¶: only list notifications with the specified error

--status {pending,successful,failed}¶: only list notifications with the specified status

--notifications_sent <integer>¶: only list notifications with the specified notifications_sent

--notification_type {email,grafana,hipchat,irc,mattermost,pagerduty,rocketchat,slack,twilio,webhook}¶: only list notifications with the specified notification_type

--recipients <text>¶: only list notifications with the specified recipients

--subject <text>¶: only list notifications with the specified subject

--body <json/yaml>¶: only list notifications with the specified body

awx organizations¶

usage: awx organizations [-h] action ...

-h, --help¶: show this help message and exit

awx organizations associate¶

usage: awx organizations associate [-h]
                                   (--start_notification  | --success_notification  | --failure_notification  | --approval_notification )
                                   id

id¶

-h, --help¶: show this help message and exit

--start_notification <start_notification>¶: The ID (or name) of the notification_template to associate

--success_notification <success_notification>¶: The ID (or name) of the notification_template to associate

--failure_notification <failure_notification>¶: The ID (or name) of the notification_template to associate

--approval_notification <approval_notification>¶: The ID (or name) of the notification_template to associate

awx organizations create¶

usage: awx organizations create [-h] --name TEXT [--description TEXT]
                                [--max_hosts INTEGER]
                                [--custom_virtualenv TEXT]

-h, --help¶: show this help message and exit

--name <text>¶: Name of this organization.

--description <text>¶: Optional description of this organization.

--max_hosts <integer>¶: Maximum number of hosts allowed to be managed by this organization.

--custom_virtualenv <text>¶: Local absolute file path containing a custom Python virtualenv to use

awx organizations delete¶

usage: awx organizations delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx organizations disassociate¶

usage: awx organizations disassociate [-h]
                                      (--start_notification  | --success_notification  | --failure_notification  | --approval_notification )
                                      id

id¶

-h, --help¶: show this help message and exit

--start_notification <start_notification>¶: The ID (or name) of the notification_template to disassociate

--success_notification <success_notification>¶: The ID (or name) of the notification_template to disassociate

--failure_notification <failure_notification>¶: The ID (or name) of the notification_template to disassociate

--approval_notification <approval_notification>¶: The ID (or name) of the notification_template to disassociate

awx organizations get¶

usage: awx organizations get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                             [--conf.color BOOLEAN] [-v]
                             id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 organizations list¶

usage: awx organizations list [-h] [--all] [-f {json,yaml,jq,human}]
                              [--filter TEXT] [--conf.color BOOLEAN] [-v]
                              [--type {organization}] [--created CREATED]
                              [--modified MODIFIED] [--name TEXT]
                              [--description TEXT] [--max_hosts INTEGER]
                              [--custom_virtualenv TEXT]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {organization}¶: only list organizations with the specified type

--created <created>¶: only list organizations with the specified created

--modified <modified>¶: only list organizations with the specified modified

--name <text>¶: only list organizations with the specified name

--description <text>¶: only list organizations with the specified description

--max_hosts <integer>¶: only list organizations with the specified max_hosts

--custom_virtualenv <text>¶: only list organizations with the specified custom_virtualenv

awx organizations modify¶

usage: awx organizations modify [-h] [--name TEXT] [--description TEXT]
                                [--max_hosts INTEGER]
                                [--custom_virtualenv TEXT]
                                id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--name <text>¶: Name of this organization.

--description <text>¶: Optional description of this organization.

--max_hosts <integer>¶: Maximum number of hosts allowed to be managed by this organization.

--custom_virtualenv <text>¶: Local absolute file path containing a custom Python virtualenv to use

awx ping¶

usage: awx ping [-h]

-h, --help¶: show this help message and exit

awx project_updates¶

usage: awx project_updates [-h] action ...

-h, --help¶: show this help message and exit

awx project_updates delete¶

usage: awx project_updates delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx project_updates get¶

usage: awx project_updates get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                               [--conf.color BOOLEAN] [-v]
                               id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 project_updates list¶

usage: awx project_updates list [-h] [--all] [-f {json,yaml,jq,human}]
                                [--filter TEXT] [--conf.color BOOLEAN] [-v]
                                [--type {project_update}] [--created CREATED]
                                [--modified MODIFIED] [--name TEXT]
                                [--description TEXT]
                                [--unified_job_template ID]
                                [--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}]
                                [--status {new,pending,waiting,running,successful,failed,error,canceled}]
                                [--failed BOOLEAN] [--started STARTED]
                                [--finished FINISHED]
                                [--canceled_on CANCELED_ON]
                                [--elapsed ELAPSED] [--job_explanation TEXT]
                                [--execution_node TEXT] [--local_path TEXT]
                                [--scm_type {,git,hg,svn,insights}]
                                [--scm_url TEXT] [--scm_branch TEXT]
                                [--scm_refspec TEXT] [--scm_clean BOOLEAN]
                                [--scm_delete_on_update BOOLEAN]
                                [--credential ID] [--timeout INTEGER]
                                [--scm_revision TEXT] [--project ID]
                                [--job_type {run,check}] [--job_tags TEXT]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {project_update}¶: only list project_updates with the specified type

--created <created>¶: only list project_updates with the specified created

--modified <modified>¶: only list project_updates with the specified modified

--name <text>¶: only list project_updates with the specified name

--description <text>¶: only list project_updates with the specified description

--unified_job_template <id>¶: only list project_updates with the specified unified_job_template

--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}¶: only list project_updates with the specified launch_type

--status {new,pending,waiting,running,successful,failed,error,canceled}¶: only list project_updates with the specified status

--failed <boolean>¶: only list project_updates with the specified failed

--started <started>¶: only list project_updates with the specified started

--finished <finished>¶: only list project_updates with the specified finished

--canceled_on <canceled_on>¶: only list project_updates with the specified canceled_on

--elapsed <elapsed>¶: only list project_updates with the specified elapsed

--job_explanation <text>¶: only list project_updates with the specified job_explanation

--execution_node <text>¶: only list project_updates with the specified execution_node

--local_path <text>¶: only list project_updates with the specified local_path

--scm_type {,git,hg,svn,insights}¶: only list project_updates with the specified scm_type

--scm_url <text>¶: only list project_updates with the specified scm_url

--scm_branch <text>¶: only list project_updates with the specified scm_branch

--scm_refspec <text>¶: only list project_updates with the specified scm_refspec

--scm_clean <boolean>¶: only list project_updates with the specified scm_clean

--scm_delete_on_update <boolean>¶: only list project_updates with the specified scm_delete_on_update

--credential <id>¶: only list project_updates with the specified credential

--timeout <integer>¶: only list project_updates with the specified timeout

--scm_revision <text>¶: only list project_updates with the specified scm_revision

--project <id>¶: only list project_updates with the specified project

--job_type {run,check}¶: only list project_updates with the specified job_type

--job_tags <text>¶: only list project_updates with the specified job_tags

awx project_updates stdout¶

usage: awx project_updates stdout [-h] id

id¶

-h, --help¶: show this help message and exit

awx projects¶

usage: awx projects [-h] action ...

-h, --help¶: show this help message and exit

awx projects associate¶

usage: awx projects associate [-h]
                              (--start_notification  | --success_notification  | --failure_notification )
                              id

id¶

-h, --help¶: show this help message and exit

--start_notification <start_notification>¶: The ID (or name) of the notification_template to associate

--success_notification <success_notification>¶: The ID (or name) of the notification_template to associate

--failure_notification <failure_notification>¶: The ID (or name) of the notification_template to associate

awx projects create¶

usage: awx projects create [-h] [--monitor] [--wait] --name TEXT
                           [--description TEXT] [--local_path TEXT]
                           [--scm_type {,git,hg,svn,insights}]
                           [--scm_url TEXT] [--scm_branch TEXT]
                           [--scm_refspec TEXT] [--scm_clean BOOLEAN]
                           [--scm_delete_on_update BOOLEAN] [--credential ID]
                           [--timeout INTEGER] [--organization ID]
                           [--scm_update_on_launch BOOLEAN]
                           [--scm_update_cache_timeout INTEGER]
                           [--allow_override BOOLEAN]
                           [--custom_virtualenv TEXT]

-h, --help¶: show this help message and exit

--monitor¶: If set, prints stdout of the project update until it finishes.

--wait¶: If set, waits until the new project has updated.

--name <text>¶: Name of this project.

--description <text>¶: Optional description of this project.

--local_path <text>¶: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.

--scm_type {,git,hg,svn,insights}¶: Specifies the source control system used to store the project.

--scm_url <text>¶: The location where the project is stored.

--scm_branch <text>¶: Specific branch, tag or commit to checkout.

--scm_refspec <text>¶: For git projects, an additional refspec to fetch.

--scm_clean <boolean>¶: Discard any local changes before syncing the project.

--scm_delete_on_update <boolean>¶: Delete the project before syncing.

--credential <id>¶: the ID of the associated credential

--timeout <integer>¶: The amount of time (in seconds) to run before the task is canceled.

--organization <id>¶: The organization used to determine access to this template.

--scm_update_on_launch <boolean>¶: Update the project when a job is launched that uses the project.

--scm_update_cache_timeout <integer>¶: The number of seconds after the last project update ran that a new project update will be launched as a job dependency.

--allow_override <boolean>¶: Allow changing the SCM branch or revision in a job template that uses this project.

--custom_virtualenv <text>¶: Local absolute file path containing a custom Python virtualenv to use

awx projects delete¶

usage: awx projects delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx projects disassociate¶

usage: awx projects disassociate [-h]
                                 (--start_notification  | --success_notification  | --failure_notification )
                                 id

id¶

-h, --help¶: show this help message and exit

--start_notification <start_notification>¶: The ID (or name) of the notification_template to disassociate

--success_notification <success_notification>¶: The ID (or name) of the notification_template to disassociate

--failure_notification <failure_notification>¶: The ID (or name) of the notification_template to disassociate

awx projects get¶

usage: awx projects get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                        [--conf.color BOOLEAN] [-v]
                        id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 projects list¶

usage: awx projects list [-h] [--all] [-f {json,yaml,jq,human}]
                         [--filter TEXT] [--conf.color BOOLEAN] [-v]
                         [--type {project}] [--created CREATED]
                         [--modified MODIFIED] [--name TEXT]
                         [--description TEXT] [--local_path TEXT]
                         [--scm_type {,git,hg,svn,insights}] [--scm_url TEXT]
                         [--scm_branch TEXT] [--scm_refspec TEXT]
                         [--scm_clean BOOLEAN]
                         [--scm_delete_on_update BOOLEAN] [--credential ID]
                         [--timeout INTEGER] [--scm_revision 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,ok,missing}]
                         [--organization ID] [--scm_update_on_launch BOOLEAN]
                         [--scm_update_cache_timeout INTEGER]
                         [--allow_override BOOLEAN] [--custom_virtualenv TEXT]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {project}¶: only list projects with the specified type

--created <created>¶: only list projects with the specified created

--modified <modified>¶: only list projects with the specified modified

--name <text>¶: only list projects with the specified name

--description <text>¶: only list projects with the specified description

--local_path <text>¶: only list projects with the specified local_path

--scm_type {,git,hg,svn,insights}¶: only list projects with the specified scm_type

--scm_url <text>¶: only list projects with the specified scm_url

--scm_branch <text>¶: only list projects with the specified scm_branch

--scm_refspec <text>¶: only list projects with the specified scm_refspec

--scm_clean <boolean>¶: only list projects with the specified scm_clean

--scm_delete_on_update <boolean>¶: only list projects with the specified scm_delete_on_update

--credential <id>¶: only list projects with the specified credential

--timeout <integer>¶: only list projects with the specified timeout

--scm_revision <text>¶: only list projects with the specified scm_revision

--last_job_run <last_job_run>¶: only list projects with the specified last_job_run

--last_job_failed <boolean>¶: only list projects with the specified last_job_failed

--next_job_run <next_job_run>¶: only list projects with the specified next_job_run

--status {new,pending,waiting,running,successful,failed,error,canceled,never updated,ok,missing}¶: only list projects with the specified status

--organization <id>¶: only list projects with the specified organization

--scm_update_on_launch <boolean>¶: only list projects with the specified scm_update_on_launch

--scm_update_cache_timeout <integer>¶: only list projects with the specified scm_update_cache_timeout

--allow_override <boolean>¶: only list projects with the specified allow_override

--custom_virtualenv <text>¶: only list projects with the specified custom_virtualenv

awx projects modify¶

usage: awx projects modify [-h] [--name TEXT] [--description TEXT]
                           [--local_path TEXT]
                           [--scm_type {,git,hg,svn,insights}]
                           [--scm_url TEXT] [--scm_branch TEXT]
                           [--scm_refspec TEXT] [--scm_clean BOOLEAN]
                           [--scm_delete_on_update BOOLEAN] [--credential ID]
                           [--timeout INTEGER] [--organization ID]
                           [--scm_update_on_launch BOOLEAN]
                           [--scm_update_cache_timeout INTEGER]
                           [--allow_override BOOLEAN]
                           [--custom_virtualenv TEXT]
                           id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--name <text>¶: Name of this project.

--description <text>¶: Optional description of this project.

--local_path <text>¶: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.

--scm_type {,git,hg,svn,insights}¶: Specifies the source control system used to store the project.

--scm_url <text>¶: The location where the project is stored.

--scm_branch <text>¶: Specific branch, tag or commit to checkout.

--scm_refspec <text>¶: For git projects, an additional refspec to fetch.

--scm_clean <boolean>¶: Discard any local changes before syncing the project.

--scm_delete_on_update <boolean>¶: Delete the project before syncing.

--credential <id>¶: the ID of the associated credential

--timeout <integer>¶: The amount of time (in seconds) to run before the task is canceled.

--organization <id>¶: The organization used to determine access to this template.

--scm_update_on_launch <boolean>¶: Update the project when a job is launched that uses the project.

--scm_update_cache_timeout <integer>¶: The number of seconds after the last project update ran that a new project update will be launched as a job dependency.

--allow_override <boolean>¶: Allow changing the SCM branch or revision in a job template that uses this project.

--custom_virtualenv <text>¶: Local absolute file path containing a custom Python virtualenv to use

awx projects update¶

usage: awx projects update [-h] [--monitor] [--timeout TIMEOUT] [--wait] id

id¶

-h, --help¶: show this help message and exit

--monitor¶: If set, prints stdout of the launched job until it finishes.

--timeout <timeout>¶: If set with –monitor or –wait, time out waiting on job completion.

--wait¶: If set, waits until the launched job finishes.

awx roles¶

usage: awx roles [-h] action ...

-h, --help¶: show this help message and exit

awx roles get¶

usage: awx roles get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                     [--conf.color BOOLEAN] [-v]
                     id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 roles list¶

usage: awx roles list [-h] [--all] [-f {json,yaml,jq,human}] [--filter TEXT]
                      [--conf.color BOOLEAN] [-v] [--type {role}]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {role}¶: only list roles with the specified type

awx schedules¶

usage: awx schedules [-h] action ...

-h, --help¶: show this help message and exit

awx schedules create¶

usage: awx schedules create [-h] --rrule TEXT --name TEXT [--description TEXT]
                            [--extra_data JSON/YAML] [--inventory ID]
                            [--scm_branch TEXT] [--job_type {None,,run,check}]
                            [--job_tags TEXT] [--skip_tags TEXT]
                            [--limit TEXT] [--diff_mode BOOLEAN]
                            [--verbosity {None,0,1,2,3,4,5}]
                            --unified_job_template ID [--enabled BOOLEAN]

-h, --help¶: show this help message and exit

--rrule <text>¶: A value representing the schedules iCal recurrence rule.

--name <text>¶: Name of this schedule.

--description <text>¶: Optional description of this schedule.

--extra_data <json/yaml>¶: a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml

--inventory <id>¶: Inventory applied as a prompt, assuming job template prompts for inventory

--scm_branch <text>¶

--job_type {None,,run,check}¶

--job_tags <text>¶

--skip_tags <text>¶

--limit <text>¶

--diff_mode <boolean>¶

--verbosity {None,0,1,2,3,4,5}¶

--unified_job_template <id>¶: the ID of the associated unified_job_template

--enabled <boolean>¶: Enables processing of this schedule.

awx schedules delete¶

usage: awx schedules delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx schedules get¶

usage: awx schedules get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                         [--conf.color BOOLEAN] [-v]
                         id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 schedules list¶

usage: awx schedules list [-h] [--all] [-f {json,yaml,jq,human}]
                          [--filter TEXT] [--conf.color BOOLEAN] [-v]
                          [--rrule TEXT] [--type {schedule}]
                          [--created CREATED] [--modified MODIFIED]
                          [--name TEXT] [--description TEXT]
                          [--extra_data JSON/YAML] [--inventory ID]
                          [--unified_job_template ID] [--enabled BOOLEAN]
                          [--dtstart DTSTART] [--dtend DTEND]
                          [--next_run NEXT_RUN]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--rrule <text>¶: only list schedules with the specified rrule

--type {schedule}¶: only list schedules with the specified type

--created <created>¶: only list schedules with the specified created

--modified <modified>¶: only list schedules with the specified modified

--name <text>¶: only list schedules with the specified name

--description <text>¶: only list schedules with the specified description

--extra_data <json/yaml>¶: only list schedules with the specified extra_data

--inventory <id>¶: only list schedules with the specified inventory

--unified_job_template <id>¶: only list schedules with the specified unified_job_template

--enabled <boolean>¶: only list schedules with the specified enabled

--dtstart <dtstart>¶: only list schedules with the specified dtstart

--dtend <dtend>¶: only list schedules with the specified dtend

--next_run <next_run>¶: only list schedules with the specified next_run

awx schedules modify¶

usage: awx schedules modify [-h] [--rrule TEXT] [--name TEXT]
                            [--description TEXT] [--extra_data JSON/YAML]
                            [--inventory ID] [--scm_branch TEXT]
                            [--job_type {None,,run,check}] [--job_tags TEXT]
                            [--skip_tags TEXT] [--limit TEXT]
                            [--diff_mode BOOLEAN]
                            [--verbosity {None,0,1,2,3,4,5}]
                            [--unified_job_template ID] [--enabled BOOLEAN]
                            id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--rrule <text>¶: A value representing the schedules iCal recurrence rule.

--name <text>¶: Name of this schedule.

--description <text>¶: Optional description of this schedule.

--extra_data <json/yaml>¶: a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml

--inventory <id>¶: Inventory applied as a prompt, assuming job template prompts for inventory

--scm_branch <text>¶

--job_type {None,,run,check}¶

--job_tags <text>¶

--skip_tags <text>¶

--limit <text>¶

--diff_mode <boolean>¶

--verbosity {None,0,1,2,3,4,5}¶

--unified_job_template <id>¶: the ID of the associated unified_job_template

--enabled <boolean>¶: Enables processing of this schedule.

awx settings¶

usage: awx settings [-h] action ...

-h, --help¶: show this help message and exit

awx settings list¶

usage: awx settings list [-h] [--slug SLUG]

-h, --help¶: show this help message and exit

--slug <slug>¶: optional setting category/slug

awx settings modify¶

usage: awx settings modify [-h] key value

key¶

value¶

-h, --help¶: show this help message and exit

awx system_job_templates¶

usage: awx system_job_templates [-h] action ...

-h, --help¶: show this help message and exit

awx system_job_templates get¶

usage: awx system_job_templates get [-h] [-f {json,yaml,jq,human}]
                                    [--filter TEXT] [--conf.color BOOLEAN]
                                    [-v]
                                    id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 system_job_templates list¶

usage: awx system_job_templates list [-h] [--all] [-f {json,yaml,jq,human}]
                                     [--filter TEXT] [--conf.color BOOLEAN]
                                     [-v] [--type {system_job_template}]
                                     [--created CREATED] [--modified MODIFIED]
                                     [--name TEXT] [--description 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,ok,missing,none,updating}]
                                     [--job_type {,cleanup_jobs,cleanup_activitystream,cleanup_sessions,cleanup_tokens}]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {system_job_template}¶: only list system_job_templates with the specified type

--created <created>¶: only list system_job_templates with the specified created

--modified <modified>¶: only list system_job_templates with the specified modified

--name <text>¶: only list system_job_templates with the specified name

--description <text>¶: only list system_job_templates with the specified description

--last_job_run <last_job_run>¶: only list system_job_templates with the specified last_job_run

--last_job_failed <boolean>¶: only list system_job_templates with the specified last_job_failed

--next_job_run <next_job_run>¶: only list system_job_templates with the specified next_job_run

--status {new,pending,waiting,running,successful,failed,error,canceled,never updated,ok,missing,none,updating}¶: only list system_job_templates with the specified status

--job_type {,cleanup_jobs,cleanup_activitystream,cleanup_sessions,cleanup_tokens}¶: only list system_job_templates with the specified job_type

awx system_jobs¶

usage: awx system_jobs [-h] action ...

-h, --help¶: show this help message and exit

awx system_jobs delete¶

usage: awx system_jobs delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx system_jobs get¶

usage: awx system_jobs get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                           [--conf.color BOOLEAN] [-v]
                           id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 system_jobs list¶

usage: awx system_jobs list [-h] [--all] [-f {json,yaml,jq,human}]
                            [--filter TEXT] [--conf.color BOOLEAN] [-v]
                            [--type {system_job}] [--created CREATED]
                            [--modified MODIFIED] [--name TEXT]
                            [--description TEXT] [--unified_job_template ID]
                            [--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}]
                            [--status {new,pending,waiting,running,successful,failed,error,canceled}]
                            [--failed BOOLEAN] [--started STARTED]
                            [--finished FINISHED] [--canceled_on CANCELED_ON]
                            [--elapsed ELAPSED] [--job_explanation TEXT]
                            [--execution_node TEXT] [--system_job_template ID]
                            [--job_type {,cleanup_jobs,cleanup_activitystream,cleanup_sessions,cleanup_tokens}]
                            [--extra_vars TEXT]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {system_job}¶: only list system_jobs with the specified type

--created <created>¶: only list system_jobs with the specified created

--modified <modified>¶: only list system_jobs with the specified modified

--name <text>¶: only list system_jobs with the specified name

--description <text>¶: only list system_jobs with the specified description

--unified_job_template <id>¶: only list system_jobs with the specified unified_job_template

--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}¶: only list system_jobs with the specified launch_type

--status {new,pending,waiting,running,successful,failed,error,canceled}¶: only list system_jobs with the specified status

--failed <boolean>¶: only list system_jobs with the specified failed

--started <started>¶: only list system_jobs with the specified started

--finished <finished>¶: only list system_jobs with the specified finished

--canceled_on <canceled_on>¶: only list system_jobs with the specified canceled_on

--elapsed <elapsed>¶: only list system_jobs with the specified elapsed

--job_explanation <text>¶: only list system_jobs with the specified job_explanation

--execution_node <text>¶: only list system_jobs with the specified execution_node

--system_job_template <id>¶: only list system_jobs with the specified system_job_template

--job_type {,cleanup_jobs,cleanup_activitystream,cleanup_sessions,cleanup_tokens}¶: only list system_jobs with the specified job_type

--extra_vars <text>¶: only list system_jobs with the specified extra_vars

awx teams¶

usage: awx teams [-h] action ...

-h, --help¶: show this help message and exit

awx teams create¶

usage: awx teams create [-h] --name TEXT [--description TEXT] --organization
                        ID

-h, --help¶: show this help message and exit

--name <text>¶: Name of this team.

--description <text>¶: Optional description of this team.

--organization <id>¶: the ID of the associated organization

awx teams delete¶

usage: awx teams delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx teams get¶

usage: awx teams get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                     [--conf.color BOOLEAN] [-v]
                     id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 teams grant¶

usage: awx teams grant [-h]
                       (--organization ID | --project ID | --inventory ID | --inventory_script ID | --team ID | --credential ID | --job_template ID | --workflow_job_template ID)
                       --role
                       {adhoc,credential_admin,execute,read,notification_admin,update,workflow_admin,auditor,member,approval,use,job_template_admin,inventory_admin,project_admin,admin}
                       id

id¶: The ID (or name) of the teams to grant access to/from

-h, --help¶: show this help message and exit

--organization <id>¶: The ID (or name) of the target organization

--project <id>¶: The ID (or name) of the target project

--inventory <id>¶: The ID (or name) of the target inventory

--inventory_script <id>¶: The ID (or name) of the target inventory_script

--team <id>¶: The ID (or name) of the target team

--credential <id>¶: The ID (or name) of the target credential

--job_template <id>¶: The ID (or name) of the target job_template

--workflow_job_template <id>¶: The ID (or name) of the target workflow_job_template

--role {adhoc,credential_admin,execute,read,notification_admin,update,workflow_admin,auditor,member,approval,use,job_template_admin,inventory_admin,project_admin,admin}¶: The name of the role to grant

awx teams list¶

usage: awx teams list [-h] [--all] [-f {json,yaml,jq,human}] [--filter TEXT]
                      [--conf.color BOOLEAN] [-v] [--type {team}]
                      [--created CREATED] [--modified MODIFIED] [--name TEXT]
                      [--description TEXT] [--organization ID]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {team}¶: only list teams with the specified type

--created <created>¶: only list teams with the specified created

--modified <modified>¶: only list teams with the specified modified

--name <text>¶: only list teams with the specified name

--description <text>¶: only list teams with the specified description

--organization <id>¶: only list teams with the specified organization

awx teams modify¶

usage: awx teams modify [-h] [--name TEXT] [--description TEXT]
                        [--organization ID]
                        id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--name <text>¶: Name of this team.

--description <text>¶: Optional description of this team.

--organization <id>¶: the ID of the associated organization

awx teams revoke¶

usage: awx teams revoke [-h]
                        (--organization ID | --project ID | --inventory ID | --inventory_script ID | --team ID | --credential ID | --job_template ID | --workflow_job_template ID)
                        --role
                        {adhoc,credential_admin,execute,read,notification_admin,update,workflow_admin,auditor,member,approval,use,job_template_admin,inventory_admin,project_admin,admin}
                        id

id¶: The ID (or name) of the teams to revoke access to/from

-h, --help¶: show this help message and exit

--organization <id>¶: The ID (or name) of the target organization

--project <id>¶: The ID (or name) of the target project

--inventory <id>¶: The ID (or name) of the target inventory

--inventory_script <id>¶: The ID (or name) of the target inventory_script

--team <id>¶: The ID (or name) of the target team

--credential <id>¶: The ID (or name) of the target credential

--job_template <id>¶: The ID (or name) of the target job_template

--workflow_job_template <id>¶: The ID (or name) of the target workflow_job_template

--role {adhoc,credential_admin,execute,read,notification_admin,update,workflow_admin,auditor,member,approval,use,job_template_admin,inventory_admin,project_admin,admin}¶: The name of the role to revoke

awx tokens¶

usage: awx tokens [-h] action ...

-h, --help¶: show this help message and exit

awx tokens create¶

usage: awx tokens create [-h] [--description TEXT] [--application ID]
                         [--scope TEXT]

-h, --help¶: show this help message and exit

--description <text>¶: Optional description of this access token.

--application <id>¶: the ID of the associated application

--scope <text>¶: Allowed scopes, further restricts user’s permissions. Must be a simple space-separated string with allowed scopes [‘read’, ‘write’].

awx tokens delete¶

usage: awx tokens delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx tokens get¶

usage: awx tokens get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                      [--conf.color BOOLEAN] [-v]
                      id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 tokens list¶

usage: awx tokens list [-h] [--all] [-f {json,yaml,jq,human}] [--filter TEXT]
                       [--conf.color BOOLEAN] [-v]
                       [--type {o_auth2_access_token}] [--created CREATED]
                       [--modified MODIFIED] [--description TEXT] [--user ID]
                       [--token TEXT] [--application ID] [--expires EXPIRES]
                       [--scope TEXT]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {o_auth2_access_token}¶: only list tokens with the specified type

--created <created>¶: only list tokens with the specified created

--modified <modified>¶: only list tokens with the specified modified

--description <text>¶: only list tokens with the specified description

--user <id>¶: only list tokens with the specified user

--token <text>¶: only list tokens with the specified token

--application <id>¶: only list tokens with the specified application

--expires <expires>¶: only list tokens with the specified expires

--scope <text>¶: only list tokens with the specified scope

awx tokens modify¶

usage: awx tokens modify [-h] [--description TEXT] [--application ID]
                         [--scope TEXT]
                         id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--description <text>¶: Optional description of this access token.

--application <id>¶: the ID of the associated application

--scope <text>¶: Allowed scopes, further restricts user’s permissions. Must be a simple space-separated string with allowed scopes [‘read’, ‘write’].

awx unified_job_templates¶

usage: awx unified_job_templates [-h] action ...

-h, --help¶: show this help message and exit

awx unified_job_templates get¶

usage: awx unified_job_templates get [-h] [-f {json,yaml,jq,human}]
                                     [--filter TEXT] [--conf.color BOOLEAN]
                                     [-v]
                                     id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 unified_job_templates list¶

usage: awx unified_job_templates list [-h] [--all] [-f {json,yaml,jq,human}]
                                      [--filter TEXT] [--conf.color BOOLEAN]
                                      [-v]
                                      [--type {project,inventory_source,job_template,system_job_template,workflow_job_template}]
                                      [--created CREATED]
                                      [--modified MODIFIED] [--name TEXT]
                                      [--description 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,ok,missing,none,updating}]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {project,inventory_source,job_template,system_job_template,workflow_job_template}¶: only list unified_job_templates with the specified type

--created <created>¶: only list unified_job_templates with the specified created

--modified <modified>¶: only list unified_job_templates with the specified modified

--name <text>¶: only list unified_job_templates with the specified name

--description <text>¶: only list unified_job_templates with the specified description

--last_job_run <last_job_run>¶: only list unified_job_templates with the specified last_job_run

--last_job_failed <boolean>¶: only list unified_job_templates with the specified last_job_failed

--next_job_run <next_job_run>¶: only list unified_job_templates with the specified next_job_run

--status {new,pending,waiting,running,successful,failed,error,canceled,never updated,ok,missing,none,updating}¶: only list unified_job_templates with the specified status

awx unified_jobs¶

usage: awx unified_jobs [-h] action ...

-h, --help¶: show this help message and exit

awx unified_jobs get¶

usage: awx unified_jobs get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                            [--conf.color BOOLEAN] [-v]
                            id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 unified_jobs list¶

usage: awx unified_jobs list [-h] [--all] [-f {json,yaml,jq,human}]
                             [--filter TEXT] [--conf.color BOOLEAN] [-v]
                             [--type {project_update,inventory_update,job,ad_hoc_command,system_job,workflow_job}]
                             [--created CREATED] [--modified MODIFIED]
                             [--name TEXT] [--description TEXT]
                             [--unified_job_template ID]
                             [--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}]
                             [--status {new,pending,waiting,running,successful,failed,error,canceled}]
                             [--failed BOOLEAN] [--started STARTED]
                             [--finished FINISHED] [--canceled_on CANCELED_ON]
                             [--elapsed ELAPSED] [--job_explanation TEXT]
                             [--execution_node TEXT] [--controller_node TEXT]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {project_update,inventory_update,job,ad_hoc_command,system_job,workflow_job}¶: only list unified_jobs with the specified type

--created <created>¶: only list unified_jobs with the specified created

--modified <modified>¶: only list unified_jobs with the specified modified

--name <text>¶: only list unified_jobs with the specified name

--description <text>¶: only list unified_jobs with the specified description

--unified_job_template <id>¶: only list unified_jobs with the specified unified_job_template

--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}¶: only list unified_jobs with the specified launch_type

--status {new,pending,waiting,running,successful,failed,error,canceled}¶: only list unified_jobs with the specified status

--failed <boolean>¶: only list unified_jobs with the specified failed

--started <started>¶: only list unified_jobs with the specified started

--finished <finished>¶: only list unified_jobs with the specified finished

--canceled_on <canceled_on>¶: only list unified_jobs with the specified canceled_on

--elapsed <elapsed>¶: only list unified_jobs with the specified elapsed

--job_explanation <text>¶: only list unified_jobs with the specified job_explanation

--execution_node <text>¶: only list unified_jobs with the specified execution_node

--controller_node <text>¶: only list unified_jobs with the specified controller_node

awx users¶

usage: awx users [-h] action ...

-h, --help¶: show this help message and exit

awx users create¶

usage: awx users create [-h] --username TEXT [--first_name TEXT]
                        [--last_name TEXT] [--email TEXT]
                        [--is_superuser BOOLEAN] [--is_system_auditor BOOLEAN]
                        --password TEXT

-h, --help¶: show this help message and exit

--username <text>¶: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

--first_name <text>¶

--last_name <text>¶

--email <text>¶

--is_superuser <boolean>¶: Designates that this user has all permissions without explicitly assigning them.

--is_system_auditor <boolean>¶

--password <text>¶: Write-only field used to change the password.

awx users delete¶

usage: awx users delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx users get¶

usage: awx users get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                     [--conf.color BOOLEAN] [-v]
                     id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 users grant¶

usage: awx users grant [-h]
                       (--organization ID | --project ID | --inventory ID | --inventory_script ID | --team ID | --credential ID | --job_template ID | --workflow_job_template ID)
                       --role
                       {adhoc,credential_admin,execute,read,notification_admin,update,workflow_admin,auditor,member,approval,use,job_template_admin,inventory_admin,project_admin,admin}
                       id

id¶: The ID (or name) of the users to grant access to/from

-h, --help¶: show this help message and exit

--organization <id>¶: The ID (or name) of the target organization

--project <id>¶: The ID (or name) of the target project

--inventory <id>¶: The ID (or name) of the target inventory

--inventory_script <id>¶: The ID (or name) of the target inventory_script

--team <id>¶: The ID (or name) of the target team

--credential <id>¶: The ID (or name) of the target credential

--job_template <id>¶: The ID (or name) of the target job_template

--workflow_job_template <id>¶: The ID (or name) of the target workflow_job_template

--role {adhoc,credential_admin,execute,read,notification_admin,update,workflow_admin,auditor,member,approval,use,job_template_admin,inventory_admin,project_admin,admin}¶: The name of the role to grant

awx users list¶

usage: awx users list [-h] [--all] [-f {json,yaml,jq,human}] [--filter TEXT]
                      [--conf.color BOOLEAN] [-v] [--type {user}]
                      [--username TEXT] [--first_name TEXT] [--last_name TEXT]
                      [--email TEXT] [--is_superuser BOOLEAN]
                      [--last_login LAST_LOGIN]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {user}¶: only list users with the specified type

--username <text>¶: only list users with the specified username

--first_name <text>¶: only list users with the specified first_name

--last_name <text>¶: only list users with the specified last_name

--email <text>¶: only list users with the specified email

--is_superuser <boolean>¶: only list users with the specified is_superuser

--last_login <last_login>¶: only list users with the specified last_login

awx users modify¶

usage: awx users modify [-h] [--username TEXT] [--first_name TEXT]
                        [--last_name TEXT] [--email TEXT]
                        [--is_superuser BOOLEAN] [--is_system_auditor BOOLEAN]
                        [--password TEXT]
                        id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--username <text>¶: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

--first_name <text>¶

--last_name <text>¶

--email <text>¶

--is_superuser <boolean>¶: Designates that this user has all permissions without explicitly assigning them.

--is_system_auditor <boolean>¶

--password <text>¶: Write-only field used to change the password.

awx users revoke¶

usage: awx users revoke [-h]
                        (--organization ID | --project ID | --inventory ID | --inventory_script ID | --team ID | --credential ID | --job_template ID | --workflow_job_template ID)
                        --role
                        {adhoc,credential_admin,execute,read,notification_admin,update,workflow_admin,auditor,member,approval,use,job_template_admin,inventory_admin,project_admin,admin}
                        id

id¶: The ID (or name) of the users to revoke access to/from

-h, --help¶: show this help message and exit

--organization <id>¶: The ID (or name) of the target organization

--project <id>¶: The ID (or name) of the target project

--inventory <id>¶: The ID (or name) of the target inventory

--inventory_script <id>¶: The ID (or name) of the target inventory_script

--team <id>¶: The ID (or name) of the target team

--credential <id>¶: The ID (or name) of the target credential

--job_template <id>¶: The ID (or name) of the target job_template

--workflow_job_template <id>¶: The ID (or name) of the target workflow_job_template

--role {adhoc,credential_admin,execute,read,notification_admin,update,workflow_admin,auditor,member,approval,use,job_template_admin,inventory_admin,project_admin,admin}¶: The name of the role to revoke

awx workflow_approvals¶

usage: awx workflow_approvals [-h] action ...

-h, --help¶: show this help message and exit

awx workflow_approvals create¶

usage: awx workflow_approvals create [-h] --name TEXT [--description TEXT]

-h, --help¶: show this help message and exit

--name <text>¶: Name of this workflow approval.

--description <text>¶: Optional description of this workflow approval.

awx workflow_approvals delete¶

usage: awx workflow_approvals delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx workflow_approvals get¶

usage: awx workflow_approvals get [-h] [-f {json,yaml,jq,human}]
                                  [--filter TEXT] [--conf.color BOOLEAN] [-v]
                                  id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 workflow_approvals list¶

usage: awx workflow_approvals list [-h] [--all] [-f {json,yaml,jq,human}]
                                   [--filter TEXT] [--conf.color BOOLEAN] [-v]
                                   [--type {workflow_approval}]
                                   [--created CREATED] [--modified MODIFIED]
                                   [--name TEXT] [--description TEXT]
                                   [--unified_job_template ID]
                                   [--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}]
                                   [--status {new,pending,waiting,running,successful,failed,error,canceled}]
                                   [--failed BOOLEAN] [--started STARTED]
                                   [--finished FINISHED]
                                   [--canceled_on CANCELED_ON]
                                   [--elapsed ELAPSED]
                                   [--job_explanation TEXT]
                                   [--timed_out BOOLEAN]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {workflow_approval}¶: only list workflow_approvals with the specified type

--created <created>¶: only list workflow_approvals with the specified created

--modified <modified>¶: only list workflow_approvals with the specified modified

--name <text>¶: only list workflow_approvals with the specified name

--description <text>¶: only list workflow_approvals with the specified description

--unified_job_template <id>¶: only list workflow_approvals with the specified unified_job_template

--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}¶: only list workflow_approvals with the specified launch_type

--status {new,pending,waiting,running,successful,failed,error,canceled}¶: only list workflow_approvals with the specified status

--failed <boolean>¶: only list workflow_approvals with the specified failed

--started <started>¶: only list workflow_approvals with the specified started

--finished <finished>¶: only list workflow_approvals with the specified finished

--canceled_on <canceled_on>¶: only list workflow_approvals with the specified canceled_on

--elapsed <elapsed>¶: only list workflow_approvals with the specified elapsed

--job_explanation <text>¶: only list workflow_approvals with the specified job_explanation

--timed_out <boolean>¶: only list workflow_approvals with the specified timed_out

awx workflow_job_nodes¶

usage: awx workflow_job_nodes [-h] action ...

-h, --help¶: show this help message and exit

awx workflow_job_nodes get¶

usage: awx workflow_job_nodes get [-h] [-f {json,yaml,jq,human}]
                                  [--filter TEXT] [--conf.color BOOLEAN] [-v]
                                  id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 workflow_job_nodes list¶

usage: awx workflow_job_nodes list [-h] [--all] [-f {json,yaml,jq,human}]
                                   [--filter TEXT] [--conf.color BOOLEAN] [-v]
                                   [--type {workflow_job_node}]
                                   [--created CREATED] [--modified MODIFIED]
                                   [--extra_data JSON/YAML] [--inventory ID]
                                   [--job ID] [--workflow_job ID]
                                   [--unified_job_template ID]
                                   [--all_parents_must_converge BOOLEAN]
                                   [--do_not_run BOOLEAN] [--identifier TEXT]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {workflow_job_node}¶: only list workflow_job_nodes with the specified type

--created <created>¶: only list workflow_job_nodes with the specified created

--modified <modified>¶: only list workflow_job_nodes with the specified modified

--extra_data <json/yaml>¶: only list workflow_job_nodes with the specified extra_data

--inventory <id>¶: only list workflow_job_nodes with the specified inventory

--job <id>¶: only list workflow_job_nodes with the specified job

--workflow_job <id>¶: only list workflow_job_nodes with the specified workflow_job

--unified_job_template <id>¶: only list workflow_job_nodes with the specified unified_job_template

--all_parents_must_converge <boolean>¶: only list workflow_job_nodes with the specified all_parents_must_converge

--do_not_run <boolean>¶: only list workflow_job_nodes with the specified do_not_run

--identifier <text>¶: only list workflow_job_nodes with the specified identifier

awx workflow_job_template_nodes¶

usage: awx workflow_job_template_nodes [-h] action ...

-h, --help¶: show this help message and exit

awx workflow_job_template_nodes create¶

usage: awx workflow_job_template_nodes create [-h] [--extra_data JSON/YAML]
                                              [--inventory ID]
                                              [--scm_branch TEXT]
                                              [--job_type {None,,run,check}]
                                              [--job_tags TEXT]
                                              [--skip_tags TEXT]
                                              [--limit TEXT]
                                              [--diff_mode BOOLEAN]
                                              [--verbosity {None,0,1,2,3,4,5}]
                                              --workflow_job_template ID
                                              [--unified_job_template ID]
                                              [--all_parents_must_converge BOOLEAN]
                                              [--identifier TEXT]

-h, --help¶: show this help message and exit

--extra_data <json/yaml>¶: a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml

--inventory <id>¶: Inventory applied as a prompt, assuming job template prompts for inventory

--scm_branch <text>¶

--job_type {None,,run,check}¶

--job_tags <text>¶

--skip_tags <text>¶

--limit <text>¶

--diff_mode <boolean>¶

--verbosity {None,0,1,2,3,4,5}¶

--workflow_job_template <id>¶: the ID of the associated workflow_job_template

--unified_job_template <id>¶: the ID of the associated unified_job_template

--all_parents_must_converge <boolean>¶: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node

--identifier <text>¶: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.

awx workflow_job_template_nodes delete¶

usage: awx workflow_job_template_nodes delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx workflow_job_template_nodes get¶

usage: awx workflow_job_template_nodes get [-h] [-f {json,yaml,jq,human}]
                                           [--filter TEXT]
                                           [--conf.color BOOLEAN] [-v]
                                           id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 workflow_job_template_nodes list¶

usage: awx workflow_job_template_nodes list [-h] [--all]
                                            [-f {json,yaml,jq,human}]
                                            [--filter TEXT]
                                            [--conf.color BOOLEAN] [-v]
                                            [--type {workflow_job_template_node}]
                                            [--created CREATED]
                                            [--modified MODIFIED]
                                            [--extra_data JSON/YAML]
                                            [--inventory ID]
                                            [--workflow_job_template ID]
                                            [--unified_job_template ID]
                                            [--all_parents_must_converge BOOLEAN]
                                            [--identifier TEXT]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {workflow_job_template_node}¶: only list workflow_job_template_nodes with the specified type

--created <created>¶: only list workflow_job_template_nodes with the specified created

--modified <modified>¶: only list workflow_job_template_nodes with the specified modified

--extra_data <json/yaml>¶: only list workflow_job_template_nodes with the specified extra_data

--inventory <id>¶: only list workflow_job_template_nodes with the specified inventory

--workflow_job_template <id>¶: only list workflow_job_template_nodes with the specified workflow_job_template

--unified_job_template <id>¶: only list workflow_job_template_nodes with the specified unified_job_template

--all_parents_must_converge <boolean>¶: only list workflow_job_template_nodes with the specified all_parents_must_converge

--identifier <text>¶: only list workflow_job_template_nodes with the specified identifier

awx workflow_job_template_nodes modify¶

usage: awx workflow_job_template_nodes modify [-h] [--extra_data JSON/YAML]
                                              [--inventory ID]
                                              [--scm_branch TEXT]
                                              [--job_type {None,,run,check}]
                                              [--job_tags TEXT]
                                              [--skip_tags TEXT]
                                              [--limit TEXT]
                                              [--diff_mode BOOLEAN]
                                              [--verbosity {None,0,1,2,3,4,5}]
                                              [--workflow_job_template ID]
                                              [--unified_job_template ID]
                                              [--all_parents_must_converge BOOLEAN]
                                              [--identifier TEXT]
                                              id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--extra_data <json/yaml>¶: a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml

--inventory <id>¶: Inventory applied as a prompt, assuming job template prompts for inventory

--scm_branch <text>¶

--job_type {None,,run,check}¶

--job_tags <text>¶

--skip_tags <text>¶

--limit <text>¶

--diff_mode <boolean>¶

--verbosity {None,0,1,2,3,4,5}¶

--workflow_job_template <id>¶: the ID of the associated workflow_job_template

--unified_job_template <id>¶: the ID of the associated unified_job_template

--all_parents_must_converge <boolean>¶: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node

--identifier <text>¶: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.

awx workflow_job_templates¶

usage: awx workflow_job_templates [-h] action ...

-h, --help¶: show this help message and exit

awx workflow_job_templates associate¶

usage: awx workflow_job_templates associate [-h]
                                            (--start_notification  | --success_notification  | --failure_notification  | --approval_notification )
                                            id

id¶

-h, --help¶: show this help message and exit

--start_notification <start_notification>¶: The ID (or name) of the notification_template to associate

--success_notification <success_notification>¶: The ID (or name) of the notification_template to associate

--failure_notification <failure_notification>¶: The ID (or name) of the notification_template to associate

--approval_notification <approval_notification>¶: The ID (or name) of the notification_template to associate

awx workflow_job_templates create¶

usage: awx workflow_job_templates create [-h] --name TEXT [--description TEXT]
                                         [--extra_vars JSON/YAML]
                                         [--organization ID]
                                         [--survey_enabled BOOLEAN]
                                         [--allow_simultaneous BOOLEAN]
                                         [--ask_variables_on_launch BOOLEAN]
                                         [--inventory ID] [--limit TEXT]
                                         [--scm_branch TEXT]
                                         [--ask_inventory_on_launch BOOLEAN]
                                         [--ask_scm_branch_on_launch BOOLEAN]
                                         [--ask_limit_on_launch BOOLEAN]
                                         [--webhook_service {,github,gitlab}]
                                         [--webhook_credential ID]

-h, --help¶: show this help message and exit

--name <text>¶: Name of this workflow job template.

--description <text>¶: Optional description of this workflow job template.

--extra_vars <json/yaml>¶: a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml

--organization <id>¶: The organization used to determine access to this template.

--survey_enabled <boolean>¶

--allow_simultaneous <boolean>¶

--ask_variables_on_launch <boolean>¶

--inventory <id>¶: Inventory applied as a prompt, assuming job template prompts for inventory

--limit <text>¶

--scm_branch <text>¶

--ask_inventory_on_launch <boolean>¶

--ask_scm_branch_on_launch <boolean>¶

--ask_limit_on_launch <boolean>¶

--webhook_service {,github,gitlab}¶: Service that webhook requests will be accepted from

--webhook_credential <id>¶: Personal Access Token for posting back the status to the service API

awx workflow_job_templates delete¶

usage: awx workflow_job_templates delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx workflow_job_templates disassociate¶

usage: awx workflow_job_templates disassociate [-h]
                                               (--start_notification  | --success_notification  | --failure_notification  | --approval_notification )
                                               id

id¶

-h, --help¶: show this help message and exit

--start_notification <start_notification>¶: The ID (or name) of the notification_template to disassociate

--success_notification <success_notification>¶: The ID (or name) of the notification_template to disassociate

--failure_notification <failure_notification>¶: The ID (or name) of the notification_template to disassociate

--approval_notification <approval_notification>¶: The ID (or name) of the notification_template to disassociate

awx workflow_job_templates get¶

usage: awx workflow_job_templates get [-h] [-f {json,yaml,jq,human}]
                                      [--filter TEXT] [--conf.color BOOLEAN]
                                      [-v]
                                      id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 workflow_job_templates launch¶

usage: awx workflow_job_templates launch [-h] [--monitor] [--timeout TIMEOUT]
                                         [--wait]
                                         [--ask_limit_on_launch BOOLEAN]
                                         [--ask_scm_branch_on_launch BOOLEAN]
                                         [--extra_vars JSON/YAML]
                                         [--inventory ID] [--limit TEXT]
                                         [--scm_branch TEXT]
                                         id

id¶

-h, --help¶: show this help message and exit

--monitor¶: If set, prints stdout of the launched job until it finishes.

--timeout <timeout>¶: If set with –monitor or –wait, time out waiting on job completion.

--wait¶: If set, waits until the launched job finishes.

--ask_limit_on_launch <boolean>¶

--ask_scm_branch_on_launch <boolean>¶

--extra_vars <json/yaml>¶: a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml

--inventory <id>¶: the ID of the associated inventory

--limit <text>¶

--scm_branch <text>¶

awx workflow_job_templates list¶

usage: awx workflow_job_templates list [-h] [--all] [-f {json,yaml,jq,human}]
                                       [--filter TEXT] [--conf.color BOOLEAN]
                                       [-v] [--type {workflow_job_template}]
                                       [--created CREATED]
                                       [--modified MODIFIED] [--name TEXT]
                                       [--description 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,ok,missing,none,updating}]
                                       [--extra_vars JSON/YAML]
                                       [--organization ID]
                                       [--survey_enabled BOOLEAN]
                                       [--allow_simultaneous BOOLEAN]
                                       [--ask_variables_on_launch BOOLEAN]
                                       [--inventory ID]
                                       [--ask_inventory_on_launch BOOLEAN]
                                       [--ask_scm_branch_on_launch BOOLEAN]
                                       [--ask_limit_on_launch BOOLEAN]
                                       [--webhook_service {,github,gitlab}]
                                       [--webhook_credential ID]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {workflow_job_template}¶: only list workflow_job_templates with the specified type

--created <created>¶: only list workflow_job_templates with the specified created

--modified <modified>¶: only list workflow_job_templates with the specified modified

--name <text>¶: only list workflow_job_templates with the specified name

--description <text>¶: only list workflow_job_templates with the specified description

--last_job_run <last_job_run>¶: only list workflow_job_templates with the specified last_job_run

--last_job_failed <boolean>¶: only list workflow_job_templates with the specified last_job_failed

--next_job_run <next_job_run>¶: only list workflow_job_templates with the specified next_job_run

--status {new,pending,waiting,running,successful,failed,error,canceled,never updated,ok,missing,none,updating}¶: only list workflow_job_templates with the specified status

--extra_vars <json/yaml>¶: only list workflow_job_templates with the specified extra_vars

--organization <id>¶: only list workflow_job_templates with the specified organization

--survey_enabled <boolean>¶: only list workflow_job_templates with the specified survey_enabled

--allow_simultaneous <boolean>¶: only list workflow_job_templates with the specified allow_simultaneous

--ask_variables_on_launch <boolean>¶: only list workflow_job_templates with the specified ask_variables_on_launch

--inventory <id>¶: only list workflow_job_templates with the specified inventory

--ask_inventory_on_launch <boolean>¶: only list workflow_job_templates with the specified ask_inventory_on_launch

--ask_scm_branch_on_launch <boolean>¶: only list workflow_job_templates with the specified ask_scm_branch_on_launch

--ask_limit_on_launch <boolean>¶: only list workflow_job_templates with the specified ask_limit_on_launch

--webhook_service {,github,gitlab}¶: only list workflow_job_templates with the specified webhook_service

--webhook_credential <id>¶: only list workflow_job_templates with the specified webhook_credential

awx workflow_job_templates modify¶

usage: awx workflow_job_templates modify [-h] [--name TEXT]
                                         [--description TEXT]
                                         [--extra_vars JSON/YAML]
                                         [--organization ID]
                                         [--survey_enabled BOOLEAN]
                                         [--allow_simultaneous BOOLEAN]
                                         [--ask_variables_on_launch BOOLEAN]
                                         [--inventory ID] [--limit TEXT]
                                         [--scm_branch TEXT]
                                         [--ask_inventory_on_launch BOOLEAN]
                                         [--ask_scm_branch_on_launch BOOLEAN]
                                         [--ask_limit_on_launch BOOLEAN]
                                         [--webhook_service {,github,gitlab}]
                                         [--webhook_credential ID]
                                         id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

--name <text>¶: Name of this workflow job template.

--description <text>¶: Optional description of this workflow job template.

--extra_vars <json/yaml>¶: a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml

--organization <id>¶: The organization used to determine access to this template.

--survey_enabled <boolean>¶

--allow_simultaneous <boolean>¶

--ask_variables_on_launch <boolean>¶

--inventory <id>¶: Inventory applied as a prompt, assuming job template prompts for inventory

--limit <text>¶

--scm_branch <text>¶

--ask_inventory_on_launch <boolean>¶

--ask_scm_branch_on_launch <boolean>¶

--ask_limit_on_launch <boolean>¶

--webhook_service {,github,gitlab}¶: Service that webhook requests will be accepted from

--webhook_credential <id>¶: Personal Access Token for posting back the status to the service API

awx workflow_jobs¶

usage: awx workflow_jobs [-h] action ...

-h, --help¶: show this help message and exit

awx workflow_jobs delete¶

usage: awx workflow_jobs delete [-h] id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

awx workflow_jobs get¶

usage: awx workflow_jobs get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                             [--conf.color BOOLEAN] [-v]
                             id

id¶: the ID (or unique name) of the resource

-h, --help¶: show this help message and exit

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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 workflow_jobs list¶

usage: awx workflow_jobs list [-h] [--all] [-f {json,yaml,jq,human}]
                              [--filter TEXT] [--conf.color BOOLEAN] [-v]
                              [--type {workflow_job}] [--created CREATED]
                              [--modified MODIFIED] [--name TEXT]
                              [--description TEXT] [--unified_job_template ID]
                              [--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}]
                              [--status {new,pending,waiting,running,successful,failed,error,canceled}]
                              [--failed BOOLEAN] [--started STARTED]
                              [--finished FINISHED]
                              [--canceled_on CANCELED_ON] [--elapsed ELAPSED]
                              [--job_explanation TEXT]
                              [--workflow_job_template ID]
                              [--extra_vars JSON/YAML]
                              [--allow_simultaneous BOOLEAN]
                              [--job_template ID] [--is_sliced_job BOOLEAN]
                              [--inventory ID]
                              [--webhook_service {,github,gitlab}]
                              [--webhook_credential ID] [--webhook_guid TEXT]

-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)

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶: specify an output format

--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

--type {workflow_job}¶: only list workflow_jobs with the specified type

--created <created>¶: only list workflow_jobs with the specified created

--modified <modified>¶: only list workflow_jobs with the specified modified

--name <text>¶: only list workflow_jobs with the specified name

--description <text>¶: only list workflow_jobs with the specified description

--unified_job_template <id>¶: only list workflow_jobs with the specified unified_job_template

--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}¶: only list workflow_jobs with the specified launch_type

--status {new,pending,waiting,running,successful,failed,error,canceled}¶: only list workflow_jobs with the specified status

--failed <boolean>¶: only list workflow_jobs with the specified failed

--started <started>¶: only list workflow_jobs with the specified started

--finished <finished>¶: only list workflow_jobs with the specified finished

--canceled_on <canceled_on>¶: only list workflow_jobs with the specified canceled_on

--elapsed <elapsed>¶: only list workflow_jobs with the specified elapsed

--job_explanation <text>¶: only list workflow_jobs with the specified job_explanation

--workflow_job_template <id>¶: only list workflow_jobs with the specified workflow_job_template

--extra_vars <json/yaml>¶: only list workflow_jobs with the specified extra_vars

--allow_simultaneous <boolean>¶: only list workflow_jobs with the specified allow_simultaneous

--job_template <id>¶: only list workflow_jobs with the specified job_template

--is_sliced_job <boolean>¶: only list workflow_jobs with the specified is_sliced_job

--inventory <id>¶: only list workflow_jobs with the specified inventory

--webhook_service {,github,gitlab}¶: only list workflow_jobs with the specified webhook_service

--webhook_credential <id>¶: only list workflow_jobs with the specified webhook_credential

--webhook_guid <text>¶: only list workflow_jobs with the specified webhook_guid