awx.awx.controller_meta – Returns metadata about the collection this module lives in.

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.controller_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
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
validate_certs boolean	Choices: no yes	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

- controller_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 + '.controller_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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/awx/awx/controller_meta_module.html

Docs

Docs4dev

Title here