awx.awx.tower_meta – Returns metadata about the collection this module lives in.
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_meta.
Synopsis
- Allows a user to find out what collection this module exists in.
- This takes common module parameters, but does nothing with them.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| 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
|
|
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
- tower_meta:
register: result
- name: Show details about the collection
debug: var=result
- name: Load the UI setting without hard-coding the collection name
debug:
msg: "{{ lookup(result.prefix + '.tower_api', 'settings/ui') }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| name
string
|
success |
Collection name
Sample:
awx
|
| namespace
string
|
success |
Collection namespace
Sample:
awx
|
| prefix
string
|
success |
Collection namespace and name in the namespace.name format
Sample:
awx.awx
|
| version
string
|
success |
Version of the collection
Sample:
0.0.1-devel
|
Authors
- Alan Rominger (@alancoding)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/awx/awx/tower_meta_module.html