Documentation

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

New in version 2.3.

Synopsis

Requirements (on host that executes module)

  • python >= 2.6
  • ansible-tower-cli >= 3.0.2

Options

parameter required default choices comments
credential
no
Credential to use for the group.
description
no
The description to use for the group.
group_by
no
Limit groups automatically created from inventory source.
instance_filters
no
Comma-separated list of filter expressions for matching hosts.
inventory
yes
Inventory the group should be made a member of.
name
yes
The name to use for the group.
overwrite
no
Delete child roups and hosts not found in source.
overwrite_vars
no
Override vars in child groups and hosts with those from external source.
source
no null,
  • manual
  • file
  • ec2
  • rax
  • vmware
  • gce
  • azure
  • azure_rm
  • openstack
  • satellite6
  • cloudforms
  • custom
The source to use for this group.
source_regions
no
Regions for cloud provider.
source_script
no
Inventory script to be used when group type is "custom".
source_vars
no
Override variables from source with variables from this field.
state
no present
  • present
  • absent
Desired state of the resource.
tower_config_file
no
Path to the Tower config file. See notes.
tower_host
no
URL to your Tower instance.
tower_password
no
Password for your Tower instance.
tower_username
no
Username for your Tower instance.
tower_verify_ssl
no True
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
no
Refresh inventory data from its source each time a job is run.
variables
no
Variables to use for the group, use '@' for a file.

Examples

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

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

Status

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

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.