Applies to: Exchange Server 2013
Topic Last Modified: 2012-11-28
Use the Set-OutlookAnywhere cmdlet to modify the properties on a computer running Microsoft Exchange Server 2013 enabled for Microsoft Outlook Anywhere.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Set-OutlookAnywhere -Identity
<VirtualDirectoryIdParameter> [-Confirm
[<SwitchParameter>]] [-DefaultAuthenticationMethod <Basic
| Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic
| WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos |
Negotiate | LiveIdNegotiate | Misconfigured>] [-DomainController
<Fqdn>] [-ExtendedProtectionFlags
<MultiValuedProperty>] [-ExtendedProtectionSPNList
<MultiValuedProperty>] [-ExtendedProtectionTokenChecking
<None | Allow | Require>]
[-ExternalClientAuthenticationMethod <Basic | Digest | Ntlm |
Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity |
Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate |
LiveIdNegotiate | Misconfigured>] [-ExternalClientsRequireSsl
<$true | $false>] [-ExternalHostname <String>]
[-IISAuthenticationMethods <MultiValuedProperty>]
[-InternalClientAuthenticationMethod <Basic | Digest | Ntlm |
Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity |
Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate |
LiveIdNegotiate | Misconfigured>] [-InternalClientsRequireSsl
<$true | $false>] [-InternalHostname <String>] [-Name
<String>] [-SSLOffloading <$true | $false>] [-WhatIf
[<SwitchParameter>]] [-XropUrl <Uri>]
|
Examples
EXAMPLE 1
This example sets the client authentication method to NTLM for the /rpc virtual directory on the Client Access server CAS01.
Copy Code | |
---|---|
Set-OutlookAnywhere -Identity:CAS01\rpc (Default Web Site) -ExternalClientAuthenticationMethod:Ntlm |
EXAMPLE 2
This example sets SSL offloading for the /rpc virtual directory to false, which means that SSL isn't used for securing client connections to the Client Access server EXCH1.
Copy Code | |
---|---|
Set-OutlookAnywhere -Identity 'EXCH1\rpc (Default Web Site)' -SSLOffloading $false |
EXAMPLE 3
This example sets the authentication method for the /rpc virtual directory setting in IIS to NTLM.
Copy Code | |
---|---|
Set-OutlookAnywhere -Identity 'EXCH1\rpc (Default Web Site)' -IISAuthenticationMethods NTLM |
EXAMPLE 4
This example sets the available authentication methods for the /rpc virtual directory setting in IIS to use both Basic and NTLM authentication. After you set this value, you can use the IIS virtual directory to handle authentication for multiple applications that require different authentication methods.
Copy Code | |
---|---|
Set-OutlookAnywhere -Identity 'EXCH1\rpc (Default Web Site)' -IISAuthenticationMethods Basic,NTLM |
Detailed Description
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 "Outlook Anywhere configuration (enable, disable, change, view)" entry in the Clients and Mobile Devices Permissions topic.
Parameters
Parameter | Required | Type | Description | ||||
---|---|---|---|---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter |
The Identity parameter specifies the name or GUID of the virtual directory. It's represented as: ServerName\VirtualDirectoryName (WebsiteName). |
||||
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. |
||||
DefaultAuthenticationMethod |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.AuthenticationMethod |
The DefaultAuthenticationMethod parameter can be specified to set the ExternalClientAuthenticationMethod, InternalClientAuthenticationMethod, and IISAuthenticationMethods parameters to the same authentication value. This authentication method can be set to one of these values:
|
||||
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
||||
ExtendedProtectionFlags |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ExtendedProtectionFlags parameter is used to customize the options you use if you're using Extended Protection for Authentication. The possible values are:
|
||||
ExtendedProtectionSPNList |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the specified virtual directory. The possible values are:
|
||||
ExtendedProtectionTokenChecking |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.ExtendedProtectionTokenCheckingMode |
The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the specified Exchange virtual directory. Extended Protection for Authentication isn't enabled by default. The available settings are:
|
||||
ExternalClientAuthenticationMethod |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.AuthenticationMethod |
The ExternalClientAuthenticationMethod parameter specifies the authentication method used for external client authentication. Possible values include:
|
||||
ExternalClientsRequireSsl |
Optional |
System.Boolean |
The ExternalClientsRequireSsl parameter specifies whether
clients connecting via Outlook Anywhere from outside the network
must use Secure Sockets Layer (SSL). The default value is
|
||||
ExternalHostname |
Optional |
System.String |
The ExternalHostname parameter specifies the external host name to use in the Microsoft Outlook profiles for users enabled for Outlook Anywhere. |
||||
IISAuthenticationMethods |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The IISAuthenticationMethods parameter specifies the authentication method enabled on the /rpc virtual directory in Internet Information Services (IIS). You can set the virtual directory to allow Basic authentication or NTLM authentication. Alternatively, you can also set the virtual directory to allow both Basic and NTLM authentication. All other authentication methods are disabled. You may want to enable both Basic and NTLM authentication if you're using the IIS virtual directory with multiple applications that require different authentication methods.
For more information about configuring this parameter with multiple values, see the example later in this topic. |
||||
InternalClientAuthenticationMethod |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.AuthenticationMethod |
The InternalClientAuthenticationMethod parameter specifies the authentication method used for internal client authentication. Possible values include:
|
||||
InternalClientsRequireSsl |
Optional |
System.Boolean |
The InternalClientsRequireSsl parameter specifies whether
clients connecting via Outlook Anywhere from inside the network
require SSL. The default value is |
||||
InternalHostname |
Optional |
System.String |
The InternalHostname parameter specifies the internal hostname for the Outlook Anywhere virtual directory. |
||||
Name |
Optional |
System.String |
The Name parameter specifies the name of the user. |
||||
SSLOffloading |
Optional |
System.Boolean |
The SSLOffloading parameter specifies whether the Client
Access server requires SSL. This value should be set only to
|
||||
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. |
||||
XropUrl |
Optional |
System.Uri |
This parameter is reserved for internal Microsoft use. |
Input Types
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.
Return Types
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.