ansible.builtin.tower (v2.9.27) — inventory

Ansible dynamic inventory plugin for Ansible Tower.

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

Authors: Matthew Jones (@matburt), Yunfan Zhang (@YunfanZhang42)

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Reads inventories from Ansible Tower.

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

If reading from the YAML file, the file name must end with tower.(yml|yaml) or tower_inventory.(yml|yaml), the path in the command would be /path/to/tower_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 @tower_inventory.

Inputs

    
host:
    description: The network address of your Ansible Tower host.
    env:
    - name: TOWER_HOST
    required: true
    type: string

plugin:
    choices:
    - tower
    description: the name of this plugin, it should always be set to 'tower' for this
      plugin to recognize it as it's own.
    env:
    - name: ANSIBLE_INVENTORY_ENABLED
    required: true

password:
    description: The password for your Ansible Tower user.
    env:
    - name: TOWER_PASSWORD
    required: true
    type: string

username:
    description: The user that you plan to use to access inventories on Ansible Tower.
    env:
    - name: TOWER_USERNAME
    required: true
    type: string

inventory_id:
    description:
    - The ID of the Ansible Tower 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: TOWER_INVENTORY
    required: true
    type: raw

validate_certs:
    aliases:
    - verify_ssl
    default: true
    description: Specify whether Ansible should verify the SSL certificate of Ansible
      Tower host.
    env:
    - name: TOWER_VERIFY_SSL
    required: false
    type: bool

include_metadata:
    default: false
    description: Make extra requests to provide all group vars with metadata about the
      source Ansible Tower host.
    type: bool
    version_added: '2.8'
    version_added_collection: ansible.builtin