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

Install Ansible via pip

Install with pip install ansible==2.5.12

Description

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

Usage examples

Scanned by Steampunk Spotter

• 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.
    required: false

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

group_by:
    default: null
    description:
    - Limit groups automatically created from inventory source.
    required: false

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

overwrite:
    default: false
    description:
    - Delete child roups and hosts not found in source.
    required: false

variables:
    default: null
    description:
    - Variables to use for the group, use '@' for a file.
    required: false

credential:
    default: null
    description:
    - Credential to use for the group.
    required: false

description:
    default: null
    description:
    - The description to use for the group.
    required: false

source_vars:
    default: null
    description:
    - Override variables from source with variables from this field.
    required: false

source_script:
    default: null
    description:
    - Inventory script to be used when group type is "custom".
    required: false

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

source_regions:
    default: null
    description:
    - Regions for cloud provider.
    required: false

validate_certs:
    aliases:
    - tower_verify_ssl
    description:
    - Whether to allow insecure connections to AWX.
    - If C(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 C(CONTROLLER_VERIFY_SSL) and then
      config files
    type: bool

controller_host:
    aliases:
    - tower_host
    description:
    - URL to your Automation Platform Controller instance.
    - If value not set, will try environment variable C(CONTROLLER_HOST) and then config
      files
    - If value not specified by any means, the value of C(127.0.0.1) will be used
    type: str

request_timeout:
    description:
    - 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
    type: float

instance_filters:
    default: null
    description:
    - Comma-separated list of filter expressions for matching hosts.
    required: false

update_on_launch:
    default: false
    description:
    - Refresh inventory data from its source each time a job is run.
    required: false

controller_password:
    aliases:
    - tower_password
    description:
    - Password for your controller instance.
    - If value not set, will try environment variable C(CONTROLLER_PASSWORD) and then
      config files
    type: str

controller_username:
    aliases:
    - tower_username
    description:
    - Username for your controller instance.
    - If value not set, will try environment variable C(CONTROLLER_USERNAME) and then
      config files
    type: str

controller_oauthtoken:
    aliases:
    - tower_oauthtoken
    description:
    - 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 C(CONTROLLER_OAUTH_TOKEN) and then
      config files
    type: raw
    version_added: 3.7.0
    version_added_collection: awx.awx

controller_config_file:
    aliases:
    - tower_config_file
    description:
    - Path to the controller config file.
    - If provided, the other locations for config files will not be considered.
    type: path