Submit-BECatalogMediaJob Help

Synopsis

Submits a job to perform a catalog of backup sets on media in Backup Exec.

Syntax

Submit-BECatalogMediaJob -DiskCartridgeDevice [<BEDiskCartridgeDevice>] [-BackupExecServer [<BEBackupExecServer>]] [-MediaPassword [<SecureString>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Submit-BECatalogMediaJob -TapeDriveDevice [<BETapeDriveDevice>] [-BackupExecServer [<BEBackupExecServer>]] [-MediaPassword [<SecureString>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Submit-BECatalogMediaJob -RoboticLibrarySlot [<BERoboticLibrarySlot>] [-BackupExecServer [<BEBackupExecServer>]] [-MediaPassword [<SecureString>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Submit-BECatalogMediaJob -Media [<BEMedia>] [-BackupExecServer [<BEBackupExecServer>]] [-MediaPassword [<SecureString>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Description

Submits a job to perform a catalog of backup sets on media in Backup Exec.

If you specify a storage device, the media that you want to catalog must be in the storage device. If you specify media, Backup Exec determines the appropriate device to perform the catalog job.

Parameters

-DiskCartridgeDevice <BEDiskCartridgeDevice>

Specifies the disk cartridge device to catalog.

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

-TapeDriveDevice <BETapeDriveDevice>

Specifies the tape drive device to catalog.

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

-RoboticLibrarySlot <BERoboticLibrarySlot>

Specifies the robotic library slot to catalog.

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

-Media <BEMedia>

Specifies the media to catalog.

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

-MediaPassword <SecureString>

Specifies the media password if the media is protected by a password.

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

You can pipe a Backup Exec disk cartridge device object to Submit-BECatalogMediaJob.

BackupExec.Management.CLI.BETapeDriveDevice

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

BackupExec.Management.CLI.BERoboticLibrarySlot

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

BackupExec.Management.CLI.BEMedia

You can pipe a Backup Exec media object to Submit-BECatalogMediaJob.

Return Value

BackupExec.Management.CLI.BEJob

Submit-BECatalogMediaJob returns the job that was submitted.

Example

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

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