Rename-BEBackupDefinition Help

Synopsis

Renames a backup definition in Backup Exec.

Syntax

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

Description

Renames a backup definition in Backup Exec.

Parameters

-InputObject <BEBackupDefinition>

Specifies the backup definition object that you want to rename.

Required	true
Position	0
Accepts pipeline input	true (ByValue)
Accepts wildcard characters	false

-NewName <String>

The new name to assign to the backup definition 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.BEBackupDefinition

You can pipe a Backup Exec backup definition object to Rename-BEBackupDefinition.

Return Value

BackupExec.Management.CLI.BEBackupDefinition

Rename-BEBackupDefinition returns an object that represents the backup definition that was renamed.

Example

C:\PS> Get-BEBackupDefinition "Backup Definition 01" | Rename-BEBackupDefinition -NewName "Backup Definition 02"

These commands rename a backup definition named "Backup Definition 01" to "Backup Definition 02".