awx.awx.tower_settings – Modify Ansible Tower settings.
awx.awx.tower_settings – Modify Ansible Tower settings.
Note
This plugin is part of the awx.awx collection (version 17.0.1).
To install it use: ansible-galaxy collection install awx.awx
.
To use it in a playbook, specify: awx.awx.tower_settings
.
Synopsis
- Modify Ansible Tower settings. See https://www.ansible.com/tower for an overview.
Requirements
The below requirements are needed on the host that executes this module.
- pyyaml
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
name string |
Name of setting to modify | |
settings dictionary |
A data structure to be sent into the settings endpoint | |
tower_config_file path |
Path to the Tower or AWX config file. If provided, the other locations for config files will not be considered. | |
tower_host string |
URL to your Tower or AWX instance. If value not set, will try environment variable If value not specified by any means, the value of | |
tower_oauthtoken raw added in 3.7 of awx.awx |
The Tower 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 tower_token module. If value not set, will try environment variable | |
tower_password string |
Password for your Tower or AWX instance. If value not set, will try environment variable | |
tower_username string |
Username for your Tower or AWX instance. If value not set, will try environment variable | |
validate_certs boolean |
|
Whether to allow insecure connections to Tower or AWX. If This should only be used on personally controlled sites using self-signed certificates. If value not set, will try environment variable
|
value string |
Value to be modified for given setting. If given a non-string type, will make best effort to cast it to type API expects. For better control over types, use the |
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: Set the value of AWX_PROOT_BASE_PATH
tower_settings:
name: AWX_PROOT_BASE_PATH
value: "/tmp"
register: testing_settings
- name: Set the value of AWX_PROOT_SHOW_PATHS
tower_settings:
name: "AWX_PROOT_SHOW_PATHS"
value: "'/var/lib/awx/projects/', '/tmp'"
register: testing_settings
- name: Set the LDAP Auth Bind Password
tower_settings:
name: "AUTH_LDAP_BIND_PASSWORD"
value: "Password"
no_log: true
- name: Set all the LDAP Auth Bind Params
tower_settings:
settings:
AUTH_LDAP_BIND_PASSWORD: "password"
AUTH_LDAP_USER_ATTR_MAP:
email: "mail"
first_name: "givenName"
last_name: "surname"
Authors
- Nikhil Jain (@jainnikhil30)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/awx/awx/tower_settings_module.html