awx.awx.group – create, update, or destroy Automation Platform Controller group.
Note
This plugin is part of the awx.awx collection (version 19.4.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.group
.
Synopsis
- Create, update, or destroy Automation Platform Controller groups. See https://www.ansible.com/tower for an overview.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
children list / elements=string | List of groups that should be nested inside in this group. aliases: groups | |
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 filesIf value not specified by any means, the value of 127.0.0.1 will be usedaliases: 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 filesaliases: tower_oauthtoken | |
controller_password string | Password for your controller instance. If value not set, will try environment variable CONTROLLER_PASSWORD and then config filesaliases: tower_password | |
controller_username string | Username for your controller instance. If value not set, will try environment variable CONTROLLER_USERNAME and then config filesaliases: tower_username | |
description string | The description to use for the group. | |
hosts list / elements=string | List of hosts that should be put in this group. | |
inventory string / required | Inventory the group should be made a member of. | |
name string / required | The name to use for the group. | |
new_name string | A new name for this group (for renaming) | |
preserve_existing_children boolean |
| Provide option (False by default) to preserves existing children in an existing group. aliases: preserve_existing_groups |
preserve_existing_hosts boolean |
| Provide option (False by default) to preserves existing hosts in an existing group. |
state string |
| Desired state of the resource. |
validate_certs 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 filesaliases: tower_verify_ssl |
variables dictionary | 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
Authors
- Wayne Witzel III (@wwitzel3)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/awx/awx/group_module.html