Auvik Networks
Auvik network and interface entities: the network entity model, IP-range scoping, interface-to-device relationships, and adminStatus vs operStatus.
Install
npx skills add https://github.com/WYRE-AI/msp-claude-plugins/tree/main/msp-claude-plugins/auvik/auvik/skills/networks
claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install wyre-ai-msp-claude-plugins@llmmart
git clone https://github.com/WYRE-AI/msp-claude-plugins.git
The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole wyre-ai/msp-claude-plugins collection as a plugin from our marketplace. Git is the plain clone.
Skill manifest
Auvik Networks and Interfaces
A network in Auvik is an IP scope - typically a subnet that Auvik has discovered devices on. An interface is a port on a device. Both are distinct entity types with their own list endpoints. This skill clarifies the data model and the relationships.
Anti-triggers
- A Meraki "network" — in the Meraki Dashboard a network is a site
container holding devices, not an IP scope. The word collides
completely; use
meraki-devices. - Scanning a subnet, mapping topology, or chasing an IP conflict —
those run from a collector inside the LAN, not from Auvik's polled
read model; use
domotz-network. - Changing a VLAN or shutting a port — Auvik reads
adminStatusand never sets it. On Meraki switches that write lives inmeraki-devices.
Tools
| Tool | Use For |
|---|---|
auvik_networks_list |
List networks for a tenant |
auvik_networks_get |
Detail for one network |
auvik_interfaces_list |
List interfaces for a tenant |
Network Entity
Fields you'll see:
networkName- usually the subnet in CIDR formnetworkType-private,internet,unknownscanStatus- whether discovery scans for this network are healthygatewayIp,dhcpEnableddescription- free-form, often blank
Networks are not VLANs in the Auvik model - VLAN information lives on interface records and switch configurations. A single VLAN typically maps to a single network, but the network entity is keyed on subnet, not VLAN ID.
Interface Entity
Fields you'll see:
interfaceName- e.g.GigabitEthernet1/0/24interfaceType-ethernet,wireless,virtual,loopback,tunnel, etc.adminStatus-upordown- operator-setoperStatus-upordown- actual current statelinkSpeed- in bpsparentDeviceId- the device that owns the interfacedescription- administrator-set port description (when populated)
adminStatus vs operStatus
| adminStatus | operStatus | Meaning |
|---|---|---|
| up | up | Healthy |
| up | down | Link down - real condition (flap, cable, upstream) |
| down | down | Administratively shut down - usually deliberate |
| up | testing | In test mode - transient |
A flapping interface will move between up and down on operStatus while adminStatus stays up. Capacity and statistics tools only return useful data for up/up interfaces.
Relationships
- Interface -> Device via
parentDeviceId->auvik_devices_get - Device -> Networks via the device's IP addresses (in
auvik_devices_get_details) - Network -> Devices via the address scope - a device with an IP in the network's range belongs to that network
There is no direct "list devices in this network" call - you list devices, list networks, and join on IP membership client-side.
Common Workflows
Network footprint of a tenant
auvik_networks_list- count, list IP ranges.- Note
scanStatusfor each - any in error state is a discovery problem.
Find flapping interfaces
auvik_interfaces_listfor the tenant.- Filter
adminStatus = up,operStatus = down. - Resolve owning device via
parentDeviceId. - Pull
auvik_statistics_interfaceover a short window to see flap frequency.
Cross-reference an alert to an interface and device
- Alert references
entityIdwithentityType = interface. - The interface record has
parentDeviceId. auvik_devices_geton the parent for the human-readable context.
Edge Cases
- Virtual interfaces (SVIs, port-channels, tunnels) appear in
auvik_interfaces_listalongside physical ones. TheirinterfaceTypedistinguishes them. For capacity reporting, excludeinterfaceType in {loopback, tunnel, virtual}unless the question is specifically about them. - Some devices expose hundreds of interfaces (large modular switches) - paginate aggressively.
linkSpeedis 0 for down interfaces on some platforms - guard against divide-by-zero in utilization math.
Related Skills
Files (msp-claude-plugins)
-
SKILL.md 4.5 KB
--- name: "Auvik Networks" description: > Auvik network and interface entities: the network entity model, IP-range scoping, interface-to-device relationships, and adminStatus vs operStatus. when_to_use: >- When listing or inspecting Auvik networks and interfaces, or correlating interfaces back to their devices. Use when: auvik network, auvik interface, auvik vlan, auvik subnet, auvik link, or auvik topology. --- # Auvik Networks and Interfaces A `network` in Auvik is an IP scope - typically a subnet that Auvik has discovered devices on. An `interface` is a port on a device. Both are distinct entity types with their own list endpoints. This skill clarifies the data model and the relationships. ## Anti-triggers - **A Meraki "network"** — in the Meraki Dashboard a network is a site container holding devices, not an IP scope. The word collides completely; use `meraki-devices`. - **Scanning a subnet, mapping topology, or chasing an IP conflict** — those run from a collector inside the LAN, not from Auvik's polled read model; use `domotz-network`. - **Changing a VLAN or shutting a port** — Auvik reads `adminStatus` and never sets it. On Meraki switches that write lives in `meraki-devices`. ## Tools | Tool | Use For | |------|---------| | `auvik_networks_list` | List networks for a tenant | | `auvik_networks_get` | Detail for one network | | `auvik_interfaces_list` | List interfaces for a tenant | ## Network Entity Fields you'll see: - `networkName` - usually the subnet in CIDR form - `networkType` - `private`, `internet`, `unknown` - `scanStatus` - whether discovery scans for this network are healthy - `gatewayIp`, `dhcpEnabled` - `description` - free-form, often blank Networks are not VLANs in the Auvik model - VLAN information lives on interface records and switch configurations. A single VLAN typically maps to a single network, but the network entity is keyed on subnet, not VLAN ID. ## Interface Entity Fields you'll see: - `interfaceName` - e.g. `GigabitEthernet1/0/24` - `interfaceType` - `ethernet`, `wireless`, `virtual`, `loopback`, `tunnel`, etc. - `adminStatus` - `up` or `down` - operator-set - `operStatus` - `up` or `down` - actual current state - `linkSpeed` - in bps - `parentDeviceId` - the device that owns the interface - `description` - administrator-set port description (when populated) ### adminStatus vs operStatus | adminStatus | operStatus | Meaning | |-------------|------------|---------| | up | up | Healthy | | up | down | Link down - real condition (flap, cable, upstream) | | down | down | Administratively shut down - usually deliberate | | up | testing | In test mode - transient | A flapping interface will move between `up` and `down` on `operStatus` while `adminStatus` stays `up`. Capacity and statistics tools only return useful data for `up/up` interfaces. ## Relationships - Interface -> Device via `parentDeviceId` -> `auvik_devices_get` - Device -> Networks via the device's IP addresses (in `auvik_devices_get_details`) - Network -> Devices via the address scope - a device with an IP in the network's range belongs to that network There is no direct "list devices in this network" call - you list devices, list networks, and join on IP membership client-side. ## Common Workflows ### Network footprint of a tenant 1. `auvik_networks_list` - count, list IP ranges. 2. Note `scanStatus` for each - any in error state is a discovery problem. ### Find flapping interfaces 1. `auvik_interfaces_list` for the tenant. 2. Filter `adminStatus = up`, `operStatus = down`. 3. Resolve owning device via `parentDeviceId`. 4. Pull `auvik_statistics_interface` over a short window to see flap frequency. ### Cross-reference an alert to an interface and device 1. Alert references `entityId` with `entityType = interface`. 2. The interface record has `parentDeviceId`. 3. `auvik_devices_get` on the parent for the human-readable context. ## Edge Cases - Virtual interfaces (SVIs, port-channels, tunnels) appear in `auvik_interfaces_list` alongside physical ones. Their `interfaceType` distinguishes them. For capacity reporting, exclude `interfaceType in {loopback, tunnel, virtual}` unless the question is specifically about them. - Some devices expose hundreds of interfaces (large modular switches) - paginate aggressively. - `linkSpeed` is 0 for down interfaces on some platforms - guard against divide-by-zero in utilization math. ## Related Skills - [devices](../devices/SKILL.md) - [alerts](../alerts/SKILL.md) - [api-patterns](../api-patterns/SKILL.md)
Comments (0)
Sign in to join the conversation.
Reviews (0)
No reviews yet.
No comments yet.