Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class fv:AEPgDef (ABSTRACT)

Class ID:2077
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: [admin]
Creatable/Deletable: derived (see Container Mos for details)
Possible Semantic Scopes: EPG, Infra, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: false ]

Abstract representation of an endpoint group definition.

Naming Rules 


DN FORMAT:


Diagram

Super Mo: fv:EPgDef,
Sub Mos: dhcp:ProvDhcp, fv:AEpP, fv:EPgSummaryDef, span:ADestSummary, vns:AdjacencyDefCont, vns:CopyAdjacencyDef, vz:ACtrctEpgDef, vz:AToEPg,
Relations To: l2:Dom, l3:Dom,
Relations: fv:RsEPgDefToL2Dom, fv:RsEPgDefToL3Dom,


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] dhcp:ProvDhcp Internal object that points to the provider details of a DHCP relay profile.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] fv:AEpP Abstract representation of an endpoint profile.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] fv:AREpP Abstract representation of the resolvable endpoint profile. This is an abstract class and cannot be instantiated.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] cloud:EpP 
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] fv:AMgmtEpP Abstract representation of the management endpoint policy for a fabric node management endpoint group. This is an abstract class and cannot be instantiated.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] fv:InBEpP An in-band management endpoint profile for a fabric node management endpoint group.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] fv:InstPEpP Instance Profile Management EpP for the Fabric Node Management EPG. This EpP is created per external management entity instance profile (InstP EPg).
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] fv:OoBEpP An out-of-band management endpoint profile for a fabric node management endpoint group.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] fv:EpP An endpoint profile.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] fv:ExtEpP Abstraction of a profile created for an endpoint connected to an external router or switch.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] fv:BrEpP The bridge endpoint profile represents L2 outside present under a tenant.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] fv:RtdEpP A target relation to an L3 routed outside present under a tenant.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] fv:SvcEpP Abstract representation of a service endpoint profile, such as an endpoint profile created per node in the service graph.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] fv:TnlEpP 
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] fv:EPgSummaryDef 
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] span:ADestSummary The abstraction of a SPAN destination information summary, which is used for configuring the SPAN destination information summary.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] span:AEpgSummary The abstraction of a SPAN destination endpoint group (EPG) summary, which stores EPG information for SPAN.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] span:EpgSummary The SPAN destination Epg summary.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] span:VEpgSummary The VEpg summary.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] span:VEpgSummaryDef The VSPAN EpgSummaryDef is used for VERSPAN definitions.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vns:AdjacencyDefCont 
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vns:CopyAdjacencyDef 
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vz:ACtrctEpgDef An endpoint group associated with a contract can be provider or consumer.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vz:ConsDef A consumer definition.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vz:CtrctEntityDef The contract entity definition.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vz:IntraSecurityDef  Represent an EPg with Intra EPg security enabled
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vz:ProvDef A provider definition.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vz:AToEPg 
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vz:ToEPg The destination endpoint group.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vz:ToEPgAny 


Events


Faults


Fsms


Properties Summary
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: fv:EPgCont
reference:BinRef epgDn  (fv:EPgCont:epgDn)
          
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.
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




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

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


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




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.







Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail