Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class comp:AEpPD (ABSTRACT)

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

An abstraction for the endpoint group policy description. This object is generated and used only by internal process.

Naming Rules 


DN FORMAT:


Diagram

Super Mo: comp:Entity,
Sub Mos: comp:AAppEpPD, infra:AEpPD,
Relations To: vmm:CtrlrP, fv:EpCP,
Relations: comp:RsCtrlrP, comp:RsLocalEpCP,


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
 		[V] naming:NamedIdentifiedObject An abstract base class for an object that contains a name and ID.
 
 		 ├
 		[V] comp:Entity An abstract based class representing a compute entity.
 
 		 
 		 ├
 		[V] comp:AEpPD An abstraction for the endpoint group policy description. This object is generated and used only by internal process.
 
 		 
 		 
 		 ├
 		[V] comp:AAppEpPD The abstraction of an endpoint group policy description. This is an internal object used by the system.
 
 		 
 		 
 		 
 		 ├
 		[V] comp:EpPD An abstraction for the endpoint group policy description. This object is generated and used only by internal process.
 
 		 
 		 
 		 
 		 ├
 		[V] vmm:AEpPD  Abstract class representing VMM EpPD
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vmm:EpPD An endpoint group in the VMM context. This object translates to port groups and/or virtual wires in vCenter and vShield.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vmm:EpgAggr EPG Aggregator Object @@@ This is managed by PolicyMgr
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vmm:IntAggr Internal EPG Aggregator Object @@@ This is managed by PolicyMgr
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vmm:IntCustomAggr 
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vmm:UsrAggr User configurable EPG Aggregator Object @@@ This is managed by PolicyMgr
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vmm:UsrCustomAggr 
 
 		 
 		 
 		 ├
 		[V] infra:AEpPD An abstraction of an endpoint group in an infrastructure context. This object translates to port groups and/or virtual wires in vCenter and vShield.
 
 		 
 		 
 		 
 		 ├
 		[V] infra:EpPD The endpoint group policy descriptor for infrastructure policies. For example, endpoint groups under tenant infra. This object is generated and used only by internal processes.
 
 		 
 		 
 		 
 		 ├
 		[V] infra:EpPDDef The endpoint group policy descriptor for infrastructure policies. For example, endpoint groups under tenant infra. This object is generated and used only by internal processes.


Events


Faults


Fsms


Properties Summary
Defined in: comp:AEpPD
reference:BinRef bdDn  (comp:AEpPD:bdDn)
           The distinguished name of the bridge domain.
fv:ClassPref
          scalar:Enum8 		classPref  (comp:AEpPD:classPref)
           Classification Preference
comp:EppdFlags
          scalar:Bitmask32 		configFlags  (comp:AEpPD:configFlags)
           NO COMMENTS
scalar:Bool crtrnEnabled  (comp:AEpPD:crtrnEnabled)
          
comp:DeployIssues
          scalar:Bitmask64 		deployIssues  (comp:AEpPD:deployIssues)
           Deployment status of EpPD. It captures various errors in a bitmask to collect all errors and provide feedback to users.
base:Encap encap  (comp:AEpPD:encap)
           Encapsulation
reference:BinRef encapAllocKey  (comp:AEpPD:encapAllocKey)
           encap alloc key
scalar:Bool encapChanged  (comp:AEpPD:encapChanged)
           Criterion Enabled
string:Basic encapCtx  (comp:AEpPD:encapCtx)
          
reference:BinRef epgPKey  (comp:AEpPD:epgPKey)
           null
reference:BinRef eppDn  (comp:AEpPD:eppDn)
           EPP Distinguished Name (Dn)
reference:BinRef faultDKey  (comp:AEpPD:faultDKey)
          
reference:BinRef idConsumerDn  (comp:AEpPD:idConsumerDn)
           Id Consumer DN used for encap allocation
fv:InstrImedcy
          scalar:Enum8 		instrImedcy  (comp:AEpPD:instrImedcy)
           A property to specify whether policies are applied immediately or when needed.
string:Basic lagPolicyName  (comp:AEpPD:lagPolicyName)
           LAG Policy Name
comp:LbAlgo
          scalar:Enum8 		lbAlgo  (comp:AEpPD:lbAlgo)
           LB hash algorithm
address:Ip mcastAddr  (comp:AEpPD:mcastAddr)
           Multicast address
fv:ResImedcy
          scalar:Enum8 		resImedcy  (comp:AEpPD:resImedcy)
           null
scalar:Uint64 txId  (comp:AEpPD:txId)
           The identifier of the transaction in which the user action occurred.
scalar:Bool untagged  (comp:AEpPD:untagged)
           Untagged Access port
scalar:Uint64 updateTs  (comp:AEpPD:updateTs)
           An update timestamp. The time when this instance is updated.
Defined in: comp:Entity
naming:Descr
          string:Basic 		descr  (comp:Entity:descr)
           Additional descriptive information about the object.
naming:Id
          scalar:Uint64 		id  (comp:Entity:id)
           Overrides:naming:NamedIdentifiedObject:id
           ID
comp:Issues
          scalar:Bitmask64 		issues  (comp:Entity:issues)
           General Issues It captures various issues happened to the Entity.
naming:Name
          string:Basic 		name  (comp:Entity:name)
           Overrides:naming:NamedObject:name
           Name
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

bdDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The distinguished name of the bridge domain.


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




classPref

Type: fv:ClassPref
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Classification Preference
Constants
encap 0 Packet Encapsulation NO COMMENTS
useg 1 uSeg NO COMMENTS
DEFAULT encap(0) Packet Encapsulation NO COMMENTS




configFlags

Type: comp:EppdFlags
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
none 0x0u None NO COMMENTS
add-del-task-pending 0x10u Whether an add or delete extpol task is pending to be executed NO COMMENTS
skip-encap-validation 0x1u Skip validation of encapsulation value NO COMMENTS
skip-ep-attach 0x2u Skip Ep attach NO COMMENTS
skip-pg-create 0x4u Skip PG creation on vDS NO COMMENTS
skip-inner-pvlan 0x8u Skip allocation on inner PVLAN for AVE EpPD NO COMMENTS
DEFAULT none(0x0u) None NO COMMENTS




crtrnEnabled

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




deployIssues

Type: comp:DeployIssues
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Deployment status of EpPD. It captures various errors in a bitmask to collect all errors and provide feedback to users.
Constants
none 0x0ull N/A NO COMMENTS
invalid-vlan-encap 0x1000000000ull VLAN encap mode is not allowed for AVE Non-Local switching domain NO COMMENTS
missing-internal-vlan-pool 0x100000000ull Missing Internal VLAN pools for EPGs in AVE Domain NO COMMENTS
trunk-portgroup-unsupported 0x10000000ull Trunk portgroup not supported NO COMMENTS
epg-pol-enforce-unsupported 0x1000000ull Intra EPG Isolation is not supported in AVS-VLAN mode and AVE-VLAN mode VMM domains NO COMMENTS
epp-mcast-addr-match-fabric 0x100000ull EPG mcast address is the same as fabric mcast address. Domain fabric multicast address overlaps multicast address pool. NO COMMENTS
invalid-mcast-addr 0x10000ull No valid mcast address allocated for the epg NO COMMENTS
dvs-config-failed 0x1000ull Failed to configure DVS. NO COMMENTS
no-ctrlr-dn 0x100ull Controller DN missing. NO COMMENTS
proc-vmm-error 0x10ull Cluster type object missing from controller. NO COMMENTS
invalid-encap 0x1ull No valid encapsulation identifier allocated for the epg NO COMMENTS
invalid-lag-policy-association 0x2000000000ull Invalid Enhanced LAG Policy Associated with this EPG NO COMMENTS
internal-vlan-pool-full 0x200000000ull Insufficient VLANs. Internal VLAN pool full for EPGs in AVE Domain NO COMMENTS
resimedcy-unsupported 0x20000000ull resolution immediacy not supported for this domain NO COMMENTS
invalid-usegepg-encap 0x2000000ull primary encap property and encap property both need to be set NO COMMENTS
duplicate-static-encap 0x200000ull Duplicate EPG encapsulation value NO COMMENTS
attr-dom-not-supported 0x20000ull attribute based EPG is not supported for the domain type NO COMMENTS
policy-not-found 0x2000ull Failed to find Policy Container for Controller. NO COMMENTS
dvs-version-error 0x200ull Could not get DVS version. NO COMMENTS
dvs-prep-error 0x20ull DVS preparation error for VXLAN. NO COMMENTS
dvs-error 0x2ull Failed to get DVS config. NO COMMENTS
invalid-intra-epg-isolation 0x4000000000ull Enforcing intra EPG isolation is invalid without primary and secondary vlans set NO COMMENTS
invalid-encap-mode 0x400000000ull Encap Mode cannot be VXLAN when Switching Mode is native for this VMM Domain NO COMMENTS
invalid-netflow-preference 0x40000000ull Netflow cannot be Enabled for EPG associated to VMM domain in AVS Mode NO COMMENTS
epg-useg-unsupported 0x4000000ull Microsegmentation is not supported for the controller NO COMMENTS
invalid-switching-mode 0x400000ull VMM Domain needs to be of type Cisco AVE for Switching Mode AVE NO COMMENTS
invalid-vip 0x40000ull VIP has not been allocated NO COMMENTS
ctrlr-unsupported 0x4000ull Unsupported Controller. NO COMMENTS
pg-api-error 0x400ull Portgroup property get API failed. NO COMMENTS
unsupported-ctrlr 0x40ull Invalid Controller scope. NO COMMENTS
vdn-error 0x4ull Network scope creation error. NO COMMENTS
epg-pol-enforce-redhat-unsupported 0x800000000ull Intra EPG Isolation is not supported for Redhat domains NO COMMENTS
ipv6-dstaddr-unsupported 0x80000000ull Netflow Exporter DstAddr supports IPv6 from DVS version 6.0 and higher. Please use an IPv4 address for the Netflow Exporter DstAddr NO COMMENTS
invalid-trunk-portgroup-range 0x8000000ull trunk portgroup VLAN ranges are out of domain VLAN pool NO COMMENTS
epg-pol-enforce-missing-pri_encap 0x800000ull Missing primary encap in VMM Domain relation for policy enforced EPG NO COMMENTS
invalid-static-encap 0x80000ull EPG encapsulation value is not part of any static encapsulation block for the VMM domain NO COMMENTS
ctrlr-not-deployable 0x8000ull Controller not deployable. NO COMMENTS
lacp-apply-failed 0x800ull LACP update for Portgroup failed. NO COMMENTS
no-ctrlr-map 0x80ull Controller missing from internal map. NO COMMENTS
prep-vxlan-error 0x8ull VXLAN cluster preparation error. NO COMMENTS
DEFAULT none(0x0ull) N/A NO COMMENTS




descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Additional descriptive information about the object.


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


encapAllocKey

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
encap alloc key


encapChanged

Type: scalar:Bool

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




encapCtx

Type: string:Basic

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


epgPKey

Type: reference:BinRef

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


eppDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
EPP Distinguished Name (Dn)


faultDKey

Type: reference:BinRef

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


id

Type: naming:Id
Primitive Type: scalar:Uint64

Overrides:naming:NamedIdentifiedObject:id

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


idConsumerDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Id Consumer DN used for encap allocation


instrImedcy

Type: fv:InstrImedcy
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A property to specify whether policies are applied immediately or when needed.
Constants
immediate 1 Immediate NO COMMENTS
lazy 2 On Demand NO COMMENTS
DEFAULT lazy(2) On Demand NO COMMENTS




issues

Type: comp:Issues
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
General Issues It captures various issues happened to the Entity.
Constants
none 0x0ull None NO COMMENTS
tagging-cat-fault 0x10000ull Failed to retrieve all Tag Category information NO COMMENTS
ds-update-fault 0x1000ull Failed to update DS(Data Store) property NO COMMENTS
hv-miss-vmknic-fault 0x100ull ESX Host does not have any vmknic NO COMMENTS
vnic-miss-epg-fault 0x10ull VNIC is attached to an invalid DVS Port Group or unable to communicate with vCenter NO COMMENTS
lnode-property-fault 0x1ull Failed to get DVS property NO COMMENTS
prep-iso-file-fault 0x20000ull Failed to prepare or push iso file for service vm deployment. Please check if correct datastore is selected in policy. NO COMMENTS
rp-update-fault 0x2000ull Failed to update RP(Resource Pool) property NO COMMENTS
mgmtnic-miss-dvs-fault 0x200ull VMK Nic is configured with invalid DVS NO COMMENTS
hpnic-miss-epg-fault 0x20ull HpNIC is attached to an invalid uplink DVS Port Group NO COMMENTS
hv-update-fault 0x2ull Failed to update Hv(ESX Host) property NO COMMENTS
vmfolder-update-fault 0x40000ull Failed to update VM(Virtual Machine) Folder property NO COMMENTS
opflex-channels-down-ave 0x4000ull Both the opflex channels are down for AVE. Please check the connections on the host. NO COMMENTS
hv-miss-pnic-fault 0x400ull ESX Host does not have any pnic NO COMMENTS
hv-miss-dvs-fault 0x40ull ESX Host is configured with invalid DVS NO COMMENTS
vm-update-fault 0x4ull Failed to update VM(Virtual Machine) property NO COMMENTS
tagging-tag-fault 0x8000ull Failed to retrieve all Tag information NO COMMENTS
vm-deploy-task-fault 0x800ull deployVm task failed on vcenter NO COMMENTS
hv-disconnect-fault 0x80ull ESX Host is disconnected or not responding NO COMMENTS
vm-miss-hv-fault 0x8ull VM is attached to an invalid Hv(ESX Host) NO COMMENTS
DEFAULT none(0x0ull) None NO COMMENTS




lagPolicyName

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
LAG Policy Name


lbAlgo

Type: comp:LbAlgo
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
LB hash algorithm
Constants
ip-hash 1 ip-hash NO COMMENTS
mac-pin 2 mac-pin NO COMMENTS
mac-pin-nicload 3 mac-pin-nicload NO COMMENTS
explicit-failover 4 explicit-failover NO COMMENTS
DEFAULT mac-pin(2) mac-pin NO COMMENTS




mcastAddr

Type: address:Ip

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


name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name

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


nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

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


resImedcy

Type: fv:ResImedcy
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
null
Constants
immediate 1 Immediate NO COMMENTS
lazy 2 On Demand NO COMMENTS
pre-provision 3 Pre-provision NO COMMENTS
DEFAULT lazy(2) On Demand 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.


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.


untagged

Type: scalar:Bool

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




updateTs

Type: scalar:Uint64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
An update timestamp. The time when this instance is updated.




Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail