shanemcd.awx.controller (20.0.14) — inventory

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

Reads inventories from the Automation Platform Controller.

Supports reading configuration from both YAML config file and environment variables.

If reading from the YAML file, the file name must end with controller.(yml|yaml) or controller_inventory.(yml|yaml), the path in the command would be /path/to/controller_inventory.(yml|yaml). If some arguments in the config file are missing, this plugin will try to fill in missing arguments by reading from environment variables.

If reading configurations from environment variables, the path in the command must be @controller_inventory.

Inputs

    
host:
    description: The network address of your Automation Platform Controller host.
    env:
    - name: CONTROLLER_HOST
    - deprecated:
        alternatives: CONTROLLER_HOST
        collection_name: awx.awx
        version: 4.0.0
        why: Collection name change
      name: TOWER_HOST

password:
    description: The password for your controller user.
    env:
    - name: CONTROLLER_PASSWORD
    - deprecated:
        alternatives: CONTROLLER_PASSWORD
        collection_name: awx.awx
        version: 4.0.0
        why: Collection name change
      name: TOWER_PASSWORD

username:
    description: The user that you plan to use to access inventories on the controller.
    env:
    - name: CONTROLLER_USERNAME
    - deprecated:
        alternatives: CONTROLLER_USERNAME
        collection_name: awx.awx
        version: 4.0.0
        why: Collection name change
      name: TOWER_USERNAME

verify_ssl:
    aliases:
    - validate_certs
    description:
    - Specify whether Ansible should verify the SSL certificate of the controller host.
    - Defaults to True, but this is handled by the shared module_utils code
    env:
    - name: CONTROLLER_VERIFY_SSL
    - deprecated:
        alternatives: CONTROLLER_VERIFY_SSL
        collection_name: awx.awx
        version: 4.0.0
        why: Collection name change
      name: TOWER_VERIFY_SSL
    type: bool

oauth_token:
    description:
    - The OAuth token to use.
    env:
    - name: CONTROLLER_OAUTH_TOKEN
    - deprecated:
        alternatives: CONTROLLER_OAUTH_TOKEN
        collection_name: awx.awx
        version: 4.0.0
        why: Collection name change
      name: TOWER_OAUTH_TOKEN

inventory_id:
    description:
    - The ID of the inventory that you wish to import.
    - This is allowed to be either the inventory primary key or its named URL slug.
    - Primary key values will be accepted as strings or integers, and URL slugs must be
      strings.
    - Named URL slugs follow the syntax of "inventory_name++organization_name".
    env:
    - name: CONTROLLER_INVENTORY
    required: true
    type: raw

include_metadata:
    default: false
    description: Make extra requests to provide all group vars with metadata about the
      source host.
    type: bool