## PowerCLI Reference

# Stop-VMGuest

## Synopsis

This cmdlet shuts down the specified virtual machine guest OS.

Syntax

Stop-VMGuest [[-VM] <VirtualMachine[]>] [[-Server] <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Stop-VMGuest [[-Guest] <VMGuest[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-VMGuest
Restart-VMGuest
Suspend-VMGuest

Detailed 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

Name | Type | Description | Required? | Pipeline Input | Default Value
--- | --- | --- | --- | --- | ---
Guest | VMGuest[] | Specifies the virtual machine guests you want to shut down. | false | true (ByValue)
VM | VirtualMachine[] | Specifies the virtual machines whose operating systems you want to shut down. The virtual machines must have VMware Tools installed. | false | true (ByValue)
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. | false | false
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
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 shutdown VMGuest objects

Notes

Examples

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

    Get-VM VM | Stop-VMGuest

Shuts down the guest OS of the virtual machine named VM.

Copyright © VMware, Inc. All rights reserved.