awx.awx.tower_instance_group – create, update, or destroy Ansible Tower instance groups.

From Get docs
Ansible/docs/2.11/collections/awx/awx/tower instance group module


awx.awx.tower_instance_group – create, update, or destroy Ansible Tower instance groups.

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_instance_group.


New in version 4.0: of awx.awx


Synopsis

Parameters

Parameter Choices/Defaults Comments

credential

string

Credential to authenticate with Kubernetes or OpenShift. Must be of type "Kubernetes/OpenShift API Bearer Token".

instances

list / elements=string

The instances associated with this instance_group

name

string / required

Name of this instance group.

new_name

string / required

Setting this option will change the existing name (looked up via the name field.

pod_spec_override

string

A custom Kubernetes or OpenShift Pod specification.

policy_instance_list

list / elements=string

List of exact-match Instances that will be assigned to this group

policy_instance_minimum

integer

Default:

"0"

Static minimum number of Instances that will be automatically assign to this group when new instances come online.

policy_instance_percentage

integer

Default:

"0"

Minimum percentage of all instances that will be automatically assigned to this group when new instances come online.

state

string

  • present

  • absent

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

  • 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

Authors

  • John Westcott IV (@john-westcott-iv)

© 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_instance_group_module.html