7.4 OSPF Monitor
NAME
ospf_monitor - monitor OSPF gateways
SYNOPSIS
ospf_monitor mon_db_file
7.4.1 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_fileis 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.
Refer to RFC-1583 (OSPF Specification, version 2) for details about OSPF database and packet
formats.
7.4.2 Commands
Upon entering interactive mode, ospf_monitor presents the '[ # ] dest command
params >' prompt, 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 the router-id of the router which originated this link state
advertisement. 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 condensing 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 condensing 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 Displays the next hop list. This is a list of valid next hops mostly derived from the
SPF calculation.
- l [ retrans ]
- Display the link-state database (except for ASE's). 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 [ which ]
- Display the OSPF routing table. This table reports the AS border routes, area border
routes, summary AS border routes, networks, summary networks and AS external
networks currently managed via OSPF. If which is omitted, all of the above will be
listed. If specified, the value of which (between 1 and 63) specifies that only certain
tables should be displayed. The appropriate value is determined by adding up the values
for the desired tables from the following list:
- 1 Routes to AS border routers in this area.
- 2 Routes to area border routers for this area.
- 4 Summary routes to AS border routers in other areas.
- 8 Routes to networks in this area.
- 16 Summary routes to networks in other areas.
- 32 AS routes to non-OSPF networks.
- 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.
AUTHORS
Rob Coltun <rcoltun@ni.umd.edu>
Jeffrey C Honig <jch@gated.cornell.edu>
SEE ALSO
gated (8)
, gdc (8), ripquery (8), routed (8),
GateD Documentation
GateD Configuration Guide
COPYRIGHT INFORMATION
This package and associated documentation is Copyright (c) 1990,1991,1992,1993,1994,1995
Cornell University., all rights reserved. This software contains code that is Copyright (c) 1988
Regents of the University of California., all rights reserved.;
This package contains code that is Copyright (c) 1989, 1990, 1991 The University of Maryland,
College Park, Maryland., all rights reserved.
<!--
------------------------------------------------------------------------ GateD, Release 4.0 Copyright (c)
1996 The Regents of the University of Michigan All Rights Reserved License to use, copy,
modify, and distribute this software and its documentation can be obtained from Merit at the
University of Michigan. Merit GateDaemon Project 4251 Plymouth Road, Suite C
Ann Arbor, MI 48105 THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE REGENTS OF THE UNIVERSITY OF MICHIGAN AND MERIT DO NOT
WARRANT THAT THE FUNCTIONS CONTAINED IN THE SOFTWARE WILL MEET
LICENSEE'S REQUIREMENTS OR THAT OPERATION WILL BE UNINTERRUPTED OR
ERROR FREE. The Regents of the University of Michigan and Merit shall not be liable for any
special, indirect, incidental or consequential damages with respect to any claim by Licensee or any
third party arising from use of the software. GateDaemon was originated and developed through
release 3.0 by Cornell University and its collaborators. Please forward bug fixes, enhancements
and questions to the gated mailing list: gated-people@gated.merit.edu.
------------------------------------------------------------------------ Portions of this software may
fall under the following copyrights: Copyright (c) 1988 Regents of the University of California.
All rights reserved. Redistribution and use in source and binary forms are permitted provided that
the above copyright notice and this paragraph are duplicated in all such forms and that any
documentation, advertising materials, and other materials related to such distribution and use
acknowledge that the software was developed by the University of California, Berkeley. The
name of the University may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED ``AS IS''
AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE. >
Last updated April 27, 1997
gated@gated.merit.edu