Esx.Settings.Clusters.Vms.ClusterSolutionSpec

Esx.Settings.Clusters.Vms.ClusterSolutionSpec
Esx.Settings.Clusters.Vms.ClusterSolutionSpec

The Esx.Settings.Clusters.Vms.ClusterSolutionSpec schema contains properties that describe solution configuration only applicable for solutions with deployment type Esx.Settings.Clusters.Vms.DeploymentType.CLUSTER_VM_SET.

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "vm_count": 0,
    "vm_placement_policies": [
        "string"
    ],
    "vm_networks": {
        "vm_networks": "string"
    },
    "vm_datastores": [
        "string"
    ],
    "devices": {},
    "remediation_policy": "string",
    "alternative_vm_specs": [
        {
            "selection_criteria": {
                "selection_type": "string",
                "extra_config_value": "string"
            },
            "devices": {}
        }
    ]
}
integer As int64 As int64
vm_count
Required

The number of instances of the specified VM to be deployed across the cluster.

This property was added in vSphere API 9.0.0.0.

array of string
vm_placement_policies
Optional

VM placement policies to be configured on the VMs.

Possible values:

  • VM_VM_ANTI_AFFINITY: VMs are anti-affined to each other.

For more information see: Esx.Settings.Clusters.Vms.VmPlacementPolicy.

This property was added in vSphere API 9.0.0.0.

If missing or null no VM placement policies are configured.

object
vm_networks
Optional

Networks to be configured on the VMs. The map keys represent the logical network names defined in the OVF descriptor while the map values represent the VM network identifiers.

This property was added in vSphere API 9.0.0.0.

If missing or null no VM networks are configured.

When clients pass a value of this schema as a parameter, the value in the property map must be an identifier for the resource type: Network. When operations return a value of this schema as a response, the value in the property map will be an identifier for the resource type: Network.

array of string
vm_datastores
Optional

Datastores to be configured as a storage of the VMs. The first datastore from the list available in the cluster is used.

This property was added in vSphere API 9.0.0.0.

If missing or null the system automatically selects the datastore. The selection takes into account the other properties of the desired state specification (the provided VM storage policies and VM devices) and the runtime state of the datastores in the cluster. It is required DRS to be enabled on the cluster.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Datastore. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Datastore.

object
devices
Optional

Devices of the VMs not defined in the OVF descriptor.

If {#member vmDatastores} is not set, the devices of the VMs not defined in the OVF descriptor should be provided to {#member devices} and not as part of a VM lifecycle hook (VM reconfiguration). Otherwise, the compatibility of the devices with the selected host and datastore where the VM is deployed needs to be ensured by the client.

  1. For VM initial placement the devices are added to the VM configuration. 2. For the reconfiguration it is checked what devices need to be added, removed, and edited on the existing VMs. NOTE: No VM relocation is executed before the VM reconfiguration.

The supported property of vim.vm.ConfigSpec is vim.vm.ConfigSpec.deviceChange. The supported vim.vm.device.VirtualDeviceSpec.operation is Operation#add. For vim.vm.device.VirtualEthernetCard the unique identifier is vim.vm.device.VirtualDevice#unitNumber. {#member vmNetworks} and {#member devices} are mutually exclusive.

This property was added in vSphere API 9.0.0.0.

If missing or null no additional devices will be added to the VMs.

string
remediation_policy
Optional

Remediation policy to be configured for the deployment units.

Possible values:

  • PARALLEL: Default remediation policy. Entities are remediated in parallel.
  • SEQUENTIAL: Entities are remediated sequentially, one at a time.

For more information see: Esx.Settings.Clusters.Vms.RemediationPolicy.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

if missing or null, defaults to Esx.Settings.Clusters.Vms.RemediationPolicy.PARALLEL.

array of Esx.Settings.Clusters.Vms.AlternativeVmSpec
alternative_vm_specs
Optional

List of Esx.Settings.Clusters.Vms.AlternativeVmSpecs to be applied on the System VMs.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

If missing or null no Esx.Settings.Clusters.Vms.AlternativeVmSpecs will be applied to the System VMs.