shanemcd.awx.instance_group (20.0.14) — module

Install collection

Install with ansible-galaxy collection install shanemcd.awx:==20.0.14

Add to requirements.yml

  collections:
    - name: shanemcd.awx
      version: 20.0.14

Description

Create, update, or destroy Automation Platform Controller instance groups. See U(https://www.ansible.com/tower) for an overview.

Inputs

    
name:
    description:
    - Name of this instance group.
    required: true
    type: str

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

new_name:
    description:
    - Setting this option will change the existing name (looked up via the name field.
    type: str

instances:
    description:
    - The instances associated with this instance_group
    elements: str
    required: false
    type: list

credential:
    description:
    - Credential to authenticate with Kubernetes or OpenShift.  Must be of type "OpenShift
      or Kubernetes API Bearer Token".
    required: false
    type: str

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

pod_spec_override:
    description:
    - A custom Kubernetes or OpenShift Pod specification.
    required: false
    type: str

is_container_group:
    default: false
    description:
    - Signifies that this InstanceGroup should act as a ContainerGroup. If no credential
      is specified, the underlying Pod's ServiceAccount will be used.
    required: false
    type: bool

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

policy_instance_list:
    description:
    - List of exact-match Instances that will be assigned to this group
    elements: str
    required: false
    type: list

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: shanemcd.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

policy_instance_minimum:
    default: '0'
    description:
    - Static minimum number of Instances that will be automatically assign to this group
      when new instances come online.
    required: false
    type: int

policy_instance_percentage:
    default: '0'
    description:
    - Minimum percentage of all instances that will be automatically assigned to this
      group when new instances come online.
    required: false
    type: int