# Get-CVId

The `Get-CVId` cmdlet retrieves the ID of an entity 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-CVId [-ClientName] $[String] [[-AgentName] $[String]] [[-BackupSetName] $[String]] [[-InstanceName] $[String]] [[-SubclientName] $[String]] [$[CommonParameters]]

## Required Parameters

Parameter | Description | Data type | Values | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter
--- | --- | --- | --- | --- | --- | ---
`-ClientName` | The client name that you want to retrieve the ID for. | String |  | Yes, by: Value Property name | No | Positional:1

## Optional Parameters

### Commvault Parameters

Parameter | Description | Data type | Values | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter
--- | --- | --- | --- | --- | --- | ---
`-AgentName` | The agent name that you want to retrieve the ID for. For example, File System, Active Directory | String |  | Yes, by: Value Property name | No | Positional:2
`–BackupSetName` | The backup set name that you want to retrieve the ID for. | String |  | Yes, by: Value Property name | No | Positional:3
`-InstanceName` | The instance name that you want to retrieve the ID for. | String |  | Yes, by: Value Property name | No | Positional:4
`-SubclientName` | The subclient name that you want to retrieve the ID for. | String |  | Yes, by: Value Property name | No | Positional:5

### 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 ID of the client.

## Example

This example retrieves the ID for the carbonwincs client.

    Get-CVId -Name carbonwincs

×

Loading...