Set-DPMProtectionJobStartTime

Reference

Module:: DataProtectionManager

Sets the start time of a protection job.

Syntax

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

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

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.

Type:	Int32
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-JobType

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

Type:	ProtectionJobType
Accepted values:	ConsistencyCheck
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-MaximumDurationInHours

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

Type:	Int32
Position:	4
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProtectionGroup

Specifies a protection group. To obtain a ProtectionGroup object, use the Get-DPMProtectionGroup cmdlet.

Type:	ProtectionGroup
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Remove

Indicates that DPM stops the protection job.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-StartTime

Specifies a start time for the protection job.

Type:	DateTime
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Outputs

ProtectionGroup