Loading...

Remove-CVBlackoutWindow

The Remove-CVBlackoutWindow cmdlet removes a blackout window rule from the 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

Remove-CVBlackoutWindow [-Id] <Int32> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

Required Parameters

Parameter

Description

Data type

Values

Accepts pipeline input?

Accepts wildcard characters?

Type of parameter

–Id

The ID of the blackout window rule.

Int32

The default value is 0.

Yes, by:

  • Value
  • Property name

No

Positional: 1

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 PSCustomObject that contains the job submission results with a message that indicates whether the blackout window rule was removed successfully.

Example

This example removes the blackout window rule 42 from the CommCell environment.

Remove-CVBlackoutWindow -Id 42

Last modified: 8/28/2020 4:16:59 AM