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 for a System Center 2012 – Data Protection Manager (DPM) protection group. These options include library and drive information, and short-term and long-term tape backup options.
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
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
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 protection group set for which this cmdlet modifies options. To obtain a protection group set object, use the Get-DPMPGSet cmdlet.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ProtectionGroup<ProtectionGroup>
Specifies a protection group for which this cmdlet modifies options. To obtain a ProtectionGroup object, use the Get-DPMProtectionGroup cmdlet.
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
Examples
Example 1: Set tape backup options for short-term backup
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.
PS C:\> $PGroup = Get-DPMProtectionGroup -DPMServerName "Contoso-DPMServer"
PS C:\> Set-DPMTapeBackupOption -ProtectionGroup $PGroup -ShortTerm -EncryptData
Example 2: Set tape backup options for a protection group
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.
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