Loading...

Get-CVSchedulePolicy

The Get-CVSchedulePolicy cmdlet retrieves schedule policies from the CommServe server. You can filter the output by client, subclient, policy name, or policy ID.

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-CVSchedulePolicy [-ScheduleType <Enumerated>] [<CommonParameters>]

Get-CVSchedulePolicy -ClientName <String> -SubclientName <String> [-ScheduleType <Enumerated>] [<CommonParameters>]

Get-CVSchedulePolicy [-Name <String>] [-ScheduleType <Enumerated>] [<CommonParameters>]

Get-CVSchedulePolicy [-Id <Int32>] [-ScheduleType <Enumerated>] [<CommonParameters>]

Required Parameters

Parameter

Description

Data type

Accepts pipeline input?

Accepts wildcard characters?

Type of parameter

–ClientName

The name of the client name to get schedule policies for.

String

No

No

Named

–SubClientName

The name of the subclient to get schedule policies for.

String

No

No

Named

Optional Parameters

Commvault Parameters

Parameter

Description

Data type

Values

Accepts pipeline input?

Accepts wildcard characters?

Type of parameter

Name

The name of the schedule policy.

String

 

No

No

Named

–Id

The ID of the schedule policy.

Int32

The default value is 0.

No

No

Named

–ScheduleType

The schedule type.

String

Valid values:

  • All (default)
  • DataProtection
  • AuxiliaryCopy
  • BackupCopy
  • OfflineContentIndexing
  • DDBVerification
  • ContentIndexing
  • Workflow

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 schedule policy information.

Examples

Get Information About a Specific Schedule Policy

The following example returns information about the AuditDB-3 schedule policy.

Get-CVSchedulePolicy -Name AuditDB-3

Get Information About All Schedule Policies of a Subclient

The following example returns information about the AuditDB schedule policy, which belongs to a client called carbonwincs1.

Get-CVSchedulePolicy -SubclientName AuditDB -ClientName carbonwincs1

Last modified: 3/18/2020 7:44:02 AM