Rename-BEBackupTask Help

Synopsis

Renames a backup task in a backup definition in Backup Exec.

Syntax

Rename-BEBackupTask -BackupDefinition [<BEBackupDefinition>] [-Name] [<String>] [-NewName] [<String>] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Rename-BEBackupTask -BackupJobDefault [<BEBackupJobDefaults>] [-Name] [<String>] [-NewName] [<String>] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Description

Renames a backup task in a backup definition in Backup Exec.

To rename a backup task in a new backup definition, use Rename-BEBackupTask and New-BEBackupDefinition.

To rename a backup task in an existing backup definition, use Rename-BEBackupTask and Get-BEBackupDefinition.

To rename a backup task in the backup job defaults, use Rename-BEBackupTask and Get-BEBackupJobDefault.

When you create or edit a backup definition, the backup definition must be passed to Save-BEBackupDefinition to commit the changes.

When you edit the backup job defaults, the backup job defaults must be passed to Save-BEBackupJobDefault to commit the changes.

Parameters

-BackupDefinition <BEBackupDefinition>

Specifies the backup definition to modify.

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

-BackupJobDefault <BEBackupJobDefaults>

Specifies the backup job defaults to modify.

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

-Name <String>

Specifies the name of the backup task in the backup definition to rename.

Required	true
Position	0
Accepts pipeline input	false
Accepts wildcard characters	false

-NewName <String>

The new name of the backup task.

Required	true
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 Types

BackupExec.Management.CLI.BEBackupDefinition

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

BackupExec.Management.CLI.BackupJobDefault

You can pipe a Backup Exec backup job default object to Rename-BEBackupTask.

Return Values

BackupExec.Management.CLI.BEBackupDefinition

The backup definition that has been modified.

BackupExec.Management.CLI.BackupJobDefault

The backup job default that has been modified.

Examples

Example 1

C:\PS> Get-BEBackupDefinition "Backup Definition 01" | Rename-BEBackupTask -Name "Full" -NewName "Full 1" | Save-BEBackupDefinition

These commands rename the backup named "Full" in the backup definition named "Backup Definition 01" to "Full 1".

Example 2

C:\PS> Get-BEBackupDefinition "Backup Definition 01" | Rename-BEBackupTask -Name "Duplicate" -NewName "Duplicate 1" | Save-BEBackupDefinition

These commands rename the duplicate stage named "Duplicate" in the backup definition named "Backup Definition 01" to "Duplicate 1".

Example 3

C:\PS> Get-BEBackupJobDefault BackupToDisk | Rename-BEBackupTask -Name "Full" -NewName "Full 1" | Save-BEBackupJobDefault

These commands rename the backup named "Full" in the back up to disk job defaults to "Full 1".