# Get-CVBlackoutWindow

The `Get-CVBlackoutWindow` cmdlet returns information about a specific blackout window rule. If you do not specify a parameter, such as Name and Id, this cmdlet returns all blackout window rules that are available 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

    Get-CVBlackoutWindow [-CommcellId $[int32]] [-ClientId $[int32]] [-AppTypeId $[int32]] [-InstanceId $[int32]] [-BackupsetId $[int32]] [-SubclientId $[int32]] [-ClientgroupId $[int32]] [-CompanyId $[int32]] [-SchedulePolicyId $[int32]] [$[CommonParameters]]

    Get-CVBlackoutWindow [-Name $[String]] [-CommcellId $[int32]] [-ClientId $[int32]] [-AppTypeId $[int32]] [-InstanceId$[int32]] [-BackupsetId $[int32]] [-SubclientId $[int32]] [-ClientgroupId $[int32]] [-CompanyId $[int32]] [-SchedulePolicyId $[int32]] [$[CommonParameters]]

    Get-CVBlackoutWindow [-Id $[int32]] [-CommcellId $[int32]] [-ClientId $[int32]] [-AppTypeId $[int32]] [-InstanceId $[int32]] [-BackupsetId $[int32]] [-SubclientId $[int32]] [-ClientgroupId $[int32]] [-CompanyId $[int32]] [-SchedulePolicyId $[int32]] [$[CommonParameters]]

## Optional Parameters

### Commvault Parameters

Parameter | Description | Data type | Values | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter
--- | --- | --- | --- | --- | --- | ---
Name | The name of the blackout window. | String |  | Yes, by: Value Property name | No | Named
Id | The ID of the blackout window. | Int32 | The default value is 0. | Yes, by: Value Property name | No | Named
CommcellId | The ID of the CommCell | Int32 | The default value is 2. | Yes, by: Value Property name | No | Named
`–ClientId` | The ID of the client. | Int32 | The default value is 0. | Yes, by: Value Property name | No | Named
`–AppTypeId` | The ID of the application type. | Int32 | The default value is 0. | Yes, by: Value Property name | No | Named
`–InstanceId` | The ID of the instance. | Int32 | The default value is 0. | Yes, by: Value Property name | No | Named
`–BackupsetId` | The ID of the backup set. | Int32 | The default value is 0. | Yes, by: Value Property name | No | Named
SubclientId | The ID of the subclient. | Int32 | The default value is 0. | Yes, by: Value Property name | No | Named
ClientgroupId | The ID of the server group. | Int32 | The default value is 0. | Yes, by: Value Property name | No | Named
CompanyId | The ID of the company. | Int32 | The default value is 0. | Yes, by: Value Property name | No | Named
SchedulePolicyId | The ID of the schedule policy. | Int32 | The default value is 0. | Yes, by: Value Property name | 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

A PSCustomObject that contains blackout window rules.

## Examples

### Get Properties for a Specific Blackout Window By Name

This example returns information for Newbwrule blackout window rule.

    Get-CVBlackoutWindow -name Newbwrule

### Get Properties of All Blackout Window Rules

This example returns information about all of the blackout window rules that are available in the CommCell environment.

    Get-CVBlackoutWindow

×

Loading...