Ref: 11640122
Title: Documenting Your Wide Area Network
Date: 4/26/90

Copyright 3Com Corporation, 1991.  All rights reserved.

Carefully documenting the components of your wide area network will save
you time and trouble when problems occur.  Use the following list
to help you organize your network documentation.

Note:  See the Network Management Guide for templates you can copy for
an address list, network request forms, etc.

1.  Create a Network Map showing network topology with:

    a.  All devices shown
    b.  Ethernet or IP addresses for all devices
    c.  Manufacturer, model, and type of each device
    d.  User name(s) associated with end-systems
    e.  Manager name(s) if network large enough to be managed by
        several people

Note:  You may choose codes to represent devices on the Network Map, but
make sure you have a key showing what the codes stand for.

On 3Com Communication Servers, the prompt can be configured to consist of
the assigned code for each Communication Server and the port number; this
allows users to read the prompt to the network manager and this will be
sufficient to identify port number and box by name.  It is a good idea to
assign names that indicate the department and/or location of the device.

2.  Create and fill out a device management form for each device, providing:

    a.  Manufacturer (and vendor, if different)
    b.  Server name
    c.  Model number and serial number
    d.  Warranty and service information
    e.  Ethernet and IP addresses
    f.  Location of both the tap and the device
    g.  Hardware, software, and firmware revision(s) for all boards
    h.  Hardware configuration
    i.  Date of installation
    j.  Clearinghouse or Internet names and ports
    k.  Rotaries
    l.  Port configurations (software)
    m.  Attached device(s) and/or host information as applicable
    n.  Cabling information (including custom cable pinouts, length,
        shielding method, connector sex, and types)
    o.  Additional information as applicable.  For example, for an NCS
        one might find the following useful:

        *  List of named configurations and what they are
        *  List of backup servers
        *  Global parameters
        *  Macros in use--keep a copy of each macro
        *  All access control info:  who, when, what, where, etc.


3.  Keep a list of all applications in use on each end station.

4.  Keep a list of hosts and applications used by each user.

5.  Keep a file of all problem reports, cross-filed by user and by affected
device (NOT device type or device model).  This allows the tracking of
problem frequency and user sensitivity.

6.  Label your cables at both ends, using the codes in the Map.

