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 |
---|---|
Prefix to be used in front of device ids. Default: Configuration:
|
|
Prefix to be used in front of device facts. Default: Configuration:
|
|
Prefix to be used in front of group slugs. Default: Configuration:
|
|
Base URL of NCAE instance to query without trailing slash. Configuration:
|
|
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:
Configuration:
|
|
Whether to verify SSL certificates for API connections. Choices:
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.