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-connectivity, vmm-policy]
Read Access: [access-connectivity-l2, admin, tenant-epg, vmm-connectivity, 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 ]

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, Relations: comp:RsCtrlrP, comp:RsEpgAggr, comp:RsLocalEpCP, comp:RtEpgAggr,

Containers Hierarchies

top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ fabric:Topology The root for IFC topology.    ├ fabric:Pod A pod.      ├ fabric:Node The root node for the APIC.        ├ ctx:Local The local Context.          ├ ctx:Application The context application.            ├ pol:Uni Represents policy definition/resolution universe.              ├ 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.                ├ 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.                  ├ vmm:UsrCustomAggr  top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ pol:Uni Represents policy definition/resolution universe.    ├ 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.      ├ 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.        ├ vmm:UsrCustomAggr

Contained Hierarchy

vmm:UsrCustomAggr   ├ 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  ├ comp:RsCtrlrP A source relation to the VMM controller profile.    ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.    ├ 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.      ├ 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      ├ tag:Annotation       ├ tag:Tag     ├ health:Inst A base class for a health score instance.(Switch only)  ├ comp:RsEpgAggr   ├ comp:RsLocalEpCP   ├ comp:RtEpgAggr   ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.  ├ 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.    ├ 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    ├ tag:Annotation     ├ tag:Tag   ├ fvns:EncapBlk The VLAN encapsulation block.    ├ 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    ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.    ├ 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.    ├ health:Inst A base class for a health score instance.(Switch only)    ├ tag:AInst The label instance, which is contained by the taggable object.      ├ 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.    ├ tag:Annotation     ├ tag:Tag   ├ health:Inst A base class for a health score instance.(Switch only)  ├ tag:Annotation   ├ tag:Tag

Inheritance

naming:NamedObject An abstract base class for an object that contains a name.  ├ naming:NamedIdentifiedObject An abstract base class for an object that contains a name and ID.    ├ comp:Entity An abstract based class representing a compute entity.      ├ comp:AEpPD An abstraction for the endpoint group policy description. This object is generated and used only by internal process.        ├ comp:AAppEpPD The abstraction of an endpoint group policy description. This is an internal object used by the system.          ├ vmm:AEpPD  Abstract class representing VMM EpPD            ├ vmm:EpgAggr EPG Aggregator Object @@@ This is managed by PolicyMgr              ├ vmm:UsrCustomAggr

                vmm:UsrCustomAggr:creation__vmm_UsrCustomAggr

                vmm:UsrCustomAggr:modification__vmm_UsrCustomAggr

                vmm:UsrCustomAggr:deletion__vmm_UsrCustomAggr

                

                vmm:EpgAggr:deployFailed

                

aggrImedcy

Type: fv:Immediacy
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

NO COMMENTS

allocMode

Type: comp:AllocMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

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_.:-]+

NO COMMENTS

bdDn

Type: reference:BinRef

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

The distinguished name of the bridge domain.

bindingType

Type: fv:BindingType
Primitive Type: scalar:Enum8

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

Binding type for ports

blockAllPorts

Type: comp:ConfigMode
Primitive Type: scalar:Enum8

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

cfgdDelimiter

Type: vmm:DelimiterType
Primitive Type: string:Basic

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

Delimiter Flags

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction

Delete or ignore. For internal use only.

classPref

Type: fv:ClassPref
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Classification Preference

configFlags

Type: comp:EppdFlags
Primitive Type: scalar:Bitmask32

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

NO COMMENTS

crtrnEnabled

Type: scalar:Bool

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

deployIssues

Type: comp:DeployIssues
Primitive Type: scalar:Bitmask64

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

Deployment status of EpPD. It captures various errors in a bitmask to collect all errors and provide feedback to users.

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\\!#$%()*,-./:;@ _{|}~?&+]+

Additional descriptive information about the object.

dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn

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

Domain Name of the EPG aggregator

encap

Type: base:Encap

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

Encapsulation

encapAllocKey

Type: reference:BinRef

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

encap alloc key

encapChanged

Type: scalar:Bool

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

Criterion Enabled

encapCtx

Type: string:Basic

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

encapMode

Type: comp:EncapMode
Primitive Type: scalar:Enum8

Overrides:comp:AAppEpPD:encapMode

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

NO COMMENTS

encapModeOverride

Type: fv:EncapMode
Primitive Type: scalar:Enum8

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

NO COMMENTS

epgCos

Type: fv:EpgCos
Primitive Type: scalar:Enum8

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

NO COMMENTS

epgCosPref

Type: fv:EpgCosPref
Primitive Type: scalar:Enum8

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

NO COMMENTS

epgPKey

Type: reference:BinRef

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

null

eppDn

Type: reference:BinRef

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

EPP Distinguished Name (Dn)

extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

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

NO COMMENTS

faultDKey

Type: reference:BinRef

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

featureFlags

Type: vmm:AggrFlags
Primitive Type: scalar:Bitmask32

Overrides:vmm:EpgAggr:featureFlags

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

NO COMMENTS

forgedTransmit

Type: comp:ConfigMode
Primitive Type: scalar:Enum8

Overrides:comp:AAppEpPD:forgedTransmit

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

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.

id

Type: naming:Id
Primitive Type: scalar:Uint64

Overrides:naming:NamedIdentifiedObject:id

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

ID

idConsumerDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Id Consumer DN used for encap allocation

instrImedcy

Type: fv:InstrImedcy
Primitive Type: scalar:Enum8

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

A property to specify whether policies are applied immediately or when needed.

intraSecConf

Type: fv:IntraSec
Primitive Type: scalar:Bitmask8

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

NO COMMENTS

issues

Type: comp:Issues
Primitive Type: scalar:Bitmask64

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

General Issues It captures various issues happened to the Entity.

lagPolicyName

Type: string:Basic

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

LAG Policy Name

lbAlgo

Type: comp:LbAlgo
Primitive Type: scalar:Enum8

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

LB hash algorithm

lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

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

A value that indicates how this object was created. For internal use only.

macChange

Type: comp:ConfigMode
Primitive Type: scalar:Enum8

Overrides:comp:AAppEpPD:macChange

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

The status of the mac address change support for port groups in an external VMM controller, such as a Vcenter.

mcastAddr

Type: address:Ip

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

Multicast address

modTs

Type: mo:TStamp
Primitive Type: scalar:Date

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

The time when this object was last modified.

monPolDn

Type: reference:BinRef

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

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"

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_.-]+

NO COMMENTS

netflowDir

Type: fv:NetflowDir
Primitive Type: scalar:Enum8

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

NO COMMENTS

netflowPref

Type: fv:NetflowPref
Primitive Type: scalar:Enum8

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

NO COMMENTS

numPorts

Type: scalar:Uint16

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

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

NO COMMENTS

pcEnfPref

Type: fv:PcEnfPref
Primitive Type: scalar:Enum8

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

The preferred policy control.

portAllocation

Type: fv:PortAllocation
Primitive Type: scalar:Enum8

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

Port Allocation type for ports

primaryEncap

Type: base:Encap

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

Represents the primary encap when the encapMode is private

primaryEncapInner

Type: base:Encap

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

NO COMMENTS

promMode

Type: comp:ConfigMode
Primitive Type: scalar:Enum8

Overrides:comp:AAppEpPD:promMode

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

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.

resImedcy

Type: fv:ResImedcy
Primitive Type: scalar:Enum8

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

null

rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn

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

NO COMMENTS

statsCollectionState

Type: comp:StatsCollectionState
Primitive Type: scalar:Bool

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

A property used to indicate whether statistics collection is enabled

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus

The upgrade status. This property is for internal use only.

switchingMode

Type: fv:SwitchingModeT
Primitive Type: scalar:Enum8

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

Indicates if the EPG is in AVE (Application Virtual Edge) mode

txId

Type: scalar:Uint64

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

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

EPPD type (tenant or management)

uid

Type: scalar:Uint16

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

A unique identifier for this object.

untagged

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Untagged Access port

updateTs

Type: scalar:Uint64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

An update timestamp. The time when this instance is updated.