powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-VMHostStartPolicy



NAME
Set-VMHostStartPolicy

SYNOPSIS
Updates the host default start policy.

SYNTAX
Set-VMHostStartPolicy [-VMHostStartPolicy] [-Enabled []] [-StartDelay ] [-Sto
pAction ] [-StopDelay ] [-WaitForHeartBeat []] [-WhatIf] [-Confirm] [ s>]


DESCRIPTION
Updates the host default start policy. Start policy defines what happens to virtual machines when the server starts
up or stops.


PARAMETERS
-VMHostStartPolicy
Specify the host start policy you want to modify.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

-Enabled []
Indicate that the service that controls the host start policies is enabled. If it is enabled, the default start
policies and the start policies of the specified hosts are applied. If disabled, no start policy is applied.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-StartDelay
Specify a default start delay of the virtual machines in seconds.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-StopAction
Specify the default action that is applied to the virtual machines when the server stops. The valid values are
None, Suspend, PowerOff, or GuestShutDown.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-StopDelay
Specify a default stop delay of the virtual machines in seconds.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WaitForHeartBeat []
Specify whether the virtual machines should start after receiving a heartbeat from the host, 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 hos
t to power on or it waits until it receives a successful heartbeat from a powered-on host.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm
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.

Required? false
Position? named
Default value $true
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
VMHostStartPolicy


NOTES




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

C:\PS>Get-VMHost Host | Get-VMHostStartPolicy | Set-VMHostStartPolicy -Enabled:$true -StartOrder 2 -StartDelay 300
-StopAction GuestShutDown -StopDelay 300


Retrieves the start policy of the Host host and modifies its configuration settings.





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

C:\PS>Get-VMHost Host | Get-VMHostStartPolicy | Set-VMHostStartPolicy -WaitForHeartbeat


Retrieves the start policy of the Host host and modifies its configuration settings, so that virtual machines on th
e specified host wait for the host heartbeat.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Set-VMHostStartPolicy.html
Get-VMHostStartPolicy