PowerCLI Reference



This cmdlet modifies the virtual machine start policy.


Set-VMStartPolicy [-StartPolicy] <VMStartPolicy[]> [-InheritStartDelayFromHost] [-InheritStopActionFromHost] [-InheritStopDelayFromHost] [-InheritWaitForHeartbeatFromHost] [-StartAction <VmStartAction>] [-StartDelay <Int32>] [-StartOrder <Int32>] [-StopAction <VmStopAction>] [-StopDelay <Int32>] [-UnspecifiedStartOrder] [-WaitForHeartBeat <Boolean>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet modifies the virtual machine start policy. Start policy defines what happens to virtual machines when the server starts up or stops.


NameTypeDescriptionRequired?Pipeline InputDefault Value
StartPolicyVMStartPolicy[]Specifies the virtual machine start policy you want to modify.trueTrue (ByValue)
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falseFalse
InheritStartDelayFromHostSwitchParameterIndicates that the virtual machine uses the value of the StartDelay parameter of the host.falseFalse
InheritStopActionFromHostSwitchParameterIndicates that the virtual machine uses the value of the StopAction parameter of the host.falseFalse
InheritStopDelayFromHostSwitchParameterIndicates that the virtual machine uses the value of the StopDelay parameter of the host.falseFalse
InheritWaitForHeartbeatFromHostSwitchParameterIndicates that the virtual machine uses the value of the WaitforHeartbeat parameter of the host.falseFalse
StartActionVmStartActionSpecifies a start action for virtual machines. It can be None or PowerOn.falseFalse
StartDelayInt32Specifies a default start delay in seconds.falseFalse
StartOrderInt32Specifies a number to define the virtual machines start order.falseFalse
StopActionVmStopActionSpecifies the default action of the virtual machine when the server stops. The valid values are None, Suspend, PowerOff, and GuestShutDown.falseFalse
StopDelayInt32Specifies the default stop delay in seconds.falseFalse
UnspecifiedStartOrderSwitchParameterIndicates that no order is defined for starting the virtual machines.falseFalse
WaitForHeartBeatBooleanIndicates whether the virtual machine should start after receiving a heartbeat, ignore heartbeats and start after the StartDelay has elapsed ($true), or follow the system default before powering on ($false). When a virtual machine is next in the start order, the system either waits a specified period of time for a virtual machine to power on or it waits until it receives a successful heartbeat from a powered on virtual machine.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

Zero or more modified VMStartPolicy objects



-------------------------- Example 1 --------------------------

$vmstartpolicy = Get-VMStartPolicy -VM VM

Set-VMStartPolicy -StartPolicy $vmstartpolicy -StartAction PowerOn

Retrieves the start policy of the VM virtual machine and defines that when the server starts, the virtual machine is powered on.

-------------------------- Example 2 --------------------------

Get-VM VM | Get-VMStartPolicy | Set-VMStartpolicy -InheritStopActionFromHost -InheritStopDelayFromHost

Reconfigures the start policy of the VM virtual machine to inherit the values of the StopAction and StopDelay from the host.

-------------------------- Example 3 --------------------------

Get-VM VM | Get-VMStartPolicy | Set-VMStartpolicy -StartAction PowerOn -StartOrder 2 -StartDelay 300 -StopAction GuestShutDown -StopDelay 300

Retrieve the start policy of the specified virtual machine and modify its configuration settings.

Copyright © VMware, Inc. All rights reserved.