Remove-BEMedia Help

Synopsis

Removes media from Backup Exec.

Syntax

Remove-BEMedia -InputObject [<BEMedia[]>] [-PassThru [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [-Force [<SwitchParameter>]] [<CommonParameters>]

Description

Removes media from Backup Exec.

You can only remove media that is associated with the retired media set. To remove media that is not in Retired Media, use the -Force parameter.

Parameters

-PassThru <SwitchParameter>

Passes the removed object to the pipeline. By default, this cmdlet does not generate any output.

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

-InputObject <BEMedia[]>

Specifies one or more media objects. Enter a variable that contains the objects, or type a command or expression that gets the objects.

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

-Force <SwitchParameter>

Forces the media to be removed even if it is not in Retired Media.

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 Type

BackupExec.Management.CLI.BEMedia

You can pipe a Backup Exec media object to Remove-BEMedia.

Return Value

None or BackupExec.Management.CLI.BEMedia

When you use the PassThru parameter, Remove-BEMedia returns an object that represents the media that was removed. Otherwise, this cmdlet does not generate any output.

Example

C:\PS> Get-BEMedia "Media 0001" | Remove-BEMedia

These commands remove a media object named "Media 0001".