Submit-BEEraseMediaJob Help

Synopsis

Submits a media erase job in Backup Exec.

Syntax

Submit-BEEraseMediaJob -TapeDriveDevice [<BETapeDriveDevice>] [-BackupExecServer [<BEBackupExecServer>]] [-LongErase [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Submit-BEEraseMediaJob -RoboticLibraryPartition [<BERoboticLibraryPartition>] [-BackupExecServer [<BEBackupExecServer>]] [-LongErase [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Submit-BEEraseMediaJob -RoboticLibrarySlot [<BERoboticLibrarySlot[]>] [-BackupExecServer [<BEBackupExecServer>]] [-LongErase [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Description

Submits a media erase job in Backup Exec.

By default, Submit-BEEraseMediaJob performs a Quick erase. You can specify the -LongErase parameter to perform a long erase.

Devices that do not support a long erase will only perform a quick erase.

Parameters

-TapeDriveDevice <BETapeDriveDevice>

Specifies the tape drive on which you want to run the erase media job.

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

-RoboticLibraryPartition <BERoboticLibraryPartition>

Specifies the robotic library partition on which you want to run the erase media job.

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

-RoboticLibrarySlot <BERoboticLibrarySlot[]>

Specifies the robotic library slot on which you want to run the erase media job.

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

-BackupExecServer <BEBackupExecServer>

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

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

-LongErase <SwitchParameter>

Performs a long erase of the media, rather than a quick erase.

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 Types

BackupExec.Management.CLI.BETapeDriveDevice

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

BackupExec.Management.CLI.BERoboticLibraryPartition

You can pipe a Backup Exec robotic library partition object to Submit-BEEraseMediaJob.

BackupExec.Management.CLI.BERoboticLibrarySlot

You can pipe a Backup Exec robotic library slot object to Submit-BEEraseMediaJob.

Return Value

BackupExec.Management.CLI.BEJob

Submit-BEEraseMediaJob returns the job that was submitted.

Example

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

These commands submit an erase job that erases the media in the tape drive device named "Device 0001".