Rename-BEOpenStorageDevice Help

Synopsis

Renames an OpenStorage device in Backup Exec.

Syntax

Rename-BEOpenStorageDevice [-InputObject] [<BEOpenStorageDevice>] [[-NewName] [<String>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Description

Renames an OpenStorage device in Backup Exec.

Parameters

-InputObject <BEOpenStorageDevice>

Specifies the OpenStorage device object to rename.

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

-NewName <String>

Specifies the new name to assign to the OpenStorage device object.

Required	false
Position	1
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.BEOpenStorageDevice

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

Return Value

BackupExec.Management.CLI.BEOpenStorageDevice

Rename-BEOpenStorageDevice returns an object that represents the OpenStorage device that was renamed.

Example

C:\PS> Get-BEOpenStorageDevice "Device 0001" | Rename-BEOpenStorageDevice -NewName "Device 0002"

These commands rename an OpenStorage device named "Device 0001" to "Device 0002".