OSPF_MONITOR(8)

OSPF_MONITOR(8)

nwrevoke Home Page System Administration Index overchan


NAME
       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 pro-
       vide detailed information on IO  statistics,  error  logs,
       link-state  data  bases,  AS external data bases, the OSPF
       routing table, configured OSPF interfaces, and OSPF neigh-
       bors.

       Mon_db_file  is  the  complete pathname of a database com-
       posed of records configuring destinations for ospf_monitor
       remote commands.  Each destination record is a single-line
       entry which lists the destination IP address, the destina-
       tion  hostname, and an OSPF authentication key (if authen-
       tication is activated by the destination).  Since  authen-
       tication  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, ospf_monitor presents  the
       of  ospf_monitor's interactive commands.  Interactive com-
       mands 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.

       ?R        Display all remote commands and their functions.

       d         Display all configured destinations.  This  com-
                 mand  displays  dest_index , the IP address, and
                 the hostname of all potential ospf_monitor  com-
                 mand 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)  des-
                 tination.

       @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 Desig-
                        nated 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 informa-
                        tion at area borders. For  this  type  of
                        request, the ls_id field should be set to
                        the Router ID of the described AS  bound-
                        ary router.
                 5      Request  the  AS external link advertise-
                        ments. They describe routes  to  destina-
                        tions  external to the Autonomous System.
                        For this type of request, the ls_id field
                        should  be  set  to  the destination net-
                        work'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  sum-
              marized  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 mak-
              ing up the AS. If retrans is non-zero, the retrans-
              mit  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 dis-
              played. 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  net-
              work.

       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 <A HREF="MAILTO:lt;rcoltun@ni.umd.edu">lt;rcoltun@ni.umd.edu</A>
       Jeffrey C Honig <A HREF="MAILTO:lt;jch@gated.cornell.edu">lt;jch@gated.cornell.edu</A>

SEE ALSO
       gated(8) gdc(8) ripquery(8) routed(8) 
       GateD Documentation
       GateD Configuration Guide

COPYRIGHT INFORMATION
       Copyright (c) 1996, 1997 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.

       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  Califor-
       nia.,  all  rights  reserved.;  This package contains code
       that is Copyright (c) 1989, 1990, 1991 The  University  of
       Maryland, College Park, Maryland., all rights reserved.

nwrevoke Home Page System Administration Index overchan