Rename-BETapeDriveDevice Help

Synopsis

Renames a tape drive device in Backup Exec.

Syntax

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

Description

Renames a tape drive device in Backup Exec.

Parameters

-InputObject <BETapeDriveDevice>

Specifies the tape drive 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 tape drive 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.BETapeDriveDevice

You can pipe a Backup Exec tape drive device object to Rename-BETapeDriveDevice.

Return Value

BackupExec.Management.CLI.BETapeDriveDevice

Rename-BETapeDriveDevice returns an object that represents the tape drive device that was renamed.

Example

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

These commands rename a tape drive device named "Device 0001" to "Device 0002".