Test-OutlookWebServices

  • Article

 

Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3

Use the Test-OutlookWebServices cmdlet to verify the Autodiscover service settings for Microsoft Outlook on a computer that is running Microsoft Exchange Server 2007 that has the Client Access server role installed.

Syntax

Test-OutlookWebServices [-Identity <RecipientIdParameter>] [-ClientAccessServer <ClientAccessServerIdParameter>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-MonitoringContext <$true | $false>] [-TargetAddress <RecipientIdParameter[]>] [-WhatIf [<SwitchParameter>]]

Detailed Description

Use the Test-OutlookWebServices cmdlet to verify the Autodiscover service settings for Microsoft Outlook on an Exchange 2007 server that has the Client Access role installed. The Test-OutlookWebServices cmdlet uses a specified e-mail address to verify that the Outlook provider is configured correctly. The optional MonitoringLogFile parameter indicates whether the results are written to the log file for Microsoft Operations Manager (MOM).

To run the Test-OutlookWebServices cmdlet, the account you use must be delegated the Exchange Server Administrator role and membership in the local Administrators group for the target server.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange 2007, see Permission Considerations.

Parameters

Parameter Required Type Description

ClientAccessServer

Optional

Microsoft.Exchange.Configuration.Tasks.ClientAccessServerIdParameter

This parameter specifies the Client Access server that the client will access.

Confirm

Optional

System.Management.Automation.SwitchParameter

This parameter causes the command to pause processing and requires that you acknowledge what the command will do before processing continues. You do not have to specify a value with the Confirm parameter.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the domain controller to use to write this configuration change to the Active Directory directory service. Use the fully qualified domain name (FQDN) of the domain controller that you want to use.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

This parameter specifies any valid e-mail address in the forest. If you specify this parameter, incorrectly formed e-mail addresses and addresses that are outside the forest are rejected. This address is used to test the Outlook provider. This property accepts the domain and user name in the domain\user name format or an Active Directory GUID and resolves them to the SMTP address that is needed to authenticate.

MonitoringContext

Optional

System.Boolean

This parameter specifies whether the results of the command will include monitoring events and performance counters. The two possible values for this parameter are $true and $false. If you specify $true, the results will include monitoring events and performance counters, in addition to information about the MAPI transaction.

TargetAddress

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

This parameter specifies the recipient that is used to test whether Availability service data can be retrieved.

WhatIf

Optional

System.Management.Automation.SwitchParameter

This parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. You do not have to specify a value with the WhatIf parameter.

Input Types

Return Types

Errors

Error Description

 

 

Exceptions

Exceptions Description

 

 

Example

The following code example verifies the service information that is returned to the Outlook 2007 client from the Autodiscover service for a user who is named monika@contoso.com. The code example verifies information for the following services:

  • Availability service

  • Outlook Anywhere

  • Offline Address Book

  • Unified Messaging

This code example tests for a connection to each service. This example also submits a request to the Availability service for the user monika@contoso.com to determine whether the user's free/busy information is being returned correctly from the Client Access server to the Outlook 2007 client.

test-OutlookWebServices -identity:monika@contoso.com