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 22.2.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.instance_group
.
New in awx.awx 4.0.0
Synopsis
Create, update, or destroy Automation Platform Controller instance groups. See https://www.ansible.com/tower for an overview.
Parameters
Parameter |
Comments |
---|---|
Path to the controller config file. If provided, the other locations for config files will not be considered. |
|
URL to your Automation Platform Controller instance. If value not set, will try environment variable If value not specified by any means, the value of |
|
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 |
|
Password for your controller instance. If value not set, will try environment variable |
|
Username for your controller instance. If value not set, will try environment variable |
|
Credential to authenticate with Kubernetes or OpenShift. Must be of type “OpenShift or Kubernetes API Bearer Token”. |
|
The instances associated with this instance_group |
|
Signifies that this InstanceGroup should act as a ContainerGroup. If no credential is specified, the underlying Pod’s ServiceAccount will be used. Choices:
|
|
Maximum number of concurrent jobs to run on this group. Zero means no limit. |
|
Max forks to execute on this group. Zero means no limit. |
|
Name of this instance group. |
|
Setting this option will change the existing name (looked up via the name field. |
|
A custom Kubernetes or OpenShift Pod specification. |
|
List of exact-match Instances that will be assigned to this group |
|
Static minimum number of Instances that will be automatically assign to this group when new instances come online. |
|
Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. |
|
Desired state of the resource. Choices:
|
|
Whether to allow insecure connections to AWX. If This should only be used on personally controlled sites using self-signed certificates. If value not set, will try environment variable Choices:
|
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