Backup Exec Management Command Line Interface Help
Remove-BEBackupDefinition Cmdlet
Synopsis

Removes a backup definition from Backup Exec.

Syntax
Remove-BEBackupDefinition -InputObject [<BEBackupDefinition[]>] [-PassThru [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Description

Removes a backup definition from Backup Exec. When you remove a backup definition, the jobs associated with the backup definition are also removed.

Parameters

-PassThru <SwitchParameter>

Passes the removed object to the pipeline. By default, this cmdlet does not generate any output.


Required false
Position Named
Accepts pipeline input false
Accepts wildcard characters false


-InputObject <BEBackupDefinition[]>

Specifies one or more backup definition objects. Enter a variable that contains the objects, or type a command or expression that gets the objects.


Required true
Position Named
Accepts pipeline input true (ByValue)
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


<CommonParameters>

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

Return Value
None or BackupExec.Management.CLI.BEBackupDefinition

When you use the PassThru parameter, Remove-BEBackupDefinition returns an object that represents the backup definition that was removed. Otherwise, this cmdlet does not generate any output.

Examples

Example 1

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

These commands remove a backup definition named "Backup Definition 01".


Example 2
C:\PS> Get-BEBackupDefinition | Remove-BEBackupDefinition

These commands remove all of the backup definitions.

Related Link

Get-BEBackupDefinition