Edit

Share via

Stop-AppvClientPackage

  • Reference
Module:
AppvClient

Shuts down virtual environments for specified packages.

Syntax

Stop-AppvClientPackage
    [-Global]
    [-PackageId] <Guid>
    [-VersionId] <Guid>
    [<CommonParameters>]
Stop-AppvClientPackage
    [-Global]
    [-Package] <AppvClientPackage>
    [<CommonParameters>]
Stop-AppvClientPackage
    [-Global]
    [-Name] <String>
    [[-Version] <String>]
    [<CommonParameters>]

Description

The Stop-AppvClientPackage cmdlet shuts down the virtual environment for the specified packages. All applications and processes within that package are forced to shut down. Any unsaved application data is lost.

Examples

Example 1: Shut down a virtual environment for a version of a package

PS C:\> Stop-AppvClientPackage -Name "MyPackage" -Version 2

This command shuts down the virtual environment of version 2 of package named MyPackage.

Example 2: Shut down a virtual environment for all versions of a package

PS C:\> Get-AppvClientPackage -Name "MyPackage" | Stop-AppvClientPackage

This command gets all versions of the package named MyPackage, and then shuts down the virtual environment for those results.

Parameters

-Global

Specifies that the cmdlet shuts down virtual environments for the specified packages for all users on the computer. Usage of the Global parameter requires administrative credentials.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the friendly name of the package given during Sequencing time. This value is obtained from the package manifest.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Package

Specifies an App-V package.

Type:AppvClientPackage
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PackageId

Specifies a GUID that uniquely identifies the package. It can be found in the package manifest or by opening the package in the Microsoft Application Virtualization (App-V) Sequencer. The package ID is shared by all versions of a package.

Type:Guid
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Version

Specifies the version of an App-V package in a lineage. If you do not specify this parameter, the cmdlet operates on all available versions of the package on the computer.

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VersionId

Specifies a GUID that differentiates a package version from other versions, whether older, newer, or of a different lineage. If you do not specify this parameter, the cmdlet operates on all versions of the package.

Type:Guid
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.AppvAgent.AppvClientPackage

Outputs

Microsoft.AppvAgent.AppvClientPackage