Ansible Collection - haught.akips

This collection is in the early stages of supporting AKiPs Network Monitoring Software.

Inventory

To use the inventory plugin provided by this collection you will need to enable the plugin in your .ansible.cfg. (You may need to enable some of the defaults if you use them)

[inventory]
enable_plugins = haught.akips.akips_inventory

You will need to create a inventory file that ends in akips.yaml or akips.yml. For example inventory_akips.yaml.

---
plugin: haught.akips.akips_inventory
host: https://akips.example.com
username: api-ro
password: xxxxxxxx

Options

restrict_groups	Restrict groups to only matching groups
limit_groups	Limit to hosts to those belonging to these groups
ignore_groups	Skip looking at these groups for hosts
exclude_groups	Any host in these groups will be excluded
exclude_hosts	Any host matching will be excluded
exclude_networks	Any host with matching IP will be excluded
group_hostvars	Add host hostvars based on matching group
host_hostvars	Add host hostvars to matching host

You can limit what goes into the inventory using restrict_groups, limit_groups, ignore_groups, exclude_groups, exclude_hosts, and exclude_networks. These all work using regexs. Here is an example using a few of them.

---
plugin: haught.akips.akips_inventory
host: https://akips.example.com
username: api-ro
password: xxxxxxxx
limit_groups: 'Cisco-IOS|Cisco-NXOS'
exclude_groups: '^Old-Campus|^Lab'
exclude_hosts: 'bld1.*'

Host variables can be added using group_hostvars and host_hostvars.

---
plugin: haught.akips.akips_inventory
host: https://akips.example.com
username: api-ro
password: xxxxxxxx
limit_groups: '^Cisco-IOS|^Cisco-NXOS'
exclude_groups: '^Old-Campus|^Lab'
exclude_hosts: 'bld1.*'
group_hostvars:
    IOS:
        ansible_network_os: cisco.ios.ios
        ansible_connection: ansible.netcommon.network_cli
    NX-OS:
        ansible_network_os: cisco.nxos.nxos
        ansible_connection: ansible.netcommon.network_cli
host_hostvars:
    3650:
        foo: bar

See akips_inventory.py for additional details and options on how to exclude groups and hosts and add additional host variables.

Usage

You can test retreiving hosts using ansible-inventory.

ansible-inventory -i inventory_akips.yaml --list

To run a playbook using the inventory you can do something like:

ansible-playbook -i inventory_akips.yaml -l myswitch test_playbook.yaml

Developing

PRs are always welcome.

Sanity tests:

ansible-test sanity --docker --python 3.9 plugins/inventory/akips_inventory.py