credentials#
usage: awx credentials [-h] action ...
positional arguments:
action
list
create
get
modify
delete
options:
-h, --help show this help message and exit
awx credentials: the following arguments are required: action
credentials list#
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]
options:
-h, --help show this help message and exit
--all fetch all pages of content from the API when returning results (instead of just the first page)
--order_by ORDER_BY order results by given field name, prefix the field name with a dash (-) to sort in reverse eg --order_by='-name',multiple sorting fields may
be specified by separating the field names with a comma (,)
--type {credential} only list credentials with the specified type
--created CREATED only list credentials with the specified created
--modified MODIFIED only list credentials with the specified modified
--name TEXT only list credentials with the specified name
--description TEXT only list credentials with the specified description
--organization ID only list credentials with the specified organization
--credential_type ID only list credentials with the specified credential_type
--managed BOOLEAN only list credentials with the specified managed
--inputs JSON/YAML only list credentials with the specified inputs
input/output formatting:
-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}
specify a format for the input and output
--filter TEXT specify an output filter (only valid with jq or human format)
--conf.color BOOLEAN Display colorized output. Defaults to True
-v, --verbose print debug-level logs, including requests made
credentials create#
usage: awx credentials create [-h] --name TEXT [--description TEXT] [--organization ID] --credential_type ID [--inputs JSON/YAML] [--user ID] [--team ID]
required arguments:
--name TEXT Name of this credential.
--credential_type ID Specify the type of credential you want to create. Refer to the documentation for details on each type.
options:
-h, --help show this help message and exit
--description TEXT Optional description of this credential.
--organization ID Inherit permissions from organization roles. If provided on creation, do not give either user or team.
--inputs JSON/YAML 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
--user ID Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation.
--team ID Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation.
awx credentials create: the following arguments are required: --name, --credential_type
credentials get#
usage: awx credentials get [-h] [-f {json,yaml,jq,human}] [--filter TEXT] [--conf.color BOOLEAN] [-v] id
positional arguments:
id the ID (or unique name) of the resource
options:
-h, --help show this help message and exit
input/output formatting:
-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}
specify a format for the input and output
--filter TEXT specify an output filter (only valid with jq or human format)
--conf.color BOOLEAN Display colorized output. Defaults to True
-v, --verbose print debug-level logs, including requests made
awx credentials get: the following arguments are required: id
credentials modify#
usage: awx credentials modify [-h] id
positional arguments:
id the ID (or unique name) of the resource
options:
-h, --help show this help message and exit
awx credentials modify: the following arguments are required: id
credentials delete#
usage: awx credentials delete [-h] id
positional arguments:
id the ID (or unique name) of the resource
options:
-h, --help show this help message and exit
awx credentials delete: the following arguments are required: id