Class vmm:OrchsProvPlan (CONCRETE)

Class ID:5573
Class Label: Orchestrator Plans for this VMMDom
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: [admin, vmm-policy]
Read Access: [admin, 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: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]



Naming Rules
RN FORMAT: plan-{name}

    [1] PREFIX=plan- PROPERTY = name




DN FORMAT: 

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

                


Diagram

Super Mo: naming:NamedObject,
Container Mos: vmm:OrchsProv (deletable:yes),
Contained Mos: vmm:OrchsProvPlanFW, vmm:OrchsProvPlanLB, vmm:OrchsProvPlanSrvc,


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:OrchsProv 
 
 
 
 
 
 
 
 
 
 ├
[V] vmm:OrchsProvPlan 
[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:OrchsProv 
 
 
 
 
 ├
[V] vmm:OrchsProvPlan 


Contained Hierarchy
[V] vmm:OrchsProvPlan 
 ├
[V] vmm:OrchsProvPlanFW 
 ├
[V] vmm:OrchsProvPlanLB 
 ├
[V] vmm:OrchsProvPlanSrvc 


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] vmm:OrchsProvPlan 


Events
                vmm:OrchsProvPlan:creation__vmm_OrchsProvPlan
vmm:OrchsProvPlan:modification__vmm_OrchsProvPlan
vmm:OrchsProvPlan:deletion__vmm_OrchsProvPlan


Faults
                


Fsms
                


Properties Summary
Defined in: vmm:OrchsProvPlan
scalar:Bool creShrdSvc  (vmm:OrchsProvPlan:creShrdSvc)
          
scalar:Bool mapFvTenant  (vmm:OrchsProvPlan:mapFvTenant)
           NO COMMENTS
vmm:WAPCountType
          scalar:Uint32
maxBDAllowed  (vmm:OrchsProvPlan:maxBDAllowed)
           Max BD allowed per tenant
vmm:WAPCountType
          scalar:Uint32
maxCtxAllowed  (vmm:OrchsProvPlan:maxCtxAllowed)
           Max CTX or VRF allowed per tenant
vmm:WAPCountType
          scalar:Uint32
maxEPGAllowed  (vmm:OrchsProvPlan:maxEPGAllowed)
           Max EPG allowed per tenant
vmm:WAPCountType
          scalar:Uint32
maxPublicIPAllowed  (vmm:OrchsProvPlan:maxPublicIPAllowed)
           Max Public IP allowed per tenant
naming:Name
          string:Basic
name  (vmm:OrchsProvPlan:name)
           Overrides:naming:NamedObject:name
           The name of the object.
reference:BinRef sharedBD  (vmm:OrchsProvPlan:sharedBD)
          
reference:BinRef sharedDhcpEpg  (vmm:OrchsProvPlan:sharedDhcpEpg)
          
reference:BinRef sharedDnsEpg  (vmm:OrchsProvPlan:sharedDnsEpg)
          
string:Basic svcRsrcPoolName  (vmm:OrchsProvPlan:svcRsrcPoolName)
           NO COMMENTS
scalar:Bool vpcEnabled  (vmm:OrchsProvPlan:vpcEnabled)
          
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
           Delete or ignore. For internal use only.
reference:BinRef dn  (mo:TopProps:dn)
           A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN rn  (mo:TopProps:rn)
           Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Defined in: mo:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
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:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

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





creShrdSvc

Type: scalar:Bool

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





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.



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





mapFvTenant

Type: scalar:Bool

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





maxBDAllowed

Type: vmm:WAPCountType
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)4000l
    Comments:
Max BD allowed per tenant
Constants
defaultValue 4000u --- NO COMMENTS





maxCtxAllowed

Type: vmm:WAPCountType
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)4000l
    Comments:
Max CTX or VRF allowed per tenant
Constants
defaultValue 4000u --- NO COMMENTS





maxEPGAllowed

Type: vmm:WAPCountType
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)4000l
    Comments:
Max EPG allowed per tenant
Constants
defaultValue 4000u --- NO COMMENTS





maxPublicIPAllowed

Type: vmm:WAPCountType
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)4000l
    Comments:
Max Public IP allowed per tenant
Constants
defaultValue 4000u --- NO COMMENTS





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





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular Property Validators: Range: min: "1" max: "16" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    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



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.



sharedBD

Type: reference:BinRef

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



sharedDhcpEpg

Type: reference:BinRef

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



sharedDnsEpg

Type: reference:BinRef

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






svcRsrcPoolName

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
NO COMMENTS



uid

Type: scalar:Uint16

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



vpcEnabled

Type: scalar:Bool

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