Class bgp:NextHop (CONCRETE)

Class ID:2619
Class Label: Nexthop
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: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The BGP route information for the next hop.

Naming Rules
RN FORMAT: nh-{[addr]}

    [1] PREFIX=nh- PROPERTY = addr




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/bgp/inst/dom-{name}/af-{type}/nh-{[addr]}

[1] sys/bgp/inst/dom-{name}/af-{type}/nh-{[addr]}

                


Diagram

Super Mo: l3:Db,
Container Mos: bgp:DomAf (deletable:no),
Contained Mos: bgp:AttNextHop,


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 
 
 
 ├
[V] bgp:Entity The BGP control plane entity information.
 
 
 
 
 
 ├
[V] bgp:Inst The per BGP instance information. There is only instance supported in BGP.
 
 
 
 
 
 
 ├
[V] bgp:Dom The object that represents all the BGP domain (VRF) information.
 
 
 
 
 
 
 
 ├
[V] bgp:DomAf The BGP (VRF) address family information.
 
 
 
 
 
 
 
 
 ├
[V] bgp:NextHop The BGP route information for the next hop.
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 ├
[V] bgp:Entity The BGP control plane entity information.
 
 
 ├
[V] bgp:Inst The per BGP instance information. There is only instance supported in BGP.
 
 
 
 ├
[V] bgp:Dom The object that represents all the BGP domain (VRF) information.
 
 
 
 
 ├
[V] bgp:DomAf The BGP (VRF) address family information.
 
 
 
 
 
 ├
[V] bgp:NextHop The BGP route information for the next hop.


Contained Hierarchy
[V] bgp:NextHop The BGP route information for the next hop.
 ├
[V] bgp:AttNextHop The attached next hop.


Inheritance
[V] nw:Item Ignore.
 ├
[V] nw:Conn A connection abstraction.
 
 ├
[V] nw:GEp A group endpoint abstraction.
 
 
 ├
[V] nw:Db An abstraction of the database.
 
 
 
 ├
[V] l3:Db A database abstraction.
 
 
 
 
 ├
[V] bgp:NextHop The BGP route information for the next hop.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: bgp:NextHop
bgp:RnhEpoch
          scalar:UByte
activeRnhEpoch  (bgp:NextHop:activeRnhEpoch)
           Active recursive next hop (RNH) Epoch
address:Ip addr  (bgp:NextHop:addr)
           The IP address of the next hop.
bgp:NhFlags
          scalar:Bitmask8
flags  (bgp:NextHop:flags)
           Flags
bgp:Metric
          scalar:Uint32
igpMetric  (bgp:NextHop:igpMetric)
           IGP metric.
bgp:IgpPref
          scalar:UByte
igpPref  (bgp:NextHop:igpPref)
           IGP preference
bgp:IgpRtType
          scalar:UByte
igpRtType  (bgp:NextHop:igpRtType)
           IGP route type
bgp:LastResolvTs
          scalar:Date
lastResolv  (bgp:NextHop:lastResolv)
           Last resolved timestamp
bgp:NextAdvTs
          scalar:Date
nextAdv  (bgp:NextHop:nextAdv)
           Next advertised timestamp
bgp:RnhEpoch
          scalar:UByte
pendingRnhEpoch  (bgp:NextHop:pendingRnhEpoch)
           Pending recursive next hop (RNH) Epoch
address:Ip resolvedRt  (bgp:NextHop:resolvedRt)
           Resolved route prefix
cap:Quant
          scalar:Uint16
rtRefCount  (bgp:NextHop:rtRefCount)
           A property that indicates the number of routes pointing to the next hop.
Defined in: nw:Db
naming:Name
          string:Basic
name  (nw:Db: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.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

activeRnhEpoch

Type: bgp:RnhEpoch
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Active recursive next hop (RNH) Epoch



addr

Type: address:Ip

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
The IP address of the next hop.



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.



flags

Type: bgp:NhFlags
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Flags
Constants
attached 1 Attached attached
local 2 Local local
reachable 4 Reachable reachable
filtered 8 Filtered filtered
DEFAULT 0 --- Nexthop flags





igpMetric

Type: bgp:Metric
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
IGP metric.



igpPref

Type: bgp:IgpPref
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
IGP preference



igpRtType

Type: bgp:IgpRtType
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
IGP route type



lastResolv

Type: bgp:LastResolvTs
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Last resolved timestamp
Constants
never 0ull Never NO COMMENTS
DEFAULT never(0ull) Never NO COMMENTS





modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The time when this object was last modified.
Constants
never 0ull never NO COMMENTS
DEFAULT never(0ull) never 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.



nextAdv

Type: bgp:NextAdvTs
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Next advertised timestamp
Constants
never 0ull Never NO COMMENTS
DEFAULT never(0ull) Never NO COMMENTS





pendingRnhEpoch

Type: bgp:RnhEpoch
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Pending recursive next hop (RNH) Epoch



resolvedRt

Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Resolved route prefix



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.



rtRefCount

Type: cap:Quant
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
A property that indicates the number of routes pointing to the next hop.
Constants
defaultValue 0 --- NO 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.