tower_role - create, update, or destroy Ansible Tower role.
New in version 2.3.
Synopsis
- Create, update, or destroy Ansible Tower roles. See https://www.ansible.com/tower for an overview.
Requirements
The below requirements are needed on the host that executes this module.
- ansible-tower-cli >= 3.0.2
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| credential | Default:
None
|
Credential the role acts on.
|
| inventory | Default:
None
|
Inventory the role acts on.
|
| job_template | Default:
None
|
The job_template the role acts on.
|
| organization | Default:
None
|
Organiation the role acts on.
|
| project | Default:
None
|
Project the role acts on.
|
| role
required
|
|
The role type to grant/revoke.
|
| state |
|
Desired state of the resource.
|
| target_team | Default:
None
|
Team that the role acts on.
|
| team | Default:
None
|
Team that receives the permissions specified by the role.
|
| tower_config_file | Default:
None
|
Path to the Tower config file. See notes.
|
| tower_host | Default:
None
|
URL to your Tower instance.
|
| tower_password | Default:
None
|
Password for your Tower instance.
|
| tower_username | Default:
None
|
Username for your Tower instance.
|
| tower_verify_ssl | Default:
yes
|
Dis/allow insecure connections to Tower. If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
|
| user | Default:
None
|
User that receives the permissions specified by the role.
|
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 jdoe to the member role of My Team
tower_role:
user: jdoe
target_team: "My Team"
role: member
state: present
tower_config_file: "~/tower_cli.cfg"
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Wayne Witzel III (@wwitzel3)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/tower_role_module.html