Share via

Get-DPMPolicyObjective

Module:
DataProtectionManager Module

Gets the protection policy for a protection group.

Syntax

LongTerm 

Get-DPMPolicyObjective
    [-ProtectionGroup] <ProtectionGroup>
    -LongTerm <LongTermLocation>
    [<CommonParameters>]

ShortTerm 

Get-DPMPolicyObjective
    [-ProtectionGroup] <ProtectionGroup>
    [-ShortTerm]
    [<CommonParameters>]

Description

The Get-DPMPolicyObjective cmdlet gets the protection policy for a protection group. A protection policy is the retention range and frequency of synchronization to disk or backup to tape.

Examples

Example 1: Get a short-term policy objective for a protection group

PS C:\> $PGroup = Get-DPMProtectionGroup -DPMServerName "DPMServer02"
PS C:\> Get-DPMPolicyObjective -ProtectionGroup $PGroup -ShortTerm

The first command gets the protection group from the System Center 2019 - Data Protection Manager (DPM) server named DPMServer02, and then stores the group in the $PGroup variable.

The second command gets the short-term policy objective from the protection group in $PGroup.

Example 2: Get a long-term policy objective for a protection group

PS C:\> $PGroup = Get-DPMProtectionGroup -DPMServerName "DPMServer02"
PS C:\> Get-DPMPolicyObjective -ProtectionGroup $PGroup -LongTerm

The first command gets the protection group from the DPM server named DPMServer02, and then stores the group in the $PGroup variable.

The second command gets the long-term policy objective from the protection group in $PGroup.

Parameters

-LongTerm

Specifies the type of long-term protection policy that this cmdlet gets.

The acceptable values for this parameter are:

  • Tape
  • Online
  • OnlineAndTape

Parameter properties

Type:LongTermLocation
Default value:None
Accepted values:Online, Tape
Supports wildcards:False
DontShow:False

Parameter sets

LongTerm
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProtectionGroup

Specifies a protection group for which this cmdlet gets a policy. To obtain a ProtectionGroup object, use the Get-DPMProtectionGroup cmdlet.

Parameter properties

Type:ProtectionGroup
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-ShortTerm

Indicates that this cmdlet gets the short-term protection policy.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ShortTerm
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

PolicyObjective