netcloud.ncae.devices inventory – Uses NCAE as an inventory source for all devices.

Note

This inventory plugin is part of the netcloud.ncae collection (version 1.0.0).

To install it, use: ansible-galaxy collection install netcloud.ncae.

To use it in a playbook, specify: netcloud.ncae.devices.

Synopsis

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

  • All devices are automatically added as Ansible hosts with their ID prefixed by device_prefix.

  • All groups are automatically added to the inventory with their slug prefixed by 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 facts_prefix.

Parameters

Parameter

Comments

device_prefix

string

Prefix to be used in front of device ids.

Default: "ncae_device_"

Configuration:

facts_prefix

string

Prefix to be used in front of device facts.

Default: "ncae_"

Configuration:

group_prefix

string

Prefix to be used in front of group slugs.

Default: "ncae_group_"

Configuration:

ncae_base_url

string / required

Base URL of NCAE instance to query without trailing slash.

Configuration:

ncae_password

string / required

Password for authenticating against NCAE.

Configuration:

ncae_username

string / required

Username for authenticating against NCAE.

Configuration:

nest_groups

boolean

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.

Choices:

  • false

  • true ← (default)

Configuration:

validate_certs

boolean

Whether to verify SSL certificates for API connections.

Choices:

  • false

  • true ← (default)

Configuration:

Examples

# Sample configuration for NCAE devices inventory
    plugin: netcloud.ncae.devices
    ncae_base_url: https://ncae.example.com
    ncae_username: admin
    ncae_password: secret
    validate_certs: true

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.