Rename-BEMediaSet Help

Synopsis

Renames a media set in Backup Exec.

Syntax

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

Description

Renames a media set in Backup Exec.

System-defined media sets cannot be renamed.

Parameters

-InputObject <BEMediaSet>

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

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

Return Value

BackupExec.Management.CLI.BEMediaSet

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

Example

C:\PS> Get-BEMediaSet "MediaSet 0001" | Rename-BEMediaSet -NewName "MediaSet 0002"

These commands rename a media set named "MediaSet 0001" to "MediaSet 0002".