PowerCLI Reference

Stop-CIVM

Synopsis

This cmdlet powers off the specified virtual machine.

Syntax

Stop-CIVM [-VM] <CIVM[]> [-RunAsync] [-Server <CIServer[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-CIVM
Restart-CIVM
Start-CIVM
Suspend-CIVM

Detailed Description

This cmdlet powers off the specified virtual machine.

Parameters

Name	Type	Description	Required?	Pipeline Input
VM	CIVM[]	Specifies the virtual machine you want to power off.	true	true (ByValue)
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
InformationAction	ActionPreference		false	false
InformationVariable	String		false	false
PipelineVariable	String		false	false
RunAsync	SwitchParameter	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.	false	false
Server	CIServer[]	Specifies the cloud servers 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-CIServer.	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

The specified CIVM objects

Notes

Examples

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

$myVM = Get-CIVM -Name 'MyVM'
Stop-CIVM $myVM

Powers off the specified virtual machine.

-------------- Example 2 --------------

$myVM = Get-CIVM -Name 'MyVM'
$task = Stop-CIVM $myVM -RunAsync

Powers off the specified virtual machine asynchronously.