stackstorm-netbox

NetBox is an Open Source IPAM and DCIM tool maintained by Digital Ocean.

Configuration

Copy the example configuration in netbox.yaml.example to /opt/stackstorm/configs/netbox.yaml and edit as required.

It should look like this:

---
hostname: "netbox.corp.lan"
api_token: "aaabbbccc111222333"
use_https: true
ssl_verify: true

After editing, run sudo st2ctl reload --register-configs to ensure your configuration is loaded.

Actions

DCIM

• dcim_get_devices: Get device(s) via optional parameters
• dcim_get_interfaces: Get interface(s) via optional parameters
• dcim_get_sites: Get site(s) via optional parameters

IPAM

• ipam_get_ip_addresses: Get IP Address(es) via optional parameters
• ipam_get_vlan_groups: Get VLAN Group(s) via optional parameters
• ipam_get_vlans: Get VLAN(s) via optional parameters
• ipam_get_vrfs: Get VRF(s) via optional parameters
• ipam_get_prefixes: Get Prefix(es) via optional parameters
• ipam_get_available_ips: Get available IP Address(es) within a prefix
• ipam_post_available_ips: POST request to create an object assigned to the first available IP address within a given prefix