PowerCLI Reference

Suspend-CIVM

Synopsis

This cmdlet suspends the specified virtual machine.

Syntax

Suspend-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
Stop-CIVM

Detailed Description

This cmdlet suspends the specified virtual machine.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
VMCIVM[]Specifies the virtual machine you want to suspend.truetrue (ByValue)
ConfirmSwitchParameterIf 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.falsefalse
InformationActionActionPreferencefalsefalse
InformationVariableStringfalsefalse
PipelineVariableStringfalsefalse
RunAsyncSwitchParameterIndicates 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.falsefalse
ServerCIServer[]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.falsefalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

The specified CIVM objects

Notes

Examples

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

Get-CIVM -Name 'MyVM' | Suspend-CIVM

Suspend the specified virtual machine.

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

$task = (Get-CIVM -Name 'MyVM') | Suspend-CIVM -RunAsync

Suspends the specified virtual machine asynchronously.


Copyright © VMware, Inc. All rights reserved.