Class l3:ProtAdjEp (ABSTRACT)

Class ID:3745
Class Label: Protocol Adjacency
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: 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 ]

A layer 3 protocol adjacency abstraction.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: nw:ProtAdjEp,
Sub Mos: arp:AAdjEp, bgp:LocalAsn, bgp:Peer, bgp:PeerEntry, coop:AdjEp, coop:CitizenAdj, coop:ConCitizenAdj, eigrp:AdjEp, hcbgp:APeer, hcbgp:LocalAsn, isis:AdjEp, nd:AAdjEp, ospf:AAdjEp, rtdmc:AAdjEp,


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] arp:AAdjEp The abstraction of an ARP adjacency information object endpoint. This encapsulates static and dynamic endpoint objects.
 
 
 
 
 
 
 
 ├
[V] arp:AdjEp The adjacency endpoint. This is the endpoint object that contains information regarding dynamically learned endpoints.
 
 
 
 
 
 
 
 ├
[V] arp:StAdjEp The ARP static adjacency endpoint, which is the endpoint object that contains information regarding statically configured endpoints. This is a statically configured endpoint corresponding to an interface.
 
 
 
 
 
 
 
 ├
[V] arp:SvcAdjEp  Service arp adjacency definitions
 
 
 
 
 
 
 ├
[V] bgp:LocalAsn The local autonomous system (AS) information pertaining to a peer.
 
 
 
 
 
 
 ├
[V] bgp:Peer The BGP information pertaining to a peer.
 
 
 
 
 
 
 ├
[V] bgp:PeerEntry The BGP peer status specifies the status of a relationship between BGP speakers. A BGP speaker does not discover another BGP speaker automatically. You must configure the relationships between BGP speakers. A BGP peer is a BGP speaker that has an active TCP connection to another BGP speaker.
 
 
 
 
 
 
 ├
[V] coop:AdjEp The abstract class for all types of COOP adjacencies.
 
 
 
 
 
 
 
 ├
[V] coop:OracleAdj The adjacency to the Oracle node information.
 
 
 
 
 
 
 ├
[V] coop:CitizenAdj The adjacency to the citizen node.
 
 
 
 
 
 
 ├
[V] coop:ConCitizenAdj  Adjacency to the citizen node(s) connected to this Oracle
 
 
 
 
 
 
 ├
[V] eigrp:AdjEp The neighbor information.
 
 
 
 
 
 
 ├
[V] hcbgp:APeer  This object is super of hcloud bgp peers
 
 
 
 
 
 
 
 ├
[V] hcbgp:Peer  This object holds bgp information pertaining to a peer
 
 
 
 
 
 
 ├
[V] hcbgp:LocalAsn  This object holds local AS information pertaining to a peer
 
 
 
 
 
 
 ├
[V] isis:AdjEp The ISIS adjacency neighbor endpoint is a managed object that captures ISIS adjacency specific information such as peer system identifier and peer circuit identifier.
 
 
 
 
 
 
 ├
[V] nd:AAdjEp The neighbor discovery adjacency records.
 
 
 
 
 
 
 
 ├
[V] nd:AdjEp The neighbor discovery adjacency endpoint. This is the endpoint object that contains information regarding dynamically learned endpoints.
 
 
 
 
 
 
 
 ├
[V] nd:StAdjEp The static neighbor discovery adjacency definitions.
 
 
 
 
 
 
 
 ├
[V] nd:SvcAdjEp  Service nd adjacency definitions
 
 
 
 
 
 
 ├
[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.
 
 
 
 
 
 
 ├
[V] rtdmc:AAdjEp  This object holds rtdmc neighbor information
 
 
 
 
 
 
 
 ├
[V] pim6:AdjEp  This object holds pim neighbor information
 
 
 
 
 
 
 
 ├
[V] pim:AdjEp PIM neighbor information.


Events
                


Faults
                


Fsms
                


Properties Summary
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

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





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.



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.



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.