awx.awx.user – create, update, or destroy Automation Platform Controller users.
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.user.
Synopsis
- Create, update, or destroy Automation Platform Controller users. 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 files
If value not specified by any means, the value of
127.0.0.1 will be used
aliases: 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 files
aliases: tower_oauthtoken |
|
| controller_password
string
|
Password for your controller instance.
If value not set, will try environment variable
CONTROLLER_PASSWORD and then config files
aliases: tower_password |
|
| controller_username
string
|
Username for your controller instance.
If value not set, will try environment variable
CONTROLLER_USERNAME and then config files
aliases: tower_username |
|
| email
string
|
Email address of the user.
|
|
| first_name
string
|
First name of the user.
|
|
| is_superuser
boolean
|
|
Designates that this user has all permissions without explicitly assigning them.
aliases: superuser |
| is_system_auditor
boolean
|
|
User is a system wide auditor.
aliases: auditor |
| last_name
string
|
Last name of the user.
|
|
| password
string
|
Write-only field used to change the password.
|
|
| state
string
|
|
Desired state of the resource.
|
| update_secrets
boolean
|
|
true will always change password if user specifies password, even if API gives $encrypted$ for password.
false will only set the password if other values change too.
|
| username
string / required
|
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
|
|
| 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 files
aliases: 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: Add user
user:
username: jdoe
password: foobarbaz
email: jdoe@example.org
first_name: John
last_name: Doe
state: present
controller_config_file: "~/tower_cli.cfg"
- name: Add user as a system administrator
user:
username: jdoe
password: foobarbaz
email: jdoe@example.org
superuser: yes
state: present
controller_config_file: "~/tower_cli.cfg"
- name: Add user as a system auditor
user:
username: jdoe
password: foobarbaz
email: jdoe@example.org
auditor: yes
state: present
controller_config_file: "~/tower_cli.cfg"
- name: Delete user
user:
username: jdoe
email: jdoe@example.org
state: absent
controller_config_file: "~/tower_cli.cfg"
Authors
- John Westcott IV (@john-westcott-iv)
© 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/user_module.html