Add-BEVerifyBackupTask Help

Synopsis

Adds a verify task to a backup definition in Backup Exec.

Syntax

Add-BEVerifyBackupTask -BackupDefinition [<BEBackupDefinition>] [[-Name] [<String>]] -ImmediatelyAfterBackup [<String>] [-VerifyDataOnClient [<Boolean>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Add-BEVerifyBackupTask -BackupDefinition [<BEBackupDefinition>] [[-Name] [<String>]] -SourceBackup [<String[]>] -Schedule [<BESchedule>] [-VerifyDataOnClient [<Boolean>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Add-BEVerifyBackupTask -BackupJobDefault [<BEBackupJobDefaults>] [[-Name] [<String>]] -ImmediatelyAfterBackup [<String>] [-VerifyDataOnClient [<Boolean>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Add-BEVerifyBackupTask -BackupJobDefault [<BEBackupJobDefaults>] [[-Name] [<String>]] -SourceBackup [<String[]>] -Schedule [<BESchedule>] [-VerifyDataOnClient [<Boolean>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Description

Adds a verify task to a backup definition in Backup Exec.

You can add a verify task to a new backup definition or edit an existing backup definition. You can also add a verify task to the backup job defaults.

To add a verify task to a new backup definition, use Add-BEVerifyBackupTask and New-BEBackupDefinition.

To edit a backup definition and add a verify task, use Add-BEVerifyBackupTask and Get-BEBackupDefinition.

To add a verify task to the backup job defaults, use Add-BEVerifyBackupTask and Get-BEBackupJobDefault.

When you create or edit a backup definition, the backup definition must be passed to Save-BEBackupDefinition to commit the changes.

When you edit the backup job defaults, the backup job defaults must be passed to Save-BEBackupJobDefault to commit the changes.

Parameters

-BackupDefinition <BEBackupDefinition>

Specifies the backup definition to modify.

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

-BackupJobDefault <BEBackupJobDefaults>

Specifies the backup job defaults to modify.

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

-SourceBackup <String[]>

Specifies one or more backups in the backup definition to verify on a scheduled basis.

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

-ImmediatelyAfterBackup <String>

Specifies the name of the backup job in the backup definition to verify.

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

-Schedule <BESchedule>

Specifies the time and frequency that you want to run the job. See New-BESchedule.

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

-VerifyDataOnClient <Boolean>

Lets you run the verify operation remotely, if the Backup Exec agent supports it.

The valid values are:
$true
$false

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

-Name <String>

Specifies the name of the verify task.

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

-WhatIf <SwitchParameter>

Describes what would happen if you executed 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 Types

BackupExec.Management.CLI.BEBackupDefinition

You can pipe a Backup Exec backup definition object to Add-BEVerifyBackupTask.

BackupExec.Management.CLI.BackupJobDefault

You can pipe a Backup Exec backup job default object to Add-BEVerifyBackupTask.

Return Values

BackupExec.Management.CLI.BEBackupDefinition

The backup definition that has been modified.

BackupExec.Management.CLI.BackupJobDefault

The backup job default that has been modified.

Examples

Example 1

C:\PS> Get-BEAgentServer -Local | New-BEBackupDefinition BackupToDisk | Add-BEVerifyBackupTask -SourceBackup Full,Incremental -Schedule (New-BESchedule -Weekdays -StartingAt 10PM) | Save-BEBackupDefinition

These commands create a backup definition that verifies the data from a backup job named "Full" and "Incremental" every weekday at 10PM.

Example 2

C:\PS> Get-BEAgentServer -Local | New-BEBackupDefinition BackupToDisk | Add-BEVerifyBackupTask -ImmediatelyAfterBackup Full | Save-BEBackupDefinition

These commands create a backup definition that has a verify task that verfies the data from a backup job named "Full" after the backup job completes.