> Software > Manage > Integration > Developer Tools > Commvault PowerShell Module > Commvault PowerShell Module Reference > Client

Get-CVSLAReport

The Get-CVSLAReport cmdlet returns information about the service level agreement (SLA) calculation for a specific client or for an entire 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-CVSLAReport [-EmailAddr String] [-Type int32] [-Category int32] [-Status int32] [-AllProperties] [CommonParameters]
Get-CVSLAReport [-ClientName String] [-EmailAddr String] [-Type int32] [-Category int32] [-Status int32] [-AllProperties] [CommonParameters]
Get-CVSLAReport [-ClientId int32] [-EmailAddr String] [-Type int32] [-Category int32] [-Status int32] [-AllProperties] [CommonParameters]
Get-CVSLAReport [-ClientObject Object] [-EmailAddr String] [-Type int32] [-Category int32] [-Status int32] [-AllProperties] [CommonParameters]

Optional Parameters

Commvault Parameters

Parameter

Description

Data type

Values

Accepts pipeline input?

Accepts wildcard characters?

Type of Parameter

–ClientName

The name of the client.

String

No

No

Named

–ClientId

The ID of the client.

Int32

The default value is 0.

No

No

Named

–ClientObject

An object that represents the client.

Object

Yes, by:

  • Value

  • Property name

No

Named

–EmailAddr

The email address to send the report to.

String

No

No

Named

–Status

The SLA status to include in the report.

Int32

Valid values:

  • 0: Any (default)

  • 1: Protected

  • 2: Unprotected

  • 3: Excluded

No

No

named

–Category

The SLA category to include in the report.

Int32

Valid values:

  • 0: Any (default)

  • 1: Protected

  • 2: Failed

  • 3: No job found

  • 4: No schedule

No

No

Named

–Type

The client type to include in the report.

Int32

Valid values:

  • 1: Client (default)

  • 2: Agent

No

No

Named

–AllProperties

Retrieves all properties of the specified SLA report.

SwitchParameter

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

The SLA report.

Examples

Get CommCell-Level SLA Information

The following example returns the SLA information for your CommCell environment.

Get-CVSLAReport

Get SLA Information for a Client

The following example returns the SLA information for a client in your CommCell environment.

Get-CVSLAReport -ClientName myclient
×

Loading...