Rename-BECloudStorageDevice Help

Synopsis

Renames a cloud storage device in Backup Exec.

Syntax

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

Description

Renames a cloud storage device in Backup Exec.

Parameters

-InputObject <BECloudStorageDevice>

Specifies the cloud storage 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 cloud storage 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.BECloudStorageDevice

You can pipe a Backup Exec cloud storage device object to Rename-BECloudStorageDevice.

Return Value

BackupExec.Management.CLI.BECloudStorageDevice

Rename-BECloudStorageDevice returns an object that represents the cloud storage device that was renamed.

Example

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

These commands rename a cloud storage device named "Device 0001" to "Device 0002".