awx.awx.instance_group module – create, update, or destroy Automation Platform Controller instance groups.

Note

This module is part of the awx.awx collection (version 23.3.1).

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

New in awx.awx 4.0.0

Synopsis

Aliases: tower_instance_group

Parameters

Parameter

Comments

controller_config_file

aliases: tower_config_file

path

Path to the controller config file.

If provided, the other locations for config files will not be considered.

controller_host

aliases: tower_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

controller_oauthtoken

aliases: tower_oauthtoken

any

added in awx.awx 3.7.0

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

controller_password

aliases: tower_password

string

Password for your controller instance.

If value not set, will try environment variable CONTROLLER_PASSWORD and then config files

controller_username

aliases: tower_username

string

Username for your controller instance.

If value not set, will try environment variable CONTROLLER_USERNAME and then config files

credential

string

Credential name, ID, or named URL to authenticate with Kubernetes or OpenShift. Must be of type “OpenShift or Kubernetes API Bearer Token”.

instances

list / elements=string

The instance names, IDs, or named URLs associated with this instance_group

is_container_group

boolean

Signifies that this InstanceGroup should act as a ContainerGroup. If no credential is specified, the underlying Pod’s ServiceAccount will be used.

Choices:

  • false

  • true

max_concurrent_jobs

integer

Maximum number of concurrent jobs to run on this group. Zero means no limit.

max_forks

integer

Max forks to execute on this group. Zero means no limit.

name

string / required

Name of this instance group.

new_name

string

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

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

policy_instance_percentage

integer

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

request_timeout

float

Specify the timeout Ansible should use in requests to the controller host.

Defaults to 10s, but this is handled by the shared module_utils code

state

string

Desired state of the resource.

Choices:

  • "present" ← (default)

  • "absent"

  • "exists"

validate_certs

aliases: tower_verify_ssl

boolean

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

Choices:

  • false

  • true

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

Authors

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