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 ...
prints usage information for the awx tool
display awx CLI version
an OAuth2.0 token (get one by using awx login)
Allow insecure server connections when using SSL
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx activity_stream [-h] action ...
show this help message and exit
usage: awx activity_stream get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx activity_stream list [-h] [--all] [--order_by ORDER_BY]
[-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]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list activity_stream with the specified type
only list activity_stream with the specified timestamp
only list activity_stream with the specified operation
only list activity_stream with the specified changes
only list activity_stream with the specified object1
only list activity_stream with the specified object2
only list activity_stream with the specified action_node
usage: awx ad_hoc_commands [-h] action ...
show this help message and exit
usage: awx ad_hoc_commands create [-h] [--monitor]
[--action-timeout ACTION_TIMEOUT] [--wait]
[--interval INTERVAL]
[--execution_environment ID]
[--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]
show this help message and exit
If set, prints stdout of the launched job until it finishes.
If set with –monitor or –wait, time out waiting on job completion.
If set, waits until the launched job finishes.
If set with –monitor or –wait, amount of time to wait in seconds between api calls. Minimum value is 2.5 seconds to avoid overwhelming the api
The container image to be used for execution.
the ID of the associated inventory
the ID of the associated credential
usage: awx ad_hoc_commands delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx ad_hoc_commands get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx ad_hoc_commands list [-h] [--all] [--order_by ORDER_BY]
[-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}]
[--execution_environment ID]
[--failed BOOLEAN] [--started STARTED]
[--finished FINISHED]
[--canceled_on CANCELED_ON]
[--elapsed ELAPSED] [--job_explanation TEXT]
[--execution_node TEXT]
[--controller_node TEXT] [--work_unit_id 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]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list ad_hoc_commands with the specified type
only list ad_hoc_commands with the specified created
only list ad_hoc_commands with the specified modified
only list ad_hoc_commands with the specified name
only list ad_hoc_commands with the specified launch_type
only list ad_hoc_commands with the specified status
only list ad_hoc_commands with the specified execution_environment
only list ad_hoc_commands with the specified failed
only list ad_hoc_commands with the specified started
only list ad_hoc_commands with the specified finished
only list ad_hoc_commands with the specified canceled_on
only list ad_hoc_commands with the specified elapsed
only list ad_hoc_commands with the specified job_explanation
only list ad_hoc_commands with the specified execution_node
only list ad_hoc_commands with the specified controller_node
only list ad_hoc_commands with the specified work_unit_id
only list ad_hoc_commands with the specified job_type
only list ad_hoc_commands with the specified inventory
only list ad_hoc_commands with the specified limit
only list ad_hoc_commands with the specified credential
only list ad_hoc_commands with the specified module_name
only list ad_hoc_commands with the specified module_args
only list ad_hoc_commands with the specified forks
only list ad_hoc_commands with the specified verbosity
only list ad_hoc_commands with the specified extra_vars
only list ad_hoc_commands with the specified become_enabled
only list ad_hoc_commands with the specified diff_mode
usage: awx ad_hoc_commands stdout [-h] id
show this help message and exit
usage: awx analytics [-h] action ...
show this help message and exit
usage: awx analytics get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx analytics list [-h] [--all] [--order_by ORDER_BY]
[-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx applications [-h] action ...
show this help message and exit
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
show this help message and exit
Name of this application.
Optional description of this application.
Set to Public or Confidential depending on how secure the client device is.
Allowed URIs list, space separated
The Grant type the user must use for acquire tokens for this application.
Set True to skip authorization step for completely trusted applications.
Organization containing this application.
usage: awx applications delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx applications get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx applications list [-h] [--all] [--order_by ORDER_BY]
[-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]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list applications with the specified type
only list applications with the specified created
only list applications with the specified name
only list applications with the specified description
only list applications with the specified client_id
only list applications with the specified client_secret
only list applications with the specified client_type
only list applications with the specified redirect_uris
only list applications with the specified authorization_grant_type
only list applications with the specified skip_authorization
only list applications with the specified organization
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
the ID (or unique name) of the resource
show this help message and exit
Name of this application.
Optional description of this application.
Set to Public or Confidential depending on how secure the client device is.
Allowed URIs list, space separated
The Grant type the user must use for acquire tokens for this application.
Set True to skip authorization step for completely trusted applications.
Organization containing this application.
usage: awx bulk [-h] action ...
show this help message and exit
usage: awx bulk get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx bulk host_create [-h] --inventory ID --hosts HOSTS
show this help message and exit
Primary Key ID of inventory to add hosts to.
List of hosts to be created, JSON. e.g. [{“name”: “example.com”}, {“name”: “127.0.0.1”}]
usage: awx bulk host_delete [-h] --hosts HOSTS
show this help message and exit
List of hosts ids to be deleted, e.g. [105, 130, 131, 200]
usage: awx bulk job_launch [-h] [--monitor] [--action-timeout ACTION_TIMEOUT]
[--wait] [--interval INTERVAL] [--name TEXT] --jobs
JOBS [--description TEXT] [--extra_vars JSON/YAML]
[--organization ID] [--inventory ID] [--limit TEXT]
[--scm_branch TEXT] [--skip_tags TEXT]
[--job_tags TEXT]
show this help message and exit
If set, prints stdout of the launched job until it finishes.
If set with –monitor or –wait, time out waiting on job completion.
If set, waits until the launched job finishes.
If set with –monitor or –wait, amount of time to wait in seconds between api calls. Minimum value is 2.5 seconds to avoid overwhelming the api
Name of this workflow job.
List of jobs to be launched, JSON. e.g. [{“unified_job_template”: 7}, {“unified_job_template”: 10}]
Optional description of this workflow job.
a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml
Inherit permissions from this organization. If not provided, a organization the user is a member of will be selected automatically.
the ID of the associated inventory
usage: awx bulk list [-h] [--all] [--order_by ORDER_BY]
[-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx config [-h]
show this help message and exit
usage: awx constructed_inventory [-h] action ...
show this help message and exit
usage: awx constructed_inventory create [-h] --name TEXT [--description TEXT]
--organization ID
[--variables JSON/YAML]
[--prevent_instance_group_fallback BOOLEAN]
[--source_vars TEXT]
[--update_cache_timeout INTEGER]
[--limit TEXT] [--verbosity INTEGER]
show this help message and exit
Name of this inventory.
Optional description of this inventory.
Organization containing this inventory.
Inventory variables in JSON or YAML format. You can optionally specify a file path e.g., @path/to/file.yml
If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.
The source_vars for the related auto-created inventory source, special to constructed inventory.
The cache timeout for the related auto-created inventory source, special to constructed inventory
The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory.
The verbosity level for the related auto-created inventory source, special to constructed inventory
usage: awx constructed_inventory delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx constructed_inventory get [-h] [-f {json,yaml,jq,human}]
[--filter TEXT] [--conf.color BOOLEAN]
[-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx constructed_inventory list [-h] [--all] [--order_by ORDER_BY]
[-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,constructed}]
[--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]
[--pending_deletion BOOLEAN]
[--prevent_instance_group_fallback BOOLEAN]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list constructed_inventory with the specified type
only list constructed_inventory with the specified created
only list constructed_inventory with the specified modified
only list constructed_inventory with the specified name
only list constructed_inventory with the specified description
only list constructed_inventory with the specified organization
only list constructed_inventory with the specified kind
only list constructed_inventory with the specified variables
only list constructed_inventory with the specified has_active_failures
only list constructed_inventory with the specified total_hosts
only list constructed_inventory with the specified hosts_with_active_failures
only list constructed_inventory with the specified total_groups
only list constructed_inventory with the specified has_inventory_sources
only list constructed_inventory with the specified total_inventory_sources
only list constructed_inventory with the specified inventory_sources_with_failures
only list constructed_inventory with the specified pending_deletion
only list constructed_inventory with the specified prevent_instance_group_fallback
usage: awx constructed_inventory modify [-h] [--name TEXT]
[--description TEXT]
[--organization ID]
[--variables JSON/YAML]
[--prevent_instance_group_fallback BOOLEAN]
[--source_vars TEXT]
[--update_cache_timeout INTEGER]
[--limit TEXT] [--verbosity INTEGER]
id
the ID (or unique name) of the resource
show this help message and exit
Name of this inventory.
Optional description of this inventory.
Organization containing this inventory.
Inventory variables in JSON or YAML format. You can optionally specify a file path e.g., @path/to/file.yml
If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.
The source_vars for the related auto-created inventory source, special to constructed inventory.
The cache timeout for the related auto-created inventory source, special to constructed inventory
The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory.
The verbosity level for the related auto-created inventory source, special to constructed inventory
usage: awx credential_input_sources [-h] action ...
show this help message and exit
usage: awx credential_input_sources create [-h] [--description TEXT]
--input_field_name TEXT
[--metadata JSON/YAML]
--target_credential ID
--source_credential ID
show this help message and exit
Optional description of this credential input source.
a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml
the ID of the associated target_credential
the ID of the associated source_credential
usage: awx credential_input_sources delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx credential_input_sources get [-h] [-f {json,yaml,jq,human}]
[--filter TEXT] [--conf.color BOOLEAN]
[-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx credential_input_sources list [-h] [--all] [--order_by ORDER_BY]
[-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]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list credential_input_sources with the specified type
only list credential_input_sources with the specified created
only list credential_input_sources with the specified modified
only list credential_input_sources with the specified description
only list credential_input_sources with the specified input_field_name
only list credential_input_sources with the specified metadata
only list credential_input_sources with the specified target_credential
only list credential_input_sources with the specified source_credential
usage: awx credential_input_sources modify [-h] [--description TEXT]
[--input_field_name TEXT]
[--metadata JSON/YAML]
[--target_credential ID]
[--source_credential ID]
id
the ID (or unique name) of the resource
show this help message and exit
Optional description of this credential input source.
a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml
the ID of the associated target_credential
the ID of the associated source_credential
usage: awx credential_types [-h] action ...
show this help message and exit
usage: awx credential_types create [-h] --name TEXT [--description TEXT]
--kind {net,cloud} [--inputs JSON/YAML]
[--injectors JSON/YAML]
show this help message and exit
Name of this credential type.
Optional description of this credential type.
Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. You can optionally specify a file path e.g., @path/to/file.yml
Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. You can optionally specify a file path e.g., @path/to/file.yml
usage: awx credential_types delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx credential_types get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx credential_types list [-h] [--all] [--order_by ORDER_BY]
[-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,registry,token,insights,external,kubernetes,galaxy,cryptography}]
[--namespace TEXT] [--managed BOOLEAN]
[--inputs JSON/YAML] [--injectors JSON/YAML]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list credential_types with the specified type
only list credential_types with the specified created
only list credential_types with the specified modified
only list credential_types with the specified name
only list credential_types with the specified description
only list credential_types with the specified kind
only list credential_types with the specified namespace
only list credential_types with the specified managed
only list credential_types with the specified inputs
only list credential_types with the specified injectors
usage: awx credential_types modify [-h] [--name TEXT] [--description TEXT]
[--kind {net,cloud}] [--inputs JSON/YAML]
[--injectors JSON/YAML]
id
the ID (or unique name) of the resource
show this help message and exit
Name of this credential type.
Optional description of this credential type.
Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. You can optionally specify a file path e.g., @path/to/file.yml
Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. You can optionally specify a file path e.g., @path/to/file.yml
usage: awx credentials [-h] action ...
show this help message and exit
usage: awx credentials create [-h] --name TEXT [--description TEXT]
[--organization ID] --credential_type ID
[--inputs JSON/YAML] [--user ID] [--team ID]
show this help message and exit
Name of this credential.
Optional description of this credential.
Inherit permissions from organization roles. If provided on creation, do not give either user or team.
Specify the type of credential you want to create. Refer to the documentation for details on each type.
Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. You can optionally specify a file path e.g., @path/to/file.yml
Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation.
Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation.
usage: awx credentials delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx credentials get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx credentials list [-h] [--all] [--order_by ORDER_BY]
[-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]
[--managed BOOLEAN] [--inputs JSON/YAML]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list credentials with the specified type
only list credentials with the specified created
only list credentials with the specified modified
only list credentials with the specified name
only list credentials with the specified description
only list credentials with the specified organization
only list credentials with the specified credential_type
only list credentials with the specified managed
only list credentials with the specified inputs
usage: awx credentials modify [-h] [--name TEXT] [--description TEXT]
[--organization ID] [--credential_type ID]
[--inputs JSON/YAML] [--user ID] [--team ID]
id
the ID (or unique name) of the resource
show this help message and exit
Name of this credential.
Optional description of this credential.
Inherit permissions from organization roles. If provided on creation, do not give either user or team.
Specify the type of credential you want to create. Refer to the documentation for details on each type.
Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. You can optionally specify a file path e.g., @path/to/file.yml
Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation.
Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation.
usage: awx execution_environments [-h] action ...
show this help message and exit
usage: awx execution_environments create [-h] --name TEXT [--description TEXT]
[--organization ID] --image TEXT
[--credential ID]
[--pull {,always,missing,never}]
show this help message and exit
Name of this execution environment.
Optional description of this execution environment.
The organization used to determine access to this execution environment.
The full image location, including the container registry, image name, and version tag.
the ID of the associated credential
Pull image before running?
usage: awx execution_environments delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx execution_environments get [-h] [-f {json,yaml,jq,human}]
[--filter TEXT] [--conf.color BOOLEAN]
[-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx execution_environments list [-h] [--all] [--order_by ORDER_BY]
[-f {json,yaml,jq,human}]
[--filter TEXT] [--conf.color BOOLEAN]
[-v] [--type {execution_environment}]
[--created CREATED]
[--modified MODIFIED] [--name TEXT]
[--description TEXT]
[--organization ID] [--image TEXT]
[--managed BOOLEAN] [--credential ID]
[--pull {,always,missing,never}]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list execution_environments with the specified type
only list execution_environments with the specified created
only list execution_environments with the specified modified
only list execution_environments with the specified name
only list execution_environments with the specified description
only list execution_environments with the specified organization
only list execution_environments with the specified image
only list execution_environments with the specified managed
only list execution_environments with the specified credential
only list execution_environments with the specified pull
usage: awx execution_environments modify [-h] [--name TEXT]
[--description TEXT]
[--organization ID] [--image TEXT]
[--credential ID]
[--pull {,always,missing,never}]
id
the ID (or unique name) of the resource
show this help message and exit
Name of this execution environment.
Optional description of this execution environment.
The organization used to determine access to this execution environment.
The full image location, including the container registry, image name, and version tag.
the ID of the associated credential
Pull image before running?
usage: awx export [-h]
show this help message and exit
usage: awx groups [-h] action ...
show this help message and exit
usage: awx groups create [-h] --name TEXT [--description TEXT] --inventory ID
[--variables JSON/YAML]
show this help message and exit
Name of this group.
Optional description of this group.
the ID of the associated inventory
Group variables in JSON or YAML format. You can optionally specify a file path e.g., @path/to/file.yml
usage: awx groups delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx groups get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx groups list [-h] [--all] [--order_by ORDER_BY]
[-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]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list groups with the specified type
only list groups with the specified created
only list groups with the specified modified
only list groups with the specified name
only list groups with the specified description
only list groups with the specified inventory
only list groups with the specified variables
usage: awx groups modify [-h] [--name TEXT] [--description TEXT]
[--inventory ID] [--variables JSON/YAML]
id
the ID (or unique name) of the resource
show this help message and exit
Name of this group.
Optional description of this group.
the ID of the associated inventory
Group variables in JSON or YAML format. You can optionally specify a file path e.g., @path/to/file.yml
usage: awx host_metric_summary_monthly [-h] action ...
show this help message and exit
usage: awx host_metric_summary_monthly get [-h] [-f {json,yaml,jq,human}]
[--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx host_metric_summary_monthly list [-h] [--all] [--order_by ORDER_BY]
[-f {json,yaml,jq,human}]
[--filter TEXT]
[--conf.color BOOLEAN] [-v]
[--date DATE]
[--license_consumed INTEGER]
[--license_capacity INTEGER]
[--hosts_added INTEGER]
[--hosts_deleted INTEGER]
[--indirectly_managed_hosts INTEGER]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list host_metric_summary_monthly with the specified date
only list host_metric_summary_monthly with the specified license_consumed
only list host_metric_summary_monthly with the specified license_capacity
only list host_metric_summary_monthly with the specified hosts_added
only list host_metric_summary_monthly with the specified hosts_deleted
only list host_metric_summary_monthly with the specified indirectly_managed_hosts
usage: awx host_metrics [-h] action ...
show this help message and exit
usage: awx host_metrics delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx host_metrics get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx host_metrics list [-h] [--all] [--order_by ORDER_BY]
[-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v] [--hostname TEXT]
[--first_automation FIRST_AUTOMATION]
[--last_automation LAST_AUTOMATION]
[--last_deleted LAST_DELETED]
[--automated_counter INTEGER]
[--deleted_counter INTEGER] [--deleted BOOLEAN]
[--used_in_inventories INTEGER]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list host_metrics with the specified hostname
only list host_metrics with the specified first_automation
only list host_metrics with the specified last_automation
only list host_metrics with the specified last_deleted
only list host_metrics with the specified automated_counter
only list host_metrics with the specified deleted_counter
only list host_metrics with the specified deleted
only list host_metrics with the specified used_in_inventories
usage: awx hosts [-h] action ...
show this help message and exit
usage: awx hosts create [-h] --name TEXT [--description TEXT] --inventory ID
[--enabled BOOLEAN] [--instance_id TEXT]
[--variables JSON/YAML]
show this help message and exit
Name of this host.
Optional description of this host.
the ID of the associated inventory
Is this host online and available for running jobs?
The value used by the remote inventory source to uniquely identify the host
Host variables in JSON or YAML format. You can optionally specify a file path e.g., @path/to/file.yml
usage: awx hosts delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx hosts get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx hosts list [-h] [--all] [--order_by ORDER_BY]
[-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v] [--type {host}]
[--created CREATED] [--modified MODIFIED] [--name TEXT]
[--description TEXT] [--inventory ID]
[--enabled BOOLEAN] [--instance_id TEXT]
[--variables JSON/YAML] [--last_job ID]
[--last_job_host_summary ID]
[--ansible_facts_modified ANSIBLE_FACTS_MODIFIED]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list hosts with the specified type
only list hosts with the specified created
only list hosts with the specified modified
only list hosts with the specified name
only list hosts with the specified description
only list hosts with the specified inventory
only list hosts with the specified enabled
only list hosts with the specified instance_id
only list hosts with the specified variables
only list hosts with the specified last_job
only list hosts with the specified last_job_host_summary
only list hosts with the specified ansible_facts_modified
usage: awx hosts modify [-h] [--name TEXT] [--description TEXT]
[--inventory ID] [--enabled BOOLEAN]
[--instance_id TEXT] [--variables JSON/YAML]
id
the ID (or unique name) of the resource
show this help message and exit
Name of this host.
Optional description of this host.
the ID of the associated inventory
Is this host online and available for running jobs?
The value used by the remote inventory source to uniquely identify the host
Host variables in JSON or YAML format. You can optionally specify a file path e.g., @path/to/file.yml
usage: awx import [-h]
show this help message and exit
usage: awx instance_groups [-h] action ...
show this help message and exit
usage: awx instance_groups create [-h] --name TEXT
[--max_concurrent_jobs INTEGER]
[--max_forks INTEGER]
[--is_container_group BOOLEAN]
[--credential ID]
[--policy_instance_percentage INTEGER]
[--policy_instance_minimum INTEGER]
[--policy_instance_list JSON/YAML]
[--pod_spec_override TEXT]
show this help message and exit
Name of this instance group.
Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced.
Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced.
Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster.
the ID of the associated credential
Minimum percentage of all instances that will be automatically assigned to this group when new instances come online.
Static minimum number of Instances that will be automatically assign to this group when new instances come online.
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
usage: awx instance_groups delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx instance_groups get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx instance_groups list [-h] [--all] [--order_by ORDER_BY]
[-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
[--type {instance_group}] [--name TEXT]
[--created CREATED] [--modified MODIFIED]
[--max_concurrent_jobs INTEGER]
[--max_forks INTEGER]
[--is_container_group BOOLEAN]
[--credential ID]
[--policy_instance_percentage INTEGER]
[--policy_instance_minimum INTEGER]
[--policy_instance_list JSON/YAML]
[--pod_spec_override TEXT]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list instance_groups with the specified type
only list instance_groups with the specified name
only list instance_groups with the specified created
only list instance_groups with the specified modified
only list instance_groups with the specified max_concurrent_jobs
only list instance_groups with the specified max_forks
only list instance_groups with the specified is_container_group
only list instance_groups with the specified credential
only list instance_groups with the specified policy_instance_percentage
only list instance_groups with the specified policy_instance_minimum
only list instance_groups with the specified policy_instance_list
only list instance_groups with the specified pod_spec_override
usage: awx instance_groups modify [-h] [--name TEXT]
[--max_concurrent_jobs INTEGER]
[--max_forks INTEGER]
[--is_container_group BOOLEAN]
[--credential ID]
[--policy_instance_percentage INTEGER]
[--policy_instance_minimum INTEGER]
[--policy_instance_list JSON/YAML]
[--pod_spec_override TEXT]
id
the ID (or unique name) of the resource
show this help message and exit
Name of this instance group.
Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced.
Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced.
Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster.
the ID of the associated credential
Minimum percentage of all instances that will be automatically assigned to this group when new instances come online.
Static minimum number of Instances that will be automatically assign to this group when new instances come online.
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
usage: awx instances [-h] action ...
show this help message and exit
usage: awx instances create [-h] --hostname TEXT
[--capacity_adjustment CAPACITY_ADJUSTMENT]
[--enabled BOOLEAN] [--managed_by_policy BOOLEAN]
[--node_type {control,execution,hybrid,hop}]
[--node_state {provisioning,provision-fail,installed,ready,unavailable,deprovisioning,deprovision-fail}]
[--listener_port INTEGER] [--peers PEERS]
[--peers_from_control_nodes BOOLEAN]
show this help message and exit
Role that this node plays in the mesh.
Indicates the current life cycle stage of this instance.
Port that Receptor will listen for incoming connections on.
If True, control plane cluster nodes should automatically peer to it.
usage: awx instances get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx instances list [-h] [--all] [--order_by ORDER_BY]
[-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v] [--hostname TEXT]
[--type {instance}] [--uuid TEXT]
[--created CREATED] [--modified MODIFIED]
[--last_seen LAST_SEEN]
[--health_check_started HEALTH_CHECK_STARTED]
[--last_health_check LAST_HEALTH_CHECK]
[--errors TEXT]
[--capacity_adjustment CAPACITY_ADJUSTMENT]
[--version TEXT] [--capacity INTEGER] [--cpu CPU]
[--memory INTEGER] [--cpu_capacity INTEGER]
[--mem_capacity INTEGER] [--enabled BOOLEAN]
[--managed_by_policy BOOLEAN]
[--node_type {control,execution,hybrid,hop}]
[--node_state {provisioning,provision-fail,installed,ready,unavailable,deprovisioning,deprovision-fail}]
[--ip_address TEXT] [--listener_port INTEGER]
[--peers_from_control_nodes BOOLEAN]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list instances with the specified hostname
only list instances with the specified type
only list instances with the specified uuid
only list instances with the specified created
only list instances with the specified modified
only list instances with the specified last_seen
only list instances with the specified health_check_started
only list instances with the specified last_health_check
only list instances with the specified errors
only list instances with the specified capacity_adjustment
only list instances with the specified version
only list instances with the specified capacity
only list instances with the specified cpu
only list instances with the specified memory
only list instances with the specified cpu_capacity
only list instances with the specified mem_capacity
only list instances with the specified enabled
only list instances with the specified managed_by_policy
only list instances with the specified node_type
only list instances with the specified node_state
only list instances with the specified ip_address
only list instances with the specified listener_port
only list instances with the specified peers_from_control_nodes
usage: awx instances modify [-h] [--hostname TEXT]
[--capacity_adjustment CAPACITY_ADJUSTMENT]
[--enabled BOOLEAN] [--managed_by_policy BOOLEAN]
[--node_type {control,execution,hybrid,hop}]
[--node_state {provisioning,provision-fail,installed,ready,unavailable,deprovisioning,deprovision-fail}]
[--listener_port INTEGER] [--peers PEERS]
[--peers_from_control_nodes BOOLEAN]
id
the ID (or unique name) of the resource
show this help message and exit
Role that this node plays in the mesh.
Indicates the current life cycle stage of this instance.
Port that Receptor will listen for incoming connections on.
If True, control plane cluster nodes should automatically peer to it.
usage: awx inventory [-h] action ...
show this help message and exit
usage: awx inventory create [-h] --name TEXT [--description TEXT]
--organization ID [--kind {,smart,constructed}]
[--host_filter TEXT] [--variables JSON/YAML]
[--prevent_instance_group_fallback BOOLEAN]
show this help message and exit
Name of this inventory.
Optional description of this inventory.
Organization containing this inventory.
Kind of inventory being represented.
Filter that will be applied to the hosts of this inventory.
Inventory variables in JSON or YAML format. You can optionally specify a file path e.g., @path/to/file.yml
If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.
usage: awx inventory delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx inventory get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx inventory list [-h] [--all] [--order_by ORDER_BY]
[-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,constructed}]
[--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]
[--pending_deletion BOOLEAN]
[--prevent_instance_group_fallback BOOLEAN]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list inventory with the specified type
only list inventory with the specified created
only list inventory with the specified modified
only list inventory with the specified name
only list inventory with the specified description
only list inventory with the specified organization
only list inventory with the specified kind
only list inventory with the specified host_filter
only list inventory with the specified variables
only list inventory with the specified has_active_failures
only list inventory with the specified total_hosts
only list inventory with the specified hosts_with_active_failures
only list inventory with the specified total_groups
only list inventory with the specified has_inventory_sources
only list inventory with the specified total_inventory_sources
only list inventory with the specified inventory_sources_with_failures
only list inventory with the specified pending_deletion
only list inventory with the specified prevent_instance_group_fallback
usage: awx inventory modify [-h] [--name TEXT] [--description TEXT]
[--organization ID] [--kind {,smart,constructed}]
[--host_filter TEXT] [--variables JSON/YAML]
[--prevent_instance_group_fallback BOOLEAN]
id
the ID (or unique name) of the resource
show this help message and exit
Name of this inventory.
Optional description of this inventory.
Organization containing this inventory.
Kind of inventory being represented.
Filter that will be applied to the hosts of this inventory.
Inventory variables in JSON or YAML format. You can optionally specify a file path e.g., @path/to/file.yml
If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.
usage: awx inventory_sources [-h] action ...
show this help message and exit
usage: awx inventory_sources associate [-h]
(--start_notification | --success_notification | --failure_notification )
id
show this help message and exit
The ID (or name) of the notification_template to associate
The ID (or name) of the notification_template to associate
The ID (or name) of the notification_template to associate
usage: awx inventory_sources create [-h] --name TEXT [--description TEXT]
[--source {file,constructed,scm,ec2,gce,azure_rm,vmware,satellite6,openstack,rhv,controller,insights}]
[--source_path TEXT] [--source_vars TEXT]
[--scm_branch TEXT] [--credential INTEGER]
[--enabled_var TEXT]
[--enabled_value TEXT]
[--host_filter TEXT] [--overwrite BOOLEAN]
[--overwrite_vars BOOLEAN]
[--timeout INTEGER] [--verbosity {0,1,2}]
[--limit TEXT]
[--execution_environment ID] --inventory
ID [--update_on_launch BOOLEAN]
[--update_cache_timeout INTEGER]
[--source_project ID]
show this help message and exit
Name of this inventory source.
Optional description of this inventory source.
Inventory source variables in YAML or JSON format.
Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true.
Cloud credential to use for inventory updates.
Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as “foo.bar”, in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get(“foo”, {}).get(“bar”, default)
Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var=”status.power_state”and enabled_value=”powered_on” with host variables:{ “status”: { “power_state”: “powered_on”, “created”: “2020-08-04T18:13:04+00:00”, “healthy”: true }, “name”: “foobar”, “ip_address”: “192.168.2.1”}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled
This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.
Overwrite local groups and hosts from remote inventory source.
Overwrite local variables from remote inventory source.
The amount of time (in seconds) to run before the task is canceled.
Enter host, group or pattern match
The container image to be used for execution.
the ID of the associated inventory
Project containing inventory file used as source.
usage: awx inventory_sources delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx inventory_sources disassociate [-h]
(--start_notification | --success_notification | --failure_notification )
id
show this help message and exit
The ID (or name) of the notification_template to disassociate
The ID (or name) of the notification_template to disassociate
The ID (or name) of the notification_template to disassociate
usage: awx inventory_sources get [-h] [-f {json,yaml,jq,human}]
[--filter TEXT] [--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx inventory_sources list [-h] [--all] [--order_by ORDER_BY]
[-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
[--type {inventory_source}]
[--created CREATED] [--modified MODIFIED]
[--name TEXT] [--description TEXT]
[--source {file,constructed,scm,ec2,gce,azure_rm,vmware,satellite6,openstack,rhv,controller,insights}]
[--source_path TEXT] [--source_vars TEXT]
[--scm_branch TEXT] [--enabled_var TEXT]
[--enabled_value TEXT] [--host_filter TEXT]
[--overwrite BOOLEAN]
[--overwrite_vars BOOLEAN]
[--custom_virtualenv TEXT]
[--timeout INTEGER] [--verbosity {0,1,2}]
[--limit TEXT] [--last_job_run LAST_JOB_RUN]
[--last_job_failed BOOLEAN]
[--next_job_run NEXT_JOB_RUN]
[--status {new,pending,waiting,running,successful,failed,error,canceled,never updated,none}]
[--execution_environment ID]
[--inventory ID]
[--update_on_launch BOOLEAN]
[--update_cache_timeout INTEGER]
[--source_project ID]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list inventory_sources with the specified type
only list inventory_sources with the specified created
only list inventory_sources with the specified modified
only list inventory_sources with the specified name
only list inventory_sources with the specified description
only list inventory_sources with the specified source
only list inventory_sources with the specified source_path
only list inventory_sources with the specified source_vars
only list inventory_sources with the specified scm_branch
only list inventory_sources with the specified enabled_var
only list inventory_sources with the specified enabled_value
only list inventory_sources with the specified host_filter
only list inventory_sources with the specified overwrite
only list inventory_sources with the specified overwrite_vars
only list inventory_sources with the specified custom_virtualenv
only list inventory_sources with the specified timeout
only list inventory_sources with the specified verbosity
only list inventory_sources with the specified limit
only list inventory_sources with the specified last_job_run
only list inventory_sources with the specified last_job_failed
only list inventory_sources with the specified next_job_run
only list inventory_sources with the specified status
only list inventory_sources with the specified execution_environment
only list inventory_sources with the specified inventory
only list inventory_sources with the specified update_on_launch
only list inventory_sources with the specified update_cache_timeout
only list inventory_sources with the specified source_project
usage: awx inventory_sources modify [-h] [--name TEXT] [--description TEXT]
[--source {file,constructed,scm,ec2,gce,azure_rm,vmware,satellite6,openstack,rhv,controller,insights}]
[--source_path TEXT] [--source_vars TEXT]
[--scm_branch TEXT] [--credential INTEGER]
[--enabled_var TEXT]
[--enabled_value TEXT]
[--host_filter TEXT] [--overwrite BOOLEAN]
[--overwrite_vars BOOLEAN]
[--timeout INTEGER] [--verbosity {0,1,2}]
[--limit TEXT]
[--execution_environment ID]
[--inventory ID]
[--update_on_launch BOOLEAN]
[--update_cache_timeout INTEGER]
[--source_project ID]
id
the ID (or unique name) of the resource
show this help message and exit
Name of this inventory source.
Optional description of this inventory source.
Inventory source variables in YAML or JSON format.
Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true.
Cloud credential to use for inventory updates.
Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as “foo.bar”, in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get(“foo”, {}).get(“bar”, default)
Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var=”status.power_state”and enabled_value=”powered_on” with host variables:{ “status”: { “power_state”: “powered_on”, “created”: “2020-08-04T18:13:04+00:00”, “healthy”: true }, “name”: “foobar”, “ip_address”: “192.168.2.1”}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled
This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.
Overwrite local groups and hosts from remote inventory source.
Overwrite local variables from remote inventory source.
The amount of time (in seconds) to run before the task is canceled.
Enter host, group or pattern match
The container image to be used for execution.
the ID of the associated inventory
Project containing inventory file used as source.
usage: awx inventory_sources update [-h] [--monitor]
[--action-timeout ACTION_TIMEOUT] [--wait]
[--interval INTERVAL]
id
show this help message and exit
If set, prints stdout of the launched job until it finishes.
If set with –monitor or –wait, time out waiting on job completion.
If set, waits until the launched job finishes.
If set with –monitor or –wait, amount of time to wait in seconds between api calls. Minimum value is 2.5 seconds to avoid overwhelming the api
usage: awx inventory_updates [-h] action ...
show this help message and exit
usage: awx inventory_updates delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx inventory_updates get [-h] [-f {json,yaml,jq,human}]
[--filter TEXT] [--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx inventory_updates list [-h] [--all] [--order_by ORDER_BY]
[-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}]
[--execution_environment ID]
[--failed BOOLEAN] [--started STARTED]
[--finished FINISHED]
[--canceled_on CANCELED_ON]
[--elapsed ELAPSED] [--job_explanation TEXT]
[--execution_node TEXT]
[--controller_node TEXT]
[--work_unit_id TEXT]
[--source {file,constructed,scm,ec2,gce,azure_rm,vmware,satellite6,openstack,rhv,controller,insights}]
[--source_path TEXT] [--source_vars TEXT]
[--scm_branch TEXT] [--enabled_var TEXT]
[--enabled_value TEXT] [--host_filter TEXT]
[--overwrite BOOLEAN]
[--overwrite_vars BOOLEAN]
[--custom_virtualenv TEXT]
[--timeout INTEGER] [--verbosity {0,1,2}]
[--limit TEXT] [--inventory ID]
[--inventory_source ID]
[--license_error BOOLEAN]
[--org_host_limit_error BOOLEAN]
[--source_project_update ID]
[--instance_group ID] [--scm_revision TEXT]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list inventory_updates with the specified type
only list inventory_updates with the specified created
only list inventory_updates with the specified modified
only list inventory_updates with the specified name
only list inventory_updates with the specified description
only list inventory_updates with the specified unified_job_template
only list inventory_updates with the specified launch_type
only list inventory_updates with the specified status
only list inventory_updates with the specified execution_environment
only list inventory_updates with the specified failed
only list inventory_updates with the specified started
only list inventory_updates with the specified finished
only list inventory_updates with the specified canceled_on
only list inventory_updates with the specified elapsed
only list inventory_updates with the specified job_explanation
only list inventory_updates with the specified execution_node
only list inventory_updates with the specified controller_node
only list inventory_updates with the specified work_unit_id
only list inventory_updates with the specified source
only list inventory_updates with the specified source_path
only list inventory_updates with the specified source_vars
only list inventory_updates with the specified scm_branch
only list inventory_updates with the specified enabled_var
only list inventory_updates with the specified enabled_value
only list inventory_updates with the specified host_filter
only list inventory_updates with the specified overwrite
only list inventory_updates with the specified overwrite_vars
only list inventory_updates with the specified custom_virtualenv
only list inventory_updates with the specified timeout
only list inventory_updates with the specified verbosity
only list inventory_updates with the specified limit
only list inventory_updates with the specified inventory
only list inventory_updates with the specified inventory_source
only list inventory_updates with the specified license_error
only list inventory_updates with the specified org_host_limit_error
only list inventory_updates with the specified source_project_update
only list inventory_updates with the specified instance_group
only list inventory_updates with the specified scm_revision
usage: awx inventory_updates stdout [-h] id
show this help message and exit
usage: awx job_templates [-h] action ...
show this help message and exit
usage: awx job_templates associate [-h]
(--start_notification | --success_notification | --failure_notification | --credential )
id
show this help message and exit
The ID (or name) of the notification_template to associate
The ID (or name) of the notification_template to associate
The ID (or name) of the notification_template to associate
The ID (or name) of the credential to associate
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]
[--execution_environment ID]
[--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]
[--ask_execution_environment_on_launch BOOLEAN]
[--ask_labels_on_launch BOOLEAN]
[--ask_forks_on_launch BOOLEAN]
[--ask_job_slice_count_on_launch BOOLEAN]
[--ask_timeout_on_launch BOOLEAN]
[--ask_instance_groups_on_launch BOOLEAN]
[--survey_enabled BOOLEAN]
[--become_enabled BOOLEAN]
[--diff_mode BOOLEAN]
[--allow_simultaneous BOOLEAN]
[--job_slice_count INTEGER]
[--webhook_service {,github,gitlab}]
[--webhook_credential ID]
[--prevent_instance_group_fallback BOOLEAN]
show this help message and exit
Name of this job template.
Optional description of this job template.
the ID of the associated inventory
the ID of the associated project
Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.
a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml
The amount of time (in seconds) to run before the task is canceled.
If enabled, the service 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.
The container image to be used for execution.
If enabled, textual changes made to any templated files on the host are shown in the standard output
The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1.
Service that webhook requests will be accepted from
Personal Access Token for posting back the status to the service API
If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.
usage: awx job_templates delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx job_templates disassociate [-h]
(--start_notification | --success_notification | --failure_notification | --credential )
id
show this help message and exit
The ID (or name) of the notification_template to disassociate
The ID (or name) of the notification_template to disassociate
The ID (or name) of the notification_template to disassociate
The ID (or name) of the credential to disassociate
usage: awx job_templates get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx job_templates launch [-h] [--monitor]
[--action-timeout ACTION_TIMEOUT] [--wait]
[--interval INTERVAL] [--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]
[--execution_environment ID] [--labels LABELS]
[--forks INTEGER] [--job_slice_count INTEGER]
[--timeout INTEGER]
[--instance_groups INSTANCE_GROUPS]
id
show this help message and exit
If set, prints stdout of the launched job until it finishes.
If set with –monitor or –wait, time out waiting on job completion.
If set, waits until the launched job finishes.
If set with –monitor or –wait, amount of time to wait in seconds between api calls. Minimum value is 2.5 seconds to avoid overwhelming the api
a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml
the ID of the associated inventory
a list of comma-delimited credentials to associate (IDs or unique names)
a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml
the ID of the associated execution_environment
usage: awx job_templates list [-h] [--all] [--order_by ORDER_BY]
[-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}]
[--execution_environment ID]
[--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]
[--ask_execution_environment_on_launch BOOLEAN]
[--ask_labels_on_launch BOOLEAN]
[--ask_forks_on_launch BOOLEAN]
[--ask_job_slice_count_on_launch BOOLEAN]
[--ask_timeout_on_launch BOOLEAN]
[--ask_instance_groups_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]
[--prevent_instance_group_fallback BOOLEAN]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list job_templates with the specified type
only list job_templates with the specified created
only list job_templates with the specified modified
only list job_templates with the specified name
only list job_templates with the specified description
only list job_templates with the specified job_type
only list job_templates with the specified inventory
only list job_templates with the specified project
only list job_templates with the specified playbook
only list job_templates with the specified scm_branch
only list job_templates with the specified forks
only list job_templates with the specified limit
only list job_templates with the specified verbosity
only list job_templates with the specified extra_vars
only list job_templates with the specified job_tags
only list job_templates with the specified force_handlers
only list job_templates with the specified skip_tags
only list job_templates with the specified start_at_task
only list job_templates with the specified timeout
only list job_templates with the specified use_fact_cache
only list job_templates with the specified organization
only list job_templates with the specified last_job_run
only list job_templates with the specified last_job_failed
only list job_templates with the specified next_job_run
only list job_templates with the specified status
only list job_templates with the specified execution_environment
only list job_templates with the specified host_config_key
only list job_templates with the specified ask_scm_branch_on_launch
only list job_templates with the specified ask_diff_mode_on_launch
only list job_templates with the specified ask_variables_on_launch
only list job_templates with the specified ask_limit_on_launch
only list job_templates with the specified ask_tags_on_launch
only list job_templates with the specified ask_skip_tags_on_launch
only list job_templates with the specified ask_job_type_on_launch
only list job_templates with the specified ask_verbosity_on_launch
only list job_templates with the specified ask_inventory_on_launch
only list job_templates with the specified ask_credential_on_launch
only list job_templates with the specified ask_execution_environment_on_launch
only list job_templates with the specified ask_labels_on_launch
only list job_templates with the specified ask_forks_on_launch
only list job_templates with the specified ask_job_slice_count_on_launch
only list job_templates with the specified ask_timeout_on_launch
only list job_templates with the specified ask_instance_groups_on_launch
only list job_templates with the specified survey_enabled
only list job_templates with the specified become_enabled
only list job_templates with the specified diff_mode
only list job_templates with the specified allow_simultaneous
only list job_templates with the specified custom_virtualenv
only list job_templates with the specified job_slice_count
only list job_templates with the specified webhook_service
only list job_templates with the specified webhook_credential
only list job_templates with the specified prevent_instance_group_fallback
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]
[--execution_environment ID]
[--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]
[--ask_execution_environment_on_launch BOOLEAN]
[--ask_labels_on_launch BOOLEAN]
[--ask_forks_on_launch BOOLEAN]
[--ask_job_slice_count_on_launch BOOLEAN]
[--ask_timeout_on_launch BOOLEAN]
[--ask_instance_groups_on_launch BOOLEAN]
[--survey_enabled BOOLEAN]
[--become_enabled BOOLEAN]
[--diff_mode BOOLEAN]
[--allow_simultaneous BOOLEAN]
[--job_slice_count INTEGER]
[--webhook_service {,github,gitlab}]
[--webhook_credential ID]
[--prevent_instance_group_fallback BOOLEAN]
id
the ID (or unique name) of the resource
show this help message and exit
Name of this job template.
Optional description of this job template.
the ID of the associated inventory
the ID of the associated project
Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.
a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml
The amount of time (in seconds) to run before the task is canceled.
If enabled, the service 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.
The container image to be used for execution.
If enabled, textual changes made to any templated files on the host are shown in the standard output
The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1.
Service that webhook requests will be accepted from
Personal Access Token for posting back the status to the service API
If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.
usage: awx jobs [-h] action ...
show this help message and exit
usage: awx jobs delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx jobs get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx jobs list [-h] [--all] [--order_by ORDER_BY]
[-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}]
[--execution_environment ID] [--failed BOOLEAN]
[--started STARTED] [--finished FINISHED]
[--canceled_on CANCELED_ON] [--elapsed ELAPSED]
[--job_explanation TEXT] [--execution_node TEXT]
[--controller_node TEXT] [--work_unit_id 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]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list jobs with the specified type
only list jobs with the specified created
only list jobs with the specified modified
only list jobs with the specified name
only list jobs with the specified description
only list jobs with the specified unified_job_template
only list jobs with the specified launch_type
only list jobs with the specified status
only list jobs with the specified execution_environment
only list jobs with the specified failed
only list jobs with the specified started
only list jobs with the specified finished
only list jobs with the specified canceled_on
only list jobs with the specified elapsed
only list jobs with the specified job_explanation
only list jobs with the specified execution_node
only list jobs with the specified controller_node
only list jobs with the specified work_unit_id
only list jobs with the specified job_type
only list jobs with the specified inventory
only list jobs with the specified project
only list jobs with the specified playbook
only list jobs with the specified scm_branch
only list jobs with the specified forks
only list jobs with the specified limit
only list jobs with the specified verbosity
only list jobs with the specified extra_vars
only list jobs with the specified job_tags
only list jobs with the specified force_handlers
only list jobs with the specified skip_tags
only list jobs with the specified start_at_task
only list jobs with the specified timeout
only list jobs with the specified use_fact_cache
only list jobs with the specified organization
only list jobs with the specified job_template
only list jobs with the specified allow_simultaneous
only list jobs with the specified artifacts
only list jobs with the specified scm_revision
only list jobs with the specified instance_group
only list jobs with the specified diff_mode
only list jobs with the specified job_slice_number
only list jobs with the specified job_slice_count
only list jobs with the specified webhook_service
only list jobs with the specified webhook_credential
only list jobs with the specified webhook_guid
usage: awx jobs monitor [-h] id
show this help message and exit
usage: awx jobs stdout [-h] id
show this help message and exit
usage: awx labels [-h] action ...
show this help message and exit
usage: awx labels create [-h] --name TEXT --organization ID
show this help message and exit
Name of this label.
Organization this label belongs to.
usage: awx labels get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx labels list [-h] [--all] [--order_by ORDER_BY]
[-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v] [--type {label}]
[--created CREATED] [--modified MODIFIED] [--name TEXT]
[--organization ID]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list labels with the specified type
only list labels with the specified created
only list labels with the specified modified
only list labels with the specified name
only list labels with the specified organization
usage: awx labels modify [-h] [--name TEXT] [--organization ID] id
the ID (or unique name) of the resource
show this help message and exit
Name of this label.
Organization this label belongs to.
usage: awx login [-h]
show this help message and exit
usage: awx me [-h]
show this help message and exit
usage: awx mesh_visualizer [-h]
show this help message and exit
usage: awx metrics [-h]
show this help message and exit
usage: awx notification_templates [-h] action ...
show this help message and exit
usage: awx notification_templates create [-h] --name TEXT [--description TEXT]
--organization ID --notification_type
{email,grafana,irc,mattermost,pagerduty,rocketchat,slack,twilio,webhook}
[--notification_configuration JSON/YAML]
[--messages JSON/YAML]
show this help message and exit
Name of this notification template.
Optional description of this notification template.
the ID of the associated organization
a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml
Optional custom messages for notification template. You can optionally specify a file path e.g., @path/to/file.yml
usage: awx notification_templates delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx notification_templates get [-h] [-f {json,yaml,jq,human}]
[--filter TEXT] [--conf.color BOOLEAN]
[-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx notification_templates list [-h] [--all] [--order_by ORDER_BY]
[-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,irc,mattermost,pagerduty,rocketchat,slack,twilio,webhook}]
[--notification_configuration JSON/YAML]
[--messages JSON/YAML]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list notification_templates with the specified type
only list notification_templates with the specified created
only list notification_templates with the specified modified
only list notification_templates with the specified name
only list notification_templates with the specified description
only list notification_templates with the specified organization
only list notification_templates with the specified notification_type
only list notification_templates with the specified notification_configuration
only list notification_templates with the specified messages
usage: awx notification_templates modify [-h] [--name TEXT]
[--description TEXT]
[--organization ID]
[--notification_type {email,grafana,irc,mattermost,pagerduty,rocketchat,slack,twilio,webhook}]
[--notification_configuration JSON/YAML]
[--messages JSON/YAML]
id
the ID (or unique name) of the resource
show this help message and exit
Name of this notification template.
Optional description of this notification template.
the ID of the associated organization
a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml
Optional custom messages for notification template. You can optionally specify a file path e.g., @path/to/file.yml
usage: awx notifications [-h] action ...
show this help message and exit
usage: awx notifications get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx notifications list [-h] [--all] [--order_by ORDER_BY]
[-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,irc,mattermost,pagerduty,rocketchat,slack,twilio,webhook}]
[--recipients TEXT] [--subject TEXT]
[--body JSON/YAML]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list notifications with the specified type
only list notifications with the specified created
only list notifications with the specified modified
only list notifications with the specified notification_template
only list notifications with the specified error
only list notifications with the specified status
only list notifications with the specified notifications_sent
only list notifications with the specified notification_type
only list notifications with the specified recipients
only list notifications with the specified subject
only list notifications with the specified body
usage: awx organizations [-h] action ...
show this help message and exit
usage: awx organizations associate [-h]
(--start_notification | --success_notification | --failure_notification | --approval_notification | --galaxy_credential )
id
show this help message and exit
The ID (or name) of the notification_template to associate
The ID (or name) of the notification_template to associate
The ID (or name) of the notification_template to associate
The ID (or name) of the notification_template to associate
The ID (or name) of the credential to associate
usage: awx organizations create [-h] --name TEXT [--description TEXT]
[--max_hosts INTEGER]
[--default_environment ID]
show this help message and exit
Name of this organization.
Optional description of this organization.
Maximum number of hosts allowed to be managed by this organization.
The default execution environment for jobs run by this organization.
usage: awx organizations delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx organizations disassociate [-h]
(--start_notification | --success_notification | --failure_notification | --approval_notification | --galaxy_credential )
id
show this help message and exit
The ID (or name) of the notification_template to disassociate
The ID (or name) of the notification_template to disassociate
The ID (or name) of the notification_template to disassociate
The ID (or name) of the notification_template to disassociate
The ID (or name) of the credential to disassociate
usage: awx organizations get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx organizations list [-h] [--all] [--order_by ORDER_BY]
[-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]
[--default_environment ID]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list organizations with the specified type
only list organizations with the specified created
only list organizations with the specified modified
only list organizations with the specified name
only list organizations with the specified description
only list organizations with the specified max_hosts
only list organizations with the specified custom_virtualenv
only list organizations with the specified default_environment
usage: awx organizations modify [-h] [--name TEXT] [--description TEXT]
[--max_hosts INTEGER]
[--default_environment ID]
id
the ID (or unique name) of the resource
show this help message and exit
Name of this organization.
Optional description of this organization.
Maximum number of hosts allowed to be managed by this organization.
The default execution environment for jobs run by this organization.
usage: awx ping [-h]
show this help message and exit
usage: awx project_updates [-h] action ...
show this help message and exit
usage: awx project_updates delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx project_updates get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx project_updates list [-h] [--all] [--order_by ORDER_BY]
[-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}]
[--execution_environment ID]
[--failed BOOLEAN] [--started STARTED]
[--finished FINISHED]
[--canceled_on CANCELED_ON]
[--elapsed ELAPSED] [--job_explanation TEXT]
[--execution_node TEXT] [--work_unit_id TEXT]
[--local_path TEXT]
[--scm_type {,git,svn,insights,archive}]
[--scm_url TEXT] [--scm_branch TEXT]
[--scm_refspec TEXT] [--scm_clean BOOLEAN]
[--scm_track_submodules BOOLEAN]
[--scm_delete_on_update BOOLEAN]
[--credential ID] [--timeout INTEGER]
[--scm_revision TEXT] [--project ID]
[--job_type {run,check}] [--job_tags TEXT]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list project_updates with the specified type
only list project_updates with the specified created
only list project_updates with the specified modified
only list project_updates with the specified name
only list project_updates with the specified description
only list project_updates with the specified unified_job_template
only list project_updates with the specified launch_type
only list project_updates with the specified status
only list project_updates with the specified execution_environment
only list project_updates with the specified failed
only list project_updates with the specified started
only list project_updates with the specified finished
only list project_updates with the specified canceled_on
only list project_updates with the specified elapsed
only list project_updates with the specified job_explanation
only list project_updates with the specified execution_node
only list project_updates with the specified work_unit_id
only list project_updates with the specified local_path
only list project_updates with the specified scm_type
only list project_updates with the specified scm_url
only list project_updates with the specified scm_branch
only list project_updates with the specified scm_refspec
only list project_updates with the specified scm_clean
only list project_updates with the specified scm_track_submodules
only list project_updates with the specified scm_delete_on_update
only list project_updates with the specified credential
only list project_updates with the specified timeout
only list project_updates with the specified scm_revision
only list project_updates with the specified project
only list project_updates with the specified job_type
only list project_updates with the specified job_tags
usage: awx project_updates stdout [-h] id
show this help message and exit
usage: awx projects [-h] action ...
show this help message and exit
usage: awx projects associate [-h]
(--start_notification | --success_notification | --failure_notification )
id
show this help message and exit
The ID (or name) of the notification_template to associate
The ID (or name) of the notification_template to associate
The ID (or name) of the notification_template to associate
usage: awx projects create [-h] [--monitor] [--wait] --name TEXT
[--description TEXT] [--local_path TEXT]
[--scm_type {,git,svn,insights,archive}]
[--scm_url TEXT] [--scm_branch TEXT]
[--scm_refspec TEXT] [--scm_clean BOOLEAN]
[--scm_track_submodules 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]
[--default_environment ID]
[--signature_validation_credential ID]
show this help message and exit
If set, prints stdout of the project update until it finishes.
If set, waits until the new project has updated.
Name of this project.
Optional description of this project.
Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.
Specifies the source control system used to store the project.
The location where the project is stored.
Specific branch, tag or commit to checkout.
For git projects, an additional refspec to fetch.
Discard any local changes before syncing the project.
Track submodules latest commits on defined branch.
Delete the project before syncing.
the ID of the associated credential
The amount of time (in seconds) to run before the task is canceled.
The organization used to determine access to this template.
Update the project when a job is launched that uses the project.
The number of seconds after the last project update ran that a new project update will be launched as a job dependency.
Allow changing the SCM branch or revision in a job template that uses this project.
The default execution environment for jobs run using this project.
An optional credential used for validating files in the project against unexpected changes.
usage: awx projects delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx projects disassociate [-h]
(--start_notification | --success_notification | --failure_notification )
id
show this help message and exit
The ID (or name) of the notification_template to disassociate
The ID (or name) of the notification_template to disassociate
The ID (or name) of the notification_template to disassociate
usage: awx projects get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx projects list [-h] [--all] [--order_by ORDER_BY]
[-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,svn,insights,archive}]
[--scm_url TEXT] [--scm_branch TEXT]
[--scm_refspec TEXT] [--scm_clean BOOLEAN]
[--scm_track_submodules 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]
[--default_environment ID]
[--signature_validation_credential ID]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list projects with the specified type
only list projects with the specified created
only list projects with the specified modified
only list projects with the specified name
only list projects with the specified description
only list projects with the specified local_path
only list projects with the specified scm_type
only list projects with the specified scm_url
only list projects with the specified scm_branch
only list projects with the specified scm_refspec
only list projects with the specified scm_clean
only list projects with the specified scm_track_submodules
only list projects with the specified scm_delete_on_update
only list projects with the specified credential
only list projects with the specified timeout
only list projects with the specified scm_revision
only list projects with the specified last_job_run
only list projects with the specified last_job_failed
only list projects with the specified next_job_run
only list projects with the specified status
only list projects with the specified organization
only list projects with the specified scm_update_on_launch
only list projects with the specified scm_update_cache_timeout
only list projects with the specified allow_override
only list projects with the specified custom_virtualenv
only list projects with the specified default_environment
only list projects with the specified signature_validation_credential
usage: awx projects modify [-h] [--name TEXT] [--description TEXT]
[--local_path TEXT]
[--scm_type {,git,svn,insights,archive}]
[--scm_url TEXT] [--scm_branch TEXT]
[--scm_refspec TEXT] [--scm_clean BOOLEAN]
[--scm_track_submodules 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]
[--default_environment ID]
[--signature_validation_credential ID]
id
the ID (or unique name) of the resource
show this help message and exit
Name of this project.
Optional description of this project.
Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.
Specifies the source control system used to store the project.
The location where the project is stored.
Specific branch, tag or commit to checkout.
For git projects, an additional refspec to fetch.
Discard any local changes before syncing the project.
Track submodules latest commits on defined branch.
Delete the project before syncing.
the ID of the associated credential
The amount of time (in seconds) to run before the task is canceled.
The organization used to determine access to this template.
Update the project when a job is launched that uses the project.
The number of seconds after the last project update ran that a new project update will be launched as a job dependency.
Allow changing the SCM branch or revision in a job template that uses this project.
The default execution environment for jobs run using this project.
An optional credential used for validating files in the project against unexpected changes.
usage: awx projects update [-h] [--monitor] [--action-timeout ACTION_TIMEOUT]
[--wait] [--interval INTERVAL]
id
show this help message and exit
If set, prints stdout of the launched job until it finishes.
If set with –monitor or –wait, time out waiting on job completion.
If set, waits until the launched job finishes.
If set with –monitor or –wait, amount of time to wait in seconds between api calls. Minimum value is 2.5 seconds to avoid overwhelming the api
usage: awx roles [-h] action ...
show this help message and exit
usage: awx roles get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx roles list [-h] [--all] [--order_by ORDER_BY]
[-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v] [--type {role}]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list roles with the specified type
usage: awx schedules [-h] action ...
show this help message and exit
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}]
[--execution_environment ID] [--forks INTEGER]
[--job_slice_count INTEGER] [--timeout INTEGER]
--unified_job_template ID [--enabled BOOLEAN]
show this help message and exit
A value representing the schedules iCal recurrence rule.
Name of this schedule.
Optional description of this schedule.
a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml
Inventory applied as a prompt, assuming job template prompts for inventory
The container image to be used for execution.
the ID of the associated unified_job_template
Enables processing of this schedule.
usage: awx schedules delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx schedules get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx schedules list [-h] [--all] [--order_by ORDER_BY]
[-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] [--execution_environment ID]
[--unified_job_template ID] [--enabled BOOLEAN]
[--dtstart DTSTART] [--dtend DTEND]
[--next_run NEXT_RUN]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list schedules with the specified rrule
only list schedules with the specified type
only list schedules with the specified created
only list schedules with the specified modified
only list schedules with the specified name
only list schedules with the specified description
only list schedules with the specified extra_data
only list schedules with the specified inventory
only list schedules with the specified execution_environment
only list schedules with the specified unified_job_template
only list schedules with the specified enabled
only list schedules with the specified dtstart
only list schedules with the specified dtend
only list schedules with the specified next_run
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}]
[--execution_environment ID] [--forks INTEGER]
[--job_slice_count INTEGER] [--timeout INTEGER]
[--unified_job_template ID] [--enabled BOOLEAN]
id
the ID (or unique name) of the resource
show this help message and exit
A value representing the schedules iCal recurrence rule.
Name of this schedule.
Optional description of this schedule.
a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml
Inventory applied as a prompt, assuming job template prompts for inventory
The container image to be used for execution.
the ID of the associated unified_job_template
Enables processing of this schedule.
usage: awx settings [-h] action ...
show this help message and exit
usage: awx settings list [-h] [--slug SLUG]
show this help message and exit
optional setting category/slug
usage: awx settings modify [-h] key value
show this help message and exit
usage: awx system_job_templates [-h] action ...
show this help message and exit
usage: awx system_job_templates get [-h] [-f {json,yaml,jq,human}]
[--filter TEXT] [--conf.color BOOLEAN]
[-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx system_job_templates list [-h] [--all] [--order_by ORDER_BY]
[-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}]
[--execution_environment ID]
[--job_type {,cleanup_jobs,cleanup_activitystream,cleanup_sessions,cleanup_tokens}]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list system_job_templates with the specified type
only list system_job_templates with the specified created
only list system_job_templates with the specified modified
only list system_job_templates with the specified name
only list system_job_templates with the specified description
only list system_job_templates with the specified last_job_run
only list system_job_templates with the specified last_job_failed
only list system_job_templates with the specified next_job_run
only list system_job_templates with the specified status
only list system_job_templates with the specified execution_environment
only list system_job_templates with the specified job_type
usage: awx system_jobs [-h] action ...
show this help message and exit
usage: awx system_jobs delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx system_jobs get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx system_jobs list [-h] [--all] [--order_by ORDER_BY]
[-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}]
[--execution_environment ID] [--failed BOOLEAN]
[--started STARTED] [--finished FINISHED]
[--canceled_on CANCELED_ON] [--elapsed ELAPSED]
[--job_explanation TEXT] [--execution_node TEXT]
[--work_unit_id TEXT] [--system_job_template ID]
[--job_type {,cleanup_jobs,cleanup_activitystream,cleanup_sessions,cleanup_tokens}]
[--extra_vars TEXT]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list system_jobs with the specified type
only list system_jobs with the specified created
only list system_jobs with the specified modified
only list system_jobs with the specified name
only list system_jobs with the specified description
only list system_jobs with the specified unified_job_template
only list system_jobs with the specified launch_type
only list system_jobs with the specified status
only list system_jobs with the specified execution_environment
only list system_jobs with the specified failed
only list system_jobs with the specified started
only list system_jobs with the specified finished
only list system_jobs with the specified canceled_on
only list system_jobs with the specified elapsed
only list system_jobs with the specified job_explanation
only list system_jobs with the specified execution_node
only list system_jobs with the specified work_unit_id
only list system_jobs with the specified system_job_template
only list system_jobs with the specified job_type
only list system_jobs with the specified extra_vars
usage: awx teams [-h] action ...
show this help message and exit
usage: awx teams create [-h] --name TEXT [--description TEXT] --organization
ID
show this help message and exit
Name of this team.
Optional description of this team.
the ID of the associated organization
usage: awx teams delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx teams get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx teams grant [-h]
(--organization ID | --project ID | --inventory ID | --team ID | --credential ID | --job_template ID | --workflow_job_template ID | --instance_group ID)
--role
{credential_admin,read,inventory_admin,workflow_admin,notification_admin,adhoc,execution_environment_admin,project_admin,update,approval,use,auditor,member,execute,admin,job_template_admin}
id
The ID (or name) of the teams to grant access to/from
show this help message and exit
The ID (or name) of the target organization
The ID (or name) of the target project
The ID (or name) of the target inventory
The ID (or name) of the target team
The ID (or name) of the target credential
The ID (or name) of the target job_template
The ID (or name) of the target workflow_job_template
The ID (or name) of the target instance_group
The name of the role to grant
usage: awx teams list [-h] [--all] [--order_by ORDER_BY]
[-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v] [--type {team}]
[--created CREATED] [--modified MODIFIED] [--name TEXT]
[--description TEXT] [--organization ID]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list teams with the specified type
only list teams with the specified created
only list teams with the specified modified
only list teams with the specified name
only list teams with the specified description
only list teams with the specified organization
usage: awx teams modify [-h] [--name TEXT] [--description TEXT]
[--organization ID]
id
the ID (or unique name) of the resource
show this help message and exit
Name of this team.
Optional description of this team.
the ID of the associated organization
usage: awx teams revoke [-h]
(--organization ID | --project ID | --inventory ID | --team ID | --credential ID | --job_template ID | --workflow_job_template ID | --instance_group ID)
--role
{credential_admin,read,inventory_admin,workflow_admin,notification_admin,adhoc,execution_environment_admin,project_admin,update,approval,use,auditor,member,execute,admin,job_template_admin}
id
The ID (or name) of the teams to revoke access to/from
show this help message and exit
The ID (or name) of the target organization
The ID (or name) of the target project
The ID (or name) of the target inventory
The ID (or name) of the target team
The ID (or name) of the target credential
The ID (or name) of the target job_template
The ID (or name) of the target workflow_job_template
The ID (or name) of the target instance_group
The name of the role to revoke
usage: awx tokens [-h] action ...
show this help message and exit
usage: awx tokens create [-h] [--description TEXT] [--application ID]
[--scope TEXT]
show this help message and exit
Optional description of this access token.
the ID of the associated application
Allowed scopes, further restricts user’s permissions. Must be a simple space-separated string with allowed scopes [‘read’, ‘write’].
usage: awx tokens delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx tokens get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx tokens list [-h] [--all] [--order_by ORDER_BY]
[-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]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list tokens with the specified type
only list tokens with the specified created
only list tokens with the specified modified
only list tokens with the specified description
only list tokens with the specified user
only list tokens with the specified token
only list tokens with the specified application
only list tokens with the specified expires
only list tokens with the specified scope
usage: awx tokens modify [-h] [--description TEXT] [--application ID]
[--scope TEXT]
id
the ID (or unique name) of the resource
show this help message and exit
Optional description of this access token.
the ID of the associated application
Allowed scopes, further restricts user’s permissions. Must be a simple space-separated string with allowed scopes [‘read’, ‘write’].
usage: awx unified_job_templates [-h] action ...
show this help message and exit
usage: awx unified_job_templates get [-h] [-f {json,yaml,jq,human}]
[--filter TEXT] [--conf.color BOOLEAN]
[-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx unified_job_templates list [-h] [--all] [--order_by ORDER_BY]
[-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}]
[--execution_environment ID]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list unified_job_templates with the specified type
only list unified_job_templates with the specified created
only list unified_job_templates with the specified modified
only list unified_job_templates with the specified name
only list unified_job_templates with the specified description
only list unified_job_templates with the specified last_job_run
only list unified_job_templates with the specified last_job_failed
only list unified_job_templates with the specified next_job_run
only list unified_job_templates with the specified status
only list unified_job_templates with the specified execution_environment
usage: awx unified_jobs [-h] action ...
show this help message and exit
usage: awx unified_jobs get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx unified_jobs list [-h] [--all] [--order_by ORDER_BY]
[-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}]
[--execution_environment ID] [--failed BOOLEAN]
[--started STARTED] [--finished FINISHED]
[--canceled_on CANCELED_ON] [--elapsed ELAPSED]
[--job_explanation TEXT] [--execution_node TEXT]
[--controller_node TEXT] [--work_unit_id TEXT]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list unified_jobs with the specified type
only list unified_jobs with the specified created
only list unified_jobs with the specified modified
only list unified_jobs with the specified name
only list unified_jobs with the specified description
only list unified_jobs with the specified unified_job_template
only list unified_jobs with the specified launch_type
only list unified_jobs with the specified status
only list unified_jobs with the specified execution_environment
only list unified_jobs with the specified failed
only list unified_jobs with the specified started
only list unified_jobs with the specified finished
only list unified_jobs with the specified canceled_on
only list unified_jobs with the specified elapsed
only list unified_jobs with the specified job_explanation
only list unified_jobs with the specified execution_node
only list unified_jobs with the specified controller_node
only list unified_jobs with the specified work_unit_id
usage: awx users [-h] action ...
show this help message and exit
usage: awx users create [-h] --username TEXT [--first_name TEXT]
[--last_name TEXT] [--email TEXT]
[--is_superuser BOOLEAN] [--is_system_auditor BOOLEAN]
--password TEXT
show this help message and exit
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
Designates that this user has all permissions without explicitly assigning them.
Field used to change the password.
usage: awx users delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx users get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx users grant [-h]
(--organization ID | --project ID | --inventory ID | --team ID | --credential ID | --job_template ID | --workflow_job_template ID | --instance_group ID)
--role
{credential_admin,read,inventory_admin,workflow_admin,notification_admin,adhoc,execution_environment_admin,project_admin,update,approval,use,auditor,member,execute,admin,job_template_admin}
id
The ID (or name) of the users to grant access to/from
show this help message and exit
The ID (or name) of the target organization
The ID (or name) of the target project
The ID (or name) of the target inventory
The ID (or name) of the target team
The ID (or name) of the target credential
The ID (or name) of the target job_template
The ID (or name) of the target workflow_job_template
The ID (or name) of the target instance_group
The name of the role to grant
usage: awx users list [-h] [--all] [--order_by ORDER_BY]
[-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]
[--password TEXT] [--last_login LAST_LOGIN]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list users with the specified type
only list users with the specified username
only list users with the specified first_name
only list users with the specified last_name
only list users with the specified email
only list users with the specified is_superuser
only list users with the specified password
only list users with the specified last_login
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
the ID (or unique name) of the resource
show this help message and exit
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
Designates that this user has all permissions without explicitly assigning them.
Field used to change the password.
usage: awx users revoke [-h]
(--organization ID | --project ID | --inventory ID | --team ID | --credential ID | --job_template ID | --workflow_job_template ID | --instance_group ID)
--role
{credential_admin,read,inventory_admin,workflow_admin,notification_admin,adhoc,execution_environment_admin,project_admin,update,approval,use,auditor,member,execute,admin,job_template_admin}
id
The ID (or name) of the users to revoke access to/from
show this help message and exit
The ID (or name) of the target organization
The ID (or name) of the target project
The ID (or name) of the target inventory
The ID (or name) of the target team
The ID (or name) of the target credential
The ID (or name) of the target job_template
The ID (or name) of the target workflow_job_template
The ID (or name) of the target instance_group
The name of the role to revoke
usage: awx workflow_approvals [-h] action ...
show this help message and exit
usage: awx workflow_approvals delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx workflow_approvals get [-h] [-f {json,yaml,jq,human}]
[--filter TEXT] [--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx workflow_approvals list [-h] [--all] [--order_by ORDER_BY]
[-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}]
[--execution_environment ID]
[--failed BOOLEAN] [--started STARTED]
[--finished FINISHED]
[--canceled_on CANCELED_ON]
[--elapsed ELAPSED]
[--job_explanation TEXT]
[--work_unit_id TEXT] [--timed_out BOOLEAN]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list workflow_approvals with the specified type
only list workflow_approvals with the specified created
only list workflow_approvals with the specified modified
only list workflow_approvals with the specified name
only list workflow_approvals with the specified description
only list workflow_approvals with the specified unified_job_template
only list workflow_approvals with the specified launch_type
only list workflow_approvals with the specified status
only list workflow_approvals with the specified execution_environment
only list workflow_approvals with the specified failed
only list workflow_approvals with the specified started
only list workflow_approvals with the specified finished
only list workflow_approvals with the specified canceled_on
only list workflow_approvals with the specified elapsed
only list workflow_approvals with the specified job_explanation
only list workflow_approvals with the specified work_unit_id
only list workflow_approvals with the specified timed_out
usage: awx workflow_job_nodes [-h] action ...
show this help message and exit
usage: awx workflow_job_nodes get [-h] [-f {json,yaml,jq,human}]
[--filter TEXT] [--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx workflow_job_nodes list [-h] [--all] [--order_by ORDER_BY]
[-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]
[--execution_environment ID] [--job ID]
[--workflow_job ID]
[--unified_job_template ID]
[--all_parents_must_converge BOOLEAN]
[--do_not_run BOOLEAN] [--identifier TEXT]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list workflow_job_nodes with the specified type
only list workflow_job_nodes with the specified created
only list workflow_job_nodes with the specified modified
only list workflow_job_nodes with the specified extra_data
only list workflow_job_nodes with the specified inventory
only list workflow_job_nodes with the specified execution_environment
only list workflow_job_nodes with the specified job
only list workflow_job_nodes with the specified workflow_job
only list workflow_job_nodes with the specified unified_job_template
only list workflow_job_nodes with the specified all_parents_must_converge
only list workflow_job_nodes with the specified do_not_run
only list workflow_job_nodes with the specified identifier
usage: awx workflow_job_template_nodes [-h] action ...
show this help message and exit
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}]
[--execution_environment ID]
[--forks INTEGER]
[--job_slice_count INTEGER]
[--timeout INTEGER]
--workflow_job_template ID
[--unified_job_template ID]
[--all_parents_must_converge BOOLEAN]
[--identifier TEXT]
show this help message and exit
a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml
Inventory applied as a prompt, assuming job template prompts for inventory
The container image to be used for execution.
the ID of the associated workflow_job_template
the ID of the associated unified_job_template
If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node
An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.
usage: awx workflow_job_template_nodes delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx workflow_job_template_nodes get [-h] [-f {json,yaml,jq,human}]
[--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx workflow_job_template_nodes list [-h] [--all] [--order_by ORDER_BY]
[-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]
[--execution_environment ID]
[--workflow_job_template ID]
[--unified_job_template ID]
[--all_parents_must_converge BOOLEAN]
[--identifier TEXT]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list workflow_job_template_nodes with the specified type
only list workflow_job_template_nodes with the specified created
only list workflow_job_template_nodes with the specified modified
only list workflow_job_template_nodes with the specified extra_data
only list workflow_job_template_nodes with the specified inventory
only list workflow_job_template_nodes with the specified execution_environment
only list workflow_job_template_nodes with the specified workflow_job_template
only list workflow_job_template_nodes with the specified unified_job_template
only list workflow_job_template_nodes with the specified all_parents_must_converge
only list workflow_job_template_nodes with the specified identifier
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}]
[--execution_environment ID]
[--forks INTEGER]
[--job_slice_count INTEGER]
[--timeout INTEGER]
[--workflow_job_template ID]
[--unified_job_template ID]
[--all_parents_must_converge BOOLEAN]
[--identifier TEXT]
id
the ID (or unique name) of the resource
show this help message and exit
a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml
Inventory applied as a prompt, assuming job template prompts for inventory
The container image to be used for execution.
the ID of the associated workflow_job_template
the ID of the associated unified_job_template
If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node
An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.
usage: awx workflow_job_templates [-h] action ...
show this help message and exit
usage: awx workflow_job_templates associate [-h]
(--start_notification | --success_notification | --failure_notification | --approval_notification )
id
show this help message and exit
The ID (or name) of the notification_template to associate
The ID (or name) of the notification_template to associate
The ID (or name) of the notification_template to associate
The ID (or name) of the notification_template to associate
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]
[--ask_labels_on_launch BOOLEAN]
[--ask_skip_tags_on_launch BOOLEAN]
[--ask_tags_on_launch BOOLEAN]
[--skip_tags TEXT] [--job_tags TEXT]
show this help message and exit
Name of this workflow job template.
Optional description of this workflow job template.
a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml
The organization used to determine access to this template.
Inventory applied as a prompt, assuming job template prompts for inventory
Service that webhook requests will be accepted from
Personal Access Token for posting back the status to the service API
usage: awx workflow_job_templates delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx workflow_job_templates disassociate [-h]
(--start_notification | --success_notification | --failure_notification | --approval_notification )
id
show this help message and exit
The ID (or name) of the notification_template to disassociate
The ID (or name) of the notification_template to disassociate
The ID (or name) of the notification_template to disassociate
The ID (or name) of the notification_template to disassociate
usage: awx workflow_job_templates get [-h] [-f {json,yaml,jq,human}]
[--filter TEXT] [--conf.color BOOLEAN]
[-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx workflow_job_templates launch [-h] [--monitor]
[--action-timeout ACTION_TIMEOUT]
[--wait] [--interval INTERVAL]
[--extra_vars JSON/YAML]
[--inventory ID] [--limit TEXT]
[--scm_branch TEXT] [--labels LABELS]
[--skip_tags TEXT] [--job_tags TEXT]
id
show this help message and exit
If set, prints stdout of the launched job until it finishes.
If set with –monitor or –wait, time out waiting on job completion.
If set, waits until the launched job finishes.
If set with –monitor or –wait, amount of time to wait in seconds between api calls. Minimum value is 2.5 seconds to avoid overwhelming the api
a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml
the ID of the associated inventory
usage: awx workflow_job_templates list [-h] [--all] [--order_by ORDER_BY]
[-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]
[--ask_labels_on_launch BOOLEAN]
[--ask_skip_tags_on_launch BOOLEAN]
[--ask_tags_on_launch BOOLEAN]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list workflow_job_templates with the specified type
only list workflow_job_templates with the specified created
only list workflow_job_templates with the specified modified
only list workflow_job_templates with the specified name
only list workflow_job_templates with the specified description
only list workflow_job_templates with the specified last_job_run
only list workflow_job_templates with the specified last_job_failed
only list workflow_job_templates with the specified next_job_run
only list workflow_job_templates with the specified status
only list workflow_job_templates with the specified extra_vars
only list workflow_job_templates with the specified organization
only list workflow_job_templates with the specified survey_enabled
only list workflow_job_templates with the specified allow_simultaneous
only list workflow_job_templates with the specified ask_variables_on_launch
only list workflow_job_templates with the specified inventory
only list workflow_job_templates with the specified ask_inventory_on_launch
only list workflow_job_templates with the specified ask_scm_branch_on_launch
only list workflow_job_templates with the specified ask_limit_on_launch
only list workflow_job_templates with the specified webhook_service
only list workflow_job_templates with the specified webhook_credential
only list workflow_job_templates with the specified ask_labels_on_launch
only list workflow_job_templates with the specified ask_skip_tags_on_launch
only list workflow_job_templates with the specified ask_tags_on_launch
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]
[--ask_labels_on_launch BOOLEAN]
[--ask_skip_tags_on_launch BOOLEAN]
[--ask_tags_on_launch BOOLEAN]
[--skip_tags TEXT] [--job_tags TEXT]
id
the ID (or unique name) of the resource
show this help message and exit
Name of this workflow job template.
Optional description of this workflow job template.
a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml
The organization used to determine access to this template.
Inventory applied as a prompt, assuming job template prompts for inventory
Service that webhook requests will be accepted from
Personal Access Token for posting back the status to the service API
usage: awx workflow_jobs [-h] action ...
show this help message and exit
usage: awx workflow_jobs delete [-h] id
the ID (or unique name) of the resource
show this help message and exit
usage: awx workflow_jobs get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v]
id
the ID (or unique name) of the resource
show this help message and exit
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
usage: awx workflow_jobs list [-h] [--all] [--order_by ORDER_BY]
[-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] [--work_unit_id 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]
show this help message and exit
fetch all pages of content from the API when returning results (instead of just the first page)
order results by given field name, prefix the field name with a dash (-) to sort in reverse eg –order_by=’-name’,multiple sorting fields may be specified by separating the field names with a comma (,)
specify a format for the input and output
specify an output filter (only valid with jq or human format)
Display colorized output. Defaults to True
print debug-level logs, including requests made
only list workflow_jobs with the specified type
only list workflow_jobs with the specified created
only list workflow_jobs with the specified modified
only list workflow_jobs with the specified name
only list workflow_jobs with the specified description
only list workflow_jobs with the specified unified_job_template
only list workflow_jobs with the specified launch_type
only list workflow_jobs with the specified status
only list workflow_jobs with the specified failed
only list workflow_jobs with the specified started
only list workflow_jobs with the specified finished
only list workflow_jobs with the specified canceled_on
only list workflow_jobs with the specified elapsed
only list workflow_jobs with the specified job_explanation
only list workflow_jobs with the specified work_unit_id
only list workflow_jobs with the specified workflow_job_template
only list workflow_jobs with the specified extra_vars
only list workflow_jobs with the specified allow_simultaneous
only list workflow_jobs with the specified job_template
only list workflow_jobs with the specified is_sliced_job
only list workflow_jobs with the specified inventory
only list workflow_jobs with the specified webhook_service
only list workflow_jobs with the specified webhook_credential
only list workflow_jobs with the specified webhook_guid
usage: awx workflow_jobs monitor [-h] id
show this help message and exit