organizations#
usage: awx organizations [-h] action ...
positional arguments:
action
list
create
get
modify
delete
associate
disassociate
options:
-h, --help show this help message and exit
awx organizations: the following arguments are required: action
organizations list#
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]
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 {organization}
only list organizations with the specified type
--created CREATED only list organizations with the specified created
--modified MODIFIED only list organizations with the specified modified
--name TEXT only list organizations with the specified name
--description TEXT only list organizations with the specified description
--max_hosts INTEGER only list organizations with the specified max_hosts
--custom_virtualenv TEXT
only list organizations with the specified custom_virtualenv
--default_environment ID
only list organizations with the specified default_environment
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
organizations create#
usage: awx organizations create [-h] --name TEXT [--description TEXT] [--max_hosts INTEGER] [--default_environment ID]
required arguments:
--name TEXT Name of this organization.
options:
-h, --help show this help message and exit
--description TEXT Optional description of this organization.
--max_hosts INTEGER Maximum number of hosts allowed to be managed by this organization.
--default_environment ID
The default execution environment for jobs run by this organization.
awx organizations create: the following arguments are required: --name
organizations get#
usage: awx organizations 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 organizations get: the following arguments are required: id
organizations modify#
usage: awx organizations modify [-h] id
positional arguments:
id the ID (or unique name) of the resource
options:
-h, --help show this help message and exit
awx organizations modify: the following arguments are required: id
organizations delete#
usage: awx organizations delete [-h] id
positional arguments:
id the ID (or unique name) of the resource
options:
-h, --help show this help message and exit
awx organizations delete: the following arguments are required: id
organizations associate#
usage: awx organizations associate [-h] (--start_notification | --success_notification | --failure_notification | --approval_notification | --galaxy_credential )
id
positional arguments:
id
options:
-h, --help show this help message and exit
--start_notification
The ID (or name) of the notification_template to associate
--success_notification
The ID (or name) of the notification_template to associate
--failure_notification
The ID (or name) of the notification_template to associate
--approval_notification
The ID (or name) of the notification_template to associate
--galaxy_credential The ID (or name) of the credential to associate
awx organizations associate: the following arguments are required: id
organizations disassociate#
usage: awx organizations disassociate [-h]
(--start_notification | --success_notification | --failure_notification | --approval_notification | --galaxy_credential )
id
positional arguments:
id
options:
-h, --help show this help message and exit
--start_notification
The ID (or name) of the notification_template to disassociate
--success_notification
The ID (or name) of the notification_template to disassociate
--failure_notification
The ID (or name) of the notification_template to disassociate
--approval_notification
The ID (or name) of the notification_template to disassociate
--galaxy_credential The ID (or name) of the credential to disassociate
awx organizations disassociate: the following arguments are required: id