Class fv:NodeDef (CONCRETE)

Class ID:7274
Class Label: Node Definition
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Ambiguous Placement in the Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, tenant-ext-connectivity-l3]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: false ]

Node Definition

Naming Rules
RN FORMAT: node-{id}

    [1] PREFIX=node- PROPERTY = id




DN FORMAT: 

[0] resPolCont/fabricExtConnPDef-{id}-{[tenantPKey]}/podConnPDef-{id}/node-{id}

                


Diagram

Super Mo: fv:ANode,
Container Mos: fv:PodConnPDef (deletable:yes),
Contained Mos: fabric:CreatedBy, fv:ExtRoutableIpDef, fv:IntersiteIpDef, fv:IpDef, fv:WanIpDef,


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] pol:ResPolCont 
 
 ├
[V] fv:FabricExtConnPDef  Site Connectivity Profile Definition @@@ PE will pull FabricExtConnPDef. An Outside pushed to spine will pull it.
 
 
 ├
[V] fv:PodConnPDef  POD Connectivity Profile Definition
 
 
 
 ├
[V] fv:NodeDef  Node Definition @@@ Class for passing some internal node specific information between PM & PE


Contained Hierarchy
[V] fv:NodeDef  Node Definition @@@ Class for passing some internal node specific information between PM & PE
 ├
[V] fabric:CreatedBy An internal object used by the PM to keep track of which objects are causing some policies to get pushed to some nodes.
 
 ├
[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] 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:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[V] fv:ExtRoutableIpDef 
 ├
[V] fv:IntersiteIpDef 
 ├
[V] fv:IpDef 
 ├
[V] fv:WanIpDef 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


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:Comp Represents a policy component. This object is part of the policy definition.
 
 
 ├
[V] infra:ANode A node is a base class representing the node where the endpoint group will be deployed.
 
 
 
 ├
[V] fv:ANode  Abstract Node Definition @@@ Class for passing some internal node specific information between PM & PE
 
 
 
 
 ├
[V] fv:NodeDef  Node Definition @@@ Class for passing some internal node specific information between PM & PE


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: fv:NodeDef
scalar:Bool fabricExtCtrlPeering  (fv:NodeDef:fabricExtCtrlPeering)
           Enable/Disable participation of this node in peering for fabric external control traffic
scalar:Bool fabricExtIntersiteCtrlPeering  (fv:NodeDef:fabricExtIntersiteCtrlPeering)
           Enable/Disable participation of this node in peering for inter-site control traffic
fabric:NodeId
          scalar:Uint16
id  (fv:NodeDef:id)
           Overrides:infra:ANode:id
           An object identifier.
scalar:Bool localIntersiteRR  (fv:NodeDef:localIntersiteRR)
           Is node serving as intersiteRR
bgp:SpineRoleType
          scalar:Bitmask8
spineRole  (fv:NodeDef:spineRole)
           Site role(s) played by this spine
Defined in: infra:ANode
fabric:PodId
          scalar:UByte
podId  (infra:ANode:podId)
           The POD identifier.
Defined in: pol:Comp
naming:Descr
          string:Basic
descr  (pol:Comp:descr)
           Specifies the description of a policy component.
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: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.
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.
Properties Detail

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





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Specifies the description of a policy component.



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.



fabricExtCtrlPeering

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Enable/Disable participation of this node in peering for fabric external control traffic
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT yes(true) --- NO COMMENTS





fabricExtIntersiteCtrlPeering

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Enable/Disable participation of this node in peering for inter-site control traffic
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





id

Type: fabric:NodeId
Primitive Type: scalar:Uint16

Overrides:infra:ANode:id
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
An object identifier.
Constants
defaultValue 1 --- NO COMMENTS





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





localIntersiteRR

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Is node serving as intersiteRR
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- 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: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



podId

Type: fabric:PodId
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The POD identifier.
Constants
defaultValue 0 --- 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.



spineRole

Type: bgp:SpineRoleType
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Site role(s) played by this spine
Constants
unspecified 0 Unspecified Unspecified
wan 1 WAN Spine WAN (GOLF) Spine
inter-pod 2 Inter-Pod Spine Inter-Pod (MPOD) Spine
msite-speaker 4 Multi-Site Speaker Multi-Site Speaker
msite-forwarder 8 Multi-Site Forwarder Multi-Site Forwarder
DEFAULT unspecified(0) Unspecified Unspecified





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.