Device Naming Conventions
Use a consistent <site>-<function>-<number> pattern for all network devices.
A consistent device naming convention is the cheapest reliability improvement in network documentation. The standard pattern is <site>-<role>-<number>: nyc-core-sw-01, lon-dist-sw-a, fw-ha-01.
The convention encodes location, function, and identity in the hostname itself, so a name alone tells you where a device lives and what it does - and the Rack Elevation, device inventory, and change log all stay aligned with no extra effort.
| Example | Pattern | Notes |
|---|---|---|
| core-sw-01 | <site>-<role>-<nn> | 2-digit zero-padded |
| nyc-fw-ha-01 | <site>-<role>-<detail>-<nn> | Include HA or cluster info |
| dc1-dist-sw-a | <site>-<tier>-<role>-<id> | Use letters for stack members |
| lon-srv-web-03 | <site>-<type>-<function>-<nn> | Type prefixes: srv, net, sto |
Read More
Guides that go deeper on the same topic.
How to Document Your Homelab Network from Scratch
Your homelab deserves better than memory and sticky notes. Here's how to build documentation that actually works, even if you're starting with nothing.
Common Mistakes When Documenting Data Centers
Data center documentation fails for predictable reasons. Here are the most common mistakes teams make and how to avoid them.
More Reference
Explore the other reference in the toolkit.
RFC 1918 Private IP Ranges
RFC 1918 defines the private IPv4 ranges 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16. See each range, host count, and common use.
Common TCP & UDP Ports
Reference list of common TCP and UDP ports: SSH, DNS, HTTP, HTTPS, SMTP, NTP, DHCP, SNMP, RDP, and more, with protocols and descriptions.
Fiber Connector Types
Reference guide to fiber optic connector types: LC, SC, ST, FC, MPO/MTP, and E2000 with polish, return loss, and typical use.
Ethernet Standards (IEEE 802.3)
Reference table of IEEE 802.3 Ethernet standards: 1000BASE-T, 10GBASE-T, 10GBASE-SR/LR, 25G, 40G, 100G, and 400G with media and distances.
RFC References for Network Engineers
Quick reference list of the essential networking RFCs every infrastructure engineer should know, from RFC 1918 to BGP, DHCP, DNS, and NTP.
Reserved & Special-Use IP Addresses
Reference table of special-use IPv4 ranges: loopback, link-local (APIPA), CGNAT, TEST-NET documentation ranges, multicast, and broadcast.
TIA-606 Cable Color Codes & Labeling Standard
TIA-606 labeling standard and cable color codes for structured cabling: blue for horizontal cabling, orange for demarcation, purple for common equipment, identifier formats, and admin classes.
Transceiver Form Factors
Reference table of optical transceiver form factors: SFP, SFP+, SFP28, QSFP+, QSFP28, QSFP-DD, CFP2, XFP, and CXP with speeds and distances.
WiFi Standards (IEEE 802.11)
Reference table of WiFi standards and generations: 802.11b through 802.11be (Wi-Fi 1 to Wi-Fi 7) with maximum speeds, frequencies, and release years.
Power Connectors & Receptacles
Reference table of data center power connectors: NEMA 5-15P, L6-30P, IEC C13/C14, C19/C20, IEC 60309, Schuko, and BS 1363 with amp and voltage ratings.
Interface & Port Naming
How to standardize network interface names across vendors: Cisco IOS, Juniper Junos, and NX-OS/AOS-CX conventions with examples.
VLAN & Subnet Naming
Best practices for VLAN naming: descriptive names like SRV-PROD and GUEST-WIFI paired with documented VLAN IDs and subnets.
VLAN ID Ranges & Reserved IDs
Reference table of VLAN ID ranges: the standard range 2-1001, the extended range 1006-4094, reserved IDs (0, 1002-1005, 4095), and the default VLAN 1.