Backup Exec Management Command Line Interface Help
Set-BEVerifyBackupTask Cmdlet
Synopsis

Modifies verify tasks in a backup definition in Backup Exec.

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

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

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

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

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

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

Modifies verify tasks in a backup definition in Backup Exec.

You can modify verify tasks in a new backup definition or edit an existing backup definition. You can also modify verify tasks in the backup job defaults.

To modify verify tasks in a new backup definition, use Set-BEVerifyBackupTask and New-BEBackupDefinition.

To modify verify tasks in an existing backup definition, use Set-BEVerifyBackupTask and Get-BEBackupDefinition.

To modify verify tasks in the backup job defaults, use Set-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 true
Position 0
Accepts pipeline input false
Accepts wildcard characters true


-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


<CommonParameters>

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 Set-BEVerifyBackupTask.



BackupExec.Management.CLI.BackupJobDefault

You can pipe a Backup Exec backup job default object to Set-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-BEBackupDefinition "Backup Definition 01" | Set-BEVerifyBackupTask -Name "Verify 2" -VerifyDataOnClient $true | Save-BEBackupDefinition

These commands set the VerifyDataOnClient setting of the verify task named "Verify 2" in the backup definition named "Backup Definition 01" to True.


Example 2
C:\PS> Get-BEBackupDefinition "Backup Definition 01" | Set-BEVerifyBackupTask -Name * -VerifyDataOnClient $true | Save-BEBackupDefinition

These commands set the VerifyDataOnClient setting of all the verify tasks in the backup definition named "Backup Definition 01" to True.

Related Links

New-BEBackupDefinition
Get-BEBackupDefinition
Get-BEBackupJobDefault
Save-BEBackupDefinition
Save-BEBackupJobDefault
New-BESchedule