Set-DPMTapeBackupOption

Set-DPMTapeBackupOption

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

Syntax

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

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

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

Detailed Description

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

Parameters

-BackupLibrary<Library>

Specifies a backup library.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CompressData

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DrivesAllocated<Int32>

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

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EncryptData

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

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.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PassThru

Indicates that the cmdlet is part of a pipeline.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PerformIntegritycheck

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PGSet<PGSet>

Specifies the name of a protection group set.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ProtectionGroup<ProtectionGroup>

Specifies the name of a protection group.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-RemovePGSet

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

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.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TapeCopyLibrary<Library>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

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

Outputs

The output type is the type of the objects that the cmdlet emits.

  • ProtectionGroup

Notes

  • For more information, type "Get-Help Set-DPMTapeBackupOption -detailed".

Examples

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

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

The first command uses the Get-ProtectionGroup cmdlet and stores the result in the variable named $PGroup.

The second command uses the Set-DPMTapeBackupOption cmdlet to set the ShortTerm and Encryption parameters.

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

Example 2: Set tape backup options for a protection group

This example sets the tape backup option for the protection group in the variable named $MPGroup.

The first command uses the Get-ProtectionGroup cmdlet and stores the result in the variable named $PGroup.

The second command uses the Get-ModifiableProtectionGroup cmdlet to retrieve the settings for the first protection group, and stores the result in the variable named $MPGroup.

The third command uses the Get-DPMLibrary cmdlet and stores the result in the variable named $Lib.

The fourth command uses the Set-DPMTapeBackupOption cmdlet to set the BackupLibrary and DrivesAllocated parameters.

The fifth command uses the Set-ProtectionGroup cmdlet to set the protection group to the value in the $MPGroup variable.

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

Get-DPMTapeBackupOption