Get-ActiveSyncVirtualDirectory

 

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

The Get-ActiveSyncVirtualDirectory cmdlet enables you to retrieve the Microsoft Exchange ActiveSync settings that are configured on the Exchange ActiveSync Web site.

Syntax

Get-ActiveSyncVirtualDirectory [-Identity <VirtualDirectoryIdParameter>] [-DomainController <Fqdn>]

Get-ActiveSyncVirtualDirectory -Server <ServerIdParameter> [-DomainController <Fqdn>]

Detailed Description

Microsoft Exchange Server 2007 contains a default virtual directory that Exchange ActiveSync devices use to synchronize with the server. You can create multiple virtual directories and assign different devices to different directories. The Get-ActiveSyncVirtualDirectory cmdlet enables you to retrieve a variety of settings for the virtual directory.

To run the Get-ActiveSyncVirtualDirectory cmdlet, the account you use must be delegated the Exchange View-Only Administrator role.

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
Identity	Optional	Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter	This parameter uniquely identifies an Exchange ActiveSync virtual directory on a physical server. If this value is not set, this command will return information that is configured on all Exchange ActiveSync Web sites that are available across all Client Access servers in the Exchange organization.
Server	Required	Microsoft.Exchange.Configuration.Tasks.ServerIdParameter	This parameter uniquely identifies a physical server. When this parameter is set, the command returns information that is configured on all virtual directories that are available on that server.
DomainController	Optional	Microsoft.Exchange.Data.Fqdn	To specify the fully qualified domain name (FQDN) of the domain controller that retrieves data from the Active Directory directory service, include the DomainController parameter in the command.

Input Types

Return Types

Parameter	Description
BasicAuthEnabled	A Boolean value that enables Basic authentication. By default, Basic authentication is disabled if Secure Sockets Layer (SSL) is not enabled on the ActiveSync server.
ClientCertEnabled	A Boolean value that enables the mobile device to use a client certificate. By default, this is enabled and the client will request a client certificate.
ClientCertProvisioningEnabled	A Boolean value that defines whether the server can send the client authentication configuration settings to the mobile device. This is available only if ClientCertEnabled is set to $true.
ClientCertTemplateName	A string that defines the template name that is required in the certification request sent by the mobile device to the certification authority (CA).
ClientCertURL	A string that defines the link to the certification authority that provides client certificates.
CompressionEnabled	An integer that identifies the compression applied to the specified Exchange ActiveSync virtual directory
IsEnabled	A Boolean value that indicates whether the user account is enabled for Exchange ActiveSync.
IsValid	A Boolean value that indicates whether the user's Active Directory account is valid or not valid.
MobileSyncURL	A string that defines the URL to the Exchange ActiveSync server. This is configured on the server and then sent to the mobile device.
WebsiteName	A string that defines the name of the Exchange ActiveSync Web site to which the mobile device will connect.
VirtualDirectoryName	A string that defines the name of the ActiveSync virtual directory. This is always Microsoft-Server-ActiveSync.

Errors

Error	Description

Exceptions

Exceptions	Description

Example

The following code example returns the settings for the Exchange ActiveSync virtual directory on the server.

Get-ActiveSyncVirtualDirectory