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

Modifies full backups in a backup definition in Backup Exec.

Syntax
Set-BEFullBackupTask -BackupDefinition [<BEBackupDefinition>] [-Name] [<String[]>] [-EncryptionType {None | Software | Hardware | SoftwareIfNoHardware}] [-VerifyAsPartOfJob [<Boolean>]] [-EncryptionKey [<BEEncryptionKey>]] [-SqlContinueIfConsistencyCheckUnsuccessful [<Boolean>]] [-SqlPreConsistencyCheckMethod {None | Physical | FullExcludingIndexes | FullIncludingIndexes}] [-RunPostCommandEvenIfJobIsUnsuccessful [<Boolean>]] [-RunPostCommandOnlyIfPreCommandIsSuccessful [<Boolean>]] [-RunPostCommandAfterVerification [<Boolean>]] [-RunCommandLocation {OnEachAgentServer | OnBackupExecServer}] [-CancelPrePostCommandIfNotCompleteWithinMinutes [<UInt32>]] [-SqlPostConsistencyCheck {None | Physical | FullExcludingIndexes | FullIncludingIndexes}] [-OraclePerformBackupOffline [<Boolean>]] [-OracleSkipBackedUpArchivedLogFile [<Boolean>]] [-DeleteSelectedFilesAfterSuccessfulBackup {Never | FilesOnly | FilesAndFolders}] [-SqlCreateDiskCopy [<Boolean>]] [-SqlUseChecksumOnBackup [<Boolean>]] [-SqlDiskCopyPath [<String>]] [-OracleDeleteBackedUpArchivedLogFile [<Boolean>]] [-SqlUseSoftwareCompression [<Boolean>]] [-RunJobOnlyIfPreCommandIsSuccessful [<Boolean>]] [-TapeStorageEnableWriteOnceReadManyMedia [<Boolean>]] [-TapeStorageEjectMediaAfterComplete [<Boolean>]] [-TapeStorageEnableDirectCopyToTape [<Boolean>]] [-DiskStorageKeepForHours [<Int32>]] [-TapeStorageRetensionMediaBeforeBackup [<Boolean>]] [-Storage [<BEStorage>]] [-TapeStorageMediaSet [<BEMediaSet>]] [-TapeStorageExportMediaToVault [<BEMediaVault>]] [-TapeStorageExportMedia [<Boolean>]] [-SubmitOnHold [<Boolean>]] [-EnableDirectAccessIfAvailable [<Boolean>]] [-TapeStorageMediaAppendMethod {Append | AppendOnly | Overwrite}] [-PreCommand [<String>]] [-PrePostCommandSuccessfulIfReturnsZero [<Boolean>]] [-PostCommand [<String>]] [-Schedule [<BESchedule>]] [-BackupSetDescription [<String>]] [-KeepJobQueuedFor [<TimeSpan>]] [-TapeStorageCompressionMethod {None | SoftwareIfNoHardware | HardwareOnly | SoftwareOnly}] [-CancelJobIfRunningAfterScheduledTimeBy [<TimeSpan>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Force [<SwitchParameter>]] [<CommonParameters>]

Set-BEFullBackupTask -BackupJobDefault [<BEBackupJobDefaults>] [-Name] [<String[]>] [-EncryptionType {None | Software | Hardware | SoftwareIfNoHardware}] [-VerifyAsPartOfJob [<Boolean>]] [-EncryptionKey [<BEEncryptionKey>]] [-SqlContinueIfConsistencyCheckUnsuccessful [<Boolean>]] [-SqlPreConsistencyCheckMethod {None | Physical | FullExcludingIndexes | FullIncludingIndexes}] [-RunPostCommandEvenIfJobIsUnsuccessful [<Boolean>]] [-RunPostCommandOnlyIfPreCommandIsSuccessful [<Boolean>]] [-RunPostCommandAfterVerification [<Boolean>]] [-RunCommandLocation {OnEachAgentServer | OnBackupExecServer}] [-CancelPrePostCommandIfNotCompleteWithinMinutes [<UInt32>]] [-OracleSkipBackedUpArchivedLogFile [<Boolean>]] [-OracleDeleteBackedUpArchivedLogFile [<Boolean>]] [-OraclePerformBackupOffline [<Boolean>]] [-SqlUseChecksumOnBackup [<Boolean>]] [-SqlPostConsistencyCheck {None | Physical | FullExcludingIndexes | FullIncludingIndexes}] [-SqlCreateDiskCopy [<Boolean>]] [-SqlUseSoftwareCompression [<Boolean>]] [-SqlDiskCopyPath [<String>]] [-RunJobOnlyIfPreCommandIsSuccessful [<Boolean>]] [-TapeStorageEnableDirectCopyToTape [<Boolean>]] [-TapeStorageEnableWriteOnceReadManyMedia [<Boolean>]] [-TapeStorageRetensionMediaBeforeBackup [<Boolean>]] [-SubmitOnHold [<Boolean>]] [-DiskStorageKeepForHours [<Int32>]] [-TapeStorageMediaSet [<BEMediaSet>]] [-Storage [<BEStorage>]] [-TapeStorageExportMedia [<Boolean>]] [-TapeStorageEjectMediaAfterComplete [<Boolean>]] [-TapeStorageExportMediaToVault [<BEMediaVault>]] [-EnableDirectAccessIfAvailable [<Boolean>]] [-TapeStorageMediaAppendMethod {Append | AppendOnly | Overwrite}] [-PreCommand [<String>]] [-PrePostCommandSuccessfulIfReturnsZero [<Boolean>]] [-PostCommand [<String>]] [-Schedule [<BESchedule>]] [-BackupSetDescription [<String>]] [-KeepJobQueuedFor [<TimeSpan>]] [-TapeStorageCompressionMethod {None | SoftwareIfNoHardware | HardwareOnly | SoftwareOnly}] [-CancelJobIfRunningAfterScheduledTimeBy [<TimeSpan>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Description

Modifies full backups in a backup definition in Backup Exec.

You can modify full backups in a new backup definition or edit a backup definition. You can also modify full backups in the backup job defaults.

To modify full backups in a new backup definition, use Set-BEFullBackupTask and New-BEBackupDefinition.

To modify full backups in an existing backup definition, use Set-BEFullBackupTask and Get-BEBackupDefinition.

To modify full backups in the backup job defaults, use Set-BEFullBackupTask 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


-Storage <BEStorage>

Specifies the storage device that you want to use for the backup job. See Get-BEStorage.


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


-TapeStorageMediaSet <BEMediaSet>

Specifies the media set to associate with the media. The media is protected from being overwritten based on the settings for the media set. The Storage parameter must be set to a tape-based storage device. See Get-BEMediaSet.


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


-TapeStorageExportMedia <Boolean>

Exports the media from the device when the job completes. The Storage parameter must be set to a tape-based storage device.

The valid values are:
$true
$false


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


-TapeStorageExportMediaToVault <BEMediaVault>

Logically moves the media to the specified vault when the job completes. The Storage parameter must be set to a tape-based storage device and TapeStorageExportMedia must be set to $true. See Get-BEMediaVault.


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


-TapeStorageEjectMediaAfterComplete <Boolean>

Ejects the media from the storage device after the job completes. The Storage parameter must be set to a tape-based storage device.

The valid values are:
$true
$false


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


-TapeStorageEnableWriteOnceReadManyMedia <Boolean>

Specifies the use of WORM (write once, read many) media for this backup job. The Storage parameter must be set to a tape-based storage device.

The valid values are:
$true
$false


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


-TapeStorageEnableDirectCopyToTape <Boolean>

Enables data to be copied from a virtual tape library directly to a physical tape device.

The valid values are:
$true
$false


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


-TapeStorageRetensionMediaBeforeBackup <Boolean>

Retensions the media before data is written to it. The Storage parameter must be set to a tape-based storage device.

The valid values are:
$true
$false


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


-DiskStorageKeepForHours <Int32>

Specifies the number of hours to retain the data on the media before the media can be overwritten. The Storage parameter must be set to a disk-based storage device.


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


-SubmitOnHold <Boolean>

Submits the job with an on-hold status.

The valid values are:
$true
$false


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


-BackupSetDescription <String>

Describes the data that was backed up and the location of the data.


Required false
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 false
Position Named
Accepts pipeline input false
Accepts wildcard characters false


-KeepJobQueuedFor <TimeSpan>

Specifies the maximum amount of time past the scheduled start time that Backup Exec considers the job to be missed and reschedules it.


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


-CancelJobIfRunningAfterScheduledTimeBy <TimeSpan>

Specifies the amount of time after the scheduled start time that you want to cancel the job if it is still running.


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


-TapeStorageCompressionMethod

Specifies the type of data compression to use performed by the hardware or software. The Storage parameter must be set to a tape-based storage device.

The valid values are:
None
SoftwareIfNoHardware
HardwareOnly
SoftwareOnly


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


-TapeStorageMediaAppendMethod

Specifies if you want to overwrite or append to the media when the job starts. The Storage parameter must be set to a tape-based storage device.

The valid values are:
Append
AppendOnly
Overwrite


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


-EnableDirectAccessIfAvailable <Boolean>

Allows backup data to be sent directly to the device specified in the Storage parameter from the Agent for Windows if the device supports it.

The valid values are:
$true
$false


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


-PreCommand <String>

Specifies a command to run before the backup job.


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


-PostCommand <String>

Specifies a command to run after the backup job.


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


-PrePostCommandSuccessfulIfReturnsZero <Boolean>

Allows Backup Exec to check the return codes of the pre- and post-commands to determine if they completed successfully.

The valid values are:
$true
$false


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


-RunJobOnlyIfPreCommandIsSuccessful <Boolean>

Runs the backup job only if the pre-command is successful. If the pre-command fails, the job does not run.

The valid values are:
$true
$false


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


-RunPostCommandOnlyIfPreCommandIsSuccessful <Boolean>

Runs the post-command only if the pre-command is successful.

The valid values are:
$true
$false


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


-RunPostCommandEvenIfJobIsUnsuccessful <Boolean>

Runs the post-command regardless of whether the job is successful or not.

The valid values are:
$true
$false


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


-RunPostCommandAfterVerification <Boolean>

Runs the post-command after the verification completes if you selected to verify the backup job.

The valid values are:
$true
$false


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


-CancelPrePostCommandIfNotCompleteWithinMinutes <UInt32>

Designates the number of minutes Backup Exec should wait before canceling a pre- or post-command that did not complete.


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


-RunCommandLocation

Determines the location where the pre- and post-command run.

The valid values are:
OnEachAgentServer
OnBackupExecServer


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


-VerifyAsPartOfJob <Boolean>

Runs a verify operation automatically when the backup job completes.

The valid values are:
$true
$false


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


-EncryptionType

Specifies the type of encryption that you want to use for the backup job.

The valid values are:
None
Software
Hardware
SoftwareIfNoHardware


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


-EncryptionKey <BEEncryptionKey>

Specifies the encryption key that you want to use. EncryptionType must be set to a value other than None.


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


-SqlPreConsistencyCheckMethod

Specifies the type of consistency check to perform before the backup job runs.

The valid values are:
None
Physical
FullExcludingIndexes
FullIncludingIndexes


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


-SqlContinueIfConsistencyCheckUnsuccessful <Boolean>

Continues the backup job even if the consistency check fails.

The valid values are:
$true
$false


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


-SqlPostConsistencyCheck

Specifies the type of consistency check to use after the backup job runs.

The valid values are:
None
Physical
FullExcludingIndexes
FullIncludingIndexes


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


-SqlUseChecksumOnBackup <Boolean>

For SQL 2005 or later, adds checksums to the SQL database data being backed up.

The valid values are:
$true
$false


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


-SqlCreateDiskCopy <Boolean>

Creates an on-disk copy of the SQL database being backed up.

The valid values are:
$true
$false


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


-SqlDiskCopyPath <String>

Specifies the path for the on-disk copy of the SQL database being backed up. CreateDiskCopy must be set to $true.


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


-SqlUseSoftwareCompression <Boolean>

For SQL 2008 or later, specifies the compression setting you want to use.

The valid values are:
$true
$false


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


-OracleDeleteBackedUpArchivedLogFile <Boolean>

Lets you delete the archived log files automatically after the backup.

The valid values are:
$true
$false


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


-OracleSkipBackedUpArchivedLogFile <Boolean>

Enables Backup Exec to skip any archived logfiles that were already backed up.

The valid values are:
$true
$false


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


-OraclePerformBackupOffline <Boolean>

Enables Backup Exec to take the database offline before you start the backup job.

The valid values are:
$true
$false


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


-DeleteSelectedFilesAfterSuccessfulBackup

Backs up the selected data, verifies the media, and then deletes the data from the volume. Since the operation deletes the files and you must perform a restore to get the data back, you must specify the Force parameter when enabling this option.

The valid values are:
Never
FilesOnly
FilesAndFolders


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


-Name <String[]>

Specifies one or more full backup jobs to modify by full backup job name (wildcards accepted). To specify multiple names, use commas to separate the names.


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


-Force <SwitchParameter>

Confirms that the DeleteSelectedFilesAfterSuccessfulBackup parameter results in a loss of data and want to continue to use it.


Required false
Position Named
Accepts pipeline input false
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


<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-BEFullBackupTask.



BackupExec.Management.CLI.BackupJobDefault

You can pipe a Backup Exec backup job default object to Set-BEFullBackupTask.

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-BEFullBackupTask -Name "Full 2" -Storage "Any disk storage" | Save-BEBackupDefinition

These commands set the storage of the full backup named "Full 2" in the backup definition named "Backup Definition 01" to the "Any disk storage" pool.


Example 2
C:\PS> Get-BEBackupDefinition "Backup Definition 01" | Set-BEFullBackupTask -Name * -Storage "Any disk storage" | Save-BEBackupDefinition

These commands set the storage of all the full backups in the backup definition named "Backup Definition 01" to the "Any disk storage" pool.


Example 3
C:\PS> Get-BEBackupJobDefault BackupToDisk | Set-BEFullBackupTask -Name * -Storage "Any disk storage" | Save-BEBackupJobDefault

These commands set the storage of all the full backups in the backup-to-disk job defaults to the "Any disk storage" pool.

Related Links

New-BEBackupDefinition
Get-BEBackupDefinition
Get-BEBackupJobDefault
Save-BEBackupDefinition
Save-BEBackupJobDefault
Get-BEStorage
Get-BEMediaSet
Get-BEMediaVault
New-BESchedule