Set-BEAlertCategory Help

Synopsis

Sets the properties for a Backup Exec alert category.

Syntax

Set-BEAlertCategory -InputObject [<BEAlertCategory[]>] [-AutoClearAlertAfterMinutes [<Int32>]] [-AutoClearAlertEnabled [<Boolean>]] [-AutoClearAlertResponse {Cancel | Yes | No}] [-RecipientNotificationEnabled [<Boolean>]] [-Enabled [<Boolean>]] [-IncludeJobLog [<Boolean>]] [-EventLogRecordingEnabled [<Boolean>]] [-SnmpNotificationEnabled [<Boolean>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Description

Sets the properties for a Backup Exec alert category.

Parameters

-Enabled <Boolean>

Enables the alert.

The valid values are:
$true
$false

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

-RecipientNotificationEnabled <Boolean>

Enables recipient notification when alerts occur.

The valid values are:
$true
$false

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

-IncludeJobLog <Boolean>

Includes a copy of the job log with the notification.

The valid values are:
$true
$false

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

-SnmpNotificationEnabled <Boolean>

Enables SNMP notifications for the alert.

The valid values are:
$true
$false

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

-EventLogRecordingEnabled <Boolean>

Enters the alert into the Windows Event Viewer.

The valid values are:
$true
$false

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

-AutoClearAlertEnabled <Boolean>

Automatically clears the alert.

The valid values are:
$true
$false

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

-AutoClearAlertAfterMinutes <Int32>

Specifies the number of minutes you want the alert to remain active before it is cleared.

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

-AutoClearAlertResponse

Specifies the response that you want Backup Exec to send automatically when the alert is cleared.

The valid values are:
Cancel
Yes
No

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

-InputObject <BEAlertCategory[]>

Specifies one or more alert category 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

-WhatIf <SwitchParameter>

Describes what happens if you execute the command without actually executing the command.

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

-Confirm <SwitchParameter>

Prompts you for confirmation before executing the command.

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

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

Input Type

BackupExec.Management.CLI.BEAlertCategory

You can pipe a Backup Exec alert category object to Set-BEAlertCategory.

Return Value

BackupExec.Management.CLI.BEAlertCategory

Set-BEAlertCategory returns an object that represents the changed Backup Exec alert category.

Example

C:\PS> Get-BEAlertCategory "Media Overwrite" | Set-BEAlertCategory -AutoClearAlertEnabled $true -AutoClearAlertAfterMinutes 5 -AutoClearAlertResponse No

These commands configure any "Media Overwrite" alerts to auto-clear after five minutes with a response of "No".