Class comp:EpPD (CONCRETE)

Class ID:1262
Class Label: VMM Port Group
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Logical Model
Write Access: [NON CONFIGURABLE]
Read Access: [admin, tenant-epg, vmm-connectivity]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: Infra
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

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

Naming Rules
RN FORMAT: eppd-{[epgPKey]}

    [1] PREFIX=eppd- PROPERTY = epgPKey




DN FORMAT: 

[0] comp/prov-{name}/ctrlr-{[domName]}-{name}/eppd-{[epgPKey]}

                


Diagram

Super Mo: comp:AAppEpPD,
Container Mos: comp:Ctrlr (deletable:no),
Contained Mos: comp:CtrctCont, comp:SvcVMDef, fvns:EncapBlkDef, ip:RouteDef,
Relations From: hvs:ExtPol, comp:ToEPg, comp:Nic,
Relations To: vmm:CtrlrP, comp:DelInfo, fv:EpCP, comp:PvlanEntry,
Relations: comp:RsCtrlrP, comp:RsDelInfo, comp:RsEpgAggr, comp:RsLocalEpCP, comp:RsPvlan, comp:RtEpPD, comp:RtEpgAggr, comp:RtToEPg, comp:RtUsegEpPD,


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] comp:Uni The top level class for all compute related objects.
 
 ├
[V] comp:Prov The VM provider inventory is the inventory of a VM provider such as VMware or Microsoft. The VM provider profile policies determine the VM inventory that is collected.
 
 
 ├
[V] comp:Ctrlr The operational state of the VM management system controller such as a VMware vCenter, VMware vShield, or Microsoft SCVMM.
 
 
 
 ├
[V] comp:EpPD An abstraction for the endpoint group policy description. This object is generated and used only by internal process.


Contained Hierarchy
[V] comp:EpPD An abstraction for the endpoint group policy description. This object is generated and used only by internal process.
 ├
[V] comp:CtrctCont 
 
 ├
[V] comp:EpCP 
 
 
 ├
[V] comp:RsEpCP 
 
 
 ├
[V] comp:RtEpCPAtt 
 
 
 ├
[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] tag:Annotation 
 
 
 
 ├
[V] tag:Tag 
 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] comp:ToEPg 
 
 
 ├
[V] comp:RsRFltAtt 
 
 
 ├
[V] comp:RsToEPg 
 
 
 ├
[V] comp:RsToEPgAtt 
 
 
 ├
[V] comp:RtToEPgAtt 
 
 
 ├
[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] tag:Annotation 
 
 
 
 ├
[V] tag:Tag 
 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] comp:RsCtrlrP A source relation to the VMM controller 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] tag:Annotation 
 
 
 ├
[V] tag:Tag 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] comp:RsDelInfo 
 ├
[V] comp:RsEpgAggr 
 ├
[V] comp:RsLocalEpCP 
 ├
[V] comp:RsPvlan 
 ├
[V] comp:RtEpPD A target relation to abstraction for the endpoint group policy description. Note that this relation is an internal object.
 ├
[V] comp:RtEpgAggr 
 ├
[V] comp:RtToEPg 
 ├
[V] comp:RtUsegEpPD 
 ├
[V] comp:SvcVMDef An L4-L7 service virtual machine. This object is generated and used only by internal process
 
 ├
[V] comp:VNicPDDef A virtual endpoint or a virtual network interface card adapter policy. This object is generated and used only by internal process.
 
 
 ├
[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] tag:Annotation 
 
 
 
 ├
[V] tag:Tag 
 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 ├
[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] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] fvns:EncapBlkDef The encapsulation block definition.
 
 ├
[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] ip:RouteDef The route definitions, which are are used for pushing subnets and static routes to PE. They also push subnets under EpPD to VMMMGR (for configuring external networks in vCD).
 
 ├
[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] ip:EpAnycastDef 
 
 
 ├
[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] ip:NexthopDef The Nexthops for the static route.
 
 
 ├
[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] ip:RtNexthopToNexthopDef A target relation to the next hops for the static route.
 
 ├
[V] ip:NexthopEpPDef 
 
 
 ├
[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] ip:RtRouteToRouteDef A target relation to the route definitions.
 
 ├
[V] ip:RtRtDefIpAddr A target relation to the route definitions.
 
 ├
[V] nd:PfxPolDef The neighbor discovery prefix policy definition.
 
 
 ├
[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.


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.


Events
                


Faults
                comp:EpPD:unsupportedOperation


Fsms
                


Properties Summary
Defined in: comp:EpPD
reference:BinRef epgPKey  (comp:EpPD:epgPKey)
           Overrides:comp:AEpPD:epgPKey
           null
string:Basic remoteErrMsg  (comp:EpPD:remoteErrMsg)
          
comp:RemoteOperIssues
          scalar:Bitmask64
remoteOperIssues  (comp:EpPD:remoteOperIssues)
           Remote Operational Issues. It captures various remote operational issues not initiated by IFC. It is represented as a bitmask to collect all errors and provide feedback to users.
vmm:VxlanDeplPref
          scalar:Enum8
vxlanDeplPref  (comp:EpPD:vxlanDeplPref)
           NO COMMENTS
Defined in: comp:AAppEpPD
comp:AllocMode
          scalar:Enum8
allocMode  (comp:AAppEpPD:allocMode)
           NO COMMENTS
comp:ConfigMode
          scalar:Enum8
blockAllPorts  (comp:AAppEpPD:blockAllPorts)
          
vmm:DelimiterType
          string:Basic
cfgdDelimiter  (comp:AAppEpPD:cfgdDelimiter)
           Delimiter Flags
comp:EncapMode
          scalar:Enum8
encapMode  (comp:AAppEpPD:encapMode)
           NO COMMENTS
fv:EncapMode
          scalar:Enum8
encapModeOverride  (comp:AAppEpPD:encapModeOverride)
           NO COMMENTS
fv:EpgCos
          scalar:Enum8
epgCos  (comp:AAppEpPD:epgCos)
           NO COMMENTS
fv:EpgCosPref
          scalar:Enum8
epgCosPref  (comp:AAppEpPD:epgCosPref)
           NO COMMENTS
comp:ConfigMode
          scalar:Enum8
forgedTransmit  (comp:AAppEpPD:forgedTransmit)
          
fv:IntraSec
          scalar:Bitmask8
intraSecConf  (comp:AAppEpPD:intraSecConf)
           NO COMMENTS
comp:ConfigMode
          scalar:Enum8
macChange  (comp:AAppEpPD:macChange)
           MAC address changes setting
reference:BinRef monPolDn  (comp:AAppEpPD:monPolDn)
           The monitoring policy attached to this observable object.
fv:NetflowDir
          scalar:Enum8
netflowDir  (comp:AAppEpPD:netflowDir)
           NO COMMENTS
fv:NetflowPref
          scalar:Enum8
netflowPref  (comp:AAppEpPD:netflowPref)
           NO COMMENTS
vmm:DelimiterType
          string:Basic
operDelimiter  (comp:AAppEpPD:operDelimiter)
           NO COMMENTS
fv:PcEnfPref
          scalar:Enum8
pcEnfPref  (comp:AAppEpPD:pcEnfPref)
           The preferred policy control.
base:Encap primaryEncap  (comp:AAppEpPD:primaryEncap)
           Represents the primary encap when the encapMode is private
base:Encap primaryEncapInner  (comp:AAppEpPD:primaryEncapInner)
           NO COMMENTS
comp:ConfigMode
          scalar:Enum8
promMode  (comp:AAppEpPD:promMode)
           Promiscuous Mode
base:Encap secondaryEncapInner  (comp:AAppEpPD:secondaryEncapInner)
           NO COMMENTS
comp:StatsCollectionState
          scalar:Bool
statsCollectionState  (comp:AAppEpPD:statsCollectionState)
           A property used to indicate whether statistics collection is enabled
fv:SwitchingModeT
          scalar:Enum8
switchingMode  (comp:AAppEpPD:switchingMode)
           Indicates if the EPG is in AVE (Application Virtual Edge) mode
comp:EpPDType
          scalar:Enum8
type  (comp:AAppEpPD:type)
           EPPD type (tenant or management)
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 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.
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: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:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
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: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

allocMode

Type: comp:AllocMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
dynamic 0 Dynamic Allocation NO COMMENTS
static 1 Static Allocation NO COMMENTS
DEFAULT dynamic(0) Dynamic Allocation NO COMMENTS





bdDn

Type: reference:BinRef

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



blockAllPorts

Type: comp:ConfigMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
Disabled 1 Disabled NO COMMENTS
Enabled 2 Enabled NO COMMENTS
DEFAULT Disabled(1) Disabled NO COMMENTS





cfgdDelimiter

Type: vmm:DelimiterType
Primitive Type: string:Basic

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



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



encapMode

Type: comp:EncapMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
access 0 Access Mode NO COMMENTS
trunk 1 Trunk Mode NO COMMENTS
private 2 Private Mode NO COMMENTS
DEFAULT access(0) Access Mode NO COMMENTS





encapModeOverride

Type: fv:EncapMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
auto 0 Auto NO COMMENTS
vlan 1 VLAN NO COMMENTS
vxlan 2 VXLAN NO COMMENTS
DEFAULT auto(0) Auto NO COMMENTS





epgCos

Type: fv:EpgCos
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
Cos0 0 Cos0 NO COMMENTS
Cos1 1 Cos1 NO COMMENTS
Cos2 2 Cos2 NO COMMENTS
Cos3 3 Cos3 NO COMMENTS
Cos4 4 Cos4 NO COMMENTS
Cos5 5 Cos5 NO COMMENTS
Cos6 6 Cos6 NO COMMENTS
Cos7 7 Cos7 NO COMMENTS
DEFAULT Cos0(0) Cos0 NO COMMENTS





epgCosPref

Type: fv:EpgCosPref
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
disabled 1 disabled NO COMMENTS
enabled 2 enabled NO COMMENTS
DEFAULT disabled(1) disabled NO COMMENTS





epgPKey

Type: reference:BinRef

Overrides:comp:AEpPD:epgPKey
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming 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:



forgedTransmit

Type: comp:ConfigMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
Disabled 1 Disabled NO COMMENTS
Enabled 2 Enabled NO COMMENTS
DEFAULT Disabled(1) Disabled NO 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





intraSecConf

Type: fv:IntraSec
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
none 0x0 none NO COMMENTS
security 0x1 security NO COMMENTS
DEFAULT none(0x0) none 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-tag-fault 0x1000ull Failed to retrieve all Tag information 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
tagging-cat-fault 0x2000ull Failed to retrieve all Tag Category information 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 0x4000ull Failed to update VM(Virtual Machine) Folder property 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
opflex-channels-down-ave 0x800ull Both the opflex channels are down for AVE. Please check the connections on the host. 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





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
DEFAULT mac-pin(2) mac-pin 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





macChange

Type: comp:ConfigMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
MAC address changes setting
Constants
Disabled 1 Disabled NO COMMENTS
Enabled 2 Enabled NO COMMENTS
DEFAULT Disabled(1) Disabled NO COMMENTS





mcastAddr

Type: address:Ip

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



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: implicit Category: TopLevelRegular
    Comments:
Name



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

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



netflowDir

Type: fv:NetflowDir
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
ingress 1 ingress NO COMMENTS
egress 2 egress NO COMMENTS
both 3 both NO COMMENTS
DEFAULT both(3) both NO COMMENTS





netflowPref

Type: fv:NetflowPref
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
disabled 1 disabled NO COMMENTS
enabled 2 enabled NO COMMENTS
DEFAULT disabled(1) disabled NO COMMENTS





operDelimiter

Type: vmm:DelimiterType
Primitive Type: string:Basic

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



pcEnfPref

Type: fv:PcEnfPref
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The preferred policy control.
Constants
enforced 1 Enforced Enforce access control rules for this private network
unenforced 2 Unenforced Do not enforce access control rules for this private network
DEFAULT unenforced(2) Unenforced Do not enforce access control rules for this private network





primaryEncap

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Represents the primary encap when the encapMode is private



primaryEncapInner

Type: base:Encap

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



promMode

Type: comp:ConfigMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Promiscuous Mode
Constants
Disabled 1 Disabled NO COMMENTS
Enabled 2 Enabled NO COMMENTS
DEFAULT Disabled(1) Disabled NO COMMENTS





remoteErrMsg

Type: string:Basic

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



remoteOperIssues

Type: comp:RemoteOperIssues
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Remote Operational Issues. It captures various remote operational issues not initiated by IFC. It is represented as a bitmask to collect all errors and provide feedback to users.
Constants
none 0x0ull None NO COMMENTS
invalid-permission 0x10000000ull Insufficient permission to create/modify port group NO COMMENTS
netflow-afto-mismatch 0x1000000ull Netflow VMM Exporter Active Flow TimeOut on DVS is different from that in the policy NO COMMENTS
portgroup-netflowpref-changed 0x100000ull Portgroup NetflowPref has been changed on external VMM controller NO COMMENTS
portgroup-forgedtx-changed 0x10000ull Portgroup Forged Transmits security policy has been changed on external VMM controller NO COMMENTS
invalid-portgroup-name 0x1000ull Port group name size is exceeding SCVMM VM Network Name size limit 64 character. NO COMMENTS
lnode-name-mismatch 0x100ull LNode(DVS) name mismatch NO COMMENTS
event-channel-down 0x10ull Event channel from external VMM controller is down. NO COMMENTS
lnode-deleted 0x1ull Lnode(DVS) deleted on external VMM controller NO COMMENTS
netflow-ifto-mismatch 0x2000000ull Netflow VMM Exporter Idle Flow TimeOut on DVS is different from that in the policy NO COMMENTS
netflow-dstaddr-mismatch 0x200000ull Netflow VMM Exporter Destination Address on DVS is different from that in the policy NO COMMENTS
portgroup-pvlan-changed 0x20000ull Portgroup PVLAN encapsulation has been changed on external VMM controller NO COMMENTS
partial-inv 0x2000ull Received partial inventory in the last inventory sync. Please look for Faults under VM and Host and fix them via VCenter, then manually re-trigger inventory sync on APIC NO COMMENTS
vsmgmt-error 0x200ull Vsmgmt port group missing in controller. NO COMMENTS
connection-down 0x20ull Connection to external VMM controller is down. NO COMMENTS
portgroup-encap-changed 0x2ull Portgroup encapsulation has been changed on external VMM controller NO COMMENTS
netflow-sr-mismatch 0x4000000ull Netflow VMM Exporter Sampling Rate on DVS is different from that in the policy NO COMMENTS
netflow-dstport-mismatch 0x400000ull Netflow VMM Exporter Destination Port on DVS is different from that in the policy NO COMMENTS
inv-completed-ex 0x40000ull Last inventory pull did not complete for a few hosts or VMs or no hosts found. Please verify the Hosts and VMs are in connected state in the VMM controller and manually re-trigger inventory sync on APIC. Please ignore this fault if there are no hosts in the VMM controller. NO COMMENTS
portgroup-promiscuous-changed 0x4000ull Portgroup Promiscuous security policy has been changed on external VMM controller NO COMMENTS
ps-error 0x400ull Powershell VMNetwork creation error. NO COMMENTS
mtu-mismatch 0x40ull MTU on DVS is different than the MTU in the policy. NO COMMENTS
portgroup-deleted 0x4ull Portgroup deleted from external VMM controller NO COMMENTS
insufficient-mtu 0x8000000ull Fabric mtu should be greater than 1550 for AVE/AVS VMM domain. NO COMMENTS
netflow-srcaddr-mismatch 0x800000ull Netflow VMM Exporter Source Address on DVS is different from that in the policy NO COMMENTS
opflex-channels-down 0x80000ull Both the opflex channels are down for the host. Please check the connections on the host. NO COMMENTS
portgroup-macchange-changed 0x8000ull Portgroup MAC Changes security policy has been changed on external VMM controller NO COMMENTS
invalid-backing 0x800ull Invalid backing port-group. NO COMMENTS
discovery-protocol-mismatch 0x80ull Discovery Protocol on DVS is different than the one in the policy. NO COMMENTS
invalid-portgroup-exist 0x8ull Invalid or Unknown portgroup exist on external VMM controller NO COMMENTS
DEFAULT none(0x0ull) None 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.



secondaryEncapInner

Type: base:Encap

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



statsCollectionState

Type: comp:StatsCollectionState
Primitive Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A property used to indicate whether statistics collection is enabled
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- 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.






switchingMode

Type: fv:SwitchingModeT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Indicates if the EPG is in AVE (Application Virtual Edge) mode
Constants
native 0 native NO COMMENTS
AVE 1 AVE NO COMMENTS
DEFAULT native(0) native NO COMMENTS





txId

Type: scalar:Uint64

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



type

Type: comp:EpPDType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
EPPD type (tenant or management)
Constants
Mgmt 1 Mgmt NO COMMENTS
Tenant 2 Tenant NO COMMENTS
Services 3 Services NO COMMENTS
DEFAULT Tenant(2) Tenant 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.



vxlanDeplPref

Type: vmm:VxlanDeplPref
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
nsx 0 Do not depoly virutal wire in the controller NO COMMENTS
vxlan 1 Deploy virtual wire in the controller NO COMMENTS
DEFAULT vxlan(1) Deploy virtual wire in the controller NO COMMENTS