Documentation

tower_role - create, update, or destroy Ansible Tower role.

New in version 2.3.

Synopsis

Requirements (on host that executes module)

  • python >= 2.6
  • ansible-tower-cli >= 3.0.3

Options

parameter required default choices comments
credential
 no
Credential the role acts on.
inventory
 no
Inventory the role acts on.
job_template
 no
The job_template the role acts on.
organization
 no
Organiation the role acts on.
project
 no
Project the role acts on.
role
 yes
  • admin
  • read
  • member
  • execute
  • adhoc
  • update
  • use
  • auditor
The role type to grant/revoke.
state
 no present
  • present
  • absent
Desired state of the resource.
target_team
 no
Team that the role acts on.
team
 no
Team that receives the permissions specified by the role.
tower_config_file
 no
Path to the Tower config file. See notes.
tower_host
 no
URL to your Tower instance.
tower_password
 no
Password for your Tower instance.
tower_username
 no
Username for your Tower instance.
tower_verify_ssl
 no True
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
 no
User that receives the permissions specified by the role.

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"

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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.