Get-PolicyObjective
Get-PolicyObjective
Returns the protection policy for a protection group.
Syntax
Get-PolicyObjective [-ProtectionGroup] <ProtectionGroup> -LongTerm [<CommonParameters>]
Get-PolicyObjective [-ProtectionGroup] <ProtectionGroup> -ShortTerm <Nullable`1> [<CommonParameters>]
Detailed Description
The Get-PolicyObjective cmdlet returns the protection policy for a protection group. The cmdlet returns the retention range and protection frequency (synchronization to disk or backup to tape) of the protection group.
Parameters
-ProtectionGroup
The name of a protection group.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByValue) |
Position? |
0 |
-LongTerm <Enum>
Indicates that the protection group is set to long-term tape protection. This parameter can take the values Tape, Online, and OnlineAndTape.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-ShortTerm
Indicates that the protection group will be on disk, on tape, or on neither, if nothing is specified.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-CommonParameter
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, and OutVariable. For more information, see about_CommonParameters.
Input and Return Types
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.
Notes
For more information, type "Get-Help Get-PolicyObjective -detailed".
For technical information, type "Get-Help Get-PolicyObjective -full".Additionally, any updated information about the cmdlet will be available at https://go.microsoft.com/fwlink/?LinkId=95130.
Examples
EXAMPLE 1
$pg = Get-ProtectionGroup -DPMServerName TestingServer
Get-PolicyObjective -ProtectionGroup $pg -ShortTerm
Returns the short-term policy objective of the protection group.
$pg holds a protection group.
EXAMPLE 2
$pg = Get-ProtectionGroup -DPMServerName TestingServer
Get-PolicyObjective -ProtectionGroup $pg -LongTerm
Returns the long-term policy objective of a protection group.
$pg holds a protection group.