Class ospf:AAdjEp (ABSTRACT)

Class ID:5788
Class Label: Adjacency
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol-l3, admin, fabric-protocol-l3, tenant-ext-protocol-l3, tenant-protocol-l3]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

An abstraction of an OSPF adjacent endpoint.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: l3:ProtAdjEp,
Sub Mos: ospf:AdjEp, ospfv3:AdjEp,


Inheritance
[V] nw:Item Ignore.
 ├
[V] nw:Conn A connection abstraction.
 
 ├
[V] nw:Ep A static endpoint.
 
 
 ├
[V] nw:ConnEp A connection endpoint abstraction.
 
 
 
 ├
[V] nw:AdjEp The adjacency endpoint. This is the endpoint object that contains information regarding dynamically learned endpoints.
 
 
 
 
 ├
[V] nw:ProtAdjEp A protocol adjacency endpoint abstraction.
 
 
 
 
 
 ├
[V] l3:ProtAdjEp A layer 3 protocol adjacency abstraction.
 
 
 
 
 
 
 ├
[V] ospf:AAdjEp An abstraction of an OSPF adjacent endpoint.
 
 
 
 
 
 
 
 ├
[V] ospf:AdjEp An adjacency endpoint contains information regarding dynamically learned endpoints.
 
 
 
 
 
 
 
 ├
[V] ospfv3:AdjEp The neighbor information.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: ospf:AAdjEp
ospf:AreaId
          address:IPv4
area  (ospf:AAdjEp:area)
           The OSPF Area ID. An area is a logical collection of OSPF networks, routers, and links that have the same area identification. A router within an area must maintain a topological database for the area to which it belongs. The router doesn't have detailed information about network topology outside of its area, thereby reducing the size of its database. Areas limit the scope of route information distribution. It is not possible to do route update filtering within an area. The link-state database (LSDB) of routers within the same area must be synchronized and be exactly the same; however, route summarization and filtering is possible between different areas. The main benefit of creating areas is a reduction in the number of routes to propagate - by the filtering and the summarization of routes. Areas are identified by an area ID. Cisco IOS software supports area IDs expressed in IP address format or decimal format, for example, area 0.0.0.0 is equal to area 0.
ospf:DesigAddr
          address:Ip
bdr  (ospf:AAdjEp:bdr)
           The OSPF backup designated router IP address.
ospf:BfdOperSt
          scalar:Enum8
bfdSt  (ospf:AAdjEp:bfdSt)
           The BFD state.
ospf:Options
          scalar:Uint32
dbdOptions  (ospf:AAdjEp:dbdOptions)
           The database descriptor packet peer options.
ospf:DesigAddr
          address:Ip
dr  (ospf:AAdjEp:dr)
           A designated router address.
ospf:AdjFlags
          scalar:Bitmask16
flags  (ospf:AAdjEp:flags)
           The IP address flags.
ospf:Options
          scalar:Uint32
helloOptions  (ospf:AAdjEp:helloOptions)
           The hello packet peer options.
ospf:AdjId
          address:IPv4
id  (ospf:AAdjEp:id)
           An object identifier.
ospf:AdjIfId
          scalar:Uint32
ifId  (ospf:AAdjEp:ifId)
           The OSPF neighbor interface ID.
ospf:AdjOperSt
          scalar:Enum8
operSt  (ospf:AAdjEp:operSt)
           The runtime state of the object or policy.
address:Ip peerIp  (ospf:AAdjEp:peerIp)
           The ID of the fabric interconnect port to which the fabric port is connected.
string:Basic peerName  (ospf:AAdjEp:peerName)
           The address of the peer
ospf:DesigPrio
          scalar:UByte
prio  (ospf:AAdjEp:prio)
           The QoS priority class ID.
Defined in: nw:Ep
naming:Name
          string:Basic
name  (nw:Ep:name)
           Overrides:nw:Conn:name
           The name of the object.
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
           Delete or ignore. For internal use only.
reference:BinRef dn  (mo:TopProps:dn)
           A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN rn  (mo:TopProps:rn)
           Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Properties Detail

area

Type: ospf:AreaId
Primitive Type: address:IPv4

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The OSPF Area ID. An area is a logical collection of OSPF networks, routers, and links that have the same area identification. A router within an area must maintain a topological database for the area to which it belongs. The router doesn't have detailed information about network topology outside of its area, thereby reducing the size of its database. Areas limit the scope of route information distribution. It is not possible to do route update filtering within an area. The link-state database (LSDB) of routers within the same area must be synchronized and be exactly the same; however, route summarization and filtering is possible between different areas. The main benefit of creating areas is a reduction in the number of routes to propagate - by the filtering and the summarization of routes. Areas are identified by an area ID. Cisco IOS software supports area IDs expressed in IP address format or decimal format, for example, area 0.0.0.0 is equal to area 0.
Constants
backbone 0u Backbone area NO COMMENTS
defaultValue 1u --- NO COMMENTS





bdr

Type: ospf:DesigAddr
Primitive Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The OSPF backup designated router IP address.



bfdSt

Type: ospf:BfdOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The BFD state.
Constants
down 0 Down The session is down
up 1 Up The session is up
DEFAULT 0 --- BFD state





childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
    Comments:
Delete or ignore. For internal use only.
Constants
deleteAll 16384u deleteAll NO COMMENTS
ignore 4096u ignore NO COMMENTS
deleteNonPresent 8192u deleteNonPresent NO COMMENTS
DEFAULT 0 --- This type is used to





dbdOptions

Type: ospf:Options
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The database descriptor packet peer options.



dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
    Comments:
A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.



dr

Type: ospf:DesigAddr
Primitive Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
A designated router address.



flags

Type: ospf:AdjFlags
Primitive Type: scalar:Bitmask16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The IP address flags.
Constants
unspecified 0 Unspecified Unspecified
master-self 1 Master self Local node is master
all-dbds-sent 2 All DBDs sent All DBDs sent
all-dbds-acked 4 All DBDs acked All DBDs acked
peer-gr-helper 8 Peer is GR Helper Neighbor in GR helper mode
DEFAULT unspecified(0) Unspecified Unspecified





helloOptions

Type: ospf:Options
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The hello packet peer options.



id

Type: ospf:AdjId
Primitive Type: address:IPv4

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
An object identifier.



ifId

Type: ospf:AdjIfId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The OSPF neighbor interface ID.



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:Conn:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
The name of the object.



operSt

Type: ospf:AdjOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
unknown 0 Unknown Unknown
down 1 Down Down
attempt 2 Attempt Attempt
initializing 3 Initializing Initializing
two-way 4 Two-way Two-way
exstart 5 Exstart Exstart
exchange 6 Exchange Exchange
loading 7 Loading Loading
full 8 Full Full
self 9 Self Self
DEFAULT down(1) Down Down





peerIp

Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The ID of the fabric interconnect port to which the fabric port is connected.



peerName

Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The address of the peer



prio

Type: ospf:DesigPrio
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The QoS priority class ID.
Constants
defaultValue 1 --- NO COMMENTS





rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
    Comments:
Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.



status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
    Comments:
The upgrade status. This property is for internal use only.
Constants
created 2u created In a setter method: specifies that an object should be created. An error is returned if the object already exists.
In the return value of a setter method: indicates that an object has been created.
modified 4u modified In a setter method: specifies that an object should be modified
In the return value of a setter method: indicates that an object has been modified.
deleted 8u deleted In a setter method: specifies that an object should be deleted.
In the return value of a setter method: indicates that an object has been deleted.
DEFAULT 0 --- This type controls the life cycle of objects passed in the XML API.

When used in a setter method (such as configConfMo), the ModificationStatus specifies whether an object should be created, modified, deleted or removed.
In the return value of a setter method, the ModificationStatus indicates the actual operation that was performed. For example, the ModificationStatus is set to "created" if the object was created. The ModificationStatus is not set if the object was neither created, modified, deleted or removed.

When invoking a setter method, the ModificationStatus is optional:
If a setter method such as configConfMo is invoked and the ModificationStatus is not set, the system automatically determines if the object should be created or modified.