awx.awx.tower_label – create, update, or destroy Ansible Tower labels.
awx.awx.tower_label – create, update, or destroy Ansible Tower labels.
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_label
.
Synopsis
- Create, update, or destroy Ansible Tower labels. See https://www.ansible.com/tower for an overview.
- Note, labels can only be created via the Tower API, they can not be deleted. Once they are fully disassociated the API will clean them up on its own.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
name string / required |
Name of this label. | |
new_name string |
Setting this option will change the existing name (looked up via the name field). | |
organization string / required |
Organization this label belongs to. | |
state string |
|
Desired state of the resource. |
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
|
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 label to tower organization
tower_label:
name: Custom Label
organization: My Organization
Authors
- Wayne Witzel III (@wwitzel3)
© 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_label_module.html