awx.awx.credential_type module – Create, update, or destroy custom Automation Platform Controller credential type.
Note
This module is part of the awx.awx collection (version 24.6.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install awx.awx
.
To use it in a playbook, specify: awx.awx.credential_type
.
Synopsis
Create, update, or destroy Automation Platform Controller credential type. See https://www.ansible.com/tower for an overview.
Aliases: tower_credential_type
Parameters
Parameter |
Comments |
---|---|
Path to the controller config file. If provided, the other locations for config files will not be considered. |
|
URL to your Automation Platform Controller instance. If value not set, will try environment variable If value not specified by any means, the value of |
|
The 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 token module. If value not set, will try environment variable |
|
Password for your controller instance. If value not set, will try environment variable |
|
Username for your controller instance. If value not set, will try environment variable |
|
The description of the credential type to give more detail about it. |
|
Enter injectors using either JSON or YAML syntax. Refer to the Automation Platform Controller documentation for example syntax. |
|
Enter inputs using either JSON or YAML syntax. Refer to the Automation Platform Controller documentation for example syntax. |
|
The type of credential type being added. Note that only cloud and net can be used for creating credential types. Refer to the Ansible for more information. Choices:
|
|
The name of the credential type. |
|
Setting this option will change the existing name (looked up via the name field. |
|
Specify the timeout Ansible should use in requests to the controller host. Defaults to 10s, but this is handled by the shared module_utils code |
|
Desired state of the resource. Choices:
|
|
Whether to allow insecure connections to AWX. If This should only be used on personally controlled sites using self-signed certificates. If value not set, will try environment variable Choices:
|
Notes
Note
If no config_file is provided we will attempt to use the tower-cli library defaults to find your host information.
config_file should be in the following format host=hostname username=username password=password
Examples
- credential_type:
name: Nexus
description: Credentials type for Nexus
kind: cloud
inputs: "{{ lookup('file', 'credential_inputs_nexus.json') }}"
injectors: {'extra_vars': {'nexus_credential': 'test' }}
state: present
validate_certs: false
- credential_type:
name: Nexus
state: absent