Set-BEErrorHandlingRule Help

Synopsis

Sets the properties for a Backup Exec error-handling rule.

Syntax

Set-BEErrorHandlingRule -InputObject [<BEErrorHandlingRule[]>] [-Note [<String>]] [-RetryIntervalMinutes [<Int32>]] [-Enabled [<Boolean>]] [-RetryJobEnabled [<Boolean>]] [-MaximumRetries [<Int32>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Description

Sets the properties for a Backup Exec error-handling rule.

Parameters

-Enabled <Boolean>

Enables the error-handling rule.

The valid values are:
$true
$false

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

-RetryJobEnabled <Boolean>

Allows Backup Exec to retry the job.

The valid values are:
$true
$false

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

-MaximumRetries <Int32>

Specifies the number of times you want the job retried.

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

-RetryIntervalMinutes <Int32>

Specifies the number of minutes to wait before the job is retried.

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

-Note <String>

Shows any miscellaneous information for the error-handling rule.

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

-InputObject <BEErrorHandlingRule[]>

Specifies one or more error handling rule 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.BEErrorHandlingRule

You can pipe a Backup Exec error-handling rule object to Set-BEErrorHandlingRule.

Return Value

BackupExec.Management.CLI.BEErrorHandlingRule

Set-BEErrorHandlingRule returns an object that represents the changed Backup Exec error-handling rule.

Example

C:\PS> Get-BEErrorHandlingRule "Job Cancellation" | Set-BEErrorHandlingRule -Enabled $true

These commands enable the error-handling rule named "Job Cancellation".