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 |
|---|---|---|---|---|---|
|
|
The name of the client group. |
String |
No |
No |
Positional: 1 |
|
|
An object that represents the properties of the client group. |
Object |
Yes, by:
|
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.
$prop = @"
{
"description": "client group description",
"clientGroup": {
"clientGroupName": "CG001"
},
"associatedClientsOperationType": 2,
"associatedClients": [
{"clientName": "test001"}
]
}
"@
$propobj = $prop | ConvertFrom-Json
Set-CVClientGroup -Name CG001 -Properties $propobj