Set-CVClient
The Set-CVClient cmdlet updates properties for a client.
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-CVClient [-Name] <String> [-Properties] <Object> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Required Parameters
Parameter |
Description |
Data type |
Values |
Accepts pipeline input? |
Accepts wildcard characters? |
Type of parameter |
|
The name of the client.
|
String |
|
No |
No |
Named |
|
The ID of the client. |
Int32 |
The default value is 0. |
No |
No |
Named |
|
An object that represents the properties of the client. |
Object |
|
Yes, by:
|
No |
Named |
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 job submission results.
Example
The following example updates properties (defined in a $clientProps object) for a client in your CommCell environment:
- Get the properties of client carbonwincs1:
$clientprops = Get -CVClient -Name carbonwincs1
- Change the client name:
$clientprops.clientName = 'NewClientName'
- Set the properties:
$clientprops | Set-CVClient -Name carbonwincs1
The name of the client is modified from carbonwincs1to NewClientName.
Last modified: 3/18/2020 8:33:38 AM