community_fabric.ansible.inventory inventory – IP Fabric inventory source
Note
This inventory plugin is part of the community_fabric.ansible collection (version 0.0.4).
To install it, use: ansible-galaxy collection install community_fabric.ansible
.
To use it in a playbook, specify: community_fabric.ansible.inventory
.
Synopsis
Get inventory hosts from IP Fabric
Parameters
Parameter |
Comments |
---|---|
Toggle to enable/disable the caching of the inventory’s source data, requires a cache plugin setup to work. Choices:
Configuration:
|
|
Cache connection data or path, read cache plugin documentation for specifics. Configuration:
|
|
Cache plugin to use for the inventory’s source data. Default: Configuration:
|
|
Prefix to use for cache plugin files/tables Default: Configuration:
|
|
Cache duration in seconds Default: Configuration:
|
|
Add columns you would like to return Default: |
|
Create vars from jinja2 expressions. Default: |
|
Filter to apply to the inventory tables Default: |
|
Add hosts to group based on Jinja2 conditionals. Default: |
|
Add hosts to group based on the values of a variable. Default: |
|
The default value when the host variable’s value is an empty string. This option is mutually exclusive with |
|
The key from input dictionary used to generate groups |
|
parent group for keyed group |
|
A keyed group name will start with this prefix Default: |
|
separator used to build the keyed group name Default: |
|
Set this option to False to omit the This option is mutually exclusive with Choices:
|
|
Use in conjunction with keyed_groups. By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore. This is because the default prefix is “” and the default separator is “_”. Set this option to False to omit the leading underscore (or other separator) if no prefix is given. If the group name is derived from a mapping the separator is still used to concatenate the items. To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead. Choices:
|
|
token that ensures this is a source file for the ‘ipfabric’ plugin. Choices:
|
|
Information used to connect to IP Fabric via API |
|
The version of the IP Fabric REST API. |
|
Url of the IP Fabric API |
|
IP Fabric API token to be able to gather device information. |
|
Allows connection when SSL certificates are not valid. Set to Choices:
|
|
IP Fabric snapshot IF to use by default for database actions. Defaults to Default: |
|
If Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. Choices:
|
|
Merge extra vars into the available variables for composition (highest precedence). Choices:
Configuration:
|
Examples
# inventory.yml file in YAML format
# Example command line: ansible-inventory -v --list -i inventory.yml
plugin: community_fabric.ansible.inventory
provider:
base_url: https://demo1.eu.ipfabric.io/
token: test-token
keyed_groups:
- key: sitename
prefix: ""
separator: ""
groups:
ciscoios: "family == 'ios'"
filter:
siteName: ['like', 'L71']
columns:
- uptime
- vendor