Class vmm:UsrCustomAggr (CONCRETE)

Class ID:10991
Class Label: User Custom End Point Group Aggregator Definition
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [admin, tenant-epg, vmm-policy]
Read Access: [access-connectivity, admin, tenant-epg, vmm-policy]
Creatable/Deletable: yes (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 ]

NO COMMENTS

Naming Rules
RN FORMAT: usrcustomaggr-{name}

    [1] PREFIX=usrcustomaggr- PROPERTY = name




DN FORMAT: 

[1] uni/vmmp-{vendor}/dom-{name}/usrcustomaggr-{name}

                


Diagram

Super Mo: vmm:EpgAggr,
Container Mos: vmm:DomP (deletable:yes),
Contained Mos: aaa:RbacAnnotation, fvns:EncapBlk, tag:Annotation, tag:Tag,
Relations To: vmm:CtrlrP, comp:AAppEpPD, fv:EpCP, lacp:EnhancedLagPol,
Relations: comp:RsCtrlrP, comp:RsEpgAggr, comp:RsLocalEpCP, comp:RtEpgAggr, vmm:RsUsrCustomAggrLagPolAtt,


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] vmm:ProvP The VMM provider profile stores the policies of VMM systems from a particular vendor (VMware or Microsoft). This container is automatically created by the system.
 
 
 
 
 
 
 
 ├
[V] vmm:DomP The VMM domain profile is a policy for grouping VM controllers with similar networking policy requirements. For example, the VM controllers can share VLAN or VXLAN space and application endpoint groups. The APIC communicates with the controller to publish network configurations such as port groups that are then applied to the virtual workloads.
 
 
 
 
 
 
 
 
 ├
[V] vmm:UsrCustomAggr 
[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] vmm:ProvP The VMM provider profile stores the policies of VMM systems from a particular vendor (VMware or Microsoft). This container is automatically created by the system.
 
 
 ├
[V] vmm:DomP The VMM domain profile is a policy for grouping VM controllers with similar networking policy requirements. For example, the VM controllers can share VLAN or VXLAN space and application endpoint groups. The APIC communicates with the controller to publish network configurations such as port groups that are then applied to the virtual workloads.
 
 
 
 ├
[V] vmm:UsrCustomAggr 


Contained Hierarchy
[V] vmm:UsrCustomAggr 
 ├
[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] 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] 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] comp:RsEpgAggr 
 ├
[V] comp:RsLocalEpCP 
 ├
[V] comp:RtEpgAggr 
 ├
[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] 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] fvns:EncapBlk The VLAN encapsulation block.
 
 ├
[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] 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] tag:AInst The label instance, which is contained by the taggable object.
 
 
 ├
[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] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] tag:Annotation 
 ├
[V] tag:Tag 
 ├
[V] vmm:RsUsrCustomAggrLagPolAtt 
 
 ├
[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] 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] 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] tag:Annotation 
 
 ├
[V] tag:Tag 


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] vmm:AEpPD  Abstract class representing VMM EpPD
 
 
 
 
 
 ├
[V] vmm:EpgAggr EPG Aggregator Object @@@ This is managed by PolicyMgr
 
 
 
 
 
 
 ├
[V] vmm:UsrCustomAggr 


Events
                vmm:UsrCustomAggr:creation__vmm_UsrCustomAggr
vmm:UsrCustomAggr:modification__vmm_UsrCustomAggr
vmm:UsrCustomAggr:deletion__vmm_UsrCustomAggr


Faults
                vmm:EpgAggr:deployFailed


Fsms
                


Properties Summary
Defined in: vmm:UsrCustomAggr
mo:Annotation
          string:Basic
annotation  (vmm:UsrCustomAggr:annotation)
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (vmm:UsrCustomAggr:extMngdBy)
           NO COMMENTS
vmm:AggrFlags
          scalar:Bitmask32
featureFlags  (vmm:UsrCustomAggr:featureFlags)
           Overrides:vmm:EpgAggr:featureFlags
           NO COMMENTS
naming:Name
          string:Basic
name  (vmm:UsrCustomAggr:name)
           Overrides:comp:Entity:name | naming:NamedObject:name
           The name of the object.
Defined in: vmm:EpgAggr
fv:Immediacy
          scalar:Enum8
aggrImedcy  (vmm:EpgAggr:aggrImedcy)
           NO COMMENTS
comp:DelimitedString
          string:Basic
domName  (vmm:EpgAggr:domName)
           Domain Name of the EPG aggregator
comp:EncapMode
          scalar:Enum8
encapMode  (vmm:EpgAggr:encapMode)
           Overrides:comp:AAppEpPD:encapMode
           NO COMMENTS
comp:ConfigMode
          scalar:Enum8
forgedTransmit  (vmm:EpgAggr:forgedTransmit)
           Overrides:comp:AAppEpPD:forgedTransmit
           A configuration option that allows virtual machines to send frames with a mac address that is different from the one specified in the virtual-nic adapter configuration.
comp:ConfigMode
          scalar:Enum8
macChange  (vmm:EpgAggr:macChange)
           Overrides:comp:AAppEpPD:macChange
           The status of the mac address change support for port groups in an external VMM controller, such as a Vcenter.
comp:ConfigMode
          scalar:Enum8
promMode  (vmm:EpgAggr:promMode)
           Overrides:comp:AAppEpPD:promMode
           The status of promiscuous mode support status for port groups in an external VMM controller, such as a Vcenter.This needs to be turned on only for service devices in the cloud, not for Enterprise AVE service deployments.
Defined in: comp:AAppEpPD
comp:AllocMode
          scalar:Enum8
allocMode  (comp:AAppEpPD:allocMode)
           NO COMMENTS
fv:BindingType
          scalar:Enum8
bindingType  (comp:AAppEpPD:bindingType)
           Binding type for ports
comp:ConfigMode
          scalar:Enum8
blockAllPorts  (comp:AAppEpPD:blockAllPorts)
          
vmm:DelimiterType
          string:Basic
cfgdDelimiter  (comp:AAppEpPD:cfgdDelimiter)
           Delimiter Flags
string:Basic customEpgName  (comp:AAppEpPD:customEpgName)
           Customized Epg display name that replaces the default t|a|e format
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
fv:IntraSec
          scalar:Bitmask8
intraSecConf  (comp:AAppEpPD:intraSecConf)
           NO COMMENTS
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
scalar:Uint16 numPorts  (comp:AAppEpPD:numPorts)
           The number of ports existing operationally in the module.
vmm:DelimiterType
          string:Basic
operDelimiter  (comp:AAppEpPD:operDelimiter)
           NO COMMENTS
fv:PcEnfPref
          scalar:Enum8
pcEnfPref  (comp:AAppEpPD:pcEnfPref)
           The preferred policy control.
fv:PortAllocation
          scalar:Enum8
portAllocation  (comp:AAppEpPD:portAllocation)
           Port Allocation type for ports
base:Encap primaryEncap  (comp:AAppEpPD:primaryEncap)
           Represents the primary encap when the encapMode is private
base:Encap primaryEncapInner  (comp:AAppEpPD:primaryEncapInner)
           NO COMMENTS
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 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.
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:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
mo:UserDomType
          string:Basic
userdom  (mo:Ownable:userdom)
           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: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

aggrImedcy

Type: fv:Immediacy
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
immediate 1 Immediate NO COMMENTS
lazy 2 On Demand NO COMMENTS
DEFAULT lazy(2) On Demand NO COMMENTS





allocMode

Type: comp:AllocMode
Primitive Type: scalar:Enum8

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





annotation

Type: mo:Annotation
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS



bdDn

Type: reference:BinRef

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



bindingType

Type: fv:BindingType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Binding type for ports
Constants
none 0 Default NO COMMENTS
staticBinding 1 Static Binding NO COMMENTS
dynamicBinding 2 Dynamic Binding NO COMMENTS
ephemeral 3 Ephemeral NO COMMENTS
DEFAULT none(0) Default NO COMMENTS





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





customEpgName

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Customized Epg display name that replaces the default t|a|e format



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
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    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.



domName

Type: comp:DelimitedString
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Domain Name of the EPG aggregator



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

Overrides:comp:AAppEpPD:encapMode
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
none 3 Untagged Access Mode NO COMMENTS
DEFAULT trunk(1) Trunk 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

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)



extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined NO COMMENTS





faultDKey

Type: reference:BinRef

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



featureFlags

Type: vmm:AggrFlags
Primitive Type: scalar:Bitmask32

Overrides:vmm:EpgAggr:featureFlags
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators:
    Comments:
NO COMMENTS
Constants
none 0x0u None NO COMMENTS
skip-encap-validation 0x1u Skip validation of encapsulation blocks NO COMMENTS
skip-rel-to-eppd 0x2u Skip creation of relation to eppd NO COMMENTS
skip-vlan-pool-inheritance 0x4u Skip inheritance of vlan pools NO COMMENTS
defaultValue 0x1u|0x2u|0x4u --- NO COMMENTS





forgedTransmit

Type: comp:ConfigMode
Primitive Type: scalar:Enum8

Overrides:comp:AAppEpPD:forgedTransmit
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators:
    Comments:
A configuration option that allows virtual machines to send frames with a mac address that is different from the one specified in the virtual-nic adapter configuration.
Constants
Disabled 1 Disabled NO COMMENTS
Enabled 2 Enabled NO COMMENTS
DEFAULT Enabled(2) Enabled 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
Property Validators:
    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-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





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

Overrides:comp:AAppEpPD:macChange
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators:
    Comments:
The status of the mac address change support for port groups in an external VMM controller, such as a Vcenter.
Constants
Disabled 1 Disabled NO COMMENTS
Enabled 2 Enabled NO COMMENTS
DEFAULT Enabled(2) Enabled 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:comp:Entity:name  |  naming:NamedObject:name
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular Property Validators: Range: min: "1" max: "128"
    Comments:
The name of the object.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+
    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





numPorts

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The number of ports existing operationally in the module.



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





portAllocation

Type: fv:PortAllocation
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Port Allocation type for ports
Constants
none 0 Default NO COMMENTS
fixed 1 Fixed NO COMMENTS
elastic 2 Elastic NO COMMENTS
DEFAULT none(0) Default NO COMMENTS





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

Overrides:comp:AAppEpPD:promMode
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators:
    Comments:
The status of promiscuous mode support status for port groups in an external VMM controller, such as a Vcenter.This needs to be turned on only for service devices in the cloud, not for Enterprise AVE service deployments.
Constants
Disabled 1 Disabled NO COMMENTS
Enabled 2 Enabled NO COMMENTS
DEFAULT Disabled(1) Disabled 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
L3Out 4 L3Out NO COMMENTS
Uplink 5 Uplink NO COMMENTS
DEFAULT Tenant(2) Tenant NO COMMENTS





uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.



untagged

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    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
Property Validators:
    Comments:
An update timestamp. The time when this instance is updated.



userdom

Type: mo:UserDomType
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS
Constants
defaultValue "all" --- NO COMMENTS