Class nd:If (CONCRETE)

Class ID:2641
Class Label: Neighbor Discovery Interface
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, admin, fabric-protocol, tenant-ext-protocol, tenant-protocol]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: false ]

The per ND protocol interface information.

Naming Rules
RN FORMAT: if-{[id]}

    [1] PREFIX=if- PROPERTY = id




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/nd/inst/dom-{name}/if-{[id]}

[1] sys/nd/inst/dom-{name}/if-{[id]}

                


Diagram

Super Mo: l3:ProtIf,
Container Mos: nd:Dom (deletable:no),
Contained Mos: nd:IfStats, nd:Pfx, nd:StAdjEp,
Relations From: nw:PathEp,
Relations: nw:RtPathToIf,


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] nd:Entity The neighbor discovery protocol entity information.
 
 
 
 
 
 ├
[V] nd:Inst The per neighbor discovery instance information. In the current implementation, only one instance of ND is running in the system.
 
 
 
 
 
 
 ├
[V] nd:Dom A neighbor discovery protocol domain.
 
 
 
 
 
 
 
 ├
[V] nd:If The per ND protocol interface information.
[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] nd:Entity The neighbor discovery protocol entity information.
 
 
 ├
[V] nd:Inst The per neighbor discovery instance information. In the current implementation, only one instance of ND is running in the system.
 
 
 
 ├
[V] nd:Dom A neighbor discovery protocol domain.
 
 
 
 
 ├
[V] nd:If The per ND protocol interface information.


Contained Hierarchy
[V] nd:If The per ND protocol interface information.
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] nd:IfStats The neighbor discovery interface statistics. This is a singleton within an interface.
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] nd:Pfx A list of prefixes to be placed in the Prefix Information options of the Router Advertisement messages sent from the interface.
 ├
[V] nd:StAdjEp The static neighbor discovery adjacency definitions.
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 
 ├
[V] tag:Annotation 
 
 
 ├
[V] tag:Tag 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] nd:RtEpDefRefToStAdjEpV6 A target relation to static neighbor discovery adjacency definitions.
 ├
[V] nw:RtPathToIf A target relation to the interface information.


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:If The interface information.
 
 
 
 
 ├
[V] nw:LogicalIf A logical interface abstraction.
 
 
 
 
 
 ├
[V] nw:ProtIf A protocol interface abstraction.
 
 
 
 
 
 
 ├
[V] l3:ProtIf A layer 3 protocol interface abstraction.
 
 
 
 
 
 
 
 ├
[V] nd:If The per ND protocol interface information.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: nd:If
nd:IfControl
          scalar:Bitmask16
ctrl  (nd:If:ctrl)
           The control state.
nd:HopLimit
          scalar:UByte
hopLimit  (nd:If:hopLimit)
           The hop limit is used by hosts in outgoing packets and link parameters such as the link MTU. This facilitates centralized administration of critical parameters that can be set on routers and automatically propagated to all attached hosts.
nw:IfId
          base:IfIndex
id  (nd:If:id)
           Overrides:nw:If:id
           An object identifier.
reference:BinRef monPolDn  (nd:If:monPolDn)
           The monitoring policy attached to this observable object.
nd:Mtu
          scalar:Uint16
mtu  (nd:If:mtu)
           In the RA message, the maximum transmission unit (MTU) value that a host should use in packets that it originates.
nd:NsIntvl
          scalar:Uint32
nsIntvl  (nd:If:nsIntvl)
           The neighbor solicitation interval is sent by a node to determine the link-layer address of a neighbor, or to verify that a neighbor is still reachable through a cached link-layer address. Neighbor solicitations are also used for duplicate address detection.
nd:NsRetries
          scalar:UByte
nsRetries  (nd:If:nsRetries)
           The retransmission retry count for sending neighbor solicitation messages.
nd:RaIntvl
          scalar:Uint16
raIntvl  (nd:If:raIntvl)
           The interval for sending router advertisement messages.
nd:RaIntvlMin
          scalar:Uint16
raIntvlMin  (nd:If:raIntvlMin)
           The minimum interval between router advertisement transmissions.
nd:RaLifetime
          scalar:Uint16
raLifetime  (nd:If:raLifetime)
           The lifetime associated with the default router.
nd:ReachableTime
          scalar:Uint32
reachableTime  (nd:If:reachableTime)
           The reachable time is the time in milliseconds that a node assumes a neighbor is reachable after receiving a reachability confirmation.
nd:RetransTimer
          scalar:Uint32
retransTimer  (nd:If:retransTimer)
           The retransmit timer has the time in milliseconds between retransmitted neighbor solicitation messages.
Defined in: nw:ProtIf
nw:IfAdminSt
          scalar:Enum8
adminSt  (nw:ProtIf:adminSt)
           The administrative state of the object or policy.
Defined in: nw:If
naming:Descr
          string:Basic
descr  (nw:If:descr)
          
Defined in: nw:Ep
naming:Name
          string:Basic
name  (nw:Ep:name)
           Overrides:nw:Conn:name
           The name of the object.
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

adminSt

Type: nw:IfAdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative state of the object or policy.
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT enabled(1) Enabled Enabled





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





ctrl

Type: nd:IfControl
Primitive Type: scalar:Bitmask16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
unspecified 0 Unspecified Unspecified
managed-cfg 2 Managed config redirects Not Supported Managed config, this flag is advertised in ICMPv6 RA messages to use stateful address auto-configuration to obtain address information
other-cfg 4 Other config Other config, this flag is advertised in ICMPv6 RA messages that hosts use stateful auto configuration to obtain non address related information
suppress-ra 8 Suppress RA suppress-ra
suppress-ra-mtu 16 Suppress RA mtu suppress-ra mtu
unsolicit-na-glean 32 Unsolicit NA Glean unsolicit-na-glean, enable neighbor gleaning on receipt of unsolicit NA
DEFAULT unspecified(0) Unspecified Unspecified





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:



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.



hopLimit

Type: nd:HopLimit
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The hop limit is used by hosts in outgoing packets and link parameters such as the link MTU. This facilitates centralized administration of critical parameters that can be set on routers and automatically propagated to all attached hosts.
Constants
defaultValue 64 --- NO COMMENTS





id

Type: nw:IfId
Primitive Type: base:IfIndex

Overrides:nw:If:id
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
An object identifier.



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





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





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy attached to this observable object.



mtu

Type: nd:Mtu
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
In the RA message, the maximum transmission unit (MTU) value that a host should use in packets that it originates.
Constants
defaultValue 9000 --- 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.



nsIntvl

Type: nd:NsIntvl
Primitive Type: scalar:Uint32

Units: msec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The neighbor solicitation interval is sent by a node to determine the link-layer address of a neighbor, or to verify that a neighbor is still reachable through a cached link-layer address. Neighbor solicitations are also used for duplicate address detection.
Constants
defaultValue 1000u --- NO COMMENTS





nsRetries

Type: nd:NsRetries
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The retransmission retry count for sending neighbor solicitation messages.
Constants
defaultValue 3 --- NO COMMENTS





raIntvl

Type: nd:RaIntvl
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The interval for sending router advertisement messages.
Constants
defaultValue 600 --- NO COMMENTS





raIntvlMin

Type: nd:RaIntvlMin
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The minimum interval between router advertisement transmissions.
Constants
defaultValue 200 --- NO COMMENTS





raLifetime

Type: nd:RaLifetime
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The lifetime associated with the default router.
Constants
defaultValue 1800 --- NO COMMENTS





reachableTime

Type: nd:ReachableTime
Primitive Type: scalar:Uint32

Units: msec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The reachable time is the time in milliseconds that a node assumes a neighbor is reachable after receiving a reachability confirmation.
Constants
defaultValue 0u --- NO COMMENTS





retransTimer

Type: nd:RetransTimer
Primitive Type: scalar:Uint32

Units: msec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The retransmit timer has the time in milliseconds between retransmitted neighbor solicitation messages.
Constants
defaultValue 0u --- 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.



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.