vSphere PowerCLI Reference

Stop-VApp

Synopsis

Stops vApps.

Syntax

Stop-VApp [-Force] [-VApp] <VApp[]> [-Server <VIServer[]>] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Export-VApp
Get-VApp
Import-VApp
New-VApp
Remove-VApp
Set-VApp
Start-VApp
Move-VApp

Detailed Description

Stops vApps.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
VAppVApp[]Specify the vApp that you want to stop.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$true
ForceSwitchParameterIndicate that the virtual machines are powered off regardless of the auto-start configuration of the vApps.falsefalse
RunAsyncSwitchParameterIndicate 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 vSphere PowerCLI console.falsefalse
ServerVIServer[]Specify the vCenter Server systems 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-VIServer.falsefalse
WhatIfSwitchParameterIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

VApp[]

Notes

Examples

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

Get-VMHost MyVMHost1 | Get-VApp | Stop-VApp

Stops all virtual appliances on the specified host.


Copyright © 1998 - 2012 VMware, Inc. All rights reserved.