Update-DPMPGSet
Update-DPMPGSet
Updates and saves changes to a protection group set.
Syntax
Parameter Set: AllParams
Update-DPMPGSet [-PGSet] <PGSet> [-Name] <String> [-WritePeriodUnit] <PGSet+TimeUnit> {Invalid | Day | Week | Month | Year} [[-AllowDifferentRetentionPeriods]] [-WritePeriodValue] <UInt32> [-ExpiryToleranceUnit] <PGSet+TimeUnit> {Invalid | Day | Week | Month | Year} [-ExpiryToleranceValue] <UInt32> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: AddPG
Update-DPMPGSet [-PGSet] <PGSet> [-Add] <ProtectionGroup> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: AllowDiffRetnPeriodsFlag
Update-DPMPGSet [-PGSet] <PGSet> [-AllowDifferentRetentionPeriods] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ChangeName
Update-DPMPGSet [-PGSet] <PGSet> [-Name] <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ChangeTimePeriods
Update-DPMPGSet [-PGSet] <PGSet> [-WritePeriodUnit] <PGSet+TimeUnit> {Invalid | Day | Week | Month | Year} [-WritePeriodValue] <UInt32> [-ExpiryToleranceUnit] <PGSet+TimeUnit> {Invalid | Day | Week | Month | Year} [-ExpiryToleranceValue] <UInt32> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RemovePG
Update-DPMPGSet [-PGSet] <PGSet> [-Remove] <ProtectionGroup> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Update-DPMPGSet cmdlet updates and saves changes to a System Center 2012 – Data Protection Manager (DPM) protection group set. A DPM protection group is a collection of protection groups that you collocate on the same tape.
Parameters
-Add<ProtectionGroup>
Specifies a protection group. The cmdlet adds this protection group to the protection group set.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AllowDifferentRetentionPeriods
Indicates that protection groups with different retention periods can be part of the same protection group set.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ExpiryToleranceUnit<PGSet+TimeUnit>
Specifies the measurement unit for expiry tolerance. Valid values are:
-- Day
-- Week
-- Month
-- Year
Aliases |
none |
Required? |
true |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ExpiryToleranceValue<UInt32>
Specifies the maximum length of time for which an expired recovery point remains on a tape before DPM marks the tape as expired.
Aliases |
none |
Required? |
true |
Position? |
5 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies a new name for the protection group set.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PGSet<PGSet>
Specifies a protection group set that this cmdlet updates. To obtain a protection group set object, use the Get-DPMPGSet cmdlet.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Remove<ProtectionGroup>
Specifies a protection group. The cmdlet removes this protection group from the protection group set.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WritePeriodUnit<PGSet+TimeUnit>
Specifies the measurement unit for the write period. Valid values are:
-- Day
-- Week
-- Month
-- Year
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WritePeriodValue<UInt32>
Specifies the length of time for which a tape is available for writing new backups. DPM marks the tape as Offsite Ready after this interval.
Aliases |
none |
Required? |
true |
Position? |
3 |
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.
Examples
Example 1: Update write period and expiry tolerance
This example updates the first protection group set from protection group sets on the on the server DPMServer07 with values for write period and expiry tolerance.
The first command uses the Get-DPMPGSet cmdlet to get the protection group sets for the specified server and stores them in the $PGSet variable.
The second command specifies the first member of $PGSet by using standard array notation. The command updates values for write period and expiry tolerance.
PS C:\> $PGSet = Get-DPMPGSet -DPMServerName "DPMServer07"
PS C:\> Update-DPMPGSet -PGSet $PGSet[0] -Name "PGSset3" -WritePeriodUnit day -WritePeriodValue 60 -ExpiryToleranceUnit Day -ExpiryToleranceValue 10
Example 2: Add a protection group to a protection group set
This example adds a protection group from DPMServer07 to the first protection group set on that DPM server.
The first command uses the Get-DPMPGSet cmdlet to get the protection group sets for the specified server and stores them in the $PGSet variable.
The second command uses the Get-DPMProtectionGroup cmdlet to get a protection group from the specified DPM server that has a name that contains PG1, and then stores it in the $PGroup variable.
The third command specifies the first member of the $PGSet variable by using standard array notation. The command updates that set to contain the protection group stored in $PGroup.
PS C:\> $PGSet = Get-DPMPGSet -DPMServerName "DPMServer07"
PS C:\> $PGroup = Get-DPMProtectionGroup -DPMServerName "DPMServer07" | where {($_.friendlyname) -match "PG1" }
PS C:\> Update-DPMPGSet -PGSet $PGSet[0] -Add $PGroup
Example 3: Remove a protection group from a protection group set
This example removes the first protection group set from the list of protection group sets on the DPM server TestingServer.
The first command uses the Get-DPMPGSet cmdlet to get the protection group sets for the specified server and stores them in the $PGSet variable.
The second command uses the Get-DPMProtectionGroup cmdlet to get a protection group from the specified DPM server that has a name that contains PG1, and then stores it in the $PGroup variable.
The third command specifies the first member of $PGSet by using standard array notation. The command updates that set to no longer contain the protection group stored in $PGroup.
PS C:\> $PGSet = Get-DPMPGSet -DPMServerName "DPMServer07"
PS C:\> $PGroup = Get-DPMProtectionGroup -DPMServerName "DPMServer07" | where { ($_.friendlyname) -match "PG1" }
PS C:\> Update-DPMPGSet -PGSet $PGSet[0] -Remove $PGroup