Submit-BEEjectMediaJob Help

Synopsis

Submits a job to eject the media that is in a disk cartridge or tape drive device in Backup Exec.

Syntax

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

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

Description

Submits a job to eject the media that is in a disk cartridge or tape drive device in Backup Exec.

Some devices do not support a software-driven media eject. If the media is a tape, the tape is rewound and you may be prompted to manually remove it.

Parameters

-DiskCartridgeDevice <BEDiskCartridgeDevice>

Specifies the disk cartridge media to eject.

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

-TapeDriveDevice <BETapeDriveDevice>

Specifies the tape media to eject.

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

BackupExec.Management.CLI.BETapeDriveDevice

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

Return Value

BackupExec.Management.CLI.BEJob

Submit-BEEjectMediaJob returns the job that was submitted.

Example

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

These commands submit an eject job that ejects the media in the tape drive device named "Device 0001".