Set-VirtualMachineStartPolicy

VMware: Modifies the virtual machine start policy

Script

#Requires -Version 5.1
#Requires -Modules VMware.VimAutomation.Core
[CmdletBinding(DefaultParameterSetName = "byName")]
Param(
    [Parameter(Mandatory = $true, ParameterSetName = "byID")]
    [Parameter(Mandatory = $true, ParameterSetName = "byName")]
    [string]$VIServer,
    [Parameter(Mandatory = $true, ParameterSetName = "byID")]
    [Parameter(Mandatory = $true, ParameterSetName = "byName")]
    [pscredential]$VICredential,
    [Parameter(Mandatory = $true, ParameterSetName = "byID")]
    [string]$VMId,
    [Parameter(Mandatory = $true, ParameterSetName = "byName")]
    [string]$VMName,
    [Parameter(ParameterSetName = "byID")]
    [Parameter(ParameterSetName = "byName")]
    [ValidateSet("None", "PowerOn")]
    [string]$StartAction = "None",
    [Parameter(ParameterSetName = "byID")]
    [Parameter(ParameterSetName = "byName")]
    [int32]$StartDelay,
    [Parameter(ParameterSetName = "byID")]
    [Parameter(ParameterSetName = "byName")]
    [int32]$StartOrder,
    [Parameter(ParameterSetName = "byID")]
    [Parameter(ParameterSetName = "byName")]
    [ValidateSet("None", "Suspend", "PowerOff", "GuestShutdown")]
    [string]$StopAction = "None",
    [Parameter(ParameterSetName = "byID")]
    [Parameter(ParameterSetName = "byName")]
    [int32]$StopDelay,
    [Parameter(ParameterSetName = "byID")]
    [Parameter(ParameterSetName = "byName")]
    [switch]$InheritStartDelayFromHost,
    [Parameter(ParameterSetName = "byID")]
    [Parameter(ParameterSetName = "byName")]
    [switch]$InheritStopActionFromHost,
    [Parameter(ParameterSetName = "byID")]
    [Parameter(ParameterSetName = "byName")]
    [switch]$InheritStopDelayFromHost,
    [Parameter(ParameterSetName = "byID")]
    [Parameter(ParameterSetName = "byName")]
    [switch]$InheritWaitForHeartbeatFromHost,
    [Parameter(ParameterSetName = "byID")]
    [Parameter(ParameterSetName = "byName")]
    [switch]$UnspecifiedStartOrder,
    [Parameter(ParameterSetName = "byID")]
    [Parameter(ParameterSetName = "byName")]
    [switch]$WaitForHeartBeat
)
Process {
    $vmServer = $null
    try {
        [string[]]$Properties = @('VirtualMachineName', 'StartAction', 'StartDelay', 'StopAction', 'StopDelay', 'IsStartDelayInherited', 'IsStopActionInherited', 'IsStopDelayInherited', 'IsWaitForHeartbeatInherited')
        $vmServer = Connect-VIServer -Server $VIServer -Credential $VICredential -ErrorAction Stop
        $timestamp = Get-Date -Format "yyyy-MM-dd HH:mm:ss"
        if ($PSCmdlet.ParameterSetName -eq "byID") {
            $machine = Get-VM -Server $vmServer -Id $VMId -ErrorAction Stop
        }
        else {
            $machine = Get-VM -Server $vmServer -Name $VMName -ErrorAction Stop
        }
        $poli = Get-VMStartPolicy -Server $vmServer -VM $machine -ErrorAction Stop
        $cmdArgs = @{ ErrorAction = 'Stop'; StartPolicy = $poli; Confirm = $false }
        if ($StartDelay -gt 0) { $null = Set-VMStartPolicy @cmdArgs -StartDelay $StartDelay }
        if ($StopDelay -gt 0) { $null = Set-VMStartPolicy @cmdArgs -StopDelay $StopDelay }
        if ($StartOrder -gt 0) { $null = Set-VMStartPolicy @cmdArgs -StartOrder $StartOrder }
        if ($PSBoundParameters.ContainsKey('StartAction')) { $null = Set-VMStartPolicy @cmdArgs -StartAction $StartAction }
        if ($PSBoundParameters.ContainsKey('StopAction')) { $null = Set-VMStartPolicy @cmdArgs -StopAction $StopAction }
        if ($PSBoundParameters.ContainsKey('UnspecifiedStartOrder')) { $null = Set-VMStartPolicy @cmdArgs -UnspecifiedStartOrder:$UnspecifiedStartOrder }
        if ($PSBoundParameters.ContainsKey('WaitForHeartBeat')) { $null = Set-VMStartPolicy @cmdArgs -WaitForHeartBeat $WaitForHeartBeat }
        if ($PSBoundParameters.ContainsKey('InheritStartDelayFromHost')) { $null = Set-VMStartPolicy @cmdArgs -InheritStartDelayFromHost:$InheritStartDelayFromHost }
        if ($PSBoundParameters.ContainsKey('InheritStopActionFromHost')) { $null = Set-VMStartPolicy @cmdArgs -InheritStopActionFromHost:$InheritStopActionFromHost }
        if ($PSBoundParameters.ContainsKey('InheritStopDelayFromHost')) { $null = Set-VMStartPolicy @cmdArgs -InheritStopDelayFromHost:$InheritStopDelayFromHost }
        if ($PSBoundParameters.ContainsKey('InheritWaitForHeartbeatFromHost')) { $null = Set-VMStartPolicy @cmdArgs -InheritWaitForHeartbeatFromHost:$InheritWaitForHeartbeatFromHost }
        $result = Get-VMStartPolicy -Server $vmServer -VM $machine -ErrorAction Stop | Select-Object $Properties
        foreach ($item in $result) {
            $item | Add-Member -NotePropertyName 'Timestamp' -NotePropertyValue $timestamp -Force
            Write-Output $item
        }
    }
    catch { throw }
    finally { if ($null -ne $vmServer) { Disconnect-VIServer -Server $vmServer -Force -Confirm:$false -ErrorAction SilentlyContinue } }
}

Customize

VIServer string

IP address or DNS name of the vSphere server

VICredential pscredential

PSCredential object for authenticating with the server

VMId string

ID of the virtual machine

VMName string

Name of the virtual machine

StartAction string

VM start action: None or PowerOn

StartDelay int32

Default start delay in seconds

StartOrder int32

Number defining the VM start order

StopAction string

Default stop action: None, Suspend, PowerOff, or GuestShutdown

StopDelay int32

Default stop delay in seconds

InheritStartDelayFromHost switch

Off

Inherit start delay from the host

InheritStopActionFromHost switch

Off

Inherit stop action from the host

InheritStopDelayFromHost switch

Off

Inherit stop delay from the host

InheritWaitForHeartbeatFromHost switch

Off

Inherit wait for heartbeat from the host

UnspecifiedStartOrder switch

Off

No specific start order defined

WaitForHeartBeat switch

Off

VM should start after receiving a heartbeat