1.2.8 Network Device Documentation
Network device documentation should contain accurate, up-to-date records of the network hardware and software. Documentation should include all pertinent information about the network devices.
Many organizations create documents with tables or spreadsheets to capture relevant device information.
Router Device Documentation
The table displays sample network device documentation for two interconnecting routers.
| Device | Model | Description | Location | IOS | License |
|---|---|---|---|---|---|
| Central | ISR 4321 | Central Edge Router | Building A
Rm: 137 |
Cisco IOS XE Software, Version 16.09.04
flash:isr4300- |
ipbasek9
securityk9 |
| Interface | Description | IPv4 Address | IPv6 Address | MAC Address | Routing |
| G0/0/0 | Connects to SVR-1 |
10.0.0.1/30 | 2001:db8:acad:1::1/64 | a03d.6fe1.e180 | OSPF |
| G0/0/1 | Connects to Branch-1 |
10.1.1.1/30 | 2001:db8:acad:A001::1/64 | a03d.6fe1.e181 | OSPFv3 |
| G0/1/0 | Connects to ISP | 209.165.200.226/30 | 2001:feed:1::2/64 | a03d.6fc3.a132 | Default |
| S0/1/1 | Connects to Branch-2 |
10.1.1.2/24 | 2001:db8:acad:2::1/64 | n/a | OSPFv3 |
| Device | Model | Description | Site | IOS | License |
| Branch-1 | ISR 4221 |
Branch-2
Edge Router |
Building B
Rm: 107 |
Cisco IOS XE Software, Version 16.09.04
flash:isr4200-universalk9.16.09.04.SPA.bin |
ipbasek9
securityk9 |
| Interface | Description | IPv4 Address | IPv6 Address | MAC Address | Routing |
| G0/0/0 | Connects to S1 |
Router-on-a-stick | Router-on-a-stick | a03d.6fe1.9d90 | OSPF |
| G0/0/1 | Connects to Central |
10.1.1.2/30 | 2001:db8:acad:A001::2/64 | a03d.6fe1.9d91 | OSPF |
LAN Switch Device Documentation
| Device | Model | Description | Mgt. IP Address | IOS | VTP |
|---|---|---|---|---|---|
| S1 | Cisco CatalystWS- C2960- 24TC-L |
Branch-1
LAN1 |
192.168.77.2/24 | 192.168.77.2/24
Image: C2960- |
Domain: CCNA
Mode: Server |
| Port | Description | Access | VLAN | Trunk | EtherChannel | Native | Enabled |
|---|---|---|---|---|---|---|---|
| Fa0/1 | Port Channel 1 trunk to S2 Fa0/1 |
– | – | Yes | Port-Channel 1 |
99 | Yes |
| Fa0/2 | Port Channel 1 trunk to S2 Fa0/2 |
– | – | Yes | Port-Channel 1 |
99 | Yes |
| Fa0/3 | *** Not in use *** | Yes | 666 | – | – | Shut | |
| Fa0/4 | *** Not in use *** | Yes | 666 | – | – | Shut | |
| Fa0/5 | Access port to user | Yes | 10 | – | – | Yes | |
| … | – | – | – | ||||
| Fa0/24 | Access port to user | Yes | 20 | – | – | Yes | |
| Fa0/24 | *** Not in use *** | Yes | 666 | – | – | Shut | |
| G0/1 | Trunk link to Branch-1 | – | – | Yes | – | 99 | Yes |
| G0/2 | *** Not in use *** | Yes | 666 | – |
End-System Documentation
End-system documentation focuses on the hardware and software used in servers, network management consoles, and user workstations. An incorrectly configured end-system can have a negative impact on the overall performance of a network. For this reason, having access to end-system device documentation can be very useful when troubleshooting.
This table displays a sample of information that could be recorded in an end-system device document.
| Device | OS | Services | MAC Address | IPv4 / IPv6 Addresses | Default Gateway | DNS |
|---|---|---|---|---|---|---|
| SRV1 | MS Server 2016 | SMTP, POP3, File services, DHCP | 5475.d08e.9ad8 | 10.0.0.2/30 | 10.0.0.1 | 10.0.0.1 |
| 2001:db8:acad:1::2/64 | 2001:db8:acad:1::1 | 2001:db8:acad:1::1 | ||||
| SRV2 | MS Server 2016 | HTTP, HTTPS | 5475.d07a.5312 | 209.165.201.10 | 209.165.201.1 | 209.165.201.1 |
| 2001:feed:1::10/64 | 2001:feed:1::1 | 2001:feed:1::1 | ||||
| PC1 | MS Windows 10 | HTTP, HTTPS | 5475.d017.3133 | 192.168.10.10/24 | 192.168.10.1 | 192.168.10.1 |
| 2001:db8:acad:1::251/64 | 2001:db8:acad:1::1 | 2001:db8:acad:1::1 | ||||
| … |