Edit

Share via

Stop-AppvClientPackage

Module:
AppvClient Module

Shuts down virtual environments for specified packages.

Syntax

ByGuid (Default) 

Stop-AppvClientPackage
    [-PackageId] <Guid>
    [-VersionId] <Guid>
    [-Global]
    [<CommonParameters>]

ByPackage 

Stop-AppvClientPackage
    [-Package] <AppvClientPackage>
    [-Global]
    [<CommonParameters>]

ByName 

Stop-AppvClientPackage
    [-Name] <String>
    [[-Version] <String>]
    [-Global]
    [<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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByName
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Package

Specifies an App-V package.

Parameter properties

Type:AppvClientPackage
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByPackage
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByGuid
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByName
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByGuid
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.AppvAgent.AppvClientPackage

Outputs

Microsoft.AppvAgent.AppvClientPackage