Loading...

Disable-CVSchedulePolicy

The Disable-CVSchedulePolicy cmdlet disables schedule policies.

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

Disable-CVSchedulePolicy -Name <String> [<CommonParameters>]

Disable-CVSchedulePolicy -Id <Int32> [<CommonParameters>]

Disable-CVSchedulePolicy -PolicyObject <Object> [<CommonParameters>]

Disable-CVSchedulePolicy -ClientName <String> -SubclientName <String> [<CommonParameters>]

Required 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

–PolicyObject

An object that contains information to identify the schedule policy.

Object

 

Yes, by:

  • Value
  • Property name

No

Named

–ClientName

The name of the client to disable schedule policies for.

String

 

No

No

Named

–SubClientName

The name of the subclient to disable schedule policies for.

String

 

No

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

A message that indicates whether the schedule policy was disabled successfully.

Examples

Disable a Schedule Policy Identified by an ID

This example disables schedule policy 229.

Disable-CVSchedulePolicy -Id 229

Disable a Schedule Policy Associated with a Subclient

This example disables all schedule policies for the AuditDB subclient.

Disable-CVSchedulePolicy -ClientName carbonWinCS1 -SubclientName AuditDB

Last modified: 3/18/2020 7:39:55 AM