Edit

Share via

Stop-AppvClientConnectionGroup

Module:
AppvClient Module

Shuts down the shared virtual environment of a connection group.

Syntax

ByGuid (Default) 

Stop-AppvClientConnectionGroup
    [-GroupId] <Guid>
    [-VersionId] <Guid>
    [-Global]
    [<CommonParameters>]

ByName 

Stop-AppvClientConnectionGroup
    [-Name] <String>
    [-Global]
    [<CommonParameters>]

ByConnectionGroup 

Stop-AppvClientConnectionGroup
    [-ConnectionGroup] <AppvClientConnectionGroup>
    [-Global]
    [<CommonParameters>]

Description

The Stop-AppvClientConnectionGroup cmdlet shuts down the shared virtual environment of a connection group. All running processes in the connection group virtual environment are shutdown.

Examples

Example 1: Stop a virtual environment for a named group

PS C:\> Stop-AppvClientConnectionGroup -Name "MyGroup"

This command stops the virtual environment of the enabled connection group that has the name MyGroup.

Example 2: Stop a virtual environment for a group by using its ID

PS C:\> Stop-AppvClientConnectionGroup -GroupID 793afd37-bd68-4ea1-859a-669f6afd0aa8

This command stops the virtual environment of the enabled connection group that has the group ID 793afd37-bd68-4ea1-859a-669f6afd0aa8.

Example 3: Stop virtual environment for groups with names that match a string

PS C:\> Get-AppvClientConnectionGroup -Name "MyGr*" | Stop-AppvClientConnectionGroup

This command gets all of the enabled connection groups that have the string MyGr in the name, and then stops each of their virtual environments.

Parameters

-ConnectionGroup

Specifies an App-V Connection Group object.

Parameter properties

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

Parameter sets

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

-Global

Indicates that the cmdlet shuts down virtual environments for the specified connection groups 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

-GroupId

Specifies the group ID of a specific connection group.

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

-Name

Specifies the name of the Microsoft Application Virtualization (App-V) connection group.

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

-VersionId

Specifies a GUID that differentiates a connection group 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 connection group.

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.AppvClientConnectionGroup

Notes

  • The cmdlet checks that you have permissions to perform the specific action. If not, the cmdlet returns an error.
  • If the enable operation fails, the cmdlet returns an error.
  • If the cmdlet cannot find the connection group on the target computer, the cmdlet returns an error.