Loading...

Set-CVClientGroup

The Set-CVClientGroup cmdlet updates properties for a client group.

Before you can use this cmdlet, you must log on to your CommCell environment using the Connect-CVServer cmdlet. For more information, see Connecting to a CommCell Environment with PowerShell.

Syntax

Set-CVClientGroup [-Name] <String> [-Properties] <Object> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

Required Parameters

Parameter

Description

Data type

Accepts pipeline input?

Accepts wildcard characters?

Type of parameter

-Name

The name of the client group.

String

No

 

No

Positional: 1

-Properties

An object that represents the properties of the client group.

Object

Yes, by:

  • Value
  • Property name

No

Positional: 2

Optional Parameters

Microsoft PowerShell Parameters

You can use the following Microsoft PowerShell parameters:

  • Debug
  • ErrorAction
  • ErrorVariable
  • OutBuffer
  • OutVariable
  • PipelineVariable
  • Verbose
  • WarningAction
  • WarningVariable
  • Force
  • Confirm
  • WhatIf

Note: Only a few cmdlets support Force, Confirm, and WhatIf parameters.

For more information, see "About Common Parameters" in the Microsoft PowerShell documentation.

Input

This cmdlet does not support input.

Output

A PSCustomObject that contains the job submission results.

Example: Update the Properties of a Client Group

The following example updates certain properties (defined in a JSON-formatted $prop object) for a client group.

Set-CVClientGroup -Name myClientGroup -Properties
$prop = @{
   {
      "clientGroupOperationType": Update,
      "clientGroupDetail": {
         "description": "client group description",
         "clientGroup": {
            "clientGroupName": "CG001"
         },
         "associatedClientsOperationType": 3,
         "associatedClients": [
            {"clientName": "test001"},
            {"clientName": "test002"}
         ]
      }
   }
}

Last modified: 3/18/2020 8:33:31 AM