links.pod

Network Management Information System

=head1 NAME

Links

=head1 DESCRIPTION

You can add, edit and delete entries to the NMIS Links table.

These are keyed by subnet, so the subnet field value must be unique.

Links are typically autogenerated by 'nmis.pl type=links' as a crontab command, run every 24 hrs - see the install docs.

The type=links looks for interfaces with ip addresses and checks via the
subnet mask/ip address if they are adjacent, if they are, it enters them
in links.csv. If you are monitoring switches, these are layer 2 and have no ip
addresses, so it can't work out what's connected (unless it's a layer 3
switch aka a router).

You can manually create links if you wish though. So long as you configure a unique subnet value, the manually created entries
will survive an auto-generated update.

Links is also used by L<Map|map.pod> to draw links between devices on a world map.

=head2 subnet

A string, of the form x.x.x.x

=head2 depend

N/A - not used

=head2 ifIndex1

SNMP ifIndex of the link on endpoint device 1.

=head2 ifIndex2

SNMP ifIndex of the link on endpoint device 2.

=head2 ifSpeed

SNMP ifSpeed of link - taken to be the lower speed if the two terminating interfaces have different rates.

=head2 ifType

SNMP ifType of link 1

=head2 interface1

SNMP ifName of interface 1

=head2 interface2

SNMP ifName of interface 1

=head2 link

SNMP ifDescr of link 1

=head2 mask

subnet mask associated with 'subnet'

=head2 node1

name of device that endpoint 1 of this link terminates on

=head2 node2

name of device that endpoint 2 of this link terminates on

=head2 role

device 1 role from L<Nodes Table|nodes.pod>