Data Object - VmPlacementPolicy(vim.vm.VmPlacementPolicy)

Property of: VirtualMachineConfigSpec, VirtualMachineRelocateSpec
Extended by: VmToVmGroupsAntiAffinity, VmVmAffinity, VmVmAntiAffinity
Extends: DynamicData
Since: vSphere API Release 9.1.0.0

Data Object Description

Describes the constraints and/or preferences that can influence where a VM needs to be placed.

A VmPlacementPolicy for a VM can be specified in VM's VirtualMachineConfigSpec or VirtualMachineRelocateSpec and that policy will be enforced when that VM's placement decision is made. The placement policies specified via vmPlacementPolicies are enforced whenever a VM with that ConfigSpec needs to be placed for creation or power-on. Similarly, placement policies specified via vmPlacementPolicies are enforced whenever a VM with that RelocateSpec needs to be placed for relocating.

This allows clients to express placement constraints/preferences directly as a part of VirtualMachineConfigSpec or VirtualMachineRelocateSpec instead of requiring the clients to first create separate vCenter constructs for expressing the same constraint/preference. For example, if a VM's VirtualMachineConfigSpec or VirtualMachineRelocateSpec has an affinity or anti-affinity towards other VMs (see VmVmAffinity and VmVmAntiAffinity), then vSphere DRS and vSphere HA can interpret and enforce that desired affinity/anti-affinity without requiring the client to first create a cluster level ClusterAffinityRuleSpec or ClusterAntiAffinityRuleSpec and then associate the VM with it.

Placement policies can be of different types. This base class only defines the common properties that the different types of policies can have. The specific constraints and/or preferences that dictate how exactly a VM's placement can be impacted are described in each sub-type of policy derived from this base VmPlacementPolicy class.

Note: VmPlacementPolicy is only applicable for VMs managed by Supervisor and they will be automatically populated by Supervisor based on the placement constraints defined in Supervisor. These placement policies will be ignored except when set by Supervisor.

Properties

Name	Type	Description
None
Properties inherited from DynamicData
None

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VmPlacementPolicy">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

vSphere Web Services API

Data Object - VmPlacementPolicy(vim.vm.VmPlacementPolicy)

Data Object Description