Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vsphere Provider
  3. API Docs
  4. HaVmOverride
vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere

vsphere.HaVmOverride

Explore with Pulumi AI

vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere

The vsphere.HaVmOverride resource can be used to add an override for vSphere HA settings on a cluster for a specific virtual machine. With this resource, one can control specific HA settings so that they are different than the cluster default, accommodating the needs of that specific virtual machine, while not affecting the rest of the cluster.

For more information on vSphere HA, see this page.

NOTE: This resource requires vCenter and is not available on direct ESXi connections.

Example Usage

The example below creates a virtual machine in a cluster using the vsphere.VirtualMachine resource, creating the virtual machine in the cluster looked up by the vsphere.ComputeCluster data source.

Considering a scenario where this virtual machine is of high value to the application or organization for which it does its work, it’s been determined in the event of a host failure, that this should be one of the first virtual machines to be started by vSphere HA during recovery. Hence, it ha_vm_restart_priority has been set to highest, which, assuming that the default restart priority is medium and no other virtual machine has been assigned the highest priority, will mean that this VM will be started before any other virtual machine in the event of host failure.

import * as pulumi from "@pulumi/pulumi";
import * as vsphere from "@pulumi/vsphere";

const datacenter = vsphere.getDatacenter({
    name: "dc-01",
});
const datastore = datacenter.then(datacenter => vsphere.getDatastore({
    name: "datastore1",
    datacenterId: datacenter.id,
}));
const cluster = datacenter.then(datacenter => vsphere.getComputeCluster({
    name: "cluster-01",
    datacenterId: datacenter.id,
}));
const network = datacenter.then(datacenter => vsphere.getNetwork({
    name: "network1",
    datacenterId: datacenter.id,
}));
const vm = new vsphere.VirtualMachine("vm", {
    name: "test",
    resourcePoolId: cluster.then(cluster => cluster.resourcePoolId),
    datastoreId: datastore.then(datastore => datastore.id),
    numCpus: 2,
    memory: 2048,
    guestId: "otherLinux64Guest",
    networkInterfaces: [{
        networkId: network.then(network => network.id),
    }],
    disks: [{
        label: "disk0",
        size: 20,
    }],
});
const haVmOverride = new vsphere.HaVmOverride("ha_vm_override", {
    computeClusterId: cluster.then(cluster => cluster.id),
    virtualMachineId: vm.id,
    haVmRestartPriority: "highest",
});
Copy
import pulumi
import pulumi_vsphere as vsphere

datacenter = vsphere.get_datacenter(name="dc-01")
datastore = vsphere.get_datastore(name="datastore1",
    datacenter_id=datacenter.id)
cluster = vsphere.get_compute_cluster(name="cluster-01",
    datacenter_id=datacenter.id)
network = vsphere.get_network(name="network1",
    datacenter_id=datacenter.id)
vm = vsphere.VirtualMachine("vm",
    name="test",
    resource_pool_id=cluster.resource_pool_id,
    datastore_id=datastore.id,
    num_cpus=2,
    memory=2048,
    guest_id="otherLinux64Guest",
    network_interfaces=[{
        "network_id": network.id,
    }],
    disks=[{
        "label": "disk0",
        "size": 20,
    }])
ha_vm_override = vsphere.HaVmOverride("ha_vm_override",
    compute_cluster_id=cluster.id,
    virtual_machine_id=vm.id,
    ha_vm_restart_priority="highest")
Copy
package main

import (
	"github.com/pulumi/pulumi-vsphere/sdk/v4/go/vsphere"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		datacenter, err := vsphere.LookupDatacenter(ctx, &vsphere.LookupDatacenterArgs{
			Name: pulumi.StringRef("dc-01"),
		}, nil)
		if err != nil {
			return err
		}
		datastore, err := vsphere.GetDatastore(ctx, &vsphere.GetDatastoreArgs{
			Name:         "datastore1",
			DatacenterId: pulumi.StringRef(datacenter.Id),
		}, nil)
		if err != nil {
			return err
		}
		cluster, err := vsphere.LookupComputeCluster(ctx, &vsphere.LookupComputeClusterArgs{
			Name:         "cluster-01",
			DatacenterId: pulumi.StringRef(datacenter.Id),
		}, nil)
		if err != nil {
			return err
		}
		network, err := vsphere.GetNetwork(ctx, &vsphere.GetNetworkArgs{
			Name:         "network1",
			DatacenterId: pulumi.StringRef(datacenter.Id),
		}, nil)
		if err != nil {
			return err
		}
		vm, err := vsphere.NewVirtualMachine(ctx, "vm", &vsphere.VirtualMachineArgs{
			Name:           pulumi.String("test"),
			ResourcePoolId: pulumi.String(cluster.ResourcePoolId),
			DatastoreId:    pulumi.String(datastore.Id),
			NumCpus:        pulumi.Int(2),
			Memory:         pulumi.Int(2048),
			GuestId:        pulumi.String("otherLinux64Guest"),
			NetworkInterfaces: vsphere.VirtualMachineNetworkInterfaceArray{
				&vsphere.VirtualMachineNetworkInterfaceArgs{
					NetworkId: pulumi.String(network.Id),
				},
			},
			Disks: vsphere.VirtualMachineDiskArray{
				&vsphere.VirtualMachineDiskArgs{
					Label: pulumi.String("disk0"),
					Size:  pulumi.Int(20),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = vsphere.NewHaVmOverride(ctx, "ha_vm_override", &vsphere.HaVmOverrideArgs{
			ComputeClusterId:    pulumi.String(cluster.Id),
			VirtualMachineId:    vm.ID(),
			HaVmRestartPriority: pulumi.String("highest"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using VSphere = Pulumi.VSphere;

return await Deployment.RunAsync(() => 
{
    var datacenter = VSphere.GetDatacenter.Invoke(new()
    {
        Name = "dc-01",
    });

    var datastore = VSphere.GetDatastore.Invoke(new()
    {
        Name = "datastore1",
        DatacenterId = datacenter.Apply(getDatacenterResult => getDatacenterResult.Id),
    });

    var cluster = VSphere.GetComputeCluster.Invoke(new()
    {
        Name = "cluster-01",
        DatacenterId = datacenter.Apply(getDatacenterResult => getDatacenterResult.Id),
    });

    var network = VSphere.GetNetwork.Invoke(new()
    {
        Name = "network1",
        DatacenterId = datacenter.Apply(getDatacenterResult => getDatacenterResult.Id),
    });

    var vm = new VSphere.VirtualMachine("vm", new()
    {
        Name = "test",
        ResourcePoolId = cluster.Apply(getComputeClusterResult => getComputeClusterResult.ResourcePoolId),
        DatastoreId = datastore.Apply(getDatastoreResult => getDatastoreResult.Id),
        NumCpus = 2,
        Memory = 2048,
        GuestId = "otherLinux64Guest",
        NetworkInterfaces = new[]
        {
            new VSphere.Inputs.VirtualMachineNetworkInterfaceArgs
            {
                NetworkId = network.Apply(getNetworkResult => getNetworkResult.Id),
            },
        },
        Disks = new[]
        {
            new VSphere.Inputs.VirtualMachineDiskArgs
            {
                Label = "disk0",
                Size = 20,
            },
        },
    });

    var haVmOverride = new VSphere.HaVmOverride("ha_vm_override", new()
    {
        ComputeClusterId = cluster.Apply(getComputeClusterResult => getComputeClusterResult.Id),
        VirtualMachineId = vm.Id,
        HaVmRestartPriority = "highest",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vsphere.VsphereFunctions;
import com.pulumi.vsphere.inputs.GetDatacenterArgs;
import com.pulumi.vsphere.inputs.GetDatastoreArgs;
import com.pulumi.vsphere.inputs.GetComputeClusterArgs;
import com.pulumi.vsphere.inputs.GetNetworkArgs;
import com.pulumi.vsphere.VirtualMachine;
import com.pulumi.vsphere.VirtualMachineArgs;
import com.pulumi.vsphere.inputs.VirtualMachineNetworkInterfaceArgs;
import com.pulumi.vsphere.inputs.VirtualMachineDiskArgs;
import com.pulumi.vsphere.HaVmOverride;
import com.pulumi.vsphere.HaVmOverrideArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var datacenter = VsphereFunctions.getDatacenter(GetDatacenterArgs.builder()
            .name("dc-01")
            .build());

        final var datastore = VsphereFunctions.getDatastore(GetDatastoreArgs.builder()
            .name("datastore1")
            .datacenterId(datacenter.id())
            .build());

        final var cluster = VsphereFunctions.getComputeCluster(GetComputeClusterArgs.builder()
            .name("cluster-01")
            .datacenterId(datacenter.id())
            .build());

        final var network = VsphereFunctions.getNetwork(GetNetworkArgs.builder()
            .name("network1")
            .datacenterId(datacenter.id())
            .build());

        var vm = new VirtualMachine("vm", VirtualMachineArgs.builder()
            .name("test")
            .resourcePoolId(cluster.resourcePoolId())
            .datastoreId(datastore.id())
            .numCpus(2)
            .memory(2048)
            .guestId("otherLinux64Guest")
            .networkInterfaces(VirtualMachineNetworkInterfaceArgs.builder()
                .networkId(network.id())
                .build())
            .disks(VirtualMachineDiskArgs.builder()
                .label("disk0")
                .size(20)
                .build())
            .build());

        var haVmOverride = new HaVmOverride("haVmOverride", HaVmOverrideArgs.builder()
            .computeClusterId(cluster.id())
            .virtualMachineId(vm.id())
            .haVmRestartPriority("highest")
            .build());

    }
}
Copy
resources:
  vm:
    type: vsphere:VirtualMachine
    properties:
      name: test
      resourcePoolId: ${cluster.resourcePoolId}
      datastoreId: ${datastore.id}
      numCpus: 2
      memory: 2048
      guestId: otherLinux64Guest
      networkInterfaces:
        - networkId: ${network.id}
      disks:
        - label: disk0
          size: 20
  haVmOverride:
    type: vsphere:HaVmOverride
    name: ha_vm_override
    properties:
      computeClusterId: ${cluster.id}
      virtualMachineId: ${vm.id}
      haVmRestartPriority: highest
variables:
  datacenter:
    fn::invoke:
      function: vsphere:getDatacenter
      arguments:
        name: dc-01
  datastore:
    fn::invoke:
      function: vsphere:getDatastore
      arguments:
        name: datastore1
        datacenterId: ${datacenter.id}
  cluster:
    fn::invoke:
      function: vsphere:getComputeCluster
      arguments:
        name: cluster-01
        datacenterId: ${datacenter.id}
  network:
    fn::invoke:
      function: vsphere:getNetwork
      arguments:
        name: network1
        datacenterId: ${datacenter.id}
Copy

Create HaVmOverride Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new HaVmOverride(name: string, args: HaVmOverrideArgs, opts?: CustomResourceOptions);
@overload
def HaVmOverride(resource_name: str,
                 args: HaVmOverrideArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def HaVmOverride(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 compute_cluster_id: Optional[str] = None,
                 virtual_machine_id: Optional[str] = None,
                 ha_vm_failure_interval: Optional[int] = None,
                 ha_datastore_apd_response_delay: Optional[int] = None,
                 ha_datastore_pdl_response: Optional[str] = None,
                 ha_host_isolation_response: Optional[str] = None,
                 ha_datastore_apd_response: Optional[str] = None,
                 ha_vm_maximum_failure_window: Optional[int] = None,
                 ha_vm_maximum_resets: Optional[int] = None,
                 ha_vm_minimum_uptime: Optional[int] = None,
                 ha_vm_monitoring: Optional[str] = None,
                 ha_vm_monitoring_use_cluster_defaults: Optional[bool] = None,
                 ha_vm_restart_priority: Optional[str] = None,
                 ha_vm_restart_timeout: Optional[int] = None,
                 ha_datastore_apd_recovery_action: Optional[str] = None)
func NewHaVmOverride(ctx *Context, name string, args HaVmOverrideArgs, opts ...ResourceOption) (*HaVmOverride, error)
public HaVmOverride(string name, HaVmOverrideArgs args, CustomResourceOptions? opts = null)
public HaVmOverride(String name, HaVmOverrideArgs args)
public HaVmOverride(String name, HaVmOverrideArgs args, CustomResourceOptions options)

type: vsphere:HaVmOverride
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. HaVmOverrideArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. HaVmOverrideArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. HaVmOverrideArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. HaVmOverrideArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. HaVmOverrideArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var haVmOverrideResource = new VSphere.HaVmOverride("haVmOverrideResource", new()
{
    ComputeClusterId = "string",
    VirtualMachineId = "string",
    HaVmFailureInterval = 0,
    HaDatastoreApdResponseDelay = 0,
    HaDatastorePdlResponse = "string",
    HaHostIsolationResponse = "string",
    HaDatastoreApdResponse = "string",
    HaVmMaximumFailureWindow = 0,
    HaVmMaximumResets = 0,
    HaVmMinimumUptime = 0,
    HaVmMonitoring = "string",
    HaVmMonitoringUseClusterDefaults = false,
    HaVmRestartPriority = "string",
    HaVmRestartTimeout = 0,
    HaDatastoreApdRecoveryAction = "string",
});
Copy
example, err := vsphere.NewHaVmOverride(ctx, "haVmOverrideResource", &vsphere.HaVmOverrideArgs{
	ComputeClusterId:                 pulumi.String("string"),
	VirtualMachineId:                 pulumi.String("string"),
	HaVmFailureInterval:              pulumi.Int(0),
	HaDatastoreApdResponseDelay:      pulumi.Int(0),
	HaDatastorePdlResponse:           pulumi.String("string"),
	HaHostIsolationResponse:          pulumi.String("string"),
	HaDatastoreApdResponse:           pulumi.String("string"),
	HaVmMaximumFailureWindow:         pulumi.Int(0),
	HaVmMaximumResets:                pulumi.Int(0),
	HaVmMinimumUptime:                pulumi.Int(0),
	HaVmMonitoring:                   pulumi.String("string"),
	HaVmMonitoringUseClusterDefaults: pulumi.Bool(false),
	HaVmRestartPriority:              pulumi.String("string"),
	HaVmRestartTimeout:               pulumi.Int(0),
	HaDatastoreApdRecoveryAction:     pulumi.String("string"),
})
Copy
var haVmOverrideResource = new HaVmOverride("haVmOverrideResource", HaVmOverrideArgs.builder()
    .computeClusterId("string")
    .virtualMachineId("string")
    .haVmFailureInterval(0)
    .haDatastoreApdResponseDelay(0)
    .haDatastorePdlResponse("string")
    .haHostIsolationResponse("string")
    .haDatastoreApdResponse("string")
    .haVmMaximumFailureWindow(0)
    .haVmMaximumResets(0)
    .haVmMinimumUptime(0)
    .haVmMonitoring("string")
    .haVmMonitoringUseClusterDefaults(false)
    .haVmRestartPriority("string")
    .haVmRestartTimeout(0)
    .haDatastoreApdRecoveryAction("string")
    .build());
Copy
ha_vm_override_resource = vsphere.HaVmOverride("haVmOverrideResource",
    compute_cluster_id="string",
    virtual_machine_id="string",
    ha_vm_failure_interval=0,
    ha_datastore_apd_response_delay=0,
    ha_datastore_pdl_response="string",
    ha_host_isolation_response="string",
    ha_datastore_apd_response="string",
    ha_vm_maximum_failure_window=0,
    ha_vm_maximum_resets=0,
    ha_vm_minimum_uptime=0,
    ha_vm_monitoring="string",
    ha_vm_monitoring_use_cluster_defaults=False,
    ha_vm_restart_priority="string",
    ha_vm_restart_timeout=0,
    ha_datastore_apd_recovery_action="string")
Copy
const haVmOverrideResource = new vsphere.HaVmOverride("haVmOverrideResource", {
    computeClusterId: "string",
    virtualMachineId: "string",
    haVmFailureInterval: 0,
    haDatastoreApdResponseDelay: 0,
    haDatastorePdlResponse: "string",
    haHostIsolationResponse: "string",
    haDatastoreApdResponse: "string",
    haVmMaximumFailureWindow: 0,
    haVmMaximumResets: 0,
    haVmMinimumUptime: 0,
    haVmMonitoring: "string",
    haVmMonitoringUseClusterDefaults: false,
    haVmRestartPriority: "string",
    haVmRestartTimeout: 0,
    haDatastoreApdRecoveryAction: "string",
});
Copy
type: vsphere:HaVmOverride
properties:
    computeClusterId: string
    haDatastoreApdRecoveryAction: string
    haDatastoreApdResponse: string
    haDatastoreApdResponseDelay: 0
    haDatastorePdlResponse: string
    haHostIsolationResponse: string
    haVmFailureInterval: 0
    haVmMaximumFailureWindow: 0
    haVmMaximumResets: 0
    haVmMinimumUptime: 0
    haVmMonitoring: string
    haVmMonitoringUseClusterDefaults: false
    haVmRestartPriority: string
    haVmRestartTimeout: 0
    virtualMachineId: string
Copy

HaVmOverride Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The HaVmOverride resource accepts the following input properties:

ComputeClusterId
This property is required.
Changes to this property will trigger replacement.
string
The managed object ID of the cluster.
VirtualMachineId
This property is required.
Changes to this property will trigger replacement.
string
The managed object ID of the virtual machine.
HaDatastoreApdRecoveryAction string
Controls the action to take on this virtual machine if an APD status on an affected datastore clears in the middle of an APD event. Can be one of useClusterDefault, none or reset.
HaDatastoreApdResponse string
Controls the action to take on this virtual machine when the cluster has detected loss to all paths to a relevant datastore. Can be one of clusterDefault, disabled, warning, restartConservative, or restartAggressive.
HaDatastoreApdResponseDelay int
Controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Specify -1 to use the cluster setting.
HaDatastorePdlResponse string
Controls the action to take on this virtual machine when the cluster has detected a permanent device loss to a relevant datastore. Can be one of clusterDefault, disabled, warning, or restartAggressive.
HaHostIsolationResponse string
The action to take on this virtual machine when a host is isolated from the rest of the cluster. Can be one of clusterIsolationResponse, none, powerOff, or shutdown.
HaVmFailureInterval int
If a heartbeat from this virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds.
HaVmMaximumFailureWindow int
The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted.
HaVmMaximumResets int
The maximum number of resets that HA will perform to this virtual machine when responding to a failure event.
HaVmMinimumUptime int
The time, in seconds, that HA waits after powering on this virtual machine before monitoring for heartbeats.
HaVmMonitoring string
The type of virtual machine monitoring to use for this virtual machine. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
HaVmMonitoringUseClusterDefaults bool
Determines whether or not the cluster's default settings or the VM override settings specified in this resource are used for virtual machine monitoring. The default is true (use cluster defaults) - set to false to have overrides take effect.
HaVmRestartPriority string
The restart priority for this virtual machine when vSphere detects a host failure. Can be one of clusterRestartPriority, lowest, low, medium, high, or highest.
HaVmRestartTimeout int
The maximum time, in seconds, that vSphere HA will wait for the virtual machine to be ready. Use -1 to use the cluster default.
ComputeClusterId
This property is required.
Changes to this property will trigger replacement.
string
The managed object ID of the cluster.
VirtualMachineId
This property is required.
Changes to this property will trigger replacement.
string
The managed object ID of the virtual machine.
HaDatastoreApdRecoveryAction string
Controls the action to take on this virtual machine if an APD status on an affected datastore clears in the middle of an APD event. Can be one of useClusterDefault, none or reset.
HaDatastoreApdResponse string
Controls the action to take on this virtual machine when the cluster has detected loss to all paths to a relevant datastore. Can be one of clusterDefault, disabled, warning, restartConservative, or restartAggressive.
HaDatastoreApdResponseDelay int
Controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Specify -1 to use the cluster setting.
HaDatastorePdlResponse string
Controls the action to take on this virtual machine when the cluster has detected a permanent device loss to a relevant datastore. Can be one of clusterDefault, disabled, warning, or restartAggressive.
HaHostIsolationResponse string
The action to take on this virtual machine when a host is isolated from the rest of the cluster. Can be one of clusterIsolationResponse, none, powerOff, or shutdown.
HaVmFailureInterval int
If a heartbeat from this virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds.
HaVmMaximumFailureWindow int
The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted.
HaVmMaximumResets int
The maximum number of resets that HA will perform to this virtual machine when responding to a failure event.
HaVmMinimumUptime int
The time, in seconds, that HA waits after powering on this virtual machine before monitoring for heartbeats.
HaVmMonitoring string
The type of virtual machine monitoring to use for this virtual machine. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
HaVmMonitoringUseClusterDefaults bool
Determines whether or not the cluster's default settings or the VM override settings specified in this resource are used for virtual machine monitoring. The default is true (use cluster defaults) - set to false to have overrides take effect.
HaVmRestartPriority string
The restart priority for this virtual machine when vSphere detects a host failure. Can be one of clusterRestartPriority, lowest, low, medium, high, or highest.
HaVmRestartTimeout int
The maximum time, in seconds, that vSphere HA will wait for the virtual machine to be ready. Use -1 to use the cluster default.
computeClusterId
This property is required.
Changes to this property will trigger replacement.
String
The managed object ID of the cluster.
virtualMachineId
This property is required.
Changes to this property will trigger replacement.
String
The managed object ID of the virtual machine.
haDatastoreApdRecoveryAction String
Controls the action to take on this virtual machine if an APD status on an affected datastore clears in the middle of an APD event. Can be one of useClusterDefault, none or reset.
haDatastoreApdResponse String
Controls the action to take on this virtual machine when the cluster has detected loss to all paths to a relevant datastore. Can be one of clusterDefault, disabled, warning, restartConservative, or restartAggressive.
haDatastoreApdResponseDelay Integer
Controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Specify -1 to use the cluster setting.
haDatastorePdlResponse String
Controls the action to take on this virtual machine when the cluster has detected a permanent device loss to a relevant datastore. Can be one of clusterDefault, disabled, warning, or restartAggressive.
haHostIsolationResponse String
The action to take on this virtual machine when a host is isolated from the rest of the cluster. Can be one of clusterIsolationResponse, none, powerOff, or shutdown.
haVmFailureInterval Integer
If a heartbeat from this virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds.
haVmMaximumFailureWindow Integer
The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted.
haVmMaximumResets Integer
The maximum number of resets that HA will perform to this virtual machine when responding to a failure event.
haVmMinimumUptime Integer
The time, in seconds, that HA waits after powering on this virtual machine before monitoring for heartbeats.
haVmMonitoring String
The type of virtual machine monitoring to use for this virtual machine. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
haVmMonitoringUseClusterDefaults Boolean
Determines whether or not the cluster's default settings or the VM override settings specified in this resource are used for virtual machine monitoring. The default is true (use cluster defaults) - set to false to have overrides take effect.
haVmRestartPriority String
The restart priority for this virtual machine when vSphere detects a host failure. Can be one of clusterRestartPriority, lowest, low, medium, high, or highest.
haVmRestartTimeout Integer
The maximum time, in seconds, that vSphere HA will wait for the virtual machine to be ready. Use -1 to use the cluster default.
computeClusterId
This property is required.
Changes to this property will trigger replacement.
string
The managed object ID of the cluster.
virtualMachineId
This property is required.
Changes to this property will trigger replacement.
string
The managed object ID of the virtual machine.
haDatastoreApdRecoveryAction string
Controls the action to take on this virtual machine if an APD status on an affected datastore clears in the middle of an APD event. Can be one of useClusterDefault, none or reset.
haDatastoreApdResponse string
Controls the action to take on this virtual machine when the cluster has detected loss to all paths to a relevant datastore. Can be one of clusterDefault, disabled, warning, restartConservative, or restartAggressive.
haDatastoreApdResponseDelay number
Controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Specify -1 to use the cluster setting.
haDatastorePdlResponse string
Controls the action to take on this virtual machine when the cluster has detected a permanent device loss to a relevant datastore. Can be one of clusterDefault, disabled, warning, or restartAggressive.
haHostIsolationResponse string
The action to take on this virtual machine when a host is isolated from the rest of the cluster. Can be one of clusterIsolationResponse, none, powerOff, or shutdown.
haVmFailureInterval number
If a heartbeat from this virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds.
haVmMaximumFailureWindow number
The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted.
haVmMaximumResets number
The maximum number of resets that HA will perform to this virtual machine when responding to a failure event.
haVmMinimumUptime number
The time, in seconds, that HA waits after powering on this virtual machine before monitoring for heartbeats.
haVmMonitoring string
The type of virtual machine monitoring to use for this virtual machine. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
haVmMonitoringUseClusterDefaults boolean
Determines whether or not the cluster's default settings or the VM override settings specified in this resource are used for virtual machine monitoring. The default is true (use cluster defaults) - set to false to have overrides take effect.
haVmRestartPriority string
The restart priority for this virtual machine when vSphere detects a host failure. Can be one of clusterRestartPriority, lowest, low, medium, high, or highest.
haVmRestartTimeout number
The maximum time, in seconds, that vSphere HA will wait for the virtual machine to be ready. Use -1 to use the cluster default.
compute_cluster_id
This property is required.
Changes to this property will trigger replacement.
str
The managed object ID of the cluster.
virtual_machine_id
This property is required.
Changes to this property will trigger replacement.
str
The managed object ID of the virtual machine.
ha_datastore_apd_recovery_action str
Controls the action to take on this virtual machine if an APD status on an affected datastore clears in the middle of an APD event. Can be one of useClusterDefault, none or reset.
ha_datastore_apd_response str
Controls the action to take on this virtual machine when the cluster has detected loss to all paths to a relevant datastore. Can be one of clusterDefault, disabled, warning, restartConservative, or restartAggressive.
ha_datastore_apd_response_delay int
Controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Specify -1 to use the cluster setting.
ha_datastore_pdl_response str
Controls the action to take on this virtual machine when the cluster has detected a permanent device loss to a relevant datastore. Can be one of clusterDefault, disabled, warning, or restartAggressive.
ha_host_isolation_response str
The action to take on this virtual machine when a host is isolated from the rest of the cluster. Can be one of clusterIsolationResponse, none, powerOff, or shutdown.
ha_vm_failure_interval int
If a heartbeat from this virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds.
ha_vm_maximum_failure_window int
The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted.
ha_vm_maximum_resets int
The maximum number of resets that HA will perform to this virtual machine when responding to a failure event.
ha_vm_minimum_uptime int
The time, in seconds, that HA waits after powering on this virtual machine before monitoring for heartbeats.
ha_vm_monitoring str
The type of virtual machine monitoring to use for this virtual machine. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
ha_vm_monitoring_use_cluster_defaults bool
Determines whether or not the cluster's default settings or the VM override settings specified in this resource are used for virtual machine monitoring. The default is true (use cluster defaults) - set to false to have overrides take effect.
ha_vm_restart_priority str
The restart priority for this virtual machine when vSphere detects a host failure. Can be one of clusterRestartPriority, lowest, low, medium, high, or highest.
ha_vm_restart_timeout int
The maximum time, in seconds, that vSphere HA will wait for the virtual machine to be ready. Use -1 to use the cluster default.
computeClusterId
This property is required.
Changes to this property will trigger replacement.
String
The managed object ID of the cluster.
virtualMachineId
This property is required.
Changes to this property will trigger replacement.
String
The managed object ID of the virtual machine.
haDatastoreApdRecoveryAction String
Controls the action to take on this virtual machine if an APD status on an affected datastore clears in the middle of an APD event. Can be one of useClusterDefault, none or reset.
haDatastoreApdResponse String
Controls the action to take on this virtual machine when the cluster has detected loss to all paths to a relevant datastore. Can be one of clusterDefault, disabled, warning, restartConservative, or restartAggressive.
haDatastoreApdResponseDelay Number
Controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Specify -1 to use the cluster setting.
haDatastorePdlResponse String
Controls the action to take on this virtual machine when the cluster has detected a permanent device loss to a relevant datastore. Can be one of clusterDefault, disabled, warning, or restartAggressive.
haHostIsolationResponse String
The action to take on this virtual machine when a host is isolated from the rest of the cluster. Can be one of clusterIsolationResponse, none, powerOff, or shutdown.
haVmFailureInterval Number
If a heartbeat from this virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds.
haVmMaximumFailureWindow Number
The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted.
haVmMaximumResets Number
The maximum number of resets that HA will perform to this virtual machine when responding to a failure event.
haVmMinimumUptime Number
The time, in seconds, that HA waits after powering on this virtual machine before monitoring for heartbeats.
haVmMonitoring String
The type of virtual machine monitoring to use for this virtual machine. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
haVmMonitoringUseClusterDefaults Boolean
Determines whether or not the cluster's default settings or the VM override settings specified in this resource are used for virtual machine monitoring. The default is true (use cluster defaults) - set to false to have overrides take effect.
haVmRestartPriority String
The restart priority for this virtual machine when vSphere detects a host failure. Can be one of clusterRestartPriority, lowest, low, medium, high, or highest.
haVmRestartTimeout Number
The maximum time, in seconds, that vSphere HA will wait for the virtual machine to be ready. Use -1 to use the cluster default.

Outputs

All input properties are implicitly available as output properties. Additionally, the HaVmOverride resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing HaVmOverride Resource

Get an existing HaVmOverride resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: HaVmOverrideState, opts?: CustomResourceOptions): HaVmOverride
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compute_cluster_id: Optional[str] = None,
        ha_datastore_apd_recovery_action: Optional[str] = None,
        ha_datastore_apd_response: Optional[str] = None,
        ha_datastore_apd_response_delay: Optional[int] = None,
        ha_datastore_pdl_response: Optional[str] = None,
        ha_host_isolation_response: Optional[str] = None,
        ha_vm_failure_interval: Optional[int] = None,
        ha_vm_maximum_failure_window: Optional[int] = None,
        ha_vm_maximum_resets: Optional[int] = None,
        ha_vm_minimum_uptime: Optional[int] = None,
        ha_vm_monitoring: Optional[str] = None,
        ha_vm_monitoring_use_cluster_defaults: Optional[bool] = None,
        ha_vm_restart_priority: Optional[str] = None,
        ha_vm_restart_timeout: Optional[int] = None,
        virtual_machine_id: Optional[str] = None) -> HaVmOverride
func GetHaVmOverride(ctx *Context, name string, id IDInput, state *HaVmOverrideState, opts ...ResourceOption) (*HaVmOverride, error)
public static HaVmOverride Get(string name, Input<string> id, HaVmOverrideState? state, CustomResourceOptions? opts = null)
public static HaVmOverride get(String name, Output<String> id, HaVmOverrideState state, CustomResourceOptions options)
resources:  _:    type: vsphere:HaVmOverride    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ComputeClusterId Changes to this property will trigger replacement. string
The managed object ID of the cluster.
HaDatastoreApdRecoveryAction string
Controls the action to take on this virtual machine if an APD status on an affected datastore clears in the middle of an APD event. Can be one of useClusterDefault, none or reset.
HaDatastoreApdResponse string
Controls the action to take on this virtual machine when the cluster has detected loss to all paths to a relevant datastore. Can be one of clusterDefault, disabled, warning, restartConservative, or restartAggressive.
HaDatastoreApdResponseDelay int
Controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Specify -1 to use the cluster setting.
HaDatastorePdlResponse string
Controls the action to take on this virtual machine when the cluster has detected a permanent device loss to a relevant datastore. Can be one of clusterDefault, disabled, warning, or restartAggressive.
HaHostIsolationResponse string
The action to take on this virtual machine when a host is isolated from the rest of the cluster. Can be one of clusterIsolationResponse, none, powerOff, or shutdown.
HaVmFailureInterval int
If a heartbeat from this virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds.
HaVmMaximumFailureWindow int
The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted.
HaVmMaximumResets int
The maximum number of resets that HA will perform to this virtual machine when responding to a failure event.
HaVmMinimumUptime int
The time, in seconds, that HA waits after powering on this virtual machine before monitoring for heartbeats.
HaVmMonitoring string
The type of virtual machine monitoring to use for this virtual machine. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
HaVmMonitoringUseClusterDefaults bool
Determines whether or not the cluster's default settings or the VM override settings specified in this resource are used for virtual machine monitoring. The default is true (use cluster defaults) - set to false to have overrides take effect.
HaVmRestartPriority string
The restart priority for this virtual machine when vSphere detects a host failure. Can be one of clusterRestartPriority, lowest, low, medium, high, or highest.
HaVmRestartTimeout int
The maximum time, in seconds, that vSphere HA will wait for the virtual machine to be ready. Use -1 to use the cluster default.
VirtualMachineId Changes to this property will trigger replacement. string
The managed object ID of the virtual machine.
ComputeClusterId Changes to this property will trigger replacement. string
The managed object ID of the cluster.
HaDatastoreApdRecoveryAction string
Controls the action to take on this virtual machine if an APD status on an affected datastore clears in the middle of an APD event. Can be one of useClusterDefault, none or reset.
HaDatastoreApdResponse string
Controls the action to take on this virtual machine when the cluster has detected loss to all paths to a relevant datastore. Can be one of clusterDefault, disabled, warning, restartConservative, or restartAggressive.
HaDatastoreApdResponseDelay int
Controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Specify -1 to use the cluster setting.
HaDatastorePdlResponse string
Controls the action to take on this virtual machine when the cluster has detected a permanent device loss to a relevant datastore. Can be one of clusterDefault, disabled, warning, or restartAggressive.
HaHostIsolationResponse string
The action to take on this virtual machine when a host is isolated from the rest of the cluster. Can be one of clusterIsolationResponse, none, powerOff, or shutdown.
HaVmFailureInterval int
If a heartbeat from this virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds.
HaVmMaximumFailureWindow int
The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted.
HaVmMaximumResets int
The maximum number of resets that HA will perform to this virtual machine when responding to a failure event.
HaVmMinimumUptime int
The time, in seconds, that HA waits after powering on this virtual machine before monitoring for heartbeats.
HaVmMonitoring string
The type of virtual machine monitoring to use for this virtual machine. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
HaVmMonitoringUseClusterDefaults bool
Determines whether or not the cluster's default settings or the VM override settings specified in this resource are used for virtual machine monitoring. The default is true (use cluster defaults) - set to false to have overrides take effect.
HaVmRestartPriority string
The restart priority for this virtual machine when vSphere detects a host failure. Can be one of clusterRestartPriority, lowest, low, medium, high, or highest.
HaVmRestartTimeout int
The maximum time, in seconds, that vSphere HA will wait for the virtual machine to be ready. Use -1 to use the cluster default.
VirtualMachineId Changes to this property will trigger replacement. string
The managed object ID of the virtual machine.
computeClusterId Changes to this property will trigger replacement. String
The managed object ID of the cluster.
haDatastoreApdRecoveryAction String
Controls the action to take on this virtual machine if an APD status on an affected datastore clears in the middle of an APD event. Can be one of useClusterDefault, none or reset.
haDatastoreApdResponse String
Controls the action to take on this virtual machine when the cluster has detected loss to all paths to a relevant datastore. Can be one of clusterDefault, disabled, warning, restartConservative, or restartAggressive.
haDatastoreApdResponseDelay Integer
Controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Specify -1 to use the cluster setting.
haDatastorePdlResponse String
Controls the action to take on this virtual machine when the cluster has detected a permanent device loss to a relevant datastore. Can be one of clusterDefault, disabled, warning, or restartAggressive.
haHostIsolationResponse String
The action to take on this virtual machine when a host is isolated from the rest of the cluster. Can be one of clusterIsolationResponse, none, powerOff, or shutdown.
haVmFailureInterval Integer
If a heartbeat from this virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds.
haVmMaximumFailureWindow Integer
The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted.
haVmMaximumResets Integer
The maximum number of resets that HA will perform to this virtual machine when responding to a failure event.
haVmMinimumUptime Integer
The time, in seconds, that HA waits after powering on this virtual machine before monitoring for heartbeats.
haVmMonitoring String
The type of virtual machine monitoring to use for this virtual machine. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
haVmMonitoringUseClusterDefaults Boolean
Determines whether or not the cluster's default settings or the VM override settings specified in this resource are used for virtual machine monitoring. The default is true (use cluster defaults) - set to false to have overrides take effect.
haVmRestartPriority String
The restart priority for this virtual machine when vSphere detects a host failure. Can be one of clusterRestartPriority, lowest, low, medium, high, or highest.
haVmRestartTimeout Integer
The maximum time, in seconds, that vSphere HA will wait for the virtual machine to be ready. Use -1 to use the cluster default.
virtualMachineId Changes to this property will trigger replacement. String
The managed object ID of the virtual machine.
computeClusterId Changes to this property will trigger replacement. string
The managed object ID of the cluster.
haDatastoreApdRecoveryAction string
Controls the action to take on this virtual machine if an APD status on an affected datastore clears in the middle of an APD event. Can be one of useClusterDefault, none or reset.
haDatastoreApdResponse string
Controls the action to take on this virtual machine when the cluster has detected loss to all paths to a relevant datastore. Can be one of clusterDefault, disabled, warning, restartConservative, or restartAggressive.
haDatastoreApdResponseDelay number
Controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Specify -1 to use the cluster setting.
haDatastorePdlResponse string
Controls the action to take on this virtual machine when the cluster has detected a permanent device loss to a relevant datastore. Can be one of clusterDefault, disabled, warning, or restartAggressive.
haHostIsolationResponse string
The action to take on this virtual machine when a host is isolated from the rest of the cluster. Can be one of clusterIsolationResponse, none, powerOff, or shutdown.
haVmFailureInterval number
If a heartbeat from this virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds.
haVmMaximumFailureWindow number
The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted.
haVmMaximumResets number
The maximum number of resets that HA will perform to this virtual machine when responding to a failure event.
haVmMinimumUptime number
The time, in seconds, that HA waits after powering on this virtual machine before monitoring for heartbeats.
haVmMonitoring string
The type of virtual machine monitoring to use for this virtual machine. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
haVmMonitoringUseClusterDefaults boolean
Determines whether or not the cluster's default settings or the VM override settings specified in this resource are used for virtual machine monitoring. The default is true (use cluster defaults) - set to false to have overrides take effect.
haVmRestartPriority string
The restart priority for this virtual machine when vSphere detects a host failure. Can be one of clusterRestartPriority, lowest, low, medium, high, or highest.
haVmRestartTimeout number
The maximum time, in seconds, that vSphere HA will wait for the virtual machine to be ready. Use -1 to use the cluster default.
virtualMachineId Changes to this property will trigger replacement. string
The managed object ID of the virtual machine.
compute_cluster_id Changes to this property will trigger replacement. str
The managed object ID of the cluster.
ha_datastore_apd_recovery_action str
Controls the action to take on this virtual machine if an APD status on an affected datastore clears in the middle of an APD event. Can be one of useClusterDefault, none or reset.
ha_datastore_apd_response str
Controls the action to take on this virtual machine when the cluster has detected loss to all paths to a relevant datastore. Can be one of clusterDefault, disabled, warning, restartConservative, or restartAggressive.
ha_datastore_apd_response_delay int
Controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Specify -1 to use the cluster setting.
ha_datastore_pdl_response str
Controls the action to take on this virtual machine when the cluster has detected a permanent device loss to a relevant datastore. Can be one of clusterDefault, disabled, warning, or restartAggressive.
ha_host_isolation_response str
The action to take on this virtual machine when a host is isolated from the rest of the cluster. Can be one of clusterIsolationResponse, none, powerOff, or shutdown.
ha_vm_failure_interval int
If a heartbeat from this virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds.
ha_vm_maximum_failure_window int
The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted.
ha_vm_maximum_resets int
The maximum number of resets that HA will perform to this virtual machine when responding to a failure event.
ha_vm_minimum_uptime int
The time, in seconds, that HA waits after powering on this virtual machine before monitoring for heartbeats.
ha_vm_monitoring str
The type of virtual machine monitoring to use for this virtual machine. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
ha_vm_monitoring_use_cluster_defaults bool
Determines whether or not the cluster's default settings or the VM override settings specified in this resource are used for virtual machine monitoring. The default is true (use cluster defaults) - set to false to have overrides take effect.
ha_vm_restart_priority str
The restart priority for this virtual machine when vSphere detects a host failure. Can be one of clusterRestartPriority, lowest, low, medium, high, or highest.
ha_vm_restart_timeout int
The maximum time, in seconds, that vSphere HA will wait for the virtual machine to be ready. Use -1 to use the cluster default.
virtual_machine_id Changes to this property will trigger replacement. str
The managed object ID of the virtual machine.
computeClusterId Changes to this property will trigger replacement. String
The managed object ID of the cluster.
haDatastoreApdRecoveryAction String
Controls the action to take on this virtual machine if an APD status on an affected datastore clears in the middle of an APD event. Can be one of useClusterDefault, none or reset.
haDatastoreApdResponse String
Controls the action to take on this virtual machine when the cluster has detected loss to all paths to a relevant datastore. Can be one of clusterDefault, disabled, warning, restartConservative, or restartAggressive.
haDatastoreApdResponseDelay Number
Controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Specify -1 to use the cluster setting.
haDatastorePdlResponse String
Controls the action to take on this virtual machine when the cluster has detected a permanent device loss to a relevant datastore. Can be one of clusterDefault, disabled, warning, or restartAggressive.
haHostIsolationResponse String
The action to take on this virtual machine when a host is isolated from the rest of the cluster. Can be one of clusterIsolationResponse, none, powerOff, or shutdown.
haVmFailureInterval Number
If a heartbeat from this virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds.
haVmMaximumFailureWindow Number
The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted.
haVmMaximumResets Number
The maximum number of resets that HA will perform to this virtual machine when responding to a failure event.
haVmMinimumUptime Number
The time, in seconds, that HA waits after powering on this virtual machine before monitoring for heartbeats.
haVmMonitoring String
The type of virtual machine monitoring to use for this virtual machine. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
haVmMonitoringUseClusterDefaults Boolean
Determines whether or not the cluster's default settings or the VM override settings specified in this resource are used for virtual machine monitoring. The default is true (use cluster defaults) - set to false to have overrides take effect.
haVmRestartPriority String
The restart priority for this virtual machine when vSphere detects a host failure. Can be one of clusterRestartPriority, lowest, low, medium, high, or highest.
haVmRestartTimeout Number
The maximum time, in seconds, that vSphere HA will wait for the virtual machine to be ready. Use -1 to use the cluster default.
virtualMachineId Changes to this property will trigger replacement. String
The managed object ID of the virtual machine.

Import

An existing override can be imported into this resource by

supplying both the path to the cluster, and the path to the virtual machine, to

pulumi import. If no override exists, an error will be given. An example

is below:

$ pulumi import vsphere:index/haVmOverride:HaVmOverride ha_vm_override \
Copy

‘{“compute_cluster_path”: “/dc1/host/cluster1”, \

“virtual_machine_path”: “/dc1/vm/srv1”}’

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
vSphere pulumi/pulumi-vsphere
License
Apache-2.0
Notes
This Pulumi package is based on the vsphere Terraform Provider.
vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere