netcloud.ncae.devices (1.0.1) — inventory

Install collection

Install with ansible-galaxy collection install netcloud.ncae:==1.0.1

Add to requirements.yml

  collections:
    - name: netcloud.ncae
      version: 1.0.1

Description

This inventory plugin gathers all devices and associated groups from NCAE.

All devices are automatically added as Ansible hosts with their ID prefixed by I(device_prefix).

All groups are automatically added to the inventory with their slug prefixed by I(group_prefix).

Devices are automatically linked to their associated groups.

The IP address of the device is automatically used for 'ansible_host'.

Additional device facts are prefixed by I(facts_prefix).

Inputs

    
nest_groups:
    default: true
    description:
    - Specifies whether a group should contain hosts associated with child groups.
    - When enabled, the behavior matches with regular YAML/INI inventories containing
      nested groups.
    - When disabled, hosts are only added to groups they directly belong to.
    env:
    - name: NCAE_INVENTORY_NEST_GROUPS
    type: bool

facts_prefix:
    default: ncae_
    description: Prefix to be used in front of device facts.
    env:
    - name: NCAE_INVENTORY_FACTS_PREFIX
    type: string

group_prefix:
    default: ncae_group_
    description: Prefix to be used in front of group slugs.
    env:
    - name: NCAE_INVENTORY_GROUP_PREFIX
    type: string

device_prefix:
    default: ncae_device_
    description: Prefix to be used in front of device ids.
    env:
    - name: NCAE_INVENTORY_DEVICE_PREFIX
    type: string

ncae_base_url:
    description: Base URL of NCAE instance to query without trailing slash.
    env:
    - name: NCAE_BASE_URL
    - name: NCAE_URL
    required: true
    type: string

ncae_password:
    description: Password for authenticating against NCAE.
    env:
    - name: NCAE_PASSWORD
    required: true
    type: string

ncae_username:
    description: Username for authenticating against NCAE.
    env:
    - name: NCAE_USERNAME
    required: true
    type: string

validate_certs:
    default: true
    description: Whether to verify SSL certificates for API connections.
    env:
    - name: NCAE_VALIDATE_CERTS
    type: bool