Rename-BEMediaVault Help

Synopsis

Renames a media vault in Backup Exec.

Syntax

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

Description

Renames a media vault in Backup Exec.

System-defined media vaults cannot be renamed.

Parameters

-InputObject <BEMediaVault>

Specifies the media vault 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 media vault 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.BEMediaVault

You can pipe a Backup Exec media vault object to Rename-BEMediaVault.

Return Value

BackupExec.Management.CLI.BEMediaVault

Rename-BEMediaVault returns an object that represents the media vault that was renamed.

Example

C:\PS> Get-BEMediaVault "MediaVault 0001" | Rename-BEMediaVault -NewName "MediaVault 0002"

These commands rename a media vault named "MediaVault 0001" to "MediaVault 0002".