Export (0) Print
Expand All

Set-ActiveSyncVirtualDirectory

 

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

Topic Last Modified: 2012-03-26

The Set-ActiveSyncVirtualDirectory command enables you to configure the Microsoft Exchange ActiveSync settings on a specified virtual directory.


Set-ActiveSyncVirtualDirectory -Identity <VirtualDirectoryIdParameter> [-ActiveSyncServer <String>] [-BadItemReportingEnabled <$true | $false>] [-BasicAuthEnabled <$true | $false>] [-ClientCertAuth <Ignore | Accepted | Required>] [-CompressionEnabled <$true | $false>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ExternalAuthenticationMethods <MultiValuedProperty>] [-ExternalUrl <Uri>] [-InstallIsapiFilter <$true | $false>] [-InstallProxySubDirectory <$true | $false>] [-InternalAuthenticationMethods <MultiValuedProperty>] [-InternalUrl <Uri>] [-MobileClientCertificateAuthorityURL <String>] [-MobileClientCertificateProvisioningEnabled <$true | $false>] [-MobileClientCertTemplateName <String>] [-Name <String>] [-RemoteDocumentsActionForUnknownServers <Nullable>] [-RemoteDocumentsAllowedServers <MultiValuedProperty>] [-RemoteDocumentsBlockedServers <MultiValuedProperty>] [-RemoteDocumentsInternalDomainSuffixList <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]] [-WindowsAuthEnabled <$true | $false>]


Set-ActiveSyncVirtualDirectory [-ActiveSyncServer <String>] [-BadItemReportingEnabled <$true | $false>] [-BasicAuthEnabled <$true | $false>] [-ClientCertAuth <Ignore | Accepted | Required>] [-CompressionEnabled <$true | $false>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ExternalAuthenticationMethods <MultiValuedProperty>] [-ExternalUrl <Uri>] [-InstallIsapiFilter <$true | $false>] [-InstallProxySubDirectory <$true | $false>] [-Instance <ADMobileVirtualDirectory>] [-InternalAuthenticationMethods <MultiValuedProperty>] [-InternalUrl <Uri>] [-MobileClientCertificateAuthorityURL <String>] [-MobileClientCertificateProvisioningEnabled <$true | $false>] [-MobileClientCertTemplateName <String>] [-Name <String>] [-RemoteDocumentsActionForUnknownServers <Nullable>] [-RemoteDocumentsAllowedServers <MultiValuedProperty>] [-RemoteDocumentsBlockedServers <MultiValuedProperty>] [-RemoteDocumentsInternalDomainSuffixList <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]] [-WindowsAuthEnabled <$true | $false>]

The Set-ActiveSyncVirtualDirectory cmdlet enables you to configure a variety of settings on the virtual directory that is used for Exchange ActiveSync.

To run the Set-ActiveSyncVirtualDirectory cmdlet, the account that 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, about delegating roles, and about the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter

This parameter uniquely identifies the Exchange ActiveSync virtual directory that is to be configured. This value must be website\microsoft-server-activesync.

ActiveSyncServer

Optional

System.String

This parameter specifies the URL of the Client Access server. It will be in the following format: https://servername/Microsoft-Server-ActiveSync.

BadItemReportingEnabled

Optional

System.Boolean

This parameter specifies whether items that cannot be synchronized should be reported to the user. If set to $true, the user receives a notification when an item cannot be synchronized to the mobile device.

BasicAuthEnabled

Optional

System.Boolean

This parameter enables or disables Basic authentication. The default setting is $true.

ClientCertAuth

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ClientCertAuthTypes

This parameter specifies the status of client certificate authentication. By default, client certificate authentication is disabled. The default value of this parameter is $null.

CompressionEnabled

Optional

System.Boolean

This parameter is an integer that identifies the compression applied to the specified Exchange ActiveSync virtual directory. The default setting is $true.

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

To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the command.

ExternalAuthenticationMethods

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the authentication methods that are supported by the server that contains the virtual directory when access is requested from outside the network firewall. If this parameter is not set, all authentication methods can be used.

ExternalUrl

Optional

System.Uri

This parameter specifies the URL that is used to connect to the virtual directory from outside the network firewall.

InstallIsapiFilter

Optional

System.Boolean

The InstallIsapiFilter parameter specifies whether the Internet Server API (ISAPI) filter is installed.

InstallProxySubDirectory

Optional

System.Boolean

The InstallProxySubDirectory parameter controls how to create the new Exchange ActiveSync subdirectory that is used as a proxy between Microsoft Exchange Server 2010 and Exchange Server 2007.

Instance

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ADMobileVirtualDirectory

The Instance parameter enables you to pass a whole object to the command to be processed. It is mainly used in scripts where a whole object must be passed to the command.

InternalAuthenticationMethods

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the authentication methods that are supported by the server that contains the virtual directory when access is requested from inside the network firewall. If this parameter is not set, all authentication methods can be used.

InternalUrl

Optional

System.Uri

This parameter is used for the Client Access server HTTP Proxy feature. If it is set, the Client Access server that is receiving the incoming client connections will proxy the requests to this URL. This can be an Internet- facing fully qualified domain name (FQDN) URL or an internal host name.

MobileClientCertificateAuthorityURL

Optional

System.String

This parameter specifies the URL for the certification authority (CA) that is used by the mobile device.

MobileClientCertificateProvisioningEnabled

Optional

System.Boolean

This parameter specifies whether the Autodiscover service will return the Certificate Services Server URL in the XML file.

MobileClientCertTemplateName

Optional

System.String

This parameter specifies the template name for the client certificate.

Name

Optional

System.String

This parameter specifies the name of the Exchange ActiveSync virtual directory.

RemoteDocumentsActionForUnknownServers

Optional

System.Nullable

This parameter specifies the action that occurs when a Windows SharePoint Services or Windows file share request comes in via Exchange ActiveSync. When a request comes in, Exchange ActiveSync will look for the requested host name in the Allow and Block lists. If the host name is not found in either list, the action specified in this parameter, either Block or Allow, will be performed.

RemoteDocumentsAllowedServers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is a multivalued property that lists all the allowed servers for remote document access.

RemoteDocumentsBlockedServers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is a multivalued property that lists all the blocked servers for remote document access.

RemoteDocumentsInternalDomainSuffixList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is used in organizations that do not run WINS in their network. In these environments, you can specify one or more FQDNs that Exchange ActiveSync treats as internal when a request for remote file access is received.

WhatIf

Optional

System.Management.Automation.SwitchParameter

This parameter instructs the command to simulate the actions that it would take on the object. By using this 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 this parameter.

WindowsAuthEnabled

Optional

System.Boolean

This parameter specifies whether Integrated Windows authentication is enabled on the Exchange ActiveSync virtual directory.

 

Error Description

 

 

 

Exceptions Description

 

 

The following code example disables Basic authentication on the default Exchange ActiveSync virtual directory on the server that is named Contoso.

Set-ActiveSyncVirtualDirectory -Identity "contoso\microsoft-server-activesync (Default Web Site)" -BasicAuthEnabled:$false

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft