1. Packages
  2. vSphere
  3. API Docs
  4. HaVmOverride
vSphere v4.10.2 published on Thursday, Jul 4, 2024 by Pulumi

vsphere.HaVmOverride

Explore with Pulumi AI

vsphere logo
vSphere v4.10.2 published on Thursday, Jul 4, 2024 by Pulumi

    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 string
    The unique name of the resource.
    args HaVmOverrideArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args HaVmOverrideArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HaVmOverrideArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
    });
    
    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"),
    })
    
    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());
    
    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")
    
    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",
    });
    
    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
    

    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

    The HaVmOverride resource accepts the following input properties:

    ComputeClusterId string
    The managed object ID of the cluster.
    VirtualMachineId 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 string
    The managed object ID of the cluster.
    VirtualMachineId 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 String
    The managed object ID of the cluster.
    virtualMachineId 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 string
    The managed object ID of the cluster.
    virtualMachineId 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 str
    The managed object ID of the cluster.
    virtual_machine_id 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 String
    The managed object ID of the cluster.
    virtualMachineId 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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 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 string
    The managed object ID of the virtual machine.
    ComputeClusterId 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 string
    The managed object ID of the virtual machine.
    computeClusterId 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 String
    The managed object ID of the virtual machine.
    computeClusterId 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 string
    The managed object ID of the virtual machine.
    compute_cluster_id 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 str
    The managed object ID of the virtual machine.
    computeClusterId 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 String
    The managed object ID of the virtual machine.

    Package Details

    Repository
    vSphere pulumi/pulumi-vsphere
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vsphere Terraform Provider.
    vsphere logo
    vSphere v4.10.2 published on Thursday, Jul 4, 2024 by Pulumi