Submit-BEInventoryJob Help

Synopsis

Submits a job to inventory media in a storage device in Backup Exec.

Syntax

Submit-BEInventoryJob -DiskCartridgeDevice [<BEDiskCartridgeDevice>] [-BackupExecServer [<BEBackupExecServer>]] [-Schedule [<BESchedule>]] [-KeepJobQueuedFor [<TimeSpan>]] [-CancelJobIfRunningAfterScheduledTimeBy [<TimeSpan>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Submit-BEInventoryJob -TapeDriveDevice [<BETapeDriveDevice>] [-BackupExecServer [<BEBackupExecServer>]] [-Schedule [<BESchedule>]] [-KeepJobQueuedFor [<TimeSpan>]] [-CancelJobIfRunningAfterScheduledTimeBy [<TimeSpan>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Submit-BEInventoryJob -RoboticLibraryDevice [<BERoboticLibraryDevice>] [-BackupExecServer [<BEBackupExecServer>]] [-Schedule [<BESchedule>]] [-KeepJobQueuedFor [<TimeSpan>]] [-CancelJobIfRunningAfterScheduledTimeBy [<TimeSpan>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Submit-BEInventoryJob -RoboticLibraryPartition [<BERoboticLibraryPartition>] [-BackupExecServer [<BEBackupExecServer>]] [-Schedule [<BESchedule>]] [-KeepJobQueuedFor [<TimeSpan>]] [-CancelJobIfRunningAfterScheduledTimeBy [<TimeSpan>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Submit-BEInventoryJob -RoboticLibrarySlot [<BERoboticLibrarySlot[]>] [-BackupExecServer [<BEBackupExecServer>]] [-Schedule [<BESchedule>]] [-KeepJobQueuedFor [<TimeSpan>]] [-CancelJobIfRunningAfterScheduledTimeBy [<TimeSpan>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Description

Submits a job to inventory media in a storage device in Backup Exec.

An inventory job updates Backup Exec with the current media information.

Parameters

-DiskCartridgeDevice <BEDiskCartridgeDevice>

Specifies the disk cartridge device to inventory.

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

-TapeDriveDevice <BETapeDriveDevice>

Specifies the tape drive device to inventory.

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

-RoboticLibraryDevice <BERoboticLibraryDevice>

Specifies the robotic library device to inventory.

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

-RoboticLibraryPartition <BERoboticLibraryPartition>

Specifies the robotic library partition to inventory.

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

-RoboticLibrarySlot <BERoboticLibrarySlot[]>

Specifies the robotic library slot to inventory.

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

-Schedule <BESchedule>

Specifies the time and frequency that you want to run the job. See New-BESchedule.

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

-KeepJobQueuedFor <TimeSpan>

Specifies the maximum amount of time past the scheduled start time that Backup Exec considers the job to be missed and reschedules it.

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

-CancelJobIfRunningAfterScheduledTimeBy <TimeSpan>

Specifies the amount of time after the scheduled start time that you want to cancel the job if it is still running.

Required	false
Position	Named
Accepts pipeline input	false
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.BEDiskCartridgeDevice

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

BackupExec.Management.CLI.BETapeDriveDevice

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

BackupExec.Management.CLI.BERoboticLibraryDevice

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

BackupExec.Management.CLI.BERoboticLibraryPartition

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

BackupExec.Management.CLI.BERoboticLibrarySlot

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

Return Value

BackupExec.Management.CLI.BEJob

Submit-BEInventoryJob returns the job that was submitted.

Examples

Example 1

C:\PS> Get-BERoboticLibraryDevice "Device 0001" | Submit-BEInventoryJob

These commands submit a job that inventories the media in the robotic library named "Device 0001".

Example 2

C:\PS> Get-BERoboticLibraryDevice "Device 0001" | Submit-BEInventoryJob -Schedule (New-BESchedule -Daily -StartingAt 10pm)

These commands submit a job that inventories the media in the robotic library named "Device 0001" every day at 10pm.