This is an archive version of the document. To get the most up-to-date information, see the current version.

Test-VEXMailboxResolution

Short Description

Tests the availability of Microsoft Exchange mailboxes before a bulk mailbox restore.

Applies to: Veeam Backup & Replication, Veeam Backup for Microsoft Office 365

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides cmdlet sets that allow you to:

  • Test mailbox resolution.

Test-VEXMailboxResolution -Mailbox <VEXMailbox[]> [-Credential <PSCredential>] [-Office365Credential <PSCredential>] [-Domain <String>] [-Force [<SwitchParameter>]] [<CommonParameters>]

  • [Veeam Backup for Microsoft Office 365 only] Test resolution of mailboxes using Multi-factor authentication with an Azure AD application ID.

Test-VEXMailboxResolution -Mailbox <VEXMailbox[]> -ApplicationId <Guid> [-Credential <PSCredential>] [-Domain <String>] [-Force [<SwitchParameter>]] [<CommonParameters>]

  • [Veeam Backup for Microsoft Office 365 only] Multi-factor authentication with an Azure AD application.

Test-VEXMailboxResolution -Mailbox <VEXMailbox[]> -ApplicationId <Guid> -ApplicationCertificatePath <String> [-Credential <PSCredential>] -ApplicationCertificatePassword <SecureString> [-Domain <String>] [-Force [<SwitchParameter>]] [<CommonParameters>]

Detailed Description

This cmdlet tests the availability of mailboxes. You may want to run this cmdlet before you start a bulk mailbox restore.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Mailbox

Specifies a mailbox. The cmdlet will check whether this mailbox is available.

Accepts the VEXMailbox object. To get this object, run the Get-VEXMailbox cmdlet.

True

Named

False

ApplicationId

Specifies an Azure AD application ID. The cmdlet will use this application ID to set up a secure connection to a Microsoft organization.

Note: This parameter works for mailboxes that are backed-up with Veeam Backup for Microsoft Office 365 only.

Guid

True

Named

False

ApplicationCertificatePath

To test mailbox resolution using Multi-factor authentication.

Specifies a path to the folder where the certificate is located. The cmdlet will import the certificate that is located in this path to set up an encrypted connection to a Microsoft organization and to test the mailbox resolution.

Note: This parameter is available for restore from backups created by Veeam Backup for Microsoft Office 365 version 4c and later.

String

True

Named

False

ApplicationCertificatePassword

To test mailbox resolution using Multi-factor authentication.

Specifies the certificate password. The cmdlet will use this password to confirm the certificate that you want to import to an Azure AD application. After that the cmdlet will set up an encrypted connection to a Microsoft organization and will test the mailbox resolution. This parameter is obligatory.

Note: This parameter is available for restore from backups created by Veeam Backup for Microsoft Office 365 version 4c and later.

SecureString

True

Named

False

Domain

Specifies a mailbox domain.

String

False

Named

False

Force

Defines that the cmdlet will ignore the certificated upon the connection.

SwitchParameter

False

Named

False

Office365Credential

Specifies Windows user credentials to connect to the Active Directory domain and the Exchange server.

PSCredential

False

Named

False

Credential

Specifies Office 365 user credentials to connect to the backup proxy server.

PSCredential

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Docs.

Examples

Test-VEXMailboxResolutionExample 1. Testing Mailbox Resolution [For Veeam Backup & Replication]

Test-VEXMailboxResolutionExample 2. Testing Mailboxes Resolution [For Veeam Backup for Microsoft Office 365]

Test-VEXMailboxResolutionExample 3. Testing Mailbox Resolution Using Multi-Factor Authentication with Azure AD Application ID [For Veeam Backup for Microsoft Office 365]

Test-VEXMailboxResolutionExample 4. Testing Mailbox Resolution Using Multi-Factor Authentication with Azure AD Application [For Veeam Backup for Microsoft Office 365]

Related Commands