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

Note

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

To install it use: ansible-galaxy collection install awx.awx.

To use it in a playbook, specify: awx.awx.instance_group.

New in version 4.0.0: of awx.awx

Synopsis

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
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
is_container_group
boolean
    Choices:
  • no ←
  • yes
Signifies that this InstanceGroup should act as a ContainerGroup. If no credential is specified, the underlying Pod's ServiceAccount will be used.
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
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
    Choices:
  • present ←
  • absent
Desired state of the resource.
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


Authors

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