Submit-BEFormatMediaJob Help

Synopsis

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

Syntax

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

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

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

Description

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

You must have the media that you want to format in the storage device.

Formatting erases the media. All data on the media is lost.

Parameters

-TapeDriveDevice <BETapeDriveDevice>

Specifies the tape drive to format.

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

-RoboticLibraryPartition <BERoboticLibraryPartition>

Specifies the robotic library partition to format.

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

-RoboticLibrarySlot <BERoboticLibrarySlot[]>

Specifies the robotic library slot to format.

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

-FormatWorm <SwitchParameter>

Enables the write once, read many parameter. Drives formatted with WORM cannot be reformatted.

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-BEFormatMediaJob.

BackupExec.Management.CLI.BERoboticLibraryPartition

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

BackupExec.Management.CLI.BERoboticLibrarySlot

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

Return Value

BackupExec.Management.CLI.BEJob

Submit-BEFormatMediaJob returns the job that was submitted.

Example

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

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