Export (0) Print
Expand All
Expand Minimize

Get-MapiVirtualDirectory

 

Applies to: Exchange Server 2013

Topic Last Modified: 2014-03-05

This cmdlet is available only in on-premises Exchange Server 2013.

Use the Get-MapiVirtualDirectory cmdlet to view Message Application Programming Interface (MAPI) virtual directories on Microsoft Exchange 2013 servers. A MAPI virtual directory is used by supported versions of Microsoft Outlook to connect to mailboxes by using the MAPIHTTP protocol.

For information about the parameter sets in the Syntax section below, see Syntax.

Get-MapiVirtualDirectory [-Identity <VirtualDirectoryIdParameter>] <COMMON PARAMETERS>
Get-MapiVirtualDirectory -Server <ServerIdParameter> <COMMON PARAMETERS>
COMMON PARAMETERS: [-ADPropertiesOnly <SwitchParameter>] [-DomainController <Fqdn>] [-ShowBackEndVirtualDirectories <SwitchParameter>] [-ShowMailboxVirtualDirectories <SwitchParameter>]

This example returns the settings of the MAPI virtual directory on the server named ContosoMail.

Get-MapiVirtualDirectory -Server ContosoMail

These examples return the settings of the MAPI virtual directory on the local server named ContosoMail. All three commands do the same thing.

Get-MapiVirtualDirectory -Identity "ContosoMail\mapi (Default Web Site)"
Get-MapiVirtualDirectory "mapi (Default Web Site)"
Get-MapiVirtualDirectory mapi*

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 "Client Access virtual directory settings" entry in the Clients and mobile devices permissions topic.

 

Parameter Required Type Description

Server

Required

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Server parameter specifies the Exchange server that will host the virtual directory. You can use any value that uniquely identifies the server. For example:

  • Name

  • FQDN

  • Distinguished name (DN)

  • Exchange Legacy DN

If you don't use the Server parameter, the virtual directory will be created on the server where the remote PowerShell session is established. This will always be a Mailbox server. If you want to create the virtual directory on a Client Access server or another Mailbox server, you need to use the Server parameter.

ADPropertiesOnly

Optional

System.Management.Automation.SwitchParameter

The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter

The Identity parameter specifies the MAPI virtual directory that you want to view.

You can use any value that uniquely identifies the virtual directory. For example:

  • Name or <Server>\Name

  • Distinguished name (DN)

  • GUID

The Name value uses the syntax "<VirtualDirectoryName> (<WebsiteName>)" from the properties of the virtual directory. You can specify the wildcard character (*) instead of the default website by using the syntax <VirtualDirectoryName>*.

ShowBackEndVirtualDirectories

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

ShowMailboxVirtualDirectories

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft