Skip to content

Network

The Network Aether is IP address management in Aethers — routing contexts, layer-2 segments, and the layer-3 address space — plus a visual designer that draws over the same data.

The Prefixes view grouped by VRFpublic/screenshots/network-prefixes.png
  • ASNs and Route Targets are the routing identifiers used to define VRFs.
  • VRFs scope everything below them — prefixes and addresses live inside a routing context.
  • VLAN Groups → VLANs model layer 2; a VLAN carries a VID (14094) and can be scoped to a group and site.
  • Prefixes → IP Addresses model layer 3; an address belongs to a prefix and can be assigned to a device or VM interface.

Virtual routing and forwarding contexts — the scope every prefix and address lives within, so overlapping address space can coexist. A VRF references no parent; prefixes and addresses point back at it.

Fields

FieldTypeNotes
namestring · requiredDisplay name.
rdstringRoute Distinguisher — unique across VRFs.
descriptionstringFree-form notes.

APIGET/POST /api/vrfs, GET/PATCH/DELETE /api/vrfs/{id}.

Route-target records used to import and export routes between VRFs. A thin identifier record — name and notes only.

Fields

FieldTypeNotes
namestring · requiredDisplay name (e.g. the RT value 65000:100).
descriptionstringFree-form notes.

APIGET/POST /api/route-targets, GET/PATCH/DELETE /api/route-targets/{id}.

Autonomous system numbers — the routing identifiers that anchor VRFs and external peering, optionally tagged with the issuing registry.

Fields

FieldTypeNotes
namestring · requiredDisplay name.
asninteger · requiredAutonomous system number.
rirstringRegional internet registry (e.g. ARIN, RIPE).
descriptionstringFree-form notes.

APIGET/POST /api/asns, GET/PATCH/DELETE /api/asns/{id}.

A grouping for VLANs, typically by site or domain, that bounds VID uniqueness. VLANs reference a group; the group itself stands alone.

Fields

FieldTypeNotes
namestring · requiredDisplay name.
slugstringURL-friendly key — unique across groups.
descriptionstringFree-form notes.

APIGET/POST /api/vlan-groups, GET/PATCH/DELETE /api/vlan-groups/{id}.

Layer-2 segments. Each carries a 12-bit VID and can be scoped to a group and a site.

Fields

FieldTypeNotes
vidinteger · requiredVLAN ID, 14094.
namestring · requiredDisplay name.
groupIduuid → VLAN GroupOptional grouping.
siteIduuid → SiteOptional site scope.
statusstringDefault active.
descriptionstringFree-form notes.

APIGET/POST /api/vlans, GET/PATCH/DELETE /api/vlans/{id}.

The VLANs list with VID, group, and sitepublic/screenshots/network-vlans.png

IP prefixes (subnets), organised within a VRF — the layer-3 building block that addresses are carved from. Optionally tied to a site and a VLAN.

Fields

FieldTypeNotes
prefixstring · requiredCIDR, e.g. 192.168.1.0/24.
vrfIduuid → VRFOptional routing context.
siteIduuid → SiteOptional site scope.
vlanIduuid → VLANOptional VLAN association.
statusenumactive·container·reserved·deprecated; default active.
isPoolbooleanMarks the prefix as an allocation pool; default false.
descriptionstringFree-form notes.

APIGET/POST /api/prefixes, GET/PATCH/DELETE /api/prefixes/{id}.

NotesisPool flags a prefix whose addresses are handed out from a pool rather than statically assigned.

Individual addresses belonging to a prefix, assignable to a device and to a precise interface. Supports bulk creation and scoping by device or interface.

Fields

FieldTypeNotes
addressstring · requiredAddress with mask, e.g. 192.168.1.1/24.
vrfIduuid → VRFOptional routing context.
deviceIduuid → DeviceDenormalised device rollup; kept in sync from interfaceId.
interfaceIduuid → Device PortThe exact interface this address lives on.
statusenumactive·reserved·deprecated·dhcp; default active.
rolestringFree-text — e.g. loopback, mgmt, peering, vip, secondary.
familyinteger4 or 6 — denormalised for the IP Addresses tab.
dnsNamestringAssociated DNS name.
descriptionstringFree-form notes.

APIGET/POST /api/ip-addresses, GET/PATCH/DELETE /api/ip-addresses/{id}, POST /api/ip-addresses/bulk. The list endpoint also accepts deviceId and interfaceId filters (a UUID, or the literal none for unassigned).

Notes

  • Assigning an IP to an interface homes it to that interface’s device. Set interfaceId and Aethers resolves and stores the parent deviceId automatically; re-assigning the interface re-homes the device. interfaceId is precise, deviceId denormalised for the device-level rollup.
  • POST /bulk accepts an items[] array (max 5000 per request) and returns { data, requested, inserted, skipped }. Rows missing an address are skipped, not rejected. Bulk inserts do not run the interface→device sync.
The IP Addresses view scoped by devicepublic/screenshots/network-ip-addresses.png

The network diagram designer — a visual canvas over the same data, where the diagrams you build are saved and reloaded. Diagrams persist via /api/diagrams (the infrastructure_diagrams table) rather than the IPAM tables above.

The network diagram designer canvas with linked nodespublic/screenshots/network-designer.png
  • Searching a list runs a case-insensitive ILIKE across that resource’s whitelisted columns — names and descriptions everywhere, plus rd (VRFs), slug (VLAN Groups), and address/dnsName/role (IP Addresses).
  • Sort keys are allow-listed per resource; an unknown sort falls back to the resource’s default (e.g. VLANs default to vid, prefixes and IP addresses to their address string).