Share via

Set-DPMTapeBackupOption

Module:
DataProtectionManager Module

Modifies the tape backup and library options for a DPM protection group.

Syntax

ShortTerm 

Set-DPMTapeBackupOption
    [-ProtectionGroup] <ProtectionGroup>
    [-ShortTerm]
    [-CompressData]
    [-EncryptData]
    [-PerformIntegritycheck]
    [-PassThru]
    [-RemovePGSet]
    [-PGSet <PGSet>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

LongTerm 

Set-DPMTapeBackupOption
    [-ProtectionGroup] <ProtectionGroup>
    [-LongTerm]
    [-CompressData]
    [-EncryptData]
    [-PerformIntegritycheck]
    [-PassThru]
    [-RemovePGSet]
    [-PGSet <PGSet>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

LibraryOptions 

Set-DPMTapeBackupOption
    [-ProtectionGroup] <ProtectionGroup>
    -BackupLibrary <Library>
    -DrivesAllocated <Int32>
    [-TapeCopyLibrary <Library>]
    [-PassThru]
    [-RemovePGSet]
    [-PGSet <PGSet>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-DPMTapeBackupOption cmdlet modifies the tape backup options for a System Center - Data Protection Manager (DPM) protection group. These options include library and drive information, and short-term and long-term tape backup options.

Examples

Example 1: Set tape backup options for short-term backup

PS C:\>$PGroup = Get-DPMProtectionGroup -DPMServerName "Contoso-DPMServer"
PS C:\> Set-DPMTapeBackupOption -ProtectionGroup $PGroup -ShortTerm -EncryptData

The first command uses the Get-ProtectionGroup cmdlet to get a protection group for Contoso-DPMServer. The command stores the group in the $PGroup variable.

The second command specifies values for the ShortTerm and Encryption parameters. This example sets the tape backup options to short-term backup with encryption.

Example 2: Set tape backup options for a protection group

PS C:\>$PGroup = Get-DPMProtectionGroup "Contoso-DPMServer"
PS C:\> $MPGroup = Get-DPMModifiableProtectionGroup -ProtectionGroup $PGroup[0]
PS C:\> $DpmLibrary = Get-DPMLibrary "Contoso-DPMServer"
PS C:\> Set-DPMTapeBackupOption -ProtectionGroup $MPGroup -BackupLibrary $DpmLibrary -DrivesAllocated 1
PS C:\> Set-DPMProtectionGroup -ProtectionGroup $MPGroup

The first command uses the Get-ProtectionGroup cmdlet to get a protection group for Contoso-DPMServer. The command stores the group in the $PGroup variable.

The second command uses the Get-ModifiableProtectionGroup cmdlet to retrieve the settings for the first protection group. The command stores the group in editable mode in the $MPGroup variable.

The third command uses the Get-DPMLibrary cmdlet to get the library for Contoso-DMPServer. The command stores it in the $DpmLibrary variable.

The fourth command specifies values for the BackupLibrary and DrivesAllocated parameters. This example sets the tape backup option for the protection group.

The fifth command uses the Set-ProtectionGroup cmdlet to save your changes to the value in $MPGroup.

Parameters

-BackupLibrary

Specifies a backup library.

Parameter properties

Type:Library
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

LibraryOptions
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CompressData

Indicates that the backup process compresses the data to reduce storage needs. Do not use compression and encryption together.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ShortTerm
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
LongTerm
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DrivesAllocated

Specifies the number of drives to allocate to the protection group.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

LibraryOptions
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EncryptData

Indicates that the backup process encrypts the data during backup. Do not use compression and encryption together.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ShortTerm
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
LongTerm
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LongTerm

Indicates that the protection group uses long-term tape protection. Do not use this parameter with the ShortTerm parameter. You must set LongTerm and ShortTerm options in separate commands.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

LongTerm
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PerformIntegritycheck

Indicates that the backup process performs an integrity check on the tape backup.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ShortTerm
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
LongTerm
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PGSet

Specifies the protection group set for which this cmdlet modifies options. To obtain a protection group set object, use the Get-DPMPGSet cmdlet.

Parameter properties

Type:PGSet
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProtectionGroup

Specifies a protection group for which this cmdlet modifies options. To obtain a ProtectionGroup object, use the Get-DPMProtectionGroup cmdlet.

Parameter properties

Type:ProtectionGroup
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-RemovePGSet

Indicates that the cmdlet removes the protection group set as an option.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ShortTerm

Indicates that the protection group will be on disk, on tape, or on neither, if nothing is specified. Do not use this parameter with the LongTerm parameter. You must set LongTerm and ShortTerm options in separate commands.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ShortTerm
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TapeCopyLibrary

Specifies a library object. Use the secondary tape library to make copies of the tape in the backup library.

Parameter properties

Type:Library
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

LibraryOptions
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Outputs

ProtectionGroup