Submit-BECleanJob Help

Synopsis

Submits a tape drive cleaning job in Backup Exec.

Syntax

Submit-BECleanJob -TapeDriveDevice [<BETapeDriveDevice>] [-BackupExecServer [<BEBackupExecServer>]] [-Schedule [<BESchedule>]] [-KeepJobQueuedFor [<TimeSpan>]] [-CancelJobIfRunningAfterScheduledTimeBy [<TimeSpan>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Description

Submits a tape drive cleaning job in Backup Exec.

Parameters

-TapeDriveDevice <BETapeDriveDevice>

Specifies the drive that contains the cleaning tape.

Required	true
Position	Named
Accepts pipeline input	true (ByValue)
Accepts wildcard characters	false

-Schedule <BESchedule>

Specifies the time and frequency that you want to run the job. See New-BESchedule.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-KeepJobQueuedFor <TimeSpan>

Specifies the maximum amount of time past the scheduled start time that Backup Exec considers the job to be missed and reschedules it.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-CancelJobIfRunningAfterScheduledTimeBy <TimeSpan>

Specifies the amount of time after the scheduled start time that you want to cancel the job if it is still running.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-BackupExecServer <BEBackupExecServer>

Specifies the Backup Exec server that process the job in a CASO environment.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-WhatIf <SwitchParameter>

Describes what happens if you execute the command without actually executing the command.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-Confirm <SwitchParameter>

Prompts you for confirmation before executing the command.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

For more information about common parameters, type "Get-Help about_commonparameters".

Input Type

BackupExec.Management.CLI.BETapeDriveDevice

You can pipe a Backup Exec tape drive device object to Submit-BECleanJob.

Return Value

BackupExec.Management.CLI.BEJob

Submit-BECleanJob returns the job that was submitted.

Examples

Example 1

C:\PS> Get-BETapeDriveDevice "Device 0001" | Submit-BECleanJob

These commands submit a cleaning job that cleans the tape drive device named "Device 0001".

Example 2

C:\PS> Get-BETapeDriveDevice "Device 0001" | Submit-BECleanJob -Schedule (New-BESchedule -Daily -StartingAt 10pm)

These commands submit a cleaning job that cleans the tape drive device named "Device 0001" every day at 10pm.