Share via

Set-ProtectionJobStartTime

  • Article

Set-ProtectionJobStartTime

Sets or changes the start time of a protection job.

Syntax

Set-ProtectionJobStartTime [-JobType] <JobTypeType> [-ProtectionGroup] <ProtectionGroup> -Remove [-PassThru <SwitchParameter>] [<CommonParameters>]


Set-ProtectionJobStartTime [-CatalogOffset] <UInt32> [-ProtectionGroup] <ProtectionGroup> [<CommonParameters>]


Set-ProtectionJobStartTime [-JobType] <JobTypeType> [-StartTime] <DateTime> [-MaximumDurationInHours] <Int32> [-ProtectionGroup] <ProtectionGroup> [-PassThru <SwitchParameter>] [<CommonParameters>]

Detailed Description

The Set-ProtectionJobStartTime cmdlet sets or changes the start time of a protection job, currently only consistency check.

Use the -Remove parameter to stop a protection job.

Parameters

-JobType

Indicates the type of job for which options are being set. The possible value that this parameter can take is ConsistencyCheck.

Attributes

Name Value

Required?

true

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

1

-StartTime

Indicates a time when an operation must begin.

Attributes

Name Value

Required?

true

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

2

-CatalogOffset

The number of minutes, after the first scheduled recovery point creation time of the SharePoint farm, at which the catalog should be created.

Attributes

Name Value

Required?

true

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

1

-MaximumDurationInHours

The maximum number of hours that a job should run.

Attributes

Name Value

Required?

true

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

3

-ProtectionGroup

The name of a protection group.

Attributes

Name Value

Required?

true

Accept wildcard characters?

false

Accept Pipeline Input?

true (ByValue)

Position?

0

-Remove

Indicates that a remove operation will be performed.

Attributes

Name Value

Required?

true

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

named

-PassThru

The -PassThru parameter can be used with many commands in DPM to return a related object in cases where there is no default output. Using the PassThru parameter allows such cmdlets to be part of a pipeline.

Attributes

Name Value

Required?

false

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-ProtectionJobStartTime -detailed".
    For technical information, type "Get-Help Get-ProtectionJobStartTime -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 
$mpg = Get-ModifiableProtectionGroup -ProtectionGroup $pg 
Set-ProtectionJobStartTime -ProtectionGroup $mpg -JobType ConsistencyCheck -StartTime 02:00 
Set-ProtectionGroup $mpg

This command schedules for a consistency check to run on the protection group at 2 a.m. every day.