ospf_monitor(1M)														  ospf_monitor(1M)

NAME

       ospf_monitor - monitor OSPF (Open Shortest Path First protocol) gateways

SYNOPSIS

       mon_db_file

DESCRIPTION

       Use  the command to query OSPF routers.	The 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,  config-
       ured OSPF interfaces, and OSPF neighbors.

       mon_db_file  is	the  complete  pathname  of a database composed of records configuring destinations for 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  authen-
       tication  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.

   COMMANDS
       Upon entering interactive mode, presents this prompt:

       From this prompt, you can enter any of the interactive commands.  Interactive commands can be interrupted at any time via a keyboard inter-
       rupt.  Note that the command line length must be less than 200 characters.

   Local Commands
       Display all local commands and their functions.

       Display all remote commands and their functions.

       Display all configured destinations. This command displays
		 dest_index, the IP address, and the hostname of all potential command destinations configured in mon_db_file.

       Display the command history buffer showing the last 30
		 interactive commands.

       Exit the  program.

       Send			     remote_command to the same (previous) destination.

       Send			     remote_command to configured destination dest_index.

       Send all       output to filename.

       Send all       output to stdout.

   Remote Commands
       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  con-
		      densing  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.

       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 sta-
		 tistics 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.

       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.

       Display the next hop list. This list of valid next hops
		 is mostly derived from the SPF calculation.

       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.

       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.

       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.

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

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

       Display Gated version information.

AUTHOR

       Rob Coltun of University of Maryland

       Jeffrey C. Honig of Cornell University

SEE ALSO

       gated(1M), gdc(1M), ripquery(1M), gated.conf(4).

       GateD Documentation

       GateD Configuration Guide

																  ospf_monitor(1M)