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

Exports a backup definition's job settings to a PowerShell script.

Syntax
Export-BEBackupDefinition [-BackupDefinition] <BEBackupDefinition> [<CommonParameters>]
Description

Exports a backup definition's job settings to a PowerShell script.

The script that Export-BEBackupDefinition generates is synonymous to a job policy in previous releases of Backup Exec.

The script can be used to create new backup jobs for additional agent servers and backup selections using the same job settings that were contained in the original backup definition.

Since the script is self-contained, it can be run on other Backup Exec servers.

In order to run the generated script, PowerShell's execution policy must set to a value that is less restrictive than AllSigned (e.g. RemoteSigned). For more information, see Get-Help Set-ExecutionPolicy.

Parameters

-BackupDefinition <BEBackupDefinition>

The backup definition to export.


Required true
Position 0
Accepts pipeline input true (ByValue)
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 definition object to Export-BEBackupDefinition

Return Value
System.String

Export-BEBackupDefinition returns a PowerShell script capable of recreating the backup definition's job settings.

Example
C:\PS> Get-BEBackupDefinition "Backup 01" | Export-BEBackupDefinition > ExportedBackup01.ps1
C:\PS> Get-BEAgentServer "myserver.mycompany.com" | .\ExportedBackup01.ps1 -FileSystemSelection C:\Users\* | Save-BEBackupDefinition

These commands export the job settings of a backup definition named "Backup 01" to a PowerShell script file named "ExportedBackup01.ps1". The script file is then used to back up the C:\Users directory of a server named "myserver.mycompany.com" using the same job settings that were in the backup definition named "Backup 01".

Since the script file is self-contained, it can be copied to and run from a different Backup Exec server.

Related Links

Get-BEBackupDefinition
Get-BEAgentServer
Save-BEBackupDefinition