Rename-BEMedia Help

Synopsis

Renames media in Backup Exec.

Syntax

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

Description

Renames media in Backup Exec.

Parameters

-InputObject <BEMedia>

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

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

Return Value

BackupExec.Management.CLI.BEMedia

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

Example

C:\PS> Get-BEMedia "Media 0001" | Rename-BEMedia -NewName "Media 0002"

These commands rename a media object named "Media 0001" to "Media 0002".