Remove-BEBackupTask Help

Synopsis

Removes a backup task from a backup definition in Backup Exec.

Syntax

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

Remove-BEBackupTask -BackupDefinition [<BEBackupDefinition>] -SimultaneousConvertToVirtualStage [<SwitchParameter>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

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

Description

Removes a backup task from a backup definition in Backup Exec. You cannot remove the initial full backup from a backup definition.

To remove a backup task from a new backup definition, use Remove-BEBackupTask and New-BEBackupDefinition.

To remove a backup task from an existing backup definition, use Remove-BEBackupTask and Get-BEBackupDefinition.

To remove a backup task from the backup job defaults, use Remove-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

-SimultaneousConvertToVirtualStage <SwitchParameter>

Removes the simultaneous convert-to-virtual stage from the backup definition.

Required	true
Position	Named
Accepts pipeline input	false
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 one or more backup tasks to remove from the backup definition by backup task name (wildcards accepted). To specify multiple names, use commas to separate the names.

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

-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 Remove-BEBackupTask.

BackupExec.Management.CLI.BackupJobDefault

You can pipe a Backup Exec backup job default object to Remove-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-BEAgentServer -Local | New-BEBackupDefinition -BackupJobDefault BackupToDisk | Remove-BEBackupTask "Incremental" | Save-BEBackupDefinition

These commands create a new backup definition for the local computer that removes the default incremental backup.

Example 2

C:\PS> Get-BEBackupDefinition "Backup Definition 01" | Remove-BEBackupTask * | Save-BEBackupDefinition

These commands remove all of the backup tasks, except for the initial full backup, from a backup definition named "Backup Definition 01".

Example 3

C:\PS> Get-BEBackupJobDefault BackupToDisk | Remove-BEBackupTask * | Save-BEBackupJobDefault

These commands remove all of the backup tasks, except for the initial full backup, from the back up to disk job defaults.