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
auvik_networks_list - count, list IP ranges.
- Note
scanStatus for each - any in error state is a discovery problem.
Find flapping interfaces
auvik_interfaces_list for the tenant.
- Filter
adminStatus = up, operStatus = down.
- Resolve owning device via
parentDeviceId.
- Pull
auvik_statistics_interface over a short window to see flap frequency.
Cross-reference an alert to an interface and device
- Alert references
entityId with entityType = interface.
- The interface record has
parentDeviceId.
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
1---2name: auvik-networks3description: Auvik network and interface entities: the network entity model, IP-range scoping, interface-to-device relationships, and adminStatus vs operStatus.4---56# Auvik Networks and Interfaces78A `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.910## Anti-triggers1112- **A Meraki "network"** — in the Meraki Dashboard a network is a site13 container holding devices, not an IP scope. The word collides14 completely; use `meraki-devices`.15- **Scanning a subnet, mapping topology, or chasing an IP conflict** —16 those run from a collector inside the LAN, not from Auvik's polled17 read model; use `domotz-network`.18- **Changing a VLAN or shutting a port** — Auvik reads `adminStatus`19 and never sets it. On Meraki switches that write lives in20 `meraki-devices`.2122## Tools2324| Tool | Use For |25|------|---------|26| `auvik_networks_list` | List networks for a tenant |27| `auvik_networks_get` | Detail for one network |28| `auvik_interfaces_list` | List interfaces for a tenant |2930## Network Entity3132Fields you'll see:3334- `networkName` - usually the subnet in CIDR form35- `networkType` - `private`, `internet`, `unknown`36- `scanStatus` - whether discovery scans for this network are healthy37- `gatewayIp`, `dhcpEnabled`38- `description` - free-form, often blank3940Networks 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.4142## Interface Entity4344Fields you'll see:4546- `interfaceName` - e.g. `GigabitEthernet1/0/24`47- `interfaceType` - `ethernet`, `wireless`, `virtual`, `loopback`, `tunnel`, etc.48- `adminStatus` - `up` or `down` - operator-set49- `operStatus` - `up` or `down` - actual current state50- `linkSpeed` - in bps51- `parentDeviceId` - the device that owns the interface52- `description` - administrator-set port description (when populated)5354### adminStatus vs operStatus5556| adminStatus | operStatus | Meaning |57|-------------|------------|---------|58| up | up | Healthy |59| up | down | Link down - real condition (flap, cable, upstream) |60| down | down | Administratively shut down - usually deliberate |61| up | testing | In test mode - transient |6263A 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.6465## Relationships6667- Interface -> Device via `parentDeviceId` -> `auvik_devices_get`68- Device -> Networks via the device's IP addresses (in `auvik_devices_get_details`)69- Network -> Devices via the address scope - a device with an IP in the network's range belongs to that network7071There is no direct "list devices in this network" call - you list devices, list networks, and join on IP membership client-side.7273## Common Workflows7475### Network footprint of a tenant76771. `auvik_networks_list` - count, list IP ranges.782. Note `scanStatus` for each - any in error state is a discovery problem.7980### Find flapping interfaces81821. `auvik_interfaces_list` for the tenant.832. Filter `adminStatus = up`, `operStatus = down`.843. Resolve owning device via `parentDeviceId`.854. Pull `auvik_statistics_interface` over a short window to see flap frequency.8687### Cross-reference an alert to an interface and device88891. Alert references `entityId` with `entityType = interface`.902. The interface record has `parentDeviceId`.913. `auvik_devices_get` on the parent for the human-readable context.9293## Edge Cases9495- 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.96- Some devices expose hundreds of interfaces (large modular switches) - paginate aggressively.97- `linkSpeed` is 0 for down interfaces on some platforms - guard against divide-by-zero in utilization math.9899## Related Skills100101- [devices](../devices/SKILL.md)102- [alerts](../alerts/SKILL.md)103- [api-patterns](../api-patterns/SKILL.md)