Class hcurib:Nexthop (CONCRETE)

Class ID:16305
Class Label: Nexthop record
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol, admin, fabric-connectivity, fabric-protocol, tenant-connectivity, tenant-ext-connectivity, tenant-ext-protocol, tenant-protocol]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

NO COMMENTS

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

    [1] PREFIX=nh- PROPERTY = routeType


    [2] PREFIX=-addr- PROPERTY = addr


    [3] PREFIX=-if- PROPERTY = if




DN FORMAT: 

[0] cprov-{vendor}/provacc-{[name]}/acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/csr-{[name]}/urib/inst/dom-{name}/routeDb/route-{[prefix]}/nh-{[routeType]}-addr-{[addr]}-if-{[if]}

[1] acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/csr-{[name]}/urib/inst/dom-{name}/routeDb/route-{[prefix]}/nh-{[routeType]}-addr-{[addr]}-if-{[if]}

                


Diagram

Super Mo: hcurib:ANexthop,
Container Mos: hcurib:ARoute (deletable:yes),


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] hcloud:Prov  MOs Cloud Provider
 
 ├
[V] hcloud:ProvAccount  Cloud Provider Account
 
 
 ├
[V] hcloud:Account  Represents a cloud tenant, i.e. both owner and container of cloud resources. It maps 1:1 to fvTenant. Which means that for each fvTenant an hcloudAccount must be created. Depending on the cloud provider it implies different things, as detailed as follows. AWS: hcloudAccount stores cloud account's credentials or just the accoun...
 
 
 
 ├
[V] hcloud:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.
 
 
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 
 
 ├
[V] hcloud:Csr 
 
 
 
 
 
 
 ├
[V] hcurib:Entity  Holds urib entity information
 
 
 
 
 
 
 
 ├
[V] hcurib:Inst  This objects hold per urib instance information. There is only one instance supported in urib
 
 
 
 
 
 
 
 
 ├
[V] hcurib:Dom  This objects hold per bgp domain (vrf) information
 
 
 
 
 
 
 
 
 
 ├
[V] hcurib:RouteDb  RIB database
 
 
 
 
 
 
 
 
 
 
 ├
[V] hcurib:Route 
 
 
 
 
 
 
 
 
 
 
 
 ├
[V] hcurib:Nexthop 
[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] hcloud:Account  Represents a cloud tenant, i.e. both owner and container of cloud resources. It maps 1:1 to fvTenant. Which means that for each fvTenant an hcloudAccount must be created. Depending on the cloud provider it implies different things, as detailed as follows. AWS: hcloudAccount stores cloud account's credentials or just the accoun...
 
 ├
[V] hcloud:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 ├
[V] hcloud:Csr 
 
 
 
 
 ├
[V] hcurib:Entity  Holds urib entity information
 
 
 
 
 
 ├
[V] hcurib:Inst  This objects hold per urib instance information. There is only one instance supported in urib
 
 
 
 
 
 
 ├
[V] hcurib:Dom  This objects hold per bgp domain (vrf) information
 
 
 
 
 
 
 
 ├
[V] hcurib:RouteDb  RIB database
 
 
 
 
 
 
 
 
 ├
[V] hcurib:Route 
 
 
 
 
 
 
 
 
 
 ├
[V] hcurib:Nexthop 


Contained Hierarchy
[V] hcurib:Nexthop 


Inheritance
[V] hcurib:ANexthop  next-hop record
 ├
[V] hcurib:Nexthop 


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: hcurib:Nexthop
address:Ip addr  (hcurib:Nexthop:addr)
           Overrides:hcurib:ANexthop:addr
           The peer IP address.
string:Basic if  (hcurib:Nexthop:if)
           Overrides:hcurib:ANexthop:if
           The OSPF Multicast nexthop interface.
hcurib:RouteT
          scalar:Enum32
routeType  (hcurib:Nexthop:routeType)
           Overrides:hcurib:ANexthop:routeType
           NO COMMENTS
Defined in: hcurib:ANexthop
hcurib:Metric
          scalar:Uint32
metric  (hcurib:ANexthop:metric)
           The interface metric.
string:Basic nextHopIfDn  (hcurib:ANexthop:nextHopIfDn)
           Nexthop interface Dn
hcurib:Pref
          scalar:Uint16
pref  (hcurib:ANexthop:pref)
           The administrative preference value for this route. This value is useful for resolving routes advertised from different protocols.
Defined in: mo:Resolvable
mo:Owner
          scalar:Enum8
lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
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

addr

Type: address:Ip

Overrides:hcurib:ANexthop:addr
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming 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





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: string:Basic

Overrides:hcurib:ANexthop:if
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
The OSPF Multicast nexthop interface.



lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A value that indicates how this object was created. For internal use only.
Constants
local 0 Local NO COMMENTS
policy 1 Policy NO COMMENTS
replica 2 Replica NO COMMENTS
resolveOnBehalf 3 ResolvedOnBehalf NO COMMENTS
implicit 4 Implicit NO COMMENTS
DEFAULT local(0) Local NO COMMENTS





metric

Type: hcurib:Metric
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The interface metric.
Constants
defaultValue 1u --- 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





nextHopIfDn

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Nexthop interface Dn



pref

Type: hcurib:Pref
Primitive Type: scalar:Uint16

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.



routeType

Type: hcurib:RouteT
Primitive Type: scalar:Enum32

Overrides:hcurib:ANexthop:routeType
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
direct 0u Direct Direct
ospf-inter-area 10u OSPF Inter Area OSPF inter area
ospf-nssa-external-type1 11u OSPF NSSA External Type1 OSPF NSSA external type1
ospf-nssa-external-type2 12u OSPF NSSA External Type2 OSPF NSSA external type2
ospf-external-type1 13u OSPF External Type1 OSPF external type1
ospf-external-type2 14u OSPF External Type2 OSPF external type2
isis 15u ISIS ISIS
isis-summary 16u ISIS Summary ISIS summary
isis-level1 17u ISIS Level 1 ISIS Level 1
isis-level2 18u ISIS Level 2 ISIS Level 2
isis-inter-area 19u ISIS Inter Area ISIS Inter Area
local 1u Local Local
connected 2u Connected Connected
static 3u Static Static
rip 4u RIP RIP
mobile 5u Mobile Mobile
bgp 6u BGP BGP
eigrp 7u EIGRP EIGRP
eigrp-external 8u EIGRP external EIGRP extrenal
ospf 9u OSPF OSPF
DEFAULT direct(0u) 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.