The Set-CVBlackoutWindow cmdlet updates the properties of a blackout window rule in 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
Set-CVBlackoutWindow [-Properties] <Object> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]Required Parameters
Parameter | Description | Data type | Values | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter |
|---|---|---|---|---|---|---|
| The properties of a blackout window rule. | Object | None | Yes, by:
| 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 accepts parameters as piped input or command line.
Output
A PSCustomObject that contains the job submission results.
Examples
Update the Name of a Blackout Window Rule
This example updates the name of the blackout window rule to PSTest.
$props = Get-CVBlackoutWindow -name 'PSblackoutwindow'
$props.name = 'PSTest'
$props | Set-CVBlackoutWindowDisable a Blackout Window Rule
This example disables the blackout window rule 7.
$props = Get-CVBlackoutWindow -Id 7
$props.ruleEnabled = $False
$props | Set-CVBlackoutWindowUpdate the Operations of a Blackout Window Rule
This example updates operations for the PSTest blackout window rule.
$props = Get-CVBlackoutWindow -name 'PSTest'
$props.operations = @(2,4)
$props | Set-CVBlackoutWindow