ansible.builtin.tower_group (v2.6.0) — module

create, update, or destroy Ansible Tower group.

| "added in version" 2.3 of ansible.builtin"

Authors: Wayne Witzel III (@wwitzel3)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.6.0

Description

Create, update, or destroy Ansible Tower groups. See U(https://www.ansible.com/tower) for an overview.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Add tower group
  tower_group:
    name: localhost
    description: "Local Host Group"
    inventory: "Local Inventory"
    state: present
    tower_config_file: "~/tower_cli.cfg"

Inputs

    
name:
    description:
    - The name to use for the group.
    required: true

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Desired state of the resource.

source:
    choices:
    - manual
    - file
    - ec2
    - rax
    - vmware
    - gce
    - azure
    - azure_rm
    - openstack
    - satellite6
    - cloudforms
    - custom
    description:
    - The source to use for this group.

group_by:
    description:
    - Limit groups automatically created from inventory source.

inventory:
    description:
    - Inventory the group should be made a member of.
    required: true

overwrite:
    default: 'no'
    description:
    - Delete child groups and hosts not found in source.
    type: bool

variables:
    description:
    - Variables to use for the group, use C(@) for a file.

credential:
    description:
    - Credential to use for the group.

tower_host:
    description:
    - URL to your Tower or AWX instance.
    type: str

description:
    description:
    - The description to use for the group.

source_vars:
    description:
    - Override variables from source with variables from this field.

source_script:
    description:
    - Inventory script to be used when group type is C(custom).

overwrite_vars:
    description:
    - Override vars in child groups and hosts with those from external source.

source_regions:
    description:
    - Regions for cloud provider.

tower_password:
    description:
    - Password for your Tower or AWX instance.
    type: str

tower_username:
    description:
    - Username for your Tower or AWX instance.
    type: str

validate_certs:
    aliases:
    - tower_verify_ssl
    description:
    - Whether to allow insecure connections to Tower or AWX.
    - If C(no), SSL certificates will not be validated.
    - This should only be used on personally controlled sites using self-signed certificates.
    type: bool

instance_filters:
    description:
    - Comma-separated list of filter expressions for matching hosts.

update_on_launch:
    default: 'no'
    description:
    - Refresh inventory data from its source each time a job is run.
    type: bool

tower_config_file:
    description:
    - Path to the Tower or AWX config file.
    type: path