< Back
Stop-VMGuest
Post
NAME Stop-VMGuest
SYNOPSIS
This cmdlet shuts down the specified virtual machine guest OS.
SYNTAX
Stop-VMGuest [[-Guest] <VMGuest[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
Stop-VMGuest [[-VM] <VirtualMachine[]>] [[-Server] <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet issues a command to the guest operating system asking it to prepare for a shutdown operation. Returns
immediately and does not wait for the guest operating system to complete the operation.
PARAMETERS
-Guest <VMGuest[]>
Specifies the virtual machine guests you want to shut down.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Server <VIServer[]>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this
parameter, the command runs on the default servers. For more information about default servers, see the
description of Connect-VIServer.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VM <VirtualMachine[]>
Specifies the virtual machines whose operating systems you want to shut down. The virtual machines must have
VMware Tools installed.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more shutdown VMGuest objects
NOTES
-------------------------- Example 1 --------------------------
Get-VM VM | Stop-VMGuest
Shuts down the guest OS of the virtual machine named VM.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... Guest.html
Get-VMGuest
Restart-VMGuest
Suspend-VMGuest
SYNOPSIS
This cmdlet shuts down the specified virtual machine guest OS.
SYNTAX
Stop-VMGuest [[-Guest] <VMGuest[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
Stop-VMGuest [[-VM] <VirtualMachine[]>] [[-Server] <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet issues a command to the guest operating system asking it to prepare for a shutdown operation. Returns
immediately and does not wait for the guest operating system to complete the operation.
PARAMETERS
-Guest <VMGuest[]>
Specifies the virtual machine guests you want to shut down.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Server <VIServer[]>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this
parameter, the command runs on the default servers. For more information about default servers, see the
description of Connect-VIServer.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VM <VirtualMachine[]>
Specifies the virtual machines whose operating systems you want to shut down. The virtual machines must have
VMware Tools installed.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more shutdown VMGuest objects
NOTES
-------------------------- Example 1 --------------------------
Get-VM VM | Stop-VMGuest
Shuts down the guest OS of the virtual machine named VM.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... Guest.html
Get-VMGuest
Restart-VMGuest
Suspend-VMGuest