Stop-CIVMGuest
This cmdlet shuts down the guest operating system of the specified virtual machine.
Syntax
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
VM | CIVM[] | named |
|
Specifies the virtual machine whose guest operating system you want to shut down. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | RunAsync | SwitchParameter | named |
|
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console. |
| optional | Server | CIServer[] | named |
|
Specifies the cloud servers 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-CIServer. |
Output
VMware.VimAutomation.Cloud.Types.V1.CIVMExamples
Example 1
$myVM = Get-CIVM -Name 'MyVM' Stop-CIVMGuest $myVM
Shuts down the guest operating system of the specified virtual machine.
Example 2
$myVM = Get-CIVM -Name 'MyVM' $task = $myVM | Shutdown-CIVM -RunAsync
Shuts down the guest operating system of the specified virtual machine asynchronously.
Related Commands
CIVM
This cmdlet retrieves virtual machines in the cloud.
This cmdlet creates a new cloud virtual machine.
This cmdlet resets the specified virtual machine.
This cmdlet powers on the specified virtual machine.
This cmdlet powers off the specified virtual machine.
This cmdlet suspends the specified virtual machine.
CIVMGuest
This cmdlet restarts the guest operating system of the specified virtual machine.
This cmdlet shuts down the guest operating system of the specified virtual machine.
CIVMTemplate
This cmdlet retrieves the virtual machine templates in the cloud.