Share via

Set-DPMProtectionJobStartTime

Module:
DataProtectionManager Module

Sets the start time of a protection job.

Syntax

Edit 

Set-DPMProtectionJobStartTime
    [-ProtectionGroup] <ProtectionGroup>
    [-JobType] <ProtectionJobType>
    [-StartTime] <DateTime>
    [-MaximumDurationInHours] <Int32>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Remove 

Set-DPMProtectionJobStartTime
    [-ProtectionGroup] <ProtectionGroup>
    [-JobType] <ProtectionJobType>
    [-Remove]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

OffsetSchedule 

Set-DPMProtectionJobStartTime
    [-ProtectionGroup] <ProtectionGroup>
    [-CatalogOffset] <Int32>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-DPMProtectionJobStartTime cmdlet sets the start time of a protection job. The only type of protection job that is currently available is consistency check. Use the Remove parameter to stop a protection job.

Examples

Example 1: Schedule a consistency check on a protection group

PS C:\>$PGroup = Get-DPMProtectionGroup -DPMServerName "DPMServer02"
PS C:\> $MPGroup = Get-DPMModifiableProtectionGroup -ProtectionGroup $PGroup
PS C:\> Set-DPMProtectionJobStartTime -ProtectionGroup $MPGroup -JobType ConsistencyCheck -StartTime 02:00
PS C:\> Set-DPMProtectionGroup ProtectionGroup $MPGroup

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

The second command makes the protection group in $PGroup modifiable, and stores the result in the $MPGroup variable.

The third command sets the start time of the protection job in $MPGroup. The command schedules for a consistency check to run on the protection group at 2:00 AM every day.

The final command uses the Set-DPMProtectionGroup cmdlet to save your changes.

Parameters

-CatalogOffset

Specifies the number of minutes, after the first scheduled recovery point creation time of the SharePoint farm, that System Center 2019 - Data Protection Manager (DPM) creates the catalog.

Parameter properties

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

Parameter sets

OffsetSchedule
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

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

-JobType

Specifies the type of job for which options are being set. The only valid value for this parameter is ConsistencyCheck.

Parameter properties

Type:ProtectionJobType
Default value:None
Accepted values:ConsistencyCheck
Supports wildcards:False
DontShow:False

Parameter sets

Edit
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Remove
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaximumDurationInHours

Specify the maximum number of hours that DPM can run a job.

Parameter properties

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

Parameter sets

Edit
Position:4
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Parameter properties

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

Parameter sets

Edit
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Remove
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProtectionGroup

Specifies a protection group. 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

-Remove

Indicates that DPM stops the protection job.

Parameter properties

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

Parameter sets

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

-StartTime

Specifies a start time for the protection job.

Parameter properties

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

Parameter sets

Edit
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
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

ProtectionGroup