awx.awx.group module – create, update, or destroy Automation Platform Controller group.
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.group
.
Synopsis
Create, update, or destroy Automation Platform Controller groups. See https://www.ansible.com/tower for an overview.
Aliases: tower_group
Parameters
Parameter |
Comments |
---|---|
List of groups names, IDs, or named URLs that should be nested inside in this group. |
|
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 |
|
The description to use for the group. |
|
List of host names, IDs, or named URLs that should be put in this group. |
|
Inventory name, ID, or named URL that the group should be made a member of. |
|
The name to use for the group. |
|
A new name for this group (for renaming) |
|
Provide option (False by default) to preserves existing children in an existing group. Choices:
|
|
Provide option (False by default) to preserves existing hosts in an existing group. 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 |
|
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:
|
|
Variables to use for the group. |
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: Add group
group:
name: localhost
description: "Local Host Group"
inventory: "Local Inventory"
state: present
controller_config_file: "~/tower_cli.cfg"
- name: Add group
group:
name: Cities
description: "Local Host Group"
inventory: Default Inventory
hosts:
- fda
children:
- NewYork
preserve_existing_hosts: True
preserve_existing_children: True