Class vns:EPgDef (CONCRETE)

Class ID:4812
Class Label: EPgDef
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: [admin, nw-svc-device, nw-svc-policy]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: EPG
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

An object used to track allocated endpoint groups. This object is used internally.

Naming Rules
RN FORMAT: EPgDef-{name}

    [1] PREFIX=EPgDef- PROPERTY = name




DN FORMAT: 

[1] uni/tn-{name}/GraphInst_C-{[ctrctDn]}-G-{[graphDn]}-S-{[scopeDn]}/TermNodeInst-{name}/LegVNode-{name}/EPgDef-{name}

[3] uni/tn-{name}/GraphInst_C-{[ctrctDn]}-G-{[graphDn]}-S-{[scopeDn]}/NodeInstDef-{name}/LegVNode-{name}/EPgDef-{name}

[5] uni/epp/vns-{[epgPKey]}/NodeInstDef-{name}/LegVNode-{name}/EPgDef-{name}

[7] uni/tn-{name}/GraphInst_C-{[ctrctDn]}-G-{[graphDn]}-S-{[scopeDn]}/NodeInst-{name}/LegVNode-{name}/EPgDef-{name}

[9] uni/tn-{name}/GraphInst_C-{[ctrctDn]}-G-{[graphDn]}-S-{[scopeDn]}/LegVNode-{name}/EPgDef-{name}

                


Diagram

Super Mo: pol:Def,
Container Mos: vns:LegVNode (deletable:yes),
Relations To: vns:AConn, vns:LIf, vns:EPpInfo, vns:SDEPpInfo,
Relations: vns:RsEPgDefToConn, vns:RsEPgDefToLIf, vns:RsEPpInfoAtt, vns:RsSEPpInfoAtt,


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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 
 
 
 
 
 ├
[V] vns:GraphInst The instance of a service graph. All instance objects are implicit.
 
 
 
 
 
 
 
 
 ├
[V] vns:TermNodeInst A terminal node instance.
 
 
 
 
 
 
 
 
 
 ├
[V] vns:LegVNode A classic mode or legacy virtual node.
 
 
 
 
 
 
 
 
 
 
 ├
[V] vns:EPgDef An object used to track allocated endpoint groups. This object is used internally.
[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:Uni Represents policy definition/resolution universe.
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 ├
[V] vns:GraphInst The instance of a service graph. All instance objects are implicit.
 
 
 
 ├
[V] vns:TermNodeInst A terminal node instance.
 
 
 
 
 ├
[V] vns:LegVNode A classic mode or legacy virtual node.
 
 
 
 
 
 ├
[V] vns:EPgDef An object used to track allocated endpoint groups. This object is used internally.
[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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 
 
 
 
 
 ├
[V] vns:GraphInst The instance of a service graph. All instance objects are implicit.
 
 
 
 
 
 
 
 
 ├
[V] vns:NodeInstDef An instance of the service node. This is an internal object.
 
 
 
 
 
 
 
 
 
 ├
[V] vns:LegVNode A classic mode or legacy virtual node.
 
 
 
 
 
 
 
 
 
 
 ├
[V] vns:EPgDef An object used to track allocated endpoint groups. This object is used internally.
[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:Uni Represents policy definition/resolution universe.
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 ├
[V] vns:GraphInst The instance of a service graph. All instance objects are implicit.
 
 
 
 ├
[V] vns:NodeInstDef An instance of the service node. This is an internal object.
 
 
 
 
 ├
[V] vns:LegVNode A classic mode or legacy virtual node.
 
 
 
 
 
 ├
[V] vns:EPgDef An object used to track allocated endpoint groups. This object is used internally.
[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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fv:EpPCont The container for an endpoint profile.
 
 
 
 
 
 
 
 ├
[V] fv:SvcEpP Abstract representation of a service endpoint profile, such as an endpoint profile created per node in the service graph.
 
 
 
 
 
 
 
 
 ├
[V] vns:NodeInstDef An instance of the service node. This is an internal object.
 
 
 
 
 
 
 
 
 
 ├
[V] vns:LegVNode A classic mode or legacy virtual node.
 
 
 
 
 
 
 
 
 
 
 ├
[V] vns:EPgDef An object used to track allocated endpoint groups. This object is used internally.
[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:Uni Represents policy definition/resolution universe.
 
 ├
[V] fv:EpPCont The container for an endpoint profile.
 
 
 ├
[V] fv:SvcEpP Abstract representation of a service endpoint profile, such as an endpoint profile created per node in the service graph.
 
 
 
 ├
[V] vns:NodeInstDef An instance of the service node. This is an internal object.
 
 
 
 
 ├
[V] vns:LegVNode A classic mode or legacy virtual node.
 
 
 
 
 
 ├
[V] vns:EPgDef An object used to track allocated endpoint groups. This object is used internally.
[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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 
 
 
 
 
 ├
[V] vns:GraphInst The instance of a service graph. All instance objects are implicit.
 
 
 
 
 
 
 
 
 ├
[V] vns:NodeInst An instance of a function node. A service graph consists of multiple function nodes..
 
 
 
 
 
 
 
 
 
 ├
[V] vns:LegVNode A classic mode or legacy virtual node.
 
 
 
 
 
 
 
 
 
 
 ├
[V] vns:EPgDef An object used to track allocated endpoint groups. This object is used internally.
[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:Uni Represents policy definition/resolution universe.
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 ├
[V] vns:GraphInst The instance of a service graph. All instance objects are implicit.
 
 
 
 ├
[V] vns:NodeInst An instance of a function node. A service graph consists of multiple function nodes..
 
 
 
 
 ├
[V] vns:LegVNode A classic mode or legacy virtual node.
 
 
 
 
 
 ├
[V] vns:EPgDef An object used to track allocated endpoint groups. This object is used internally.
[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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 
 
 
 
 
 ├
[V] vns:GraphInst The instance of a service graph. All instance objects are implicit.
 
 
 
 
 
 
 
 
 ├
[V] vns:ANodeInst The abstraction of a node instance.
 
 
 
 
 
 
 
 
 
 ├
[V] vns:LegVNode A classic mode or legacy virtual node.
 
 
 
 
 
 
 
 
 
 
 ├
[V] vns:EPgDef An object used to track allocated endpoint groups. This object is used internally.
[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:Uni Represents policy definition/resolution universe.
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 ├
[V] vns:GraphInst The instance of a service graph. All instance objects are implicit.
 
 
 
 ├
[V] vns:ANodeInst The abstraction of a node instance.
 
 
 
 
 ├
[V] vns:LegVNode A classic mode or legacy virtual node.
 
 
 
 
 
 ├
[V] vns:EPgDef An object used to track allocated endpoint groups. This object is used internally.


Contained Hierarchy
[V] vns:EPgDef An object used to track allocated endpoint groups. This object is used internally.
 ├
[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] vns:RsEPgDefToConn A source relation to a connector.
 ├
[V] vns:RsEPgDefToLIf A source relation to a logical interface.
 ├
[V] vns:RsEPpInfoAtt A source relation to an internal object that stores the encap (vlan/vxlan) information of an endpoint.
 ├
[V] vns:RsSEPpInfoAtt 


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:Def Represents self-contained policy document.
 
 
 ├
[V] vns:EPgDef An object used to track allocated endpoint groups. This object is used internally.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: vns:EPgDef
base:Encap encap  (vns:EPgDef:encap)
           The VLAN ID for the endpoint group output.
base:Encap fabEncap  (vns:EPgDef:fabEncap)
          
reference:BinRef lIfCtxDn  (vns:EPgDef:lIfCtxDn)
           NO COMMENTS
vz:MembType
          scalar:Enum8
membType  (vns:EPgDef:membType)
          
reference:BinRef monPolDn  (vns:EPgDef:monPolDn)
           The monitoring policy attached to this observable object.
naming:Name
          string:Basic
name  (vns:EPgDef:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           null
vz:GPCTag
          scalar:Uint32
pcTag  (vns:EPgDef:pcTag)
           null
reference:BinRef rEPpInfoAtt  (vns:EPgDef:rEPpInfoAtt)
          
address:Ip rtrId  (vns:EPgDef:rtrId)
           The BGP router ID.
Defined in: pol:Def
naming:Descr
          string:Basic
descr  (pol:Def:descr)
           Specifies a description of the policy definition.
naming:Descr
          string:Basic
ownerKey  (pol:Def:ownerKey)
           The key for enabling clients to own their data for entity correlation.
naming:Descr
          string:Basic
ownerTag  (pol:Def:ownerTag)
           A tag for enabling clients to add their own data. For example, to indicate who created this object.
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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

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 a description of the policy definition.



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.



encap

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The VLAN ID for the endpoint group output.



fabEncap

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:



lIfCtxDn

Type: reference:BinRef

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





membType

Type: vz:MembType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
none 0 none NO COMMENTS
prov 1 prov NO COMMENTS
cons 2 cons NO COMMENTS
both 3 both NO COMMENTS
prov_as_any 4 prov_as_any NO COMMENTS
cons_as_any 5 cons_as_any NO COMMENTS
both_as_any 6 both_as_any NO COMMENTS
intra 7 intra NO COMMENTS
DEFAULT 0 --- 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.



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:pol:Obj:name  |  naming:NamedObject:name
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
null



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS



ownerKey

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The key for enabling clients to own their data for entity correlation.



ownerTag

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
A tag for enabling clients to add their own data. For example, to indicate who created this object.



pcTag

Type: vz:GPCTag
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
null
Constants
any 0u any NO COMMENTS
DEFAULT 0 --- A shorthand for GroupPolicyClassTag: A tag that is used to identify and classify a particular group of resources/end-points for policy enforcement purposes





rEPpInfoAtt

Type: reference:BinRef

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



rtrId

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The BGP router ID.



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.