Get-OBRetentionPolicy
Get-OBRetentionPolicy
Gets the current retention policy for backups from the backup policy (OBPolicy object).
Syntax
Parameter Set: Default
Get-OBRetentionPolicy [-Policy] <CBPolicy> [ <CommonParameters>]
Detailed Description
The Get-OBRetentionPolicy cmdlet gets the current retention policy for backups from the backup policy (OBPolicy object). The retention policy allows the number of retention days to be set to one of the following values: 7
, 15
, 30
.
Parameters
-Policy<CBPolicy>
Specify the OBPolicy object for which the OBRetentionPolicy should be retrieved.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Internal.CloudBackup.Commands.OBPolicy
Examples
EXAMPLE 1
This example returns a saved retention policy.
PS C:\> Get-OBPolicy | Get-OBRetentionPolicy