Set-OutlookAnywhere

 

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

The Set-OutlookAnywhere cmdlet is used to modify the properties on a computer that is running Microsoft Exchange Server 2007 that has the Client Access server role installed and is enabled for Outlook Anywhere.

Syntax

Set-OutlookAnywhere -Identity <VirtualDirectoryIdParameter> [-ClientAuthenticationMethod <Basic | Digest | Ntlm | Fba | WindowsIntegrated | Misconfigured>] [-Confirm [<SwitchParameter>]] [-DefaultAuthenticationMethod <Basic | Digest | Ntlm | Fba | WindowsIntegrated | Misconfigured>] [-DomainController <Fqdn>] [-ExternalHostname <Hostname>] [-IISAuthenticationMethods <MultiValuedProperty>] [-Name <String>] [-SSLOffloading <$true | $false>] [-WhatIf [<SwitchParameter>]]

Set-OutlookAnywhere [-ClientAuthenticationMethod <Basic | Digest | Ntlm | Fba | WindowsIntegrated | Misconfigured>] [-Confirm [<SwitchParameter>]] [-DefaultAuthenticationMethod <Basic | Digest | Ntlm | Fba | WindowsIntegrated | Misconfigured>] [-DomainController <Fqdn>] [-ExternalHostname <Hostname>] [-IISAuthenticationMethods <MultiValuedProperty>] [-Instance <ADRpcHttpVirtualDirectory>] [-Name <String>] [-SSLOffloading <$true | $false>] [-WhatIf [<SwitchParameter>]]

Detailed Description

The Set-OutlookAnywhere cmdlet is used to modify the properties on an Exchange 2007 Client Access server that is enabled for Outlook Anywhere.

To run the Set-OutlookAnywhere cmdlet, the account you use must be delegated the Exchange Server Administrator role and 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
Confirm	Optional	System.Management.Automation.SwitchParameter	The Confirm 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	To specify the fully qualified domain name of the domain controller that retrieves data from the Active Directory directory service, include the DomainController parameter in the command.
ExternalHostname	Optional	Microsoft.Exchange.Data.Hostname	This parameter specifies the external host name to use in the Outlook profiles for users who are enabled for Outlook Anywhere.
Identity	Required	Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter	This parameter specifies the name or GUID of the virtual directory. It is represented as: ServerName\VirtualDirectoryName (WebsiteName).
ClientAuthenticationMethod	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.AuthenticationMethod	This parameter specifies the authentication method that the Autodiscover service will provide to the Outlook Anywhere clients to authenticate to the Client Access server. The authentication method can be set to Basic or NTLM. Note   This parameter must be specified if you do not use the DefaultAuthenticationMethod parameter. When you use this parameter without specifying the IISAuthenticationMethods parameter, the authentication method is set to both NTLM and Basic.
DefaultAuthenticationMethod	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.AuthenticationMethod	This parameter can be used to set both the ClientAuthenticationMethod parameter and the IISAuthenticationMethods parameter to the same authentication value. When you set an authentication value by using the DefaultAuthenticationMethod parameter, you force the specified authentication method to be used on the /rpc virtual directory in Internet Information Services (IIS). The authentication method can be set to Basic or NTLM. Note   If the DefaultAuthenticationMethod parameter is specified, neither the ClientAuthenticationMethod nor the IISAuthenticationMethods parameters can be used.
IISAuthenticationMethods	Optional	Microsoft.Exchange.Data.MultiValuedProperty	This parameter specifies the authentication methods that will be enabled on the /rpc virtual directory in IIS. When you use this parameter, all other authentication methods will be disabled. More than one value can be specified for this parameter by using a comma to separate the list of authentication methods. For example: NTLM, Basic.
Instance	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.ADRpcHttpVirtualDirectory	This parameter enables you to pass an entire object to the command to be processed. It is mainly used in scripts where an entire object must be passed to the command.
Name	Optional	System.String	Use the name parameter to specify name of the user.
SSLOffloading	Optional	System.Boolean	This parameter specifies whether the Client Access server requires Secure Sockets Layer (SSL). This value should be set only to $true when an SSL hardware solution is running in front of the Client Access server.
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

This code example sets the external authentication method to NTLM for the Client Access server named CAS01.

Set-OutlookAnywhere -Identity:"CAS01\Rpc (Default Web Site)" -ClientAuthenticationMethod:NTLM