Documentation

tower_credential - create, update, or destroy Ansible Tower credential.

New in version 2.3.

Synopsis

Requirements (on host that executes module)

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

Options

parameter required default choices comments
authorize
 no
Should use authroize for net type.
authorize_password
 no
Password for net credentials that require authroize.
become_method
 no None
  • None
  • sudo
  • su
  • pbrun
  • pfexec
  • pmrun
Become method to Use for privledge escalation.
become_password
 no
Become password. Use ASK for prompting.
become_username
 no
Become username. Use ASK for prompting.
client
 no
Client or application ID for azure_rm type.
description
 no
The description to use for the credential.
domain
 no
Domain for openstack type.
host
 no
Host for this credential.
kind
 yes
  • ssh
  • net
  • scm
  • aws
  • rax
  • vmware
  • satellite6
  • cloudforms
  • gce
  • azure
  • azure_rm
  • openstack
Type of credential being added.
name
 yes
The name to use for the credential.
organization
 no
Organization that should own the credential.
password
 no
Password for this credential. Use ASK for prompting. secret_key for AWS. api_key for RAX.
project
 no
Project that should for this credential.
secret
 no
Secret token for azure_rm type.
ssh_key_data
 no
Path to SSH private key.
ssh_key_unlock
 no
Unlock password for ssh_key. Use ASK for prompting.
state
 no present
  • present
  • absent
Desired state of the resource.
subscription
 no
Subscription ID for azure_rm type.
team
 no
Team that should own this credential.
tenant
 no
Tenant ID for azure_rm type.
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 should own this credential.
username
 no
Username for this credential. access_key for AWS.
vault_password
 no
Valut password. Use ASK for prompting.

Examples

- name: Add tower credential
  tower_credential:
    name: Team Name
    description: Team Description
    organization: test-org
    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.