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.

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

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

virtualization_get_cluster_groups: Get Cluster Group(s) via optional parameters
virtualization_get_cluster_types: Get Cluster Type(s) via optional parameters
virtualization_get_clusters: Get Cluster(s) via optional parameters
virtualization_get_interfaces: Get Virtual Machine Interface(s) via optional parameters
virtualization_post_interfaces: POST request to create a new Virtual Machine Inteface
virtualization_put_interfaces: PUT request to replace a Virtual Machine Interface
virtualization_patch_interfaces: PATCH request to update a Virtual Machine Interface
virtualization_get_virtual_machines: Get Virtual Machine(s) via optional parameters
virtualization_post_virtual_machines: POST request to create a new Virtual Machine
virtualization_put_virtual_machines: PUT request to replace a Virtual Machine
virtualization_patch_virtual_machines: PATCH request to update a Virtual Machine