Loading...

Get-CVMediaAgent

The Get-CVMediaAgent cmdlet returns information about the MediaAgents in your CommCell environment.

If you do not provide any parameters, Get-CVMediaAgent returns information about all the 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-CVMediaAgent [-Name <String>] [<CommonParameters>]

Optional Parameters

Commvault Parameters

Parameter

Description

Data type

Accepts pipeline input?

Accepts wildcard characters?

Type of parameter

Name

The name of theMediaAgent.

String

No

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

PSCustomObject objects that contain information about the MediaAgents.

Examples

Get the MediaAgents in the CommCell Environment

The following example returns all the MediaAgents in your CommCell environment.

Get-CVMediaAgent

Get Information About a MediaAgent in the CommCell Environment

The following example returns information about a specific MediaAgent in your CommCell environment.

Get-CVMediaAgent -Name myMA

Last modified: 3/18/2020 7:43:53 AM