awx.awx.tower_user – create, update, or destroy Ansible Tower users.
Note
This plugin is part of the awx.awx collection (version 17.0.1).
To install it use: ansible-galaxy collection install awx.awx
.
To use it in a playbook, specify: awx.awx.tower_user
.
Synopsis
- Create, update, or destroy Ansible Tower users. See https://www.ansible.com/tower for an overview.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
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. |
tower_config_file path | Path to the Tower or AWX config file. If provided, the other locations for config files will not be considered. | |
tower_host string | URL to your Tower or AWX instance. If value not set, will try environment variable TOWER_HOST and then config filesIf value not specified by any means, the value of 127.0.0.1 will be used | |
tower_oauthtoken raw added in 3.7 of awx.awx | The Tower 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 tower_token module. If value not set, will try environment variable TOWER_OAUTH_TOKEN and then config files | |
tower_password string | Password for your Tower or AWX instance. If value not set, will try environment variable TOWER_PASSWORD and then config files | |
tower_username string | Username for your Tower or AWX instance. If value not set, will try environment variable TOWER_USERNAME and then config files | |
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 Tower or 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 TOWER_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 Tower host information.
- config_file should contain Tower configuration in the following format host=hostname username=username password=password
Examples
- name: Add tower user tower_user: username: jdoe password: foobarbaz email: [email protected] first_name: John last_name: Doe state: present tower_config_file: "~/tower_cli.cfg" - name: Add tower user as a system administrator tower_user: username: jdoe password: foobarbaz email: [email protected] superuser: yes state: present tower_config_file: "~/tower_cli.cfg" - name: Add tower user as a system auditor tower_user: username: jdoe password: foobarbaz email: [email protected] auditor: yes state: present tower_config_file: "~/tower_cli.cfg" - name: Delete tower user tower_user: username: jdoe email: [email protected] state: absent tower_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/2.11/collections/awx/awx/tower_user_module.html