awx.awx.organization – create, update, or destroy Automation Platform Controller organizations
Note
This plugin is part of the awx.awx collection (version 19.4.0).
You might already have this collection installed if you are using the ansible
package. It is not included in ansible-core
. To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install awx.awx
.
To use it in a playbook, specify: awx.awx.organization
.
Synopsis
- Create, update, or destroy Automation Platform Controller organizations. See https://www.ansible.com/tower for an overview.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
controller_config_file path | Path to the controller config file. If provided, the other locations for config files will not be considered. aliases: tower_config_file | |
controller_host string | URL to your Automation Platform Controller instance. If value not set, will try environment variable CONTROLLER_HOST and then config filesIf value not specified by any means, the value of 127.0.0.1 will be usedaliases: tower_host | |
controller_oauthtoken raw added in 3.7.0 of awx.awx | The OAuth token to use. This value can be in one of two formats. A string which is the token itself. (i.e. bqV5txm97wqJqtkxlMkhQz0pKhRMMX) A dictionary structure as returned by the token module. If value not set, will try environment variable CONTROLLER_OAUTH_TOKEN and then config filesaliases: tower_oauthtoken | |
controller_password string | Password for your controller instance. If value not set, will try environment variable CONTROLLER_PASSWORD and then config filesaliases: tower_password | |
controller_username string | Username for your controller instance. If value not set, will try environment variable CONTROLLER_USERNAME and then config filesaliases: tower_username | |
custom_virtualenv string | Local absolute file path containing a custom Python virtualenv to use. Only compatible with older versions of AWX/Tower Deprecated, will be removed in the future | |
default_environment string | Default Execution Environment to use for jobs owned by the Organization. | |
description string | The description to use for the organization. | |
galaxy_credentials list / elements=string | list of Ansible Galaxy credentials to associate to the organization | |
instance_groups list / elements=string | list of Instance Groups for this Organization to run on. | |
max_hosts integer | Default: "0" | The max hosts allowed in this organizations |
name string / required | Name to use for the organization. | |
notification_templates_approvals list / elements=string | list of notifications to send on start | |
notification_templates_error list / elements=string | list of notifications to send on error | |
notification_templates_started list / elements=string | list of notifications to send on start | |
notification_templates_success list / elements=string | list of notifications to send on success | |
state string |
| Desired state of the resource. |
validate_certs boolean |
| Whether to allow insecure connections to AWX. If no , SSL certificates will not be validated.This should only be used on personally controlled sites using self-signed certificates. If value not set, will try environment variable CONTROLLER_VERIFY_SSL and then config filesaliases: tower_verify_ssl |
Notes
Note
- If no config_file is provided we will attempt to use the tower-cli library defaults to find your host information.
- config_file should be in the following format host=hostname username=username password=password
Examples
- name: Create organization organization: name: "Foo" description: "Foo bar organization" state: present controller_config_file: "~/tower_cli.cfg" - name: Create organization using 'foo-venv' as default Python virtualenv organization: name: "Foo" description: "Foo bar organization using foo-venv" state: present controller_config_file: "~/tower_cli.cfg" - name: Create organization that pulls content from galaxy.ansible.com organization: name: "Foo" state: present galaxy_credentials: - Ansible Galaxy controller_config_file: "~/tower_cli.cfg"
Authors
- Wayne Witzel III (@wwitzel3)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/awx/awx/organization_module.html