# Get-CVSubclientMediaAgent

The `Get-CVSubclientMediaAgent` cmdlet returns the subclient MediaAgents in your 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-CVSubclientMediaAgent [-Name $[String]] [-ClientName $[String]] [$[CommonParameters]]

    Get-CVSubclientMediaAgent [-ClientName $[String]] [-Id $[int32]] [$[CommonParameters]]

    Get-CVSubclientMediaAgent [-SubclientObject $[Object]] [$[CommonParameters]]

## Required Parameters

Parameter | Description | Data type | Values | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter
--- | --- | --- | --- | --- | --- | ---
`-Name` | The name of the subclient MediaAgent. | String |  | No | No | Named
`-ClientName` | The name of the subclient. | String |  | No | No | Named
`-Id` | The ID of the subclient. | Int32 | The default value is 0. | No | No | Named
`-SubClientObject` | An object that represents the subclient. | Object |  | Yes, by: Value Property name | 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

PSCustomObject objects that contain information about the MediaAgents.

## Example: Get Information About a MediaAgent That Is Associated with a Specific Subclient

The following example returns information about a MediaAgent that is associated with the default subclient, which is associated with the carbonwincs1 client.

    Get-CVSubclientMediaAgent -Name $[default] -ClientName $[carbonwincs1]

×

Loading...