Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class ip:Nexthop (ABSTRACT)

Class ID:3811
Class Label: Nexthop
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-connectivity-l3, admin, fabric-connectivity-l3, tenant-connectivity-l3, tenant-ext-connectivity-l3]
Creatable/Deletable: derived (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 ]

The nexthops for the static route.

Naming Rules 


DN FORMAT:


Diagram

Super Mo: pol:Instr,
Sub Mos: ipv4:Nexthop, ipv4:NexthopStub, ipv6:Nexthop, ipv6:NexthopStub,
Relations To: ip:NexthopDef, fabric:AProtGEp,
Relations: ip:RsNexthopToNexthopDef, ip:RsNexthopToProtG,


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
 		[V] pol:Obj Represents a generic policy object.
 
 		 ├
 		[V] pol:Instr Represents a policy control instrumentation object.
 
 		 
 		 ├
 		[V] ip:Nexthop The nexthops for the static route.
 
 		 
 		 
 		 ├
 		[V] ipv4:Nexthop The next hops for the static route.
 
 		 
 		 
 		 ├
 		[V] ipv4:NexthopStub 
 
 		 
 		 
 		 ├
 		[V] ipv6:Nexthop The next hops for the static route.
 
 		 
 		 
 		 ├
 		[V] ipv6:NexthopStub 


Events


Faults


Fsms


Properties Summary
Defined in: ip:Nexthop
reference:BinRef LogicalDn  (ip:Nexthop:LogicalDn)
           Logical Dn of nexthopP for fault delegation
ip:RtControl
          scalar:Bitmask8 		cachedRtCtrl  (ip:Nexthop:cachedRtCtrl)
           Pervasive flag boolean
ip:ContextId
          scalar:Uint32 		contextId  (ip:Nexthop:contextId)
           A domain or VRF ID.
ip:NhControl
          scalar:Bitmask8 		ctrl  (ip:Nexthop:ctrl)
           The control state.
ip:NhFlags
          scalar:Bitmask64 		flags  (ip:Nexthop:flags)
          
address:Ip nhAddr  (ip:Nexthop:nhAddr)
          
nw:IfId
          base:IfIndex 		nhIf  (ip:Nexthop:nhIf)
          
l3:VrfName
          string:Basic 		nhVrf  (ip:Nexthop:nhVrf)
          
ip:OperSt
          scalar:Enum8 		operSt  (ip:Nexthop:operSt)
          
ip:NhOperStQual
          scalar:Enum8 		operStQual  (ip:Nexthop:operStQual)
          
rt:Preference
          scalar:UByte 		pref  (ip:Nexthop:pref)
           The administrative preference value for this route. This value is useful for resolving routes advertised from different protocols.
base:Encap rwEncap  (ip:Nexthop:rwEncap)
          
track:TrackId
          scalar:Uint32 		trackId  (ip:Nexthop:trackId)
           Object Id to track next hop by OTM
Defined in: pol:Instr
naming:Descr
          string:Basic 		descr  (pol:Instr:descr)
           Specifies a control instrumentation description.
Defined in: pol:Obj
naming:Name
          string:Basic 		name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic 		nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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

LogicalDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Logical Dn of nexthopP for fault delegation


cachedRtCtrl

Type: ip:RtControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Pervasive flag boolean
Constants
unspecified 0 Unspecified Unspecified
pervasive 1 Pervasive route Pervasive
bfd 2 BFD Bidirectional Forwarding Detection
dst-unreachable 4 Destination unreachable Dest-unreachable
track-object 8 Object tracked by IPSLA Object to be tracked
DEFAULT unspecified(0) Unspecified Unspecified




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




contextId

Type: ip:ContextId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
A domain or VRF ID.
Constants
defaultValue 0u --- NO COMMENTS




ctrl

Type: ip:NhControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
unspecified 0 Unspecified Unspecified
track-object 1 Object tracked by IPSLA Tracking Policy Enabled For Nexthop
DEFAULT 0 --- Nh Config controls




descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Specifies a control instrumentation description.


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.


flags

Type: ip:NhFlags
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
unspecified 0ull Unspecified Unspecified
rnh 1ull Recursive nexthop Recursive nexthop
rnhSent 2ull Recursive nexthop Sent to URIB Recursive nexthop
DEFAULT unspecified(0ull) Unspecified Unspecified




name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
null


nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS


nhAddr

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:


nhIf

Type: nw:IfId
Primitive Type: base:IfIndex

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:


nhVrf

Type: l3:VrfName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:


operSt

Type: ip:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
unspecified 0 Unspecified Unspecified
down 1 Down The state is down
up 2 Up The state is up
failed 3 Failed The state is fail
DEFAULT up(2) Up The state is up




operStQual

Type: ip:NhOperStQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
unspecified 0 Unspecified Unspecified
up 1 Up Up
rt-unreachable 2 Route unreachable Route unreachable, applicable only for rnh
vrf-down 2 VRF down vrf down
if-down 3 Interface down Interface down
link-local-pfx 4 Link local prefix Invalid route to link local
invalid-pfx-mask 5 Invalid prefix mask Invalid prefix mask
invalid-pfx 6 Invalid prefix Invalid prefix
invalid-pin-if-vrf 7 Invalid pin interface VRF Invalid pin interface vrf
invalid-nh 8 Invalid nexthop Invalid nexthop
invalid-nh-mask 9 Invalid nexthop Mask Invalid nexthop mask
invalid-if 10 No Interface Invalid Interface not specified
local-nh 11 Local Nexthop Local NH not allowed
mcast-nh 12 Multicast Nexthop Multicast Nexthop
lo-addr 13 Loopback Address Loopback address
max-nh-exceeded 14 Max NH count exceeded Max NH count exceeded
invalid-route-vrf 15 Invalid route-vrf Invalid route-vrf
no-nexthop 16 Nexthop not specified No nexthop
route-exists 17 Route exists with no or different pin number Route exists
rnh-not-resolved 18 Recursive nexthop not resolved Recursive nexthop not resolved
internal-cfg-err 19 Internal config error Internal config error
local-addr 20 Nexthop configured as local address Nexthop configured as local address
vrf-err 21 Invalid vrf error VRF error
no-nh 22 No nexthop No Nexthop
rt-exists 23 Route exists Route Exists
rnh-unresolved 24 RNH unresolved RNH unresolved
proxy-tunnel-down 25 Spine proxy tunnel down Spine proxy tunnel down
no-nh-ep-cfg 26 Nexthop EP Reachability not configured Nexthop EP reachability not configured
track-id-invalid 27 Track Id is invalid Invalid track Id
track-state-invalid 28 Tracking state is invalid Invalid track state
track-state-down 29 Tracking state is down Route track state down
DEFAULT unspecified(0) Unspecified Unspecified




pref

Type: rt:Preference
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
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.


rwEncap

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:


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.





trackId

Type: track:TrackId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Object Id to track next hop by OTM




Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail