Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class rib:Nexthop (ABSTRACT)

Class ID:5871
Class Label: Nexthop record
Encrypted: false - Exportable: false - Persistent: false - 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-connectivity-l3, fabric-protocol-l3, tenant-connectivity-l3, tenant-ext-connectivity-l3, tenant-ext-protocol-l3, tenant-protocol-l3]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]



Naming Rules 


DN FORMAT:


Diagram

Super Mo: rib:DbRec,
Relations From: rib:RouteOwner,
Relations: rib:RtRouteOwnerToNexthopAtt,


Inheritance
[V] nw:Item Ignore.
 ├
 		[V] nw:Conn A connection abstraction.
 
 		 ├
 		[V] nw:GEp A group endpoint abstraction.
 
 		 
 		 ├
 		[V] nw:DbRec An abstraction of a database record.
 
 		 
 		 
 		 ├
 		[V] l3:DbRec A database record abstraction.
 
 		 
 		 
 		 
 		 ├
 		[V] rib:DbRec A URIB database record.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] rib:Nexthop 


Events


Faults


Fsms


Properties Summary
Defined in: rib:Nexthop
rib:NhMetric
          scalar:Uint32 		Nhmetric  (rib:Nexthop:Nhmetric)
          
rib:NhTag
          scalar:Uint32 		Nhtag  (rib:Nexthop:Nhtag)
          
scalar:Bool active  (rib:Nexthop:active)
           A property for indicating if the new hop is active or backup.
address:Ip addr  (rib:Nexthop:addr)
           The peer IP address.
rib:CreateTs
          scalar:Date 		createTs  (rib:Nexthop:createTs)
           The creation time of the Layer 2 bridge domain.
nw:IfId
          base:IfIndex 		if  (rib:Nexthop:if)
           The OSPF Multicast nexthop interface.
rib:Metric
          scalar:Uint32 		metric  (rib:Nexthop:metric)
           The ISIS interface metric.
rib:OwnerT
          string:Basic 		owner  (rib:Nexthop:owner)
           The owner of the target relay. The DHCP relay is any host that forwards DHCP packets between clients and servers. The relays are used to forward requests and replies between clients and servers when they are not on the same physical subnet.
rib:Pref
          scalar:Uint16 		pref  (rib:Nexthop:pref)
           The administrative preference value for this route. This value is useful for resolving routes advertised from different protocols.
rib:RouteT
          scalar:Enum32 		routeType  (rib:Nexthop:routeType)
          
rib:Tag
          scalar:Uint32 		tag  (rib:Nexthop:tag)
           The color of a policy label.
rib:NhT
          scalar:Bitmask32 		type  (rib:Nexthop:type)
           The specific type of the object or component.
l3:VrfName
          string:Basic 		vrf  (rib:Nexthop:vrf)
           The VRF to which this task or object belongs.
Defined in: nw:DbRec
naming:Name
          string:Basic 		name  (nw:DbRec: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

Nhmetric

Type: rib:NhMetric
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
defaultValue 1u --- NO COMMENTS




Nhtag

Type: rib:NhTag
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
defaultValue 0u --- NO COMMENTS




active

Type: scalar:Bool

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
A property for indicating if the new hop is active or backup.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS




addr

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The peer IP address.


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




createTs

Type: rib:CreateTs
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The creation time of the Layer 2 bridge domain.


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.


if

Type: nw:IfId
Primitive Type: base:IfIndex

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The OSPF Multicast nexthop interface.


metric

Type: rib:Metric
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The ISIS interface metric.
Constants
defaultValue 1u --- NO COMMENTS




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.


owner

Type: rib:OwnerT
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The owner of the target relay. The DHCP relay is any host that forwards DHCP packets between clients and servers. The relays are used to forward requests and replies between clients and servers when they are not on the same physical subnet.


pref

Type: rib:Pref
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The administrative preference value for this route. This value is useful for resolving routes advertised from different protocols.
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.


routeType

Type: rib:RouteT
Primitive Type: scalar:Enum32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
ospf-type2 10u OSPF Type2 OSPF type2
ospf-nssa-type1 11u OSPF NSSA Type1 OSPF NSSA type1
ospf-nssa-type2 12u OSPF NSSA Type2 OSPF NSSA type2
ospfv3-intra 13u OSPFv3 Intra OSPFv3 intra
ospfv3-inter 14u OSPFv3 Inter OSPFv3 inter
ospfv3-type1 15u OSPFv3 Type1 OSPFv3 type1
ospfv3-type2 16u OSPFv3 Type2 OSPFv3 type2
ospfv3-nssa-type1 17u OSPFv3 NSSA Type1 OSPFv3 NSSA type1
ospfv3-nssa-type2 18u OSPFv3 NSSA Type2 OSPFv3 NSSA type2
ibgp 19u IBGP IBGP
direct 1u Direct Direct
ebgp 20u EBGP EBGP
imbgp 21u IMBGP IMBGP
embgp 22u EMBGP EMBGP
discard 23u Discard Discard
eigrp-internal 24u EIGRP Internal EIGRP internal
eigrp-external 25u EIGRP External EIGRP external
static 2u Static Static
coop 30u Coop Coop
isis-l1-int 31u ISIS L1 INT ISIS L1 INT
isis-l1-ext 32u ISIS L1 EXT ISIS L1 EXT
local 33u Local Local
mcast-static 3u Multicast Static Multicast static
rip 4u RIP RIP
isis-l1 5u ISIS L1 ISIS L1
isis-l2 6u ISIS L2 ISIS L2
ospf-intra 7u OSPF Intra OSPF intra
ospf-inter 8u OSPF Inter OSPF inter
ospf-type1 9u OSPF Type1 OSPF type1
DEFAULT direct(1u) Direct Direct




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.





tag

Type: rib:Tag
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The color of a policy label.
Constants
defaultValue 0u --- NO COMMENTS




type

Type: rib:NhT
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The specific type of the object or component.
Constants
pervasive 128u Pervasive Pervasive
recursive 16u Recursive Recursive
attached 1u Attached Attached
redist-only 262144u Redist-only Redist-only
local 2u Local Local
table 32u Table Table
direct 4u Direct Direct
wildcard 64u Wildcard Wildcard
limited-directed-bcast 8u Limited or directed broadcast Limited or directed broadcast
DEFAULT attached(1u) Attached Attached




vrf

Type: l3:VrfName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The VRF to which this task or object belongs.




Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail