Use the Backup-Exchange PowerShell cmdlet to back up Exchange Server to a PowerProtect DD series appliance. All cmdlets support the standard common PowerShell parameters. The Microsoft article Exchange Server PowerShell (Exchange Management Shell) provides the list of common parameters and their description.
For self-service backups with protection policies created through Data Manager, run the Import-ExchangeBackupConfigFile cmdlet with the -Backup parameter to import the backup parameters to the object.
Syntax to perform stand-alone server backups
See the following syntax to perform stand-alone server backups:
[<configuration_object>] | Backup-Exchange -BackupViaBlockBasedBackup -ClientName <FQDN_of_Exchange_Server> -DataDomainHost <Data_Domain_hostname> -DataDomainHostPath /<Data_Domain_storage_path> -DataDomainUser <Data_Domain_username> [<optional_parameters>]
- <configuration_object> (optional): Specifies the configuration object that was imported using the Import-ExchangeBackupConfigFile cmdlet.
- -ClientName <FQDN_of_Exchange_Server>: Specifies the FQDN of the Exchange Server to use for indexing the backup.
- -BackupViaBlockBasedBackup: Specifies that the backup is a block-based backup. You can use the -BBB alias for the -BackupViaBlockBasedBackup parameter.
- -DataDomainHost <Data_Domain_hostname>: Specifies the PowerProtect DD series appliance server hostname. You can use the -S, -SH, -DDHost, or -StorageHost alias for the -DataDomainHost parameter.
- -DataDomainHostPath /<Data_Domain_storage_path>: Specifies the full path to the Data Domain storage unit for the backup. The PowerProtect DD series appliance user must have appropriate access rights to this path. You can use the -Path, -DevicePath, -StoragePath, -StorageHostPath, or -DataDomainPath alias for the -DataDomainHostPath parameter.
- -DataDomainUser <Data_Domain_username>: Specifies the PowerProtect DD series appliance username. Full credentials are retrieved from the lockbox to authenticate with the host. -DDUser, -StorageUser You can use the -DDUser or -Storage User alias for the -DataDomainUser parameter.
The following is an example of a backup command:
Backup-Exchange -ClientName myexchange.msapp.com -BackupViaBlockBasedBackup -DataDomainHost myDD.lss.example.com -DataDomainPath /SU_DD163 -DataDomainUser DD163_user
The following is an example of a backup command with a configuration object:
$serverinfo | Backup-Exchange
Syntax to perform federated backup
See the following syntax to perform a federated backup:
[<configuration_object>] | Backup-Exchange -BackupViaBlockBasedBackup -ClientName <FQDN_of_Exchange_Server_DAG> -DataDomainHost <Data_Domain_hostname> -DataDomainHostPath /<Data_Domain_storage_path> -DataDomainUser <Data_Domain_username> {[-BackupActive] | [-BackupPassive] | [-BackupPreferred]} [-IncludeStandaloneDatabases] [-ServerOrderList<comma_separated_list_of_servers>] [<optional_parameters>]
- -ClientName <FQDN_of_Exchange_Server_DAG>: Specifies the FQDN of the database availability group instance to use for indexing the backup.
- {-BackupActive | -BackupPassive | -BackupPreferred} (optional): Specifies that the database backup preference is either active (-BackupActive), passive (-BackupPassive), or preferred (-BackupPreferred).
- -IncludeStandaloneDatabases (optional): Specifies to include stand-alone databases and public folder databases in the backup.
- -ServerOrderList <comma_separated_list_of_servers> (optional): Specifies the preferred Exchange Server order list if you must select multiple copies. Separate multiple servers with commas.
The following is an example is of a federated backup command:
Backup-Exchange -Identity TestDB,'Mailbox Database 1250665181' -ClientName DAG1.msapp.com -BackupViaBlockBasedBackup -DataDomainHost myDD.lss.example.com -DataDomainPath /SU_DD163 -DataDomainUser DD163_user -Preferred -ServerOrderList node1, node2 -IncludeStandaloneDatabases
The following is an example of a federated backup command with a configuration object:
$serverinfo | Backup-Exchange -Identity TestDB,'Mailbox Database 1250665181'
The following list describes the optional parameters for the Backup-Exchange cmdlet:
- -Incremental: Specifies that the backup level is a block-based incremental backup. If you do not specify this parameter, the backup is taken at the full level.
- -Retention +<number>{d | m | w | y}: Specifies the period in which to retain a backup. After the period passes, the backup expires. The default retention period is 30 days. The maximum retention date is 02-07-2106.
- -Identity <database identity>: Specifies the identity of the database to back up. If you do not specify this parameter, the operation backs up all databases.
- -LockBoxPath <full_path_to_lockbox>: Specifies the folder that contains the lockbox file, which contains encrypted information about the registered hosts and the corresponding usernames in pairs. Each pair is associated with a password that the backups use.
- -ExeFileName <msagentsv.exe_path>: Specifies the full path to the application program executable msagentsv.exe. Use this option only for diagnosis. In normal operations, the cmdlet automatically locates the installed application.
- -AsJob {$true | $false}: Runs the cmdlet as a background job. The command returns an object that represents the job and displays the command prompt. You can continue to work in the session during the job.
- -Parallelism <parallelism_value>: Specifies the parallelism setting for the backup.
Note: For a complete list of available options, see the PowerProtect Data Manager: Microsoft Exchange Server User Guide