Set-BEDuplicateStageBackupTask Help

Synopsis

Modifies duplicate stages in a backup definition in Backup Exec.

Syntax

Set-BEDuplicateStageBackupTask -BackupDefinition [<BEBackupDefinition>] [-Name] [<String[]>] [-VerifyAsPartOfJob [<Boolean>]] [-TapeStorageEnabledHardwareCompression [<Boolean>]] [-CancelJobIfRunningAfterScheduledTimeBy [<TimeSpan>]] [-BackupSetDescription [<String>]] [-KeepJobQueuedFor [<TimeSpan>]] [-EncryptionKey [<BEEncryptionKey>]] [-TapeStorageMediaAppendMethod {Append | AppendOnly | Overwrite}] [-EncryptionType {None | Software | Hardware | SoftwareIfNoHardware}] [-TapeStorageExportMediaToVault [<BEMediaVault>]] [-TapeStorageEjectMediaAfterComplete [<Boolean>]] [-TapeStorageExportMedia [<Boolean>]] [-Storage [<BEStorage>]] [-TapeStorageMediaSet [<BEMediaSet>]] [-DiskStorageKeepForHours [<Int32>]] [-SubmitOnHold [<Boolean>]] [-TapeStorageRetensionMediaBeforeBackup [<Boolean>]] [-TapeStorageEnableWriteOnceReadManyMedia [<Boolean>]] [-TapeStorageEnableDirectCopyToTape [<Boolean>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Set-BEDuplicateStageBackupTask -BackupDefinition [<BEBackupDefinition>] [-SourceBackup] {AllBackups | MostRecentFullBackup | SpecificSourceBackups} [-Name] [<String[]>] [[-SpecificSourceBackup] [<String[]>]] -Schedule [<BESchedule>] [-KeepJobQueuedFor [<TimeSpan>]] [-CancelJobIfRunningAfterScheduledTimeBy [<TimeSpan>]] [-BackupSetDescription [<String>]] [-SubmitOnHold [<Boolean>]] [-VerifyAsPartOfJob [<Boolean>]] [-EncryptionKey [<BEEncryptionKey>]] [-EncryptionType {None | Software | Hardware | SoftwareIfNoHardware}] [-TapeStorageEnabledHardwareCompression [<Boolean>]] [-TapeStorageMediaAppendMethod {Append | AppendOnly | Overwrite}] [-TapeStorageMediaSet [<BEMediaSet>]] [-TapeStorageExportMedia [<Boolean>]] [-Storage [<BEStorage>]] [-DiskStorageKeepForHours [<Int32>]] [-TapeStorageEnableDirectCopyToTape [<Boolean>]] [-TapeStorageRetensionMediaBeforeBackup [<Boolean>]] [-TapeStorageEnableWriteOnceReadManyMedia [<Boolean>]] [-TapeStorageExportMediaToVault [<BEMediaVault>]] [-TapeStorageEjectMediaAfterComplete [<Boolean>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Set-BEDuplicateStageBackupTask -BackupDefinition [<BEBackupDefinition>] [-Name] [<String[]>] -ImmediatelyAfterBackup [<String>] [-VerifyAsPartOfJob [<Boolean>]] [-TapeStorageEnabledHardwareCompression [<Boolean>]] [-CancelJobIfRunningAfterScheduledTimeBy [<TimeSpan>]] [-BackupSetDescription [<String>]] [-KeepJobQueuedFor [<TimeSpan>]] [-EncryptionKey [<BEEncryptionKey>]] [-TapeStorageMediaAppendMethod {Append | AppendOnly | Overwrite}] [-EncryptionType {None | Software | Hardware | SoftwareIfNoHardware}] [-SubmitOnHold [<Boolean>]] [-TapeStorageExportMedia [<Boolean>]] [-TapeStorageExportMediaToVault [<BEMediaVault>]] [-TapeStorageMediaSet [<BEMediaSet>]] [-Storage [<BEStorage>]] [-TapeStorageRetensionMediaBeforeBackup [<Boolean>]] [-DiskStorageKeepForHours [<Int32>]] [-TapeStorageEnableDirectCopyToTape [<Boolean>]] [-TapeStorageEjectMediaAfterComplete [<Boolean>]] [-TapeStorageEnableWriteOnceReadManyMedia [<Boolean>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Set-BEDuplicateStageBackupTask -BackupDefinition [<BEBackupDefinition>] [-Name] [<String[]>] -ImmediatelyAfterDuplicate [<String>] [-VerifyAsPartOfJob [<Boolean>]] [-TapeStorageEnabledHardwareCompression [<Boolean>]] [-CancelJobIfRunningAfterScheduledTimeBy [<TimeSpan>]] [-BackupSetDescription [<String>]] [-KeepJobQueuedFor [<TimeSpan>]] [-EncryptionKey [<BEEncryptionKey>]] [-TapeStorageMediaAppendMethod {Append | AppendOnly | Overwrite}] [-EncryptionType {None | Software | Hardware | SoftwareIfNoHardware}] [-SubmitOnHold [<Boolean>]] [-TapeStorageExportMedia [<Boolean>]] [-TapeStorageExportMediaToVault [<BEMediaVault>]] [-TapeStorageMediaSet [<BEMediaSet>]] [-Storage [<BEStorage>]] [-TapeStorageRetensionMediaBeforeBackup [<Boolean>]] [-DiskStorageKeepForHours [<Int32>]] [-TapeStorageEnableDirectCopyToTape [<Boolean>]] [-TapeStorageEjectMediaAfterComplete [<Boolean>]] [-TapeStorageEnableWriteOnceReadManyMedia [<Boolean>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Set-BEDuplicateStageBackupTask -BackupDefinition [<BEBackupDefinition>] [-Name] [<String[]>] -SourceDuplicate [<String>] -Schedule [<BESchedule>] [-CancelJobIfRunningAfterScheduledTimeBy [<TimeSpan>]] [-VerifyAsPartOfJob [<Boolean>]] [-KeepJobQueuedFor [<TimeSpan>]] [-SubmitOnHold [<Boolean>]] [-BackupSetDescription [<String>]] [-TapeStorageEnabledHardwareCompression [<Boolean>]] [-EncryptionKey [<BEEncryptionKey>]] [-TapeStorageMediaAppendMethod {Append | AppendOnly | Overwrite}] [-EncryptionType {None | Software | Hardware | SoftwareIfNoHardware}] [-TapeStorageMediaSet [<BEMediaSet>]] [-TapeStorageExportMedia [<Boolean>]] [-Storage [<BEStorage>]] [-TapeStorageExportMediaToVault [<BEMediaVault>]] [-TapeStorageRetensionMediaBeforeBackup [<Boolean>]] [-DiskStorageKeepForHours [<Int32>]] [-TapeStorageEnableDirectCopyToTape [<Boolean>]] [-TapeStorageEjectMediaAfterComplete [<Boolean>]] [-TapeStorageEnableWriteOnceReadManyMedia [<Boolean>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Description

Modifies duplicate stages in a backup definition in Backup Exec.

You can modify duplicate stages in a new backup definition or edit a backup definition.

To modify duplicate stages in a new backup definition, use Set-BEDuplicateStageBackupTask and New-BEBackupDefinition.

To modify duplicate stages in an existing backup definition, use Set-BEDuplicateStageBackupTask and Get-BEBackupDefinition.

When you create or edit a backup definition, the backup definition must be passed to Save-BEBackupDefinition 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

-SourceBackup

Specifies the source backup in the backup definition to duplicate.

The valid values are:
AllBackups
MostRecentFullBackup
SpecificSourceBackups

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

-SpecificSourceBackup <String[]>

Specifies one or more backup jobs in the backup definition to duplicate by name (string). To specify multiple names, use commas to separate the names. The Source parameter must be set to SpecificBackups.

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

-ImmediatelyAfterBackup <String>

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

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

-ImmediatelyAfterDuplicate <String>

Specifies the name of a duplicate backup job in the backup definition to duplicate.

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

-SourceDuplicate <String>

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

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

-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

-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

-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

-TapeStorageEnabledHardwareCompression <Boolean>

Enables hardware compression. 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

-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

-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

-Name <String[]>

Specifies one or more duplicate stages to modify by duplicate stage 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

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

You can pipe a Backup Exec backup definition object to Set-BEDuplicateStageBackupTask.

Return Value

BackupExec.Management.CLI.BEBackupDefinition

The backup definition that has been modified.

Examples

Example 1

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

These commands set the storage of the duplicate stage named "Duplicate 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-BEDuplicateStageBackupTask -Name * -Storage "Any disk storage" | Save-BEBackupDefinition

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