PowerCLI Reference

Stop-CIVAppGuest

Synopsis

This cmdlet shuts down the guest operating systems of all virtual machines in the specified vApp.

Syntax

Stop-CIVAppGuest [-VApp] <CIVApp[]> [-RunAsync] [-Server <CIServer[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Restart-CIVAppGuest

Detailed Description

This cmdlet shuts down the guest operating systems of all virtual machines in the specified vApp.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
VAppCIVApp[]Specifies the vApp whose virtual machine guest operating systems you want to shut down.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 CIVApp objects

Notes

Examples

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

$myVApp = Get-CIVApp -Name 'MyVApp'
Stop-CIVAppGuest $myVApp

Shuts down the guest operating systems of all virtual machines in the specified vApp.

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

$myVApp = Get-CIVApp -Name 'MyVApp'
$task = $myVApp | Stop-CIVAppGuest -RunAsync

Shuts down the guest operating systems of all virtual machines in the specified vApp asynchronously.


Copyright © VMware, Inc. All rights reserved.