Share via

Set-DPMMaintenanceJobStartTime

Module:
DataProtectionManager Module

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

Syntax

Reset (Default) 

Set-DPMMaintenanceJobStartTime
    [[-DPMServerName] <String>]
    [-MaintenanceJob] <HouseKeepingJobs>
    [[-StartTime] <DateTime>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Remove 

Set-DPMMaintenanceJobStartTime
    [[-DPMServerName] <String>]
    [-MaintenanceJob] <HouseKeepingJobs>
    [-Remove]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

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 - Data Protection Manager (DPM).

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

Examples

Example 1: Set the start time for a job

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

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

Example 2: Remove scheduled job

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

This command removes the scheduled LibraryInventory job and prevents it from running on the DPM server named DPMServer07, in future.

Parameters

-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

-DPMServerName

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

Parameter properties

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

Parameter sets

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

-MaintenanceJob

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.

Parameter properties

Type:HouseKeepingJobs
Default value:None
Accepted values:CatalogPruning, LibraryInventory
Supports wildcards:False
DontShow:False

Parameter sets

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

-Remove

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

Parameter properties

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

Parameter sets

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

-StartTime

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

Parameter properties

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

Parameter sets

Reset
Position:3
Mandatory:False
Value from pipeline:True
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.