Stop-VMGuest
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.
Syntax
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional | Server | VIServer[] | 1 |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | VM | VirtualMachine[] | named |
|
Specifies the virtual machines whose operating systems you want to shut down. The virtual machines must have VMware Tools installed. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional | Guest | VMGuest[] | named |
|
Specifies the virtual machine guests you want to shut down. |
| optional | ProgressAction | ActionPreference | named |
|
Output
VMware.VimAutomation.ViCore.Types.V1.VM.Guest.VMGuestExamples
Example 1
Get-VM VM | Stop-VMGuest
Shuts down the guest OS of the virtual machine named VM.
Related Commands
VM
This cmdlet retrieves the virtual machines on a vCenter Server system.
This cmdlet moves virtual machines to another location.
This cmdlet creates a new virtual machine.
This cmdlet removes the specified virtual machines from the vCenter Server system.
This cmdlet restarts the specified virtual machines.
This cmdlet modifies the configuration of the virtual machine.
This cmdlet powers on virtual machines.
This cmdlet powers off virtual machines.
This cmdlet suspends virtual machines.
This cmdlet unlocks the specified virtual machine.
VMConsoleWindow
This cmdlet opens a window to the virtual machine's console.
VMGuest
This cmdlet retrieves the guest operating systems of the specified virtual machines.
This cmdlet restarts the virtual machine guest operating systems.
This cmdlet shuts down the specified virtual machine guest OS.
This cmdlet suspends the specified guest operating systems.
VMGuestDisk
This cmdlet retrieves storage volumes as seen by the virtual machines' guest operating systems.
VMGuestFile
This cmdlet copies files and folders from and to the guest OS of the specified virtual machines using VMware Tools.
VMQuestion
This cmdlet retrieves the pending questions for the specified virtual machines.
This cmdlet answers the specified virtual machine question.
VMResourceConfiguration
This cmdlet retrieves information about the resource allocation between the selected virtual machines.
This cmdlet configures resource allocation between the virtual machines.
VMScript
This cmdlet runs a script in the guest OS of each of the specified virtual machines.
VMStartPolicy
This cmdlet retrieves the start policy of the virtual machines on a vCenter Server system.
This cmdlet modifies the virtual machine start policy.