Set-OBRetentionPolicy
Set-OBRetentionPolicy
Sets the retention policy for the backup policy (OBPolicy object).
Syntax
Parameter Set: Default
Set-OBRetentionPolicy [-Policy] <CBPolicy> [-RetentionPolicy] <CBRetentionPolicy> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-OBRetentionPolicy cmdlet sets the retention policy for the backup policy (OBPolicy object). The allowed retention days for the OBRetentionPolicy object are 7
, 15
,or 30
.
This cmdlet supports WhatIf and Confirm parameters with a medium impact. The medium impact signifies that the cmdlet will not prompt the user for confirmation by default. The WhatIf parameter gives a verbose description of what the cmdlet does without performing any operation. The Confirm parameter specifies whether the cmdlet should prompt the user. Using –Confirm:$FALSE will override the prompt.
Parameters
-Policy<CBPolicy>
Specifies the policy related to backup.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-RetentionPolicy<CBRetentionPolicy>
Specifies the retention policy to be used for backup.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
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.
- Microsoft.Internal.CloudBackup.Commands.OBRetentionPolicy
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Internal.CloudBackup.Commands.OBRetentionPolicy
Examples
EXAMPLE 1
This example sets up and updates a new retention policy.
PS C:\> $newpo = New-OBPolicy
PS C:\> New-OBRetentionPolicy | Set-OBRetentionPolicy -Policy $newpo