Syntax
Set-VMStartPolicy [-StartPolicy] <VMStartPolicy[]> [-StartAction <VmStartAction>] [-StartOrder <Int32>] [-InheritStopActionFromHost] [-InheritStopDelayFromHost] [-InheritWaitForHeartbeatFromHost] [-InheritStartDelayFromHost] [-UnspecifiedStartOrder] [-StartDelay <Int32>] [-StopAction <VmStopAction>] [-StopDelay <Int32>] [-WaitForHeartBeat <Boolean>] [-WhatIf] [-Confirm] [<CommonParameters>]Related Commands
Online versionDetailed Description
This cmdlet modifies the virtual machine start policy. Start policy defines what happens to virtual machines when the server starts up or stops.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| StartPolicy | VMStartPolicy[] | Specifies the virtual machine start policy you want to modify. | true | true (ByValue) | |
| Confirm | SwitchParameter | If 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. | false | false | |
| InheritStartDelayFromHost | SwitchParameter | Indicates that the virtual machine uses the value of the StartDelay parameter of the host. | false | false | |
| InheritStopActionFromHost | SwitchParameter | Indicates that the virtual machine uses the value of the StopAction parameter of the host. | false | false | |
| InheritStopDelayFromHost | SwitchParameter | Indicates that the virtual machine uses the value of the StopDelay parameter of the host. | false | false | |
| InheritWaitForHeartbeatFromHost | SwitchParameter | Indicates that the virtual machine uses the value of the WaitforHeartbeat parameter of the host. | false | false | |
| StartAction | VmStartAction | Specifies a start action for virtual machines. It can be None or PowerOn. | false | false | |
| StartDelay | Int32 | Specifies a default start delay in seconds. | false | false | |
| StartOrder | Int32 | Specifies a number to define the virtual machines start order. | false | false | |
| StopAction | VmStopAction | Specifies the default action of the virtual machine when the server stops. The valid values are None, Suspend, PowerOff, and GuestShutDown. | false | false | |
| StopDelay | Int32 | Specifies the default stop delay in seconds. | false | false | |
| UnspecifiedStartOrder | SwitchParameter | Indicates that no order is defined for starting the virtual machines. | false | false | |
| WaitForHeartBeat | Boolean | Indicates 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. | false | false | |
| WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | false |
Return Type
Zero or more modified VMStartPolicy objectsNotes
Examples
-------------- 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.