Remove-BEOpenStorageDevice Help

Synopsis

Removes an OpenStorage devices from Backup Exec.

Syntax

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

Description

Removes an OpenStorage devices from Backup Exec.

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

Specifies one or more OpenStorage device 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 would happen if you executed 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.BEOpenStorageDevice

You can pipe a Backup Exec OpenStorage device object to Remove-BEOpenStorageDevice.

Return Value

None or BackupExec.Management.CLI.BEOpenStorageDevice

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

Example

C:\PS> Get-BEOpenStorageDevice "Device 0001" | Remove-BEOpenStorageDevice

These commands remove an OpenStorage device named "Device 0001".