Stop-CIVAppGuest

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

Syntax

-VApp  <CIVApp[]>
[-RunAsync]
[-Server  <CIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
VApp
CIVApp[] named
  • pipeline
  • Specifies the vApp whose virtual machine guest operating systems you want to shut down.
    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.CIVApp

    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.

    Related Commands

    Feedback

    Was this page helpful?