Documentation

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

New in version 2.3.

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • ansible-tower-cli >= 3.0.2

Parameters

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

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