Documentation

tower_group - create, update, or destroy Ansible Tower group.

New in version 2.3.

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • ansible-tower-cli >= 3.0.2

Parameters

Parameter Choices/Defaults Comments
credential Default:
None
Credential to use for the group.
description Default:
None
The description to use for the group.
group_by Default:
None
Limit groups automatically created from inventory source.
instance_filters Default:
None
Comma-separated list of filter expressions for matching hosts.
inventory
required
Inventory the group should be made a member of.
name
required
The name to use for the group.
overwrite Default:
no
Delete child roups and hosts not found in source.
overwrite_vars Default:
None
Override vars in child groups and hosts with those from external source.
source
    Choices:
  • manual
  • file
  • ec2
  • rax
  • vmware
  • gce
  • azure
  • azure_rm
  • openstack
  • satellite6
  • cloudforms
  • custom
Default:
null,
The source to use for this group.
source_regions Default:
None
Regions for cloud provider.
source_script Default:
None
Inventory script to be used when group type is "custom".
source_vars Default:
None
Override variables from source with variables from this field.
state
    Choices:
  • present ←
  • absent
Desired state of the resource.
tower_config_file Default:
None
Path to the Tower config file. See notes.
tower_host Default:
None
URL to your Tower instance.
tower_password Default:
None
Password for your Tower instance.
tower_username Default:
None
Username for your Tower instance.
tower_verify_ssl Default:
yes
Dis/allow insecure connections to Tower. If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
update_on_launch Default:
no
Refresh inventory data from its source each time a job is run.
variables Default:
None
Variables to use for the group, use '@' for a file.

Notes

Note

  • If no config_file is provided we will attempt to use the tower-cli library defaults to find your Tower host information.
  • config_file should contain Tower configuration in the following format host=hostname username=username password=password

Examples

- name: Add tower group
  tower_group:
    name: localhost
    description: "Local Host Group"
    inventory: "Local Inventory"
    state: present
    tower_config_file: "~/tower_cli.cfg"

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Wayne Witzel III (@wwitzel3)

Hint

If you notice any issues in this documentation you can edit this document to improve it.