shanemcd.awx.organization (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 organizations. 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: Create organization
  organization:
    name: "Foo"
    description: "Foo bar organization"
    state: present
    controller_config_file: "~/tower_cli.cfg"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create organization using 'foo-venv' as default Python virtualenv
  organization:
    name: "Foo"
    description: "Foo bar organization using foo-venv"
    state: present
    controller_config_file: "~/tower_cli.cfg"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create organization that pulls content from galaxy.ansible.com
  organization:
    name: "Foo"
    state: present
    galaxy_credentials:
      - Ansible Galaxy
    controller_config_file: "~/tower_cli.cfg"

Inputs

    
name:
    description:
    - Name to use for the organization.
    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

max_hosts:
    default: '0'
    description:
    - The max hosts allowed in this organizations
    type: int

description:
    description:
    - The description to use for the organization.
    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

instance_groups:
    description:
    - list of Instance Groups for this Organization to run on.
    elements: str
    type: list

custom_virtualenv:
    description:
    - Local absolute file path containing a custom Python virtualenv to use.
    - Only compatible with older versions of AWX/Tower
    - Deprecated, will be removed in the future
    type: str

galaxy_credentials:
    description:
    - list of Ansible Galaxy credentials to associate to the organization
    elements: str
    type: list

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

default_environment:
    description:
    - Default Execution Environment to use for jobs owned by the Organization.
    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: 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

notification_templates_error:
    description:
    - list of notifications to send on error
    elements: str
    type: list

notification_templates_started:
    description:
    - list of notifications to send on start
    elements: str
    type: list

notification_templates_success:
    description:
    - list of notifications to send on success
    elements: str
    type: list

notification_templates_approvals:
    description:
    - list of notifications to send on start
    elements: str
    type: list