powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Shutdown-VMGuest



NAME
Shutdown-VMGuest

SYNOPSIS
Shutdowns the specified virtual machine guest OS.

SYNTAX
Shutdown-VMGuest [[-VM] ] [[-Server] ] [-WhatIf] [-Confirm] []

Shutdown-VMGuest [[-Guest] ] [-WhatIf] [-Confirm] []


DESCRIPTION
Issues a command to the guest operating system asking it to prepare for a shutdown operation. Returns immediately a
nd does not wait for the guest operating system to complete the operation.


PARAMETERS
-VM
Specify the virtual machines whose operating systems you want to shut down. The virtual machines must have VMwa
re Tools installed.

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

-Server
vSphere servers to search for virtual machine names. If not specified, the command will use the server currentl
y specified in the $DefaultVIServer variable.

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

-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

-Guest
Specify the virtual machine guests you want to shut down.

Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue)
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
VMGuest


NOTES




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

C:\PS>Get-VM VM | Shutdown-VMGuest


Shutdowns the guest OS of the virtual machine named VM.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Shutdown-VMGuest.html
Get-VMGuest
Restart-VMGuest
Suspend-VMGuest