awx.awx.tower_label – create, update, or destroy Ansible Tower labels.

Note

This plugin is part of the awx.awx collection (version 14.1.0).

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
    Choices:
  • present ←
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 TOWER_HOST and then config files
If value not specified by any means, the value of 127.0.0.1 will be used
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_OAUTH_TOKEN and then config files
tower_password
string
Password for your Tower or AWX instance.
If value not set, will try environment variable TOWER_PASSWORD and then config files
tower_username
string
Username for your Tower or AWX instance.
If value not set, will try environment variable TOWER_USERNAME and then config files
validate_certs
boolean
    Choices:
  • no
  • yes
Whether to allow insecure connections to Tower or 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 TOWER_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 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)