Export (0) Print
Expand All
1 out of 2 rated this helpful - Rate this topic

Set-WebServicesVirtualDirectory

Applies to: Exchange Server 2010

Topic Last Modified: 2011-03-19

Use the Set-WebServicesVirtualDirectory cmdlet to modify an existing Exchange Web Services virtual directory on a server running Microsoft Exchange Server 2010 that has the Client Access server role installed.


Set-WebServicesVirtualDirectory -Identity <VirtualDirectoryIdParameter> [-BasicAuthentication <$true | $false>] [-CertificateAuthentication <$true | $false>] [-Confirm [<SwitchParameter>]] [-DigestAuthentication <$true | $false>] [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-Force <SwitchParameter>] [-GzipLevel <Off | Low | High | Error>] [-InternalNLBBypassUrl <Uri>] [-InternalUrl <Uri>] [-LiveIdBasicAuthentication <$true | $false>] [-LiveIdSpNegoAuthentication <$true | $false>] [-UpdateManagementVirtualDirectory <SwitchParameter>] [-WhatIf [<SwitchParameter>]] [-WindowsAuthentication <$true | $false>] [-WSSecurityAuthentication <$true | $false>]

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter

The Identity parameter specifies the name of the virtual directory. You can also specify a wildcard character instead of the default Web site.

BasicAuthentication

Optional

System.Boolean

The BasicAuthentication parameter specifies whether Basic authentication is enabled on the Exchange Web Services virtual directory. This parameter can be used with the DigestAuthentication and WindowsAuthentication parameters.

CertificateAuthentication

Optional

System.Boolean

The CertificateAuthentication parameter specifies whether certificate authentication is enabled. This parameter affects the <Servername>/ews/management/ virtual directory. It doesn't affect the <Servername>/ews/ virtual directory.

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.

DigestAuthentication

Optional

System.Boolean

The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory.

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.

ExternalUrl

Optional

System.Uri

The ExternalUrl parameter specifies the host name used to connect to the Exchange server from outside the firewall. This setting is also important when Secure Sockets Layer (SSL) is used.

Force

Optional

System.Management.Automation.SwitchParameter

The Force parameter specifies whether to suppress the warning or confirmation messages that appear during specific configuration changes.

GzipLevel

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.GzipLevel

The GzipLevel parameter sets Gzip configuration information for the Exchange Web Services virtual directory. This parameter can be set to the following values:

  • Off   This value results in no compression.
  • Low   This value results in static compression only. Don't use this setting for Exchange Web Services because Exchange Web Services content is dynamic. You get a warning if you set the GzipLevel parameter to this value. If you use this setting, it behaves the same as the Off setting.
  • High   This value results in static and dynamic compression. Content from Exchange Web Services is compressed if clients have indicated support for Gzip compression in their requests.

InternalNLBBypassUrl

Optional

System.Uri

The InternalNLBBypassUrl parameter specifies the URL of the Client Access server, regardless of whether it's behind a Network Load Balancing (NLB) array. Although the InternalUrl parameter is set to the URL of the NLB array, the InternalNLBBypassUrl parameter should always be set to the URL of the Client Access server. This is because certain Exchange Web Services calls require machine affinity, and Exchange Web Services proxy incoming calls to a more appropriate Client Access server whenever possible.

InternalUrl

Optional

System.Uri

The InternalUrl parameter specifies the host name of the Exchange server for a connection from inside the firewall. This setting is also important when SSL is used.

LiveIdBasicAuthentication

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

LiveIdSpNegoAuthentication

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

UpdateManagementVirtualDirectory

Optional

System.Management.Automation.SwitchParameter

The UpdateManagementVirtualDirectory parameter makes sure that the Exchange Web Services objects in Active Directory and the respective objects in Internet Information Services (IIS) are up to date and consistent.

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.

WindowsAuthentication

Optional

System.Boolean

The WindowsAuthentication parameter specifies whether Integrated Windows authentication is permitted on the Exchange Web Services virtual directory.

WSSecurityAuthentication

Optional

System.Boolean

The WSSecurityAuthentication parameter specifies whether Web Services Security authentication is enabled on the Exchange Web Services virtual directory. This parameter can be used with BasicAuthentication, DigestAuthentication, and WindowsAuthentication.

If you have a load balanced set of Client Access servers, you don't have to specify the name of each server when you run the command. It's sufficient to use only the name of one of the networked load balanced servers.

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 "Exchange Web Services settings" entry in the Client Access Permissions topic.

Error Description

 

 

Exceptions Description

 

 

This example sets the authentication method to Basic authentication for the virtual directory EWS on the server Contoso. This example also sets the external and internal URLs for this virtual directory.

Set-WebServicesVirtualDirectory -Identity Contoso\EWS(default Web site)-ExternalUrl https://www.contoso.com/EWS/exchange.asmx -ExternalAuthenticationMethods Basic -InternalUrl https://contoso.internal.com/EWS/exchange.asmx

This example uses a wildcard character instead of "default Web site" as was used in Example 1.

Set-WebServicesVirtualDirectory -Identity Contoso\EWS* -ExternalUrl https://www.contoso.com/EWS/exchange.asmx
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.