Class vz:ToEPgAny (CONCRETE)

Class ID:5638
Class Label: To EPG
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Explicit
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: false ]



Naming Rules
RN FORMAT: to-{[epgDn]}

    [1] PREFIX=to- PROPERTY = epgDn




DN FORMAT: 

[1] anydefcont/anydef-{[anyDn]}/to-{[epgDn]}

                


Diagram

Super Mo: vz:AToEPg,
Container Mos: vz:AnyDef (deletable:yes),
Contained Mos: fv:AEpPConfIssues, l3ext:SubnetDef, vz:LToEPg,
Relations To: l2:Dom, l3:Dom,
Relations: fv:RsEPgDefToL2Dom, fv:RsEPgDefToL3Dom,


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] vz:AnyDefCont 
 
 
 
 
 
 
 ├
[V] vz:AnyDef 
 
 
 
 
 
 
 
 ├
[V] vz:ToEPgAny 
[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] vz:AnyDefCont 
 
 ├
[V] vz:AnyDef 
 
 
 ├
[V] vz:ToEPgAny 


Contained Hierarchy
[V] vz:ToEPgAny 
 ├
[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:AEpPConfIssues Configuration issues on an endpoint profile.
 
 ├
[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:RsEPgDefToL2Dom A source relation to a generic layer 2 flood domain.
 ├
[V] fv:RsEPgDefToL3Dom The Layer 3 Domain (VRF).
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] l3ext:SubnetDef An internal object that represents subnets defined under an L3 outside.
 
 ├
[V] bgp:RtSummPolDef  Route summarization internal policy for BGP
 
 
 ├
[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] rtsum:RtSubnetToRtSumm 
 
 ├
[V] eigrp:RtSummPolDef  Route summarization internal policy
 
 
 ├
[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] rtsum:RtSubnetToRtSumm 
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] l3ext:RsSubnetToProfile The source relation to the route control profile.
 
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] ospf:RtSummPolDef  External Route summarization internal policy
 
 
 ├
[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] rtsum:RtSubnetToRtSumm 
 ├
[V] vz:LToEPg 


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] fv:EPgCont An endpoint group container is an internal object that represents endpoint groups.
 
 
 
 ├
[V] fv:EPgDef An internal object that represents endpoint groups is used for deployment.
 
 
 
 
 ├
[V] fv:AEPgDef Abstract representation of an endpoint group definition.
 
 
 
 
 
 ├
[V] vz:AToEPg 
 
 
 
 
 
 
 ├
[V] vz:ToEPgAny 


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: vz:ToEPgAny
reference:BinRef epgDn  (vz:ToEPgAny:epgDn)
           Overrides:fv:EPgCont:epgDn
           The fully qualified name of the endpoint group.
reference:BinRef monPolDn  (vz:ToEPgAny:monPolDn)
           The monitoring policy attached to this observable object.
Defined in: vz:AToEPg
vz:GPCTag
          scalar:Uint32
ctxPcTag  (vz:AToEPg:ctxPcTag)
          
scalar:Bool isCtxPcTagInUseForRules  (vz:AToEPg:isCtxPcTagInUseForRules)
          
fv:PrefGrMemb
          scalar:Enum8
prefGrMemb  (vz:AToEPg:prefGrMemb)
           NO COMMENTS
scalar:Uint64 txId  (vz:AToEPg:txId)
           The identifier of the transaction in which the user action occurred.
Defined in: fv:AEPgDef
reference:BinRef bdDefDn  (fv:AEPgDef:bdDefDn)
          
reln:StateQual
          scalar:Enum8
bdDefStQual  (fv:AEPgDef:bdDefStQual)
          
reference:BinRef ctxDefDn  (fv:AEPgDef:ctxDefDn)
          
reln:StateQual
          scalar:Enum8
ctxDefStQual  (fv:AEPgDef:ctxDefStQual)
          
base:Encap l3CtxEncap  (fv:AEPgDef:l3CtxEncap)
           The encapsulation (VLAN or VXLAN) of a private layer 3 network context that belongs to a specific tenant or is shared.
Defined in: fv:EPgDef
fv:Seg
          scalar:Uint32
ctxSeg  (fv:EPgDef:ctxSeg)
          
vz:GPCTag
          scalar:Uint32
pcTag  (fv:EPgDef:pcTag)
          
actrl:ScopeId
          scalar:Uint32
scopeId  (fv:EPgDef:scopeId)
          
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: 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: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.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

bdDefDn

Type: reference:BinRef

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



bdDefStQual

Type: reln:StateQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
none 0 none no issue
mismatch-target 1 mismatch-target target not found, using default
default-target 2 default-target target not specified, using default
DEFAULT none(0) none no issue





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





ctxDefDn

Type: reference:BinRef

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



ctxDefStQual

Type: reln:StateQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
none 0 none no issue
mismatch-target 1 mismatch-target target not found, using default
default-target 2 default-target target not specified, using default
DEFAULT none(0) none no issue





ctxPcTag

Type: vz:GPCTag
Primitive Type: scalar:Uint32

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





ctxSeg

Type: fv:Seg
Primitive Type: scalar:Uint32

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



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.



epgDn

Type: reference:BinRef

Overrides:fv:EPgCont:epgDn
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
The fully qualified name of the endpoint group.



isCtxPcTagInUseForRules

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





l3CtxEncap

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The encapsulation (VLAN or VXLAN) of a private layer 3 network context that belongs to a specific tenant or is shared.



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.



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



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





prefGrMemb

Type: fv:PrefGrMemb
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
include 1 Include EPg is part of preferred group member
exclude 2 Exclude EPg is NOT part of preferred group member
DEFAULT exclude(2) Exclude EPg is NOT part of preferred group member





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.



scopeId

Type: actrl:ScopeId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
defaultValue 1u --- NO COMMENTS





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.






txId

Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The identifier of the transaction in which the user action occurred.