Get-BEBackupDefinition Help

Synopsis

Gets backup definitions in Backup Exec.

Syntax

Get-BEBackupDefinition [[-Name] [<String[]>]] [<CommonParameters>]

Get-BEBackupDefinition -AgentServer [<BEAgentServer[]>] [[-Name] [<String[]>]] [<CommonParameters>]

Get-BEBackupDefinition [-Id] [<Guid[]>] [<CommonParameters>]

Get-BEBackupDefinition -InputObject [<BEBackupDefinition[]>] [<CommonParameters>]

Description

Gets backup definitions in Backup Exec.

Without parameters, Get-BEBackupDefinition gets all of the Backup Exec backup definitions. You can also specify an backup definition by backup definition name or backup definition ID (Guid) or pass a backup definition object through the pipeline to Get-BEBackupDefinition.

Get-BEBackupDefinition can be used with the following commands to modify the tasks in the backup definition: Set-BEBackupDefinition, Add-BEIncrementalBackupTask, Add-BEDifferentialBackupTask, Add-BEDuplicateStageBackupTask, Add-BEConvertToVirtualStageBackupTask, Add-BEVerifyBackupTask, Set-BEIncrementalBackupTask, Set-BEDifferentialBackupTask, Set-BEDuplicateStageBackupTask, Set-BEVerifyBackupTask, and Remove-BEBackupTask.

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

Parameters

-AgentServer <BEAgentServer[]>

Specifies one or more agent server objects to filter the backup definitions. Enter a variable that contains the objects, or type a command or expression that gets the objects. See Get-BEAgentServer.

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

-Name <String[]>

Specifies one or more backup definitions by backup definition name (wildcards accepted). To specify multiple names, use commas to separate the names.

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

-Id <Guid[]>

Specifies one or more backup definitions by backup definition ID (Guid). To specify multiple IDs, use commas to separate the IDs.

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

For more information about common parameters, type "Get-Help about_commonparameters".

Input Types

BackupExec.Management.CLI.BEAgentServer

You can pipe a Backup Exec agent server object to filter backup definitions returned by Get-BEBackupDefinition.

System.Guid

You can pipe a System.Guid that contains the ID of a backup definition object to Get-BEBackupDefinition.

BackupExec.Management.CLI.BEBackupDefinition

You can pipe a backup definition object to Get-BEBackupDefinition.

Return Value

BackupExec.Management.CLI.BEBackupDefinition

Get-BEBackupDefinition returns objects that represent Backup Exec backup definitions.

Examples

Example 1

C:\PS> Get-BEBackupDefinition

This command gets all of the backup definitions.

Example 2

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

This command gets the backup definition named "Backup Definition 01".

Example 3

C:\PS> Get-BEBackupDefinition -Name "Backup*"

This command gets all of the backup definitions that match the wildcard "Backup*".

Example 4

C:\PS> Get-BEAgentServer -Local | Get-BEBackupDefinition

These commands get all of the backup definitions for the local computer.

Example 5

C:\PS> Get-BEBackupDefinition "Backup Definition 01" | Set-BEBackupDefinition -FileSystemSelection D:\* | Save-BEBackupDefinition

These commands add D:\* to the backup selections for the backup definition named "Backup Definition 01".

Example 6

C:\PS> Get-BEBackupDefinition "Backup Definition 01" | Add-BEDifferentialBackupTask | Save-BEBackupDefinition

These commands add a differential backup to a backup definition named "Backup Definition 01".