ospf_monitor(1Mtcp)

ospf_monitor -- monitor OSPF gateways

Synopsis

ospf_monitor mon_db_file

Description

Use the ospf_monitor command to query OSPF routers. The ospf_monitor command operates in interactive mode. It allows the user to query the various OSPF routers to provide detailed information on IO statistics, error logs, link-state data bases, AS external data bases, the OSPF routing table, configured OSPF interfaces, and OSPF neighbors.

mon_db_file is the complete pathname of a database composed of records configuring destinations for ospf_monitor remote commands. Each destination record is a single-line entry which lists the destination IP address, the destination hostname, and an OSPF authentication key (if authentication is activated by the destination). Since authentication keys may be present in the destination records, it is recommended that general access to this database be restricted. The recommended pathname for mon_db_file is /etc/mon.db.

Refer to RFC 1583 (OSPF Specification, version 2) for details about OSPF database and packet formats.

Commands

Upon entering interactive mode, ospf_monitor presents the prompt

[ # ] dest command params >

at which you can enter any of ospf_monitor's interactive commands. Interactive commands can be interrupted at any time via a keyboard interrupt. Note that the command line length must be less than 200 characters.

Local commands

?: Display all local commands and their functions.
?R: Display all remote commands and their functions.
d: Display all configured destinations. This command displays ``<dest index>'', the IP address, and the hostname of all potential ospf_monitor command destinations configured in mon_db_file.
h: Display the command history buffer showing the last 30 interactive commands.
x: Exit the ospf_monitor program.
@ remote_command: Send remote_command to the same (previous) destination.
@ dest_index remote_command: Send remote_command to configured destination dest_index.
F filename: Send all ospf_monitor output to filename.
S: Send all ospf_monitor output to stdout.

Remote commands

a area_id type ls_id adv_rtr

Display link state advertisement. area_id is the OSPF area for which the query is directed. adv_rtr is currently unused. type specifies the type of advertisement to request and should be specified as follows:

1: Request the router links advertisements. They describe the collected states of the router's interfaces. For this type of request, the ls_id field should be set to the originating router's Router ID.
2: Request the network links advertisements. They describe the set of routers attached to the network. For this type of request, the ls_id field should be set to the IP interface address of the network's Designated Router.
3: Request the summary link advertisements describing routes to networks. They describe inter-area routes and enable the condensation of routing information at area borders. For this type of request, the ls_id field should be set to the destination network's IP address.
4: Request the summary link advertisements describing routes to AS boundary routers. They describe inter- area routes and enable the condensation of routing information at area borders. For this type of request, the ls_id field should be set to the Router ID of the described AS boundary router.
5: Request the AS external link advertisements. They describe routes to destinations external to the Autonomous System. For this type of request, the ls_id field should be set to the destination network's IP address.

c

Display cumulative log. This log includes input/output statistics for monitor request, hello, data base description, link-state request, link-state update, and link-state ack packets. Area statistics are provided which describe the total number of routing neighbors and number of active OSPF interfaces. Routing table statistics are summarized and reported as the number of intra-area routes, inter-area routes, and AS external data base entries.

e

Display cumulative errors. This log reports the various error conditions which can occur between OSPF routing neighbors and shows the number of occurrences for each.

h

Display a list of valid next hops derived from the SPF calculation.

l [retrans]

Display the link-state database (except for ASEs). This table describes the routers and networks making up the AS. If retrans is non-zero, the retransmit list of neighbors held by this lsdb structure will be printed.

A retrans

Display the AS external data base entries. This table reports the advertising router, forwarding address, age, length, sequence number, type, and metric for each AS external route. If retrans is non-zero, the retransmit list of neighbors held by this lsdb structure will be printed.

o

Display the OSPF routing table. This table reports the AS border routes, area border routes, summary AS border routes, and networks currently managed via OSPF.

I

Display all interfaces. This report shows all interfaces configured for OSPF. Information reported includes the area, interface IP address, interface type, interface state, cost, priority, and the IP address of the DR and BDR for the network.

N

Display all OSPF routing neighbors. Information reported includes the area, local interface address, router ID, neighbor IP address, state, and mode.

V

Display gated version information.

Files

/etc/mon.db: the monitor database file

References

gated(1Mtcp), gated.conf(4tcp), gdc(1Mtcp)

RFC 1583