Rename-BEStorageDevicePool Help

Synopsis

Renames a storage device pool in Backup Exec.

Syntax

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

Description

Renames a storage device pool in Backup Exec.

System-defined storage device pools cannot be renamed.

Parameters

-InputObject <BEStorageDevicePool>

Specifies the storage device pool 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 storage device pool 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.BEStorageDevicePool

You can pipe a Backup Exec storage device pool object to Rename-BEStorageDevicePool.

Return Value

BackupExec.Management.CLI.BEStorageDevicePool

Rename-BEStorageDevicePool returns an object that represents the storage device pool that was renamed.

Example

C:\PS> Get-BEStorageDevicePool "StorageDevicePool 0001" | Rename-BEStorageDevicePool -NewName "StorageDevicePool 0002"

These commands rename a storage device pool named "StorageDevicePool 0001" to "StorageDevicePool 0002".