Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Test-ArchiveConnectivity

 

Applies to: Exchange Server 2013

Topic Last Modified: 2013-10-17

Use the Test-ArchiveConnectivity cmdlet to verify archive functionality for a mailbox user.

For information about the parameter sets in the Syntax section below, see Syntax.

Test-ArchiveConnectivity -UserSmtp <SmtpAddress> [-Confirm [<SwitchParameter>]] [-IncludeArchiveMRMConfiguration <SwitchParameter>] [-MessageId <String>] [-WhatIf [<SwitchParameter>]]

This example tests archive connectivity to Gurinder Singh's archive.

Test-ArchiveConnectivity -UserSmtp gsingh@contoso.com

This command retrieves mailboxes that have a cloud-based archive provisioned and tests archive connectivity for each mailbox.

Get-Mailbox -Filter {ArchiveGuid -ne $null -and ArchiveDomain -ne $null} -ResultSize Unlimited | Test-ArchiveConnectivity

Running the Test-ArchiveConnectivity cmdlet validates connectivity to a user's archive mailbox. End-to-end verification includes testing whether an on-premises or cloud-based archive is provisioned for the on-premises mailbox user and whether it's enabled and logging on to the archive mailbox on behalf of the user. Successful completion of the command indicates that processes such as the Managed Folder Assistant and Microsoft Office Outlook Web App are able to successfully access the archive mailbox.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "In-Place Archive – Test connectivity" entry in the Messaging Policy and Compliance Permissions topic.

 

Parameter Required Type Description

UserSmtp

Required

Microsoft.Exchange.Data.SmtpAddress

The UserSmtp parameter specifies the SMTP address of the mailbox.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

IncludeArchiveMRMConfiguration

Optional

System.Management.Automation.SwitchParameter

The IncludeArchiveMRMConfiguration switch retrieves retention tags provisioned in the user's archive mailbox and the last time the archive was processed by the Managed Folder Assistant.

MessageId

Optional

System.String

This parameter is reserved for internal Microsoft use.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.