# Get-CVClient

The `Get-CVClient` cmdlet returns the properties of a specific client. Or, if you do not specify a client name, the cmdlet returns all active clients in the CommCell environment.

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

    Get-CVClient [-Name $[String]] [-AdditionalSettings] [-Version] [-TimeZone] [-AllProperties] [$[CommonParameters]]

    Get-CVClient [-AdditionalSettings] [-Version] [-TimeZone] [-AllProperties] [$[CommonParameters]]

    Get-CVClient [-Id $[int32]] [-AdditionalSettings] [-Version] [-TimeZone] [-AllProperties] [$[CommonParameters]]

## Optional Parameters

### Commvault Parameters

Parameter | Description | Data type | Values | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter
--- | --- | --- | --- | --- | --- | ---
`–Name` | The name of the client | String |  | Yes, by value | Yes | Positional: 1
–`Id` | The ID of the client | Int32 | The default value is 0 | No | No | Named
–`AdditionalSettings` | Includes additional settings information in the output | SwitchParameter |  | No | No | Named
–`Version` | Includes version information, such as software updates and hotfixes, in the output | SwitchParameter |  | No | No | Named
–`TimeZone` | Includes time zone information in the output | SwitchParameter |  | No | No | Named
–`AllProperties` | An object that represents the properties of the client | Object |  | Yes, by value | No | Named

### 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 list of clients in your CommCell environment, or the properties of a specific client.

## Examples

### Get the Properties of a Specific Client

    Get-CVClient -Name myClient

### Get All Active Clients in the CommCell Environment

    Get-CVClient

×

Loading...