Connected: An Internet Encyclopedia
RFC 1850 - 3.7. OSPF Interface Table

Top: Connected: An Internet Encyclopedia
Up: Requests For Comments
Up: RFC 1850
Up: 3. Definitions
Prev: 3.6. OSPF Host Table
Next: 3.8. OSPF Interface Metrics

### 3.7. OSPF Interface Table

    --  OSPF Interface Table

    --      The OSPF Interface Table augments the ipAddrTable
    --             with OSPF specific information.

        ospfIfTable OBJECT-TYPE
            SYNTAX   SEQUENCE OF OspfIfEntry
            MAX-ACCESS   not-accessible
            STATUS   current
            DESCRIPTION
               "The OSPF Interface Table describes the  inter-
               faces from the viewpoint of OSPF."
           REFERENCE
              "OSPF Version 2, Appendix C.3  Router  interface
              parameters"
          ::= { ospf 7 }

        ospfIfEntry OBJECT-TYPE
            SYNTAX   OspfIfEntry
            MAX-ACCESS   not-accessible
            STATUS   current
            DESCRIPTION
               "The OSPF Interface Entry describes one  inter-
               face from the viewpoint of OSPF."
           INDEX { ospfIfIpAddress, ospfAddressLessIf }
           ::= { ospfIfTable 1 }

    OspfIfEntry ::=
        SEQUENCE {
            ospfIfIpAddress
                IpAddress,
            ospfAddressLessIf
                Integer32,
            ospfIfAreaId
                AreaID,
            ospfIfType
                INTEGER,
            ospfIfAdminStat
                Status,
            ospfIfRtrPriority
                DesignatedRouterPriority,
            ospfIfTransitDelay
                UpToMaxAge,
            ospfIfRetransInterval
                UpToMaxAge,
            ospfIfHelloInterval
                HelloRange,
            ospfIfRtrDeadInterval
                PositiveInteger,
            ospfIfPollInterval
                PositiveInteger,
            ospfIfState
                INTEGER,
            ospfIfDesignatedRouter
                IpAddress,
            ospfIfBackupDesignatedRouter
                IpAddress,
            ospfIfEvents
                Counter32,
            ospfIfAuthType
                INTEGER,
            ospfIfAuthKey
                OCTET STRING,
            ospfIfStatus
                RowStatus,
            ospfIfMulticastForwarding
                INTEGER,
            ospfIfDemand
                TruthValue
                  }

        ospfIfIpAddress OBJECT-TYPE
            SYNTAX   IpAddress
            MAX-ACCESS   read-only
            STATUS   current
            DESCRIPTION
               "The IP address of this OSPF interface."
           ::= { ospfIfEntry 1 }

        ospfAddressLessIf OBJECT-TYPE
            SYNTAX   Integer32
            MAX-ACCESS   read-only
            STATUS   current
            DESCRIPTION
               "For the purpose of easing  the  instancing  of
               addressed   and  addressless  interfaces;  This
               variable takes the value 0 on  interfaces  with
               IP  Addresses,  and  the corresponding value of
               ifIndex for interfaces having no IP Address."
           ::= { ospfIfEntry 2 }
        ospfIfAreaId OBJECT-TYPE
            SYNTAX   AreaID
            MAX-ACCESS   read-create
            STATUS   current
            DESCRIPTION
               "A 32-bit integer uniquely identifying the area
               to  which  the  interface  connects.   Area  ID
               0.0.0.0 is used for the OSPF backbone."
           DEFVAL   { '00000000'H }    -- 0.0.0.0
           ::= { ospfIfEntry 3 }

        ospfIfType OBJECT-TYPE
            SYNTAX   INTEGER    {
                        broadcast (1),
                        nbma (2),
                        pointToPoint (3),
                        pointToMultipoint (5)
                      }
            MAX-ACCESS   read-create
            STATUS   current
            DESCRIPTION
               "The OSPF interface type.

               By way of a default, this field may be intuited
               from the corresponding value of ifType.  Broad-
               cast LANs, such as  Ethernet  and  IEEE  802.5,
               take  the  value  'broadcast', X.25 and similar
               technologies take the value 'nbma',  and  links
               that  are  definitively point to point take the
               value 'pointToPoint'."
           ::= { ospfIfEntry 4 }

        ospfIfAdminStat OBJECT-TYPE
            SYNTAX   Status
            MAX-ACCESS   read-create
            STATUS   current
            DESCRIPTION
               "The OSPF  interface's  administrative  status.
               The  value formed on the interface, and the in-
               terface will be advertised as an internal route
               to  some  area.   The  value 'disabled' denotes
               that the interface is external to OSPF."
           DEFVAL { enabled }
           ::= { ospfIfEntry 5 }

        ospfIfRtrPriority OBJECT-TYPE
            SYNTAX   DesignatedRouterPriority
            MAX-ACCESS   read-create
            STATUS   current
            DESCRIPTION
               "The  priority  of  this  interface.   Used  in
               multi-access  networks,  this  field is used in
               the designated router election algorithm.   The
               value 0 signifies that the router is not eligi-
               ble to become the  designated  router  on  this
               particular  network.   In the event of a tie in
               this value, routers will use their Router ID as
               a tie breaker."
           DEFVAL { 1 }
           ::= { ospfIfEntry 6 }

        ospfIfTransitDelay OBJECT-TYPE
            SYNTAX   UpToMaxAge
            MAX-ACCESS   read-create
            STATUS   current
            DESCRIPTION
               "The estimated number of seconds  it  takes  to
               transmit  a  link state update packet over this
               interface."
           DEFVAL { 1 }
           ::= { ospfIfEntry 7 }

        ospfIfRetransInterval OBJECT-TYPE
            SYNTAX   UpToMaxAge
            MAX-ACCESS   read-create
            STATUS   current
            DESCRIPTION
               "The number of seconds between  link-state  ad-
               vertisement  retransmissions,  for  adjacencies
               belonging to this  interface.   This  value  is
               also used when retransmitting database descrip-
               tion and link-state request packets."
           DEFVAL { 5 }
           ::= { ospfIfEntry 8 }

        ospfIfHelloInterval OBJECT-TYPE
            SYNTAX   HelloRange
            MAX-ACCESS   read-create
            STATUS   current
            DESCRIPTION
               "The length of time, in  seconds,  between  the
               Hello  packets that the router sends on the in-
               terface.  This value must be the same  for  all
               routers attached to a common network."
           DEFVAL { 10 }
           ::= { ospfIfEntry 9 }

        ospfIfRtrDeadInterval OBJECT-TYPE
            SYNTAX   PositiveInteger
            MAX-ACCESS   read-create
            STATUS   current
            DESCRIPTION
               "The number of seconds that  a  router's  Hello
               packets  have  not been seen before it's neigh-
               bors declare the router down.  This  should  be
               some  multiple  of  the  Hello  interval.  This
               value must be the same for all routers attached
               to a common network."
           DEFVAL { 40 }
           ::= { ospfIfEntry 10 }

        ospfIfPollInterval OBJECT-TYPE
            SYNTAX   PositiveInteger
            MAX-ACCESS   read-create
            STATUS   current
            DESCRIPTION
               "The larger time interval, in seconds,  between
               the  Hello  packets  sent  to  an inactive non-
               broadcast multi- access neighbor."
           DEFVAL { 120 }
           ::= { ospfIfEntry 11 }

        ospfIfState OBJECT-TYPE
            SYNTAX   INTEGER    {
                        down (1),
                        loopback (2),
                        waiting (3),
                        pointToPoint (4),
                        designatedRouter (5),
                        backupDesignatedRouter (6),
                        otherDesignatedRouter (7)
                      }
            MAX-ACCESS   read-only
            STATUS   current
            DESCRIPTION
               "The OSPF Interface State."
           DEFVAL { down }
           ::= { ospfIfEntry 12 }

        ospfIfDesignatedRouter OBJECT-TYPE
            SYNTAX   IpAddress
            MAX-ACCESS   read-only
            STATUS   current
            DESCRIPTION
               "The IP Address of the Designated Router."
           DEFVAL   { '00000000'H }    -- 0.0.0.0
           ::= { ospfIfEntry 13 }

        ospfIfBackupDesignatedRouter OBJECT-TYPE
            SYNTAX   IpAddress
            MAX-ACCESS   read-only
            STATUS   current
            DESCRIPTION
               "The  IP  Address  of  the  Backup   Designated
               Router."
           DEFVAL   { '00000000'H }    -- 0.0.0.0
           ::= { ospfIfEntry 14 }

        ospfIfEvents OBJECT-TYPE
            SYNTAX   Counter32
            MAX-ACCESS   read-only
            STATUS   current
            DESCRIPTION
               "The number of times this  OSPF  interface  has
               changed its state, or an error has occurred."
           ::= { ospfIfEntry 15 }

        ospfIfAuthKey OBJECT-TYPE
            SYNTAX   OCTET STRING (SIZE (0..256))
            MAX-ACCESS   read-create
            STATUS   current
            DESCRIPTION
               "The Authentication Key.  If the Area's Author-
               ization  Type  is  simplePassword,  and the key
               length is shorter than 8 octets, the agent will
               left adjust and zero fill to 8 octets.

               Note that unauthenticated  interfaces  need  no
               authentication key, and simple password authen-
               tication cannot use a key of more  than  8  oc-
               tets.  Larger keys are useful only with authen-
               tication mechanisms not specified in this docu-
               ment.

               When read, ospfIfAuthKey always returns an  Oc-
               tet String of length zero."
           REFERENCE
              "OSPF Version 2, Section 9  The  Interface  Data
              Structure"
          DEFVAL   { '0000000000000000'H }    -- 0.0.0.0.0.0.0.0
          ::= { ospfIfEntry 16 }

        ospfIfStatus OBJECT-TYPE
            SYNTAX   RowStatus
            MAX-ACCESS   read-create
            STATUS   current
            DESCRIPTION
               "This variable displays the status of  the  en-
               try.  Setting it to 'invalid' has the effect of
               rendering it inoperative.  The internal  effect
               (row removal) is implementation dependent."
           ::= { ospfIfEntry 17 }

        ospfIfMulticastForwarding OBJECT-TYPE
            SYNTAX   INTEGER    {
                                blocked (1),        -- no multicast forwarding
                                multicast (2),        -- using multicast address
                                unicast (3)        -- to each OSPF neighbor
                      }
            MAX-ACCESS   read-create
            STATUS   current
            DESCRIPTION
               "The way multicasts should  forwarded  on  this
               interface;  not  forwarded,  forwarded  as data
               link multicasts, or forwarded as data link uni-
               casts.   Data link multicasting is not meaning-
               ful on point to point and NBMA interfaces,  and
               setting ospfMulticastForwarding to 0 effective-
               ly disables all multicast forwarding."
           DEFVAL { blocked }
           ::= { ospfIfEntry 18 }

        ospfIfDemand OBJECT-TYPE
            SYNTAX   TruthValue
            MAX-ACCESS   read-create
            STATUS   current
            DESCRIPTION
               "Indicates whether Demand OSPF procedures (hel-
               lo supression to FULL neighbors and setting the
               DoNotAge flag on proogated LSAs) should be per-
               formed on this interface."
           DEFVAL { false }
           ::= { ospfIfEntry 19 }

        ospfIfAuthType OBJECT-TYPE
            SYNTAX   INTEGER (0..255)
                        -- none (0),
                        -- simplePassword (1)
                        -- md5 (2)
                        -- reserved for specification by IANA (> 2)
            MAX-ACCESS   read-create
            STATUS   current
            DESCRIPTION
               "The authentication type specified for  an  in-
               terface.   Additional  authentication types may
               be assigned locally."
           REFERENCE
              "OSPF Version 2, Appendix E Authentication"
          DEFVAL { 0 }        -- no authentication, by default
          ::= { ospfIfEntry 20 }

Next: 3.8. OSPF Interface Metrics

Connected: An Internet Encyclopedia
RFC 1850 - 3.7. OSPF Interface Table