Disable-Appv Client Connection Group

Module:
appvclient
Disables a connection group on the computer running the App-V client.

Syntax 

Disable-AppvClientConnectionGroup
       [-Global]
       [-UserSID <String>]
       [-GroupId] <Guid>
       [-VersionId] <Guid>
       [<CommonParameters>]
Disable-AppvClientConnectionGroup
       [-Global]
       [-UserSID <String>]
       [-Name] <String>
       [<CommonParameters>]
Disable-AppvClientConnectionGroup
       [-Global]
       [-UserSID <String>]
       [-ConnectionGroup] <AppvClientConnectionGroup>
       [<CommonParameters>]

Description

The Disable-AppvClientConnectionGroup cmdlet disables an already existing connection group on the computer that runs the Microsoft Application Virtualization (App-V) client.

Examples

Example 1: Disable a connection group by using its name 

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

This command disables the connection group named MyGroup.

Example 2: Disable a connection group by using its ID 

PS C:\> Disable-AppvClientConnectionGroup -GroupID 35ec9e5f-ab21-463f-8fe6-b90d4b66d182

This command disables the connection group that has the group ID 35ec9e5f-ab21-463f-8fe6-b90d4b66d182.

Example 3: Disable all connection groups by names that match a string 

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

This command gets all the connection groups that have the string MyGr in the name, and then disables them.

Required Parameters

-ConnectionGroup

Specifies an App-V Connection Group object.

Type: AppvClientConnectionGroup
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-GroupId

Specifies the GUID associated with a specific connection group.

Type: Guid
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name

Specifies the name of the App-V connection group.

Type: String
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VersionId

Specifies a GUID that differentiates the connection group version from other versions. If you do not specify this parameter, the cmdlet operates on all versions of the connection group.

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

Optional Parameters

-Global

Indicates that this cmdlet disables the connection group is disabled for all users that log into the target computer. Otherwise, it disables the connection group only for the currently running user.

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

Specifies the SID of the intended user, in the form of S-1-2-34-56789012-3456789012-345678901-2345. This parameter requires elevated rights to run.

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

Inputs

Microsoft.AppvAgent.AppvClientConnectionGroup

Notes

  • The cmdlet checks that you have permissions to perform the specific action. If not, the cmdlet returns the following error: The action could not be performed due to current App-V permissions. Please modify the permissions and try the operation again.
  • If the disable operation fails, the cmdlet returns the following error: The disable operation could not be completed. An error code is returned.
  • If any package in the specified group is running, the connection group will not be disabled until all packages in the new group are shutdown. The cmdlet will still return success as long as the file is valid.
  • If the cmdlet cannot find the connection group, the cmdlet returns the following error: The specified connection group could not be found on the target system.