Export (0) Print
Expand All

Set-ActiveSyncVirtualDirectory

Applies to: Exchange Server 2010

Topic Last Modified: 2011-03-19

Use the Set-ActiveSyncVirtualDirectory cmdlet 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>] [-InternalAuthenticationMethods <MultiValuedProperty>] [-InternalUrl <Uri>] [-MailboxLoggingEnabled <$true | $false>] [-MobileClientCertificateAuthorityURL <String>] [-MobileClientCertificateProvisioningEnabled <$true | $false>] [-MobileClientCertTemplateName <String>] [-Name <String>] [-RemoteDocumentsActionForUnknownServers <Nullable>] [-RemoteDocumentsAllowedServers <MultiValuedProperty>] [-RemoteDocumentsBlockedServers <MultiValuedProperty>] [-RemoteDocumentsInternalDomainSuffixList <MultiValuedProperty>] [-SendWatsonReport <$true | $false>] [-WhatIf [<SwitchParameter>]] [-WindowsAuthEnabled <$true | $false>]

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter

The Identity parameter uniquely identifies the Exchange ActiveSync virtual directory to be configured. This value must be website\Microsoft-Server-ActiveSync.

ActiveSyncServer

Optional

System.String

The ActiveSyncServer parameter specifies the URL of the Client Access server. This value is in the following format: https://servername/Microsoft-Server-ActiveSync.

BadItemReportingEnabled

Optional

System.Boolean

The BadItemReportingEnabled parameter specifies whether items that can't be synchronized should be reported to the user. If set to $true, the user receives a notification when an item can't be synchronized to the mobile phone.

BasicAuthEnabled

Optional

System.Boolean

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

ClientCertAuth

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ClientCertAuthTypes

The ClientCertAuth 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

The CompressionEnabled 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

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.

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.

ExternalAuthenticationMethods

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExternalAuthenticationMethods parameter specifies the authentication methods supported by the server that contains the virtual directory when access is requested from outside the network firewall. If this parameter isn't set, all authentication methods can be used.

ExternalUrl

Optional

System.Uri

The ExternalUrl parameter specifies the URL 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.

InternalAuthenticationMethods

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The InternalAuthenticationMethods parameter specifies the authentication methods supported by the server that contains the virtual directory when access is requested from inside the network firewall. If this parameter isn't set, all authentication methods can be used.

InternalUrl

Optional

System.Uri

The InternalUrl parameter is used for the Client Access server HTTP Proxy feature. If it's set, the Client Access server receiving the incoming client connections proxies the requests to this URL. This can be an Internet-facing FQDN URL or an internal host name.

MailboxLoggingEnabled

Optional

System.Boolean

The MailboxLoggingEnabled parameter specifies whether mailbox logging is enabled.

MobileClientCertificateAuthorityURL

Optional

System.String

The MobileClientCertificateAuthorityURL parameter specifies the URL for the certification authority (CA) used by the mobile phone.

MobileClientCertificateProvisioningEnabled

Optional

System.Boolean

The MobileClientCertificateProvisioningEnabled parameter specifies whether the Autodiscover service returns the Certificate Services server URL in the XML file.

MobileClientCertTemplateName

Optional

System.String

The MobileClientCertTemplateName parameter specifies the template name for the client certificate.

Name

Optional

System.String

The Name parameter specifies the name of the Exchange ActiveSync virtual directory.

RemoteDocumentsActionForUnknownServers

Optional

System.Nullable

The RemoteDocumentsActionForUnknownServers parameter specifies the action that occurs when a Microsoft Windows SharePoint Services or Microsoft Windows file share request comes in via Exchange ActiveSync. When a request arrives, Exchange ActiveSync looks for the requested host name in the Allow and Block lists. If the host name isn't found in either list, the action specified in this parameter, either Block or Allow, is performed.

RemoteDocumentsAllowedServers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

RemoteDocumentsBlockedServers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

RemoteDocumentsInternalDomainSuffixList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RemoteDocumentsInternalDomainSuffixList parameter is used in organizations that don't run Windows Internet Name Service (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.

SendWatsonReport

Optional

System.Boolean

The SendWatsonReport parameter specifies whether a Watson report is sent for errors and events.

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.

WindowsAuthEnabled

Optional

System.Boolean

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

The Set-ActiveSyncVirtualDirectory cmdlet configures a variety of settings on the virtual directory used for Exchange ActiveSync including security, authentication, and internal and external URL settings.

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 ActiveSync virtual directory settings" entry in the Client Access Permissions topic.

Error Description

 

 

Exceptions Description

 

 

This example disables Basic authentication on the default Exchange ActiveSync virtual directory on the server Contoso.

Set-ActiveSyncVirtualDirectory -Identity "contoso\microsoft-server-activesync" -BasicAuthEnabled:$false

This example enables bad item reporting and mailbox logging on the default Exchange ActiveSync virtual directory on the server Contoso.

Set-ActiveSyncVirtualDirectory -Identity "contoso\microsoft-server-activesync" -BadItemReportingEnabled:$true -MailboxLoggingEnabled:$true

This example configures the external URL on the default Exchange ActiveSync virtual directory on the server Contoso.

Set-ActiveSyncVirtualDirectory -Identity "contoso\microsoft-server-activesync" -ExternalUrl "http://contoso.com/mail"
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft