awx.awx.instance module – create, update, or destroy Automation Platform Controller instances.
Note
This module is part of the awx.awx collection (version 24.6.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
.
New in awx.awx 4.3.0
Synopsis
Create, update, or destroy Automation Platform Controller instances. See https://www.ansible.com/tower for an overview.
Parameters
Parameter |
Comments |
---|---|
Capacity adjustment (0 <= capacity_adjustment <= 1) |
|
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 |
|
If true, the instance will be enabled and used. Choices:
|
|
Hostname of this instance. |
|
Port that Receptor will listen for incoming connections on. |
|
Managed by policy Choices:
|
|
Indicates the current life cycle stage of this instance. Choices:
|
|
Role that this node plays in the mesh. Choices:
|
|
List of peers to connect outbound to. Only configurable for hop and execution nodes. To remove all current peers, set value to an empty list, []. Each item is an ID or address of a receptor address. If item is address, it must be unique across all receptor addresses. |
|
If enabled, control plane nodes will automatically peer to this node. Choices:
|
|
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 |
|
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
- name: Create an instance
awx.awx.instance:
hostname: my-instance.prod.example.com
capacity_adjustment: 0.4
- name: Deprovision the instance
awx.awx.instance:
hostname: my-instance.prod.example.com
node_state: deprovisioning
- name: Create execution node
awx.awx.instance:
hostname: execution.example.com
node_type: execution
peers:
- 12
- route.to.hop.example.com
- name: Remove peers
awx.awx.instance:
hostname: execution.example.com
peers: