PowerProtect Data Manager 19.13 Microsoft Exchange Server User Guide

The following list details the optional parameters for the Restore-Exchange cmdlet:

-ExcludeClientNameResolution

Uses the client name that is provided as-is without converting it to the fully qualified domain name (FQDN).

Use this parameter to restore a backup taken with Microsoft application agent version 4.5 or earlier that uses the short name as the client name.

You can use the -ExcludeCNResolution alias for the -ExcludeClientNameResolution parameter.

-Confirm:{$true | $false}

Specifies whether to enable confirmation prompts for the operation. The default value is $true.

-PointInTime:{$true | $false}

Specifies whether to perform a point-in-time-restore operation. The default value is $true.

You can use the -PIT alias for the -PointInTime parameter.

-ExchangeServer <short_name>

Specifies the short name of the Microsoft Exchange Server, for example, ledmf999, if the name is different from the local hostname.

If you do not specify a value, the parameter takes the local hostname by default.

-DataDomainVDiskUser <DD_vdisk_user>

Specifies the DD vdisk user.

If you do not specify this parameter, the value defaults to the -DataDomainUser value.

Full credentials are retrieved from the lockbox to authenticate with the host.

You can use the -DDVDiskUser, -VDiskUser, or -VDU alias for the -DataDomainVDiskUser parameter.

-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 backups use.

You can use the -LB or -LBPath alias for the -LockBoxPath parameter.

-Debug

Specifies to enable the PowerShell debug output. By default, the cmdlet pauses on every debug output.

-DebugLevel <1_through_9>

Specifies the debug level for the backup. The default value is 0 (zero).

You can use the -DL or -D alias for the -DebugLevel parameter.

-DeleteDebugLogsInDays <number_of_days>

Deletes debug log files that are older than the specified number of days. The valid range is between 1 and 32767

By default, debug logs are deleted after 30 days. Regularly deleting debug logs prevents the log folder on the installation drive from becoming too large.

This parameter only deletes debug logs named in the default format and located in the logs folder at <installation_path>\MSAPPAGENT\logs.

-Verbose

Indicates the verbose output. In this context, the standard output stream of the Microsoft application agent appears.

You can use the -vb alias for the -Verbose parameter.

-VeryVerbose {True | False}

Increases the volume of the verbose output.

To use this parameter, you must also specify the -Verbose parameter.

The default value is False.

-ExeFileName <msagentrc.exe_path>

Specifies the full path to the application program executable, that is, msagentrc.exe.

Use this option only to diagnose. 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 then displays the command prompt. You can continue to work in the session during the job.

You can use the -AJ or -Job alias for the -AsJob parameter.

-JobName <name>

Specifies a friendly name for the job when you use this parameter with the -AsJob parameter. If you do not specify the -AsJob parameter, the -JobName parameter is ignored.

You can use the name to identify the job against other job cmdlets such as, Stop-Job.