Class nw:PathEp (CONCRETE)

Class ID:3578
Class Label: Network Path Endpoint
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, access-protocol, admin, tenant-connectivity]
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: true, HasHealth: true, HasEventRules: false ]

An abstraction of an endpoint path.

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

    [1] PREFIX=path- PROPERTY = id




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/conng/path-{[id]}

[1] sys/conng/path-{[id]}

                


Diagram

Super Mo: nw:APathEp,
Container Mos: nw:ConnGrp (deletable:no),
Contained Mos: l1:ProcessNodeAtt, l2:PortSecurityPolDef,
Relations From: fv:DyPathAtt, fv:EpDefRef, fv:EpDef, fv:L3EpDef, l2:Dom, fv:APathAtt, vsan:CktEp,
Relations To: nw:If,
Relations: nw:RsPathToIf, nw:RtDyPathAtt, nw:RtEpDefRefToPathEp, nw:RtEpDefToPathEp, nw:RtL3EpDefToPathEp, nw:RtPathDomAtt, nw:RtStPathAtt, nw:RtVsanPathAtt,


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] nw:ConnGrp A connection group.
 
 
 
 
 
 ├
[V] nw:PathEp An abstraction of an endpoint path.
[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] nw:ConnGrp A connection group.
 
 
 ├
[V] nw:PathEp An abstraction of an endpoint path.


Contained Hierarchy
[V] nw:PathEp An abstraction of an endpoint path.
 ├
[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] l1:ProcessNodeAtt  Mo for indicating that the port needs to be processed for Node Attachment
 ├
[V] l2:PortSecurityPolDef  Port Security Policy
 
 ├
[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] 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] nw:RsPathToIf A source relation to the interface information.
 ├
[V] nw:RtDyPathAtt A target relation to the endpoint path.
 ├
[V] nw:RtEpDefRefToPathEp 
 ├
[V] nw:RtEpDefToPathEp A target relation to the abstraction of an endpoint path.
 ├
[V] nw:RtL3EpDefToPathEp 
 ├
[V] nw:RtPathDomAtt A target relation to the endpoint path.
 ├
[V] nw:RtStPathAtt A target relation to the endpoint path.
 ├
[V] nw:RtVsanPathAtt  Associations to nw:PathEp with rel-mo to vfcif "


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:APathEp  Abstraction of AccGrp
 
 
 
 
 ├
[V] nw:PathEp An abstraction of an endpoint path.


Events
                


Faults
                nw:PathEp:vlanScopeSupportIsNotSupported


Fsms
                


Properties Summary
Defined in: nw:PathEp
naming:Descr
          string:Basic
descr  (nw:PathEp:descr)
          
nw:IfId
          base:IfIndex
id  (nw:PathEp:id)
           Overrides:nw:APathEp:id
           An identifier .
scalar:Bool managedEdmLsNodeAttached  (nw:PathEp:managedEdmLsNodeAttached)
           NO COMMENTS
reference:BinRef monPolDn  (nw:PathEp:monPolDn)
          
Defined in: nw:APathEp
nw:AllocState
          scalar:Enum8
allocState  (nw:APathEp:allocState)
           State of Path.
reference:BinRef fabricPathDn  (nw:APathEp:fabricPathDn)
           Fabric path dn corresponding to this nw path
base:Encap nativeEncap  (nw:APathEp:nativeEncap)
           Native encap on this path
l2:VlanScope
          scalar:Enum8
vlanScope  (nw:APathEp:vlanScope)
           VLAN scope on this path
nw:CfgSupported
          scalar:Enum8
vlanScopeSupport  (nw:APathEp:vlanScopeSupport)
           Is vlan scope local supported.
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

allocState

Type: nw:AllocState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
State of Path.
Constants
allocated 0 Allocated Allocated
deallocated 1 Deallocated Deallocated
DEFAULT allocated(0) Allocated Allocated





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:



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.



fabricPathDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Fabric path dn corresponding to this nw path



id

Type: nw:IfId
Primitive Type: base:IfIndex

Overrides:nw:APathEp:id
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
An 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





managedEdmLsNodeAttached

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
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





monPolDn

Type: reference:BinRef

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



nativeEncap

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Native encap on this path



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.






vlanScope

Type: l2:VlanScope
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
VLAN scope on this path
Constants
global 0 Global scope NO COMMENTS
portlocal 1 Port Local scope NO COMMENTS
DEFAULT global(0) Global scope NO COMMENTS





vlanScopeSupport

Type: nw:CfgSupported
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Is vlan scope local supported.
Constants
supported 0 Config is supported NO COMMENTS
unsupported 1 Config is not supported NO COMMENTS
DEFAULT supported(0) Config is supported NO COMMENTS