Set-TapeBackupOption

Article
04/20/2010

Set-TapeBackupOption

Sets the tape backup and library options for a protection group.

Syntax

Set-TapeBackupOption [-ProtectionGroup] <ProtectionGroup> -ShortTerm <Nullable`1> [-CompressData] [-EncryptData] [-PassThru <SwitchParameter>] [-PerformIntegritycheck] [<CommonParameters>]


Set-TapeBackupOption [-ProtectionGroup] <ProtectionGroup> -BackupLibrary <Library> -DrivesAllocated <Int32> [-PassThru <SwitchParameter>] [-TapeCopyLibrary <Library>] [<CommonParameters>]


Set-TapeBackupOption [-ProtectionGroup] <ProtectionGroup> -LongTerm [-CompressData] [-EncryptData] [-PassThru <SwitchParameter>] [-PerformIntegritycheck] [<CommonParameters>]

Detailed Description

The Set-TapeBackupOption sets the tape backup options like library and drive information, and short-term and long-term tape backup options.

The parameters CompressData and EncryptData cannot be run together. To remove data compression and encryption, run the cmdlet with neither parameter.

Long-term and short-term setting cannot be made at the same time. Run the cmdlet individually for each set of settings.

Parameters

-ProtectionGroup

The name of a protection group.

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	true (ByValue)
Position?	0

-BackupLibrary

The library used for backup.

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-DrivesAllocated

The number of drives allocated to be used in protection.

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-LongTerm

Indicates that the protection group is set to long-term tape protection.

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-ShortTerm

Indicates that the protection group will be on disk, on tape, or on neither, if nothing is specified.

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-CompressData

Indicates that on-wire compression of data must be enabled while archiving.

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-EncryptData

Indicates whether the data should be encrypted during backup.

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-PassThru

The -PassThru parameter can be used with many commands in DPM to return a related object in cases where there is no default output. Using the PassThru parameter allows such cmdlets to be part of a pipeline.

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-PerformIntegritycheck

Indicates that an integrity check must be performed on the tape.

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-TapeCopyLibrary

The secondary tape library is used while making copies of the tape in the backup library.

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-CommonParameter

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, and OutVariable. For more information, see about_CommonParameters.

Input and Return Types

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.

Notes

For more information, type "Get-Help Set-TapeBackupOption -detailed".
For technical information, type "Get-Help Set-TapeBackupOption -full".

Additionally, any updated information about the cmdlet will be available at https://go.microsoft.com/fwlink/?LinkId=95130.

Examples

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer 
Set-TapeBackupOption -ProtectionGroup $pg -ShortTerm -EncryptData

This command sets the tape backup options to short-term backup with encryption.

EXAMPLE 2

$pg = Get-ProtectionGroup TestingServer 
$mpg = Get-ModifiableProtectionGroup -ProtectionGroup $pg[0] 
$Lib = Get-DPMLibrary TestingServer 
Set-TapeBackupOption -ProtectionGroup $mpg -BackupLibrary $Lib -DrivesAllocated 1 
Set-ProtectionGroup $mpg

Set-TapeBackupOption