Set-DPMMaintenanceJobStartTime

Set-DPMMaintenanceJobStartTime

Sets the start time of a maintenance job or stops such a job from running.

Syntax

Parameter Set: Reset
Set-DPMMaintenanceJobStartTime [[-DPMServerName] <String> ] [-MaintenanceJob] <HouseKeepingJobs> {CatalogPruning | LibraryInventory} [[-StartTime] <DateTime> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Remove
Set-DPMMaintenanceJobStartTime [[-DPMServerName] <String> ] [-MaintenanceJob] <HouseKeepingJobs> {CatalogPruning | LibraryInventory} [-Remove] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-DPMMaintenanceJobStartTime cmdlet sets the start time of a maintenance job or stops such a job if it is running in System Center 2012 – Data Protection Manager (DPM).

You can reschedule Catalog Pruning and Detailed Inventory jobs by using this cmdlet.

Parameters

-DPMServerName<String>

Specifies the name of a DPM server on which this cmdlet sets a maintenance job.

Aliases	none
Required?	false
Position?	1
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-MaintenanceJob<HouseKeepingJobs>

Specifies the maintenance job that the cmdlet performs on the replica. Valid values are:

-- CatalogPruning. Removes index entries for expired tapes.
-- DetailedInventory. Identifies new tapes and recognizes tapes DPM has seen before by reading the on-media identifier (OMID) on each tape.

Aliases	none
Required?	true
Position?	2
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Remove

Indicates that the cmdlet stops the job that is currently running.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-StartTime<DateTime>

Specifies the time when the operation starts as a DateTime object.

Aliases	none
Required?	false
Position?	3
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

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

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Set the start time for a job

This command schedules the CatalogPruning maintenance job to run on the DPM server named DPMServer07 at 2 AM.

PS C:\> Set-DPMMaintenanceJobStartTime -DPMServerName "DPMServer07" -MaintenanceJob CatalogPruning -StartTime 02:00

Example 2: Stop a running job

This command stops the LibraryInventory job from running on the DPM server named DPMServer07.

PS C:\> Set-DPMMaintenanceJobStartTime -DPMServerName "DPMServer07" -MaintenanceJob LibraryInventory -Remove

Related topics

Get-DPMMaintenanceJobStartTime