The Get-CVAlert
cmdlet gets a list of the alerts that are configured in your CommCell environment. This cmdlet works with the Microsoft PowerShell paging support. For more information, see About PagingParameters Class in Microsoft PowerShell documentation.
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-CVAlert [-IncludeTotalCount] [-Skip <UInt64>] [-First <Uint64>] [<CommonParameters>]
Optional Parameters
Commvault Parameters
Parameter | Description | Data type | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter |
---|---|---|---|---|---|
– | Displays the number of alerts that are retrieved. | SwitchParameter | No | No | Named |
– | This parameter allows you to skip the first 'x' number of pages from the output and then displays the rest of the pages. | UInt64 | No | No | Named |
– | This parameter allows you to display first 'x' number of records in one page and the remaining records in the next page. | UInt64 | 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
A PSCustomObject that contains alert data.
Examples
List All the Alerts in the CommCell Environment
The following example returns a list of all the alerts in your CommCell environment.
Get-CVAlert
List All the Alerts with Paging Support
The following example returns a list of all the alerts with first 5 alerts in one page, without skipping any page from the output.
Get-CVAlert -First 5 - Skip 0