On this page
awx.awx.credential_input_source – create, update, or destroy Automation Platform Controller credential input sources.
Note
This plugin is part of the awx.awx collection (version 19.4.0).
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_input_source
.
New in version 2.3.0: of awx.awx
Synopsis
- Create, update, or destroy Automation Platform Controller credential input sources. See https://www.ansible.com/tower for an overview.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
controller_config_file
path
|
Path to the controller config file.
If provided, the other locations for config files will not be considered.
aliases: tower_config_file |
|
controller_host
string
|
URL to your Automation Platform Controller instance.
If value not set, will try environment variable
CONTROLLER_HOST and then config files
If value not specified by any means, the value of
127.0.0.1 will be used
aliases: tower_host |
|
controller_oauthtoken
raw
added in 3.7.0 of awx.awx
|
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
CONTROLLER_OAUTH_TOKEN and then config files
aliases: tower_oauthtoken |
|
controller_password
string
|
Password for your controller instance.
If value not set, will try environment variable
CONTROLLER_PASSWORD and then config files
aliases: tower_password |
|
controller_username
string
|
Username for your controller instance.
If value not set, will try environment variable
CONTROLLER_USERNAME and then config files
aliases: tower_username |
|
description
string
|
The description to use for the credential input source.
|
|
input_field_name
string / required
|
The input field the credential source will be used for
|
|
metadata
dictionary
|
A JSON or YAML string
|
|
source_credential
string
|
The credential which is the source of the credential lookup
|
|
state
string
|
|
Desired state of the resource.
|
target_credential
string / required
|
The credential which will have its input defined by this source
|
|
validate_certs
boolean
|
|
Whether to allow insecure connections to AWX.
If
no , SSL certificates will not be validated.
This should only be used on personally controlled sites using self-signed certificates.
If value not set, will try environment variable
CONTROLLER_VERIFY_SSL and then config files
aliases: tower_verify_ssl |
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
- name: Use CyberArk Lookup credential as password source
credential_input_source:
input_field_name: password
target_credential: new_cred
source_credential: cyberark_lookup
metadata:
object_query: "Safe=MY_SAFE;Object=awxuser"
object_query_format: "Exact"
state: present
Authors
- Tom Page (@Tompage1994)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/awx/awx/credential_input_source_module.html