Remove-BEMediaVault Help

Synopsis

Removes media vaults from Backup Exec.

Syntax

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

Description

Removes media vaults from Backup Exec.

You cannot remove system-defined media vaults.

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 <BEMediaVault[]>

Specifies one or more media vault 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

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

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

Return Value

None or BackupExec.Management.CLI.BEMediaVault

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

Example

C:\PS> Get-BEMediaVault "MediaVault 0001" | Remove-BEMediaVault

These commands remove a media vault named "MediaVault 0001".