Submit-BELabelMediaJob Help

Synopsis

Submits a job to write a new media label on media in a storage device in Backup Exec.

Syntax

Submit-BELabelMediaJob -TapeDriveDevice [<BETapeDriveDevice>] -Label [<String>] [-BackupExecServer [<BEBackupExecServer>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Submit-BELabelMediaJob -RoboticLibrarySlot [<BERoboticLibrarySlot>] -Label [<String>] [-BackupExecServer [<BEBackupExecServer>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Description

Submits a job to write a new media label on media in a storage device in Backup Exec.

Parameters

-TapeDriveDevice <BETapeDriveDevice>

Specifies the tape drive to label.

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

-RoboticLibrarySlot <BERoboticLibrarySlot>

Specifies the robotic library slot to label.

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

-Label <String>

Describes the media.

Required	true
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-BELabelMediaJob.

BackupExec.Management.CLI.BERoboticLibrarySlot

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

Return Value

BackupExec.Management.CLI.BEJob

Submit-BELabelMediaJob returns the job that was submitted.

Example

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

These commands submit a job that writes a new label to the media in the tape drive device named "Device 0001".