Submit-BERetensionMediaJob Help

Synopsis

Submits a job to retension the media in a storage device in Backup Exec.

Syntax

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

Submit-BERetensionMediaJob -RoboticLibraryDevice [<BERoboticLibraryDevice>] [-BackupExecServer [<BEBackupExecServer>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

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

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

Description

Submits a job to retension the media in a storage device in Backup Exec.

Use retension to run the tape in the tape drive from beginning to end at a fast speed so that the tape winds evenly and runs more smoothly past the tape drive heads.

Parameters

-TapeDriveDevice <BETapeDriveDevice>

Specifies the tape drive device to retension.

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

-RoboticLibraryDevice <BERoboticLibraryDevice>

Specifies the robotic library device to retension.

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

-RoboticLibraryPartition <BERoboticLibraryPartition>

Specifies the robotic library partition to retension.

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

-RoboticLibrarySlot <BERoboticLibrarySlot[]>

Specifies the robotic library slot to retension.

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

-BackupExecServer <BEBackupExecServer>

Specifies which Backup Exec server should 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 Types

BackupExec.Management.CLI.BETapeDriveDevice

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

BackupExec.Management.CLI.BERoboticLibraryDevice

You can pipe a Backup Exec robotic library device object to Submit-BERetensionMediaJob.

BackupExec.Management.CLI.BERoboticLibraryPartition

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

BackupExec.Management.CLI.BERoboticLibrarySlot

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

Return Value

BackupExec.Management.CLI.BEJob

Submit-BERetensionMediaJob returns the job that was submitted.

Example

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

These commands submit a job that retensions the media in the tape drive device named "Device 0001".