Backup Exec Management Command Line Interface Help
Get-BEAlert Cmdlet
Synopsis

Gets active Backup Exec alerts.

Syntax
Get-BEAlert [[-Name] [<String[]>]] [-Category {None | JobWarning | JobSuccess | JobFailure | JobCancellation | CatalogError | SoftwareUpdateInformation | SoftwareUpdateWarning | SoftwareUpdateError | InstallInformation | InstallWarning | GeneralInformation | DatabaseMaintenanceInformation | DatabaseMaintenanceFailure | BackupExecRetrieveUrlUpdateInformation | BackupExecRetrieveUrlUpdateFailure | ArchivingOptionOperationInformation | ArchivingOptionOperationFailure | IdrCopyFailed | IdrFullBackupSuccess | BackupJobContainsNoData | JobCompletedWithExceptions | JobStart | ServiceStart | ServiceStop | DeviceError | DeviceWarning | DeviceInformation | DeviceIntervention | MediaError | MediaWarning | MediaInformation | MediaIntervention | MediaInsert | MediaOverwrite | MediaRemove | LibraryInsert | TapeAlertInformation | TapeAlertWarning | TapeAlertError}] [-Severity {None | Information | Question | Warning | Error}] [<CommonParameters>]

Get-BEAlert -Storage [<BEStorage[]>] [[-Name] [<String[]>]] [-Category {None | JobWarning | JobSuccess | JobFailure | JobCancellation | CatalogError | SoftwareUpdateInformation | SoftwareUpdateWarning | SoftwareUpdateError | InstallInformation | InstallWarning | GeneralInformation | DatabaseMaintenanceInformation | DatabaseMaintenanceFailure | BackupExecRetrieveUrlUpdateInformation | BackupExecRetrieveUrlUpdateFailure | ArchivingOptionOperationInformation | ArchivingOptionOperationFailure | IdrCopyFailed | IdrFullBackupSuccess | BackupJobContainsNoData | JobCompletedWithExceptions | JobStart | ServiceStart | ServiceStop | DeviceError | DeviceWarning | DeviceInformation | DeviceIntervention | MediaError | MediaWarning | MediaInformation | MediaIntervention | MediaInsert | MediaOverwrite | MediaRemove | LibraryInsert | TapeAlertInformation | TapeAlertWarning | TapeAlertError}] [-Severity {None | Information | Question | Warning | Error}] [<CommonParameters>]

Get-BEAlert -Job [<BEJob[]>] [[-Name] [<String[]>]] [-Category {None | JobWarning | JobSuccess | JobFailure | JobCancellation | CatalogError | SoftwareUpdateInformation | SoftwareUpdateWarning | SoftwareUpdateError | InstallInformation | InstallWarning | GeneralInformation | DatabaseMaintenanceInformation | DatabaseMaintenanceFailure | BackupExecRetrieveUrlUpdateInformation | BackupExecRetrieveUrlUpdateFailure | ArchivingOptionOperationInformation | ArchivingOptionOperationFailure | IdrCopyFailed | IdrFullBackupSuccess | BackupJobContainsNoData | JobCompletedWithExceptions | JobStart | ServiceStart | ServiceStop | DeviceError | DeviceWarning | DeviceInformation | DeviceIntervention | MediaError | MediaWarning | MediaInformation | MediaIntervention | MediaInsert | MediaOverwrite | MediaRemove | LibraryInsert | TapeAlertInformation | TapeAlertWarning | TapeAlertError}] [-Severity {None | Information | Question | Warning | Error}] [<CommonParameters>]

Get-BEAlert -AgentServer [<BEAgentServer[]>] [[-Name] [<String[]>]] [-Category {None | JobWarning | JobSuccess | JobFailure | JobCancellation | CatalogError | SoftwareUpdateInformation | SoftwareUpdateWarning | SoftwareUpdateError | InstallInformation | InstallWarning | GeneralInformation | DatabaseMaintenanceInformation | DatabaseMaintenanceFailure | BackupExecRetrieveUrlUpdateInformation | BackupExecRetrieveUrlUpdateFailure | ArchivingOptionOperationInformation | ArchivingOptionOperationFailure | IdrCopyFailed | IdrFullBackupSuccess | BackupJobContainsNoData | JobCompletedWithExceptions | JobStart | ServiceStart | ServiceStop | DeviceError | DeviceWarning | DeviceInformation | DeviceIntervention | MediaError | MediaWarning | MediaInformation | MediaIntervention | MediaInsert | MediaOverwrite | MediaRemove | LibraryInsert | TapeAlertInformation | TapeAlertWarning | TapeAlertError}] [-Severity {None | Information | Question | Warning | Error}] [<CommonParameters>]

Get-BEAlert [-Id] [<Guid[]>] [<CommonParameters>]

Get-BEAlert -InputObject [<BEAlert[]>] [<CommonParameters>]
Description

Gets active Backup Exec alerts.

Without parameters, Get-BEAlert gets all of the active Backup Exec alerts. You can also specify an alert by alert name or alert ID (Guid) or pass a Backup Exec alert object through the pipeline to Get-BEAlert.

Parameters

-Storage <BEStorage[]>

Specifies one or more storage objects to filter the alerts. Enter a variable that contains the objects, or type a command or expression that gets the objects. See Get-BEStorage.


Required true
Position Named
Accepts pipeline input true (ByValue)
Accepts wildcard characters false


-Job <BEJob[]>

Specifies one or more job objects to filter the alerts. Enter a variable that contains the objects, or type a command or expression that gets the objects. See Get-BEJob.


Required true
Position Named
Accepts pipeline input true (ByValue)
Accepts wildcard characters false


-AgentServer <BEAgentServer[]>

Specifies one or more agent server objects to filter the alerts. Enter a variable that contains the objects, or type a command or expression that gets the objects. See Get-BEAgentServer.


Required true
Position Named
Accepts pipeline input true (ByValue)
Accepts wildcard characters false


-Name <String[]>

Specifies one or more alerts by alert name (wildcards accepted). To specify multiple names, use commas to separate the names.


Required false
Position 0
Accepts pipeline input false
Accepts wildcard characters true


-Severity

Specifies one or more severity values to filter the alerts. To specify multiple values, use commas to separate the values.

The valid values are:
None
Information
Question
Warning
Error


Required false
Position Named
Accepts pipeline input false
Accepts wildcard characters false


-Category

Specifies one or more category values to filter the alerts. To specify multiple values, use commas to separate the values.

The valid values are:
None
JobWarning
JobSuccess
JobFailure
JobCancellation
CatalogError
SoftwareUpdateInformation
SoftwareUpdateWarning
SoftwareUpdateError
InstallInformation
InstallWarning
GeneralInformation
DatabaseMaintenanceInformation
DatabaseMaintenanceFailure
BackupExecRetrieveUrlUpdateInformation
BackupExecRetrieveUrlUpdateFailure
ArchivingOptionOperationInformation
ArchivingOptionOperationFailure
IdrCopyFailed
IdrFullBackupSuccess
BackupJobContainsNoData
JobCompletedWithExceptions
JobStart
ServiceStart
ServiceStop
DeviceError
DeviceWarning
DeviceInformation
DeviceIntervention
MediaError
MediaWarning
MediaInformation
MediaIntervention
MediaInsert
MediaOverwrite
MediaRemove
LibraryInsert
TapeAlertInformation
TapeAlertWarning
TapeAlertError


Required false
Position Named
Accepts pipeline input false
Accepts wildcard characters false


-Id <Guid[]>

Specifies one or more alerts by alert ID (Guid). To specify multiple IDs, use commas to separate the IDs.


Required true
Position 0
Accepts pipeline input true (ByValue)
Accepts wildcard characters false


-InputObject <BEAlert[]>

Specifies one or more alert objects. Enter a variable that contains the objects, or type a command or expression that gets the objects.


Required true
Position Named
Accepts pipeline input true (ByValue)
Accepts wildcard characters false


<CommonParameters>

For more information about common parameters, type "Get-Help about_commonparameters".

Input Types
BackupExec.Management.CLI.BEStorage

You can pipe a Backup Exec storage object to filter alerts returned by Get-BEAlert.



BackupExec.Management.CLI.BEJob

You can pipe a Backup Exec job object to filter alerts returned by Get-BEAlert.



BackupExec.Management.CLI.BEAgentServer

You can pipe a Backup Exec agent server object to filter alerts returned by Get-BEAlert.



System.Guid

You can pipe a System.Guid that contains the ID of a Backup Exec alert object to Get-BEAlert.



BackupExec.Management.CLI.BEAlert

You can pipe a Backup Exec alert object to Get-BEAlert.

Return Value
BackupExec.Management.CLI.BEAlert

Get-BEAlert returns objects that represent Backup Exec alerts.

Examples

Example 1

C:\PS> Get-BEAlert

This command gets all of the active Backup Exec alerts.


Example 2
C:\PS> @(Get-BEAlert -Severity Error).Count

This command gets the number of active error alerts.


Example 3
C:\PS> Get-BEAlert -Severity Information | Clear-BEAlert -Response Ok

These commands clear all of the active informational alerts.


Example 4
C:\PS> Get-BEAgentServer myserver.mycompany.com | Get-BEAlert

These commands get all of the active alerts for a computer named "myserver.mycompany.com".


Example 5
C:\PS> Get-BEDiskStorageDevice "Disk storage 0001" | Get-BEAlert

These commands get all of the active alerts for a disk storage device named "Disk storage 0001".


Example 6
C:\PS> Get-BEJob "Backup of myserver.mycompany.com" | Get-BEAlert

These commands get all of the active alerts for a job named "Backup of myserver.mycompany.com".

Related Links

Get-BEStorage
Get-BEJob
Get-BEAgentServer
Clear-BEAlert
Get-BEDiskStorageDevice