Applies to: Exchange Server 2013

Topic Last Modified: 2012-07-24

Use the New-OABVirtualDirectory cmdlet to configure a server as a web distribution point for an offline address book (OAB).

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

Syntax


New-OabVirtualDirectory [-AppPoolId <String>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ExtendedProtectionFlags <MultiValuedProperty>] [-ExtendedProtectionSPNList <MultiValuedProperty>] [-ExtendedProtectionTokenChecking <None \| Allow \| Require>] [-ExternalUrl <Uri>] [-InternalUrl <Uri>] [-Path <String>] [-PollInterval <Int32>] [-Recovery <SwitchParameter>] [-RequireSSL <$true \| $false>] [-Role <ClientAccess \| Mailbox>] [-Server <ServerIdParameter>] [-WebSiteName <String>] [-WhatIf [<SwitchParameter>]]

New-OabVirtualDirectory [-AppPoolId <String>]
[-Confirm [<SwitchParameter>]] [-DomainController
<Fqdn>] [-ExtendedProtectionFlags
<MultiValuedProperty>] [-ExtendedProtectionSPNList
<MultiValuedProperty>] [-ExtendedProtectionTokenChecking
<None | Allow | Require>] [-ExternalUrl <Uri>]
[-InternalUrl <Uri>] [-Path <String>] [-PollInterval
<Int32>] [-Recovery <SwitchParameter>] [-RequireSSL
<$true | $false>] [-Role <ClientAccess | Mailbox>]
[-Server <ServerIdParameter>] [-WebSiteName <String>]
[-WhatIf [<SwitchParameter>]]

Examples

EXAMPLE 1

This example creates an OAB virtual directory on CASServer01 and configures the distribution service to poll the generation server every two hours.

	Copy Code
New-OABVirtualDirectory -Server CASServer01 -PollInterval 120

Detailed Description

The New-OABVirtualDirectory cmdlet configures a web distribution point for an OAB and creates the OAB virtual directory.

Note:
You have to manually create the file system folder on the server that hosts the OAB files.

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 " Offline address book connectivity " entry in the Email Address and Address Book Permissions topic.

Parameters

Parameter Required Type Description

AppPoolId

Optional

System.String

The AppPoolId parameter specifies the pool of programs that can be used with the OAB 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.

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.

ExtendedProtectionFlags

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtendedProtectionFlags parameter is used to customize the options you use if you're using Extended Protection for Authentication. The possible values are:

None Default setting.
Proxy Specifies that a proxy is terminating the SSL channel. A Service Principal Name (SPN) must be registered in the ExtendedProtectionSPNList parameter if proxy mode is configured.
ProxyCoHosting Specifies that both HTTP and HTTPS traffic may be accessing the Client Access server and that a proxy is located between at least some of the clients and the Client Access server.
AllowDotlessSPN Specifies whether you want to support valid SPNs that aren't in the fully qualified domain name (FQDN) format, for example ContosoMail. You specify valid SPNs with the ExtendedProtectionSPNList parameter. This option makes extended protection less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel.
NoServiceNameCheck Specifies that the SPN list won't be checked to validate a channel binding token. This option makes Extended Protection for Authentication less secure. We generally don't recommend this setting.

ExtendedProtectionSPNList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the specified virtual directory.

The possible values are:

Null This is the default value.
Single SPN or comma delimited list of valid SPNs By default, you must specify the fully qualified domain name (FQDN) (for example mail.contoso.com) for each SPN. If you want to add an SPN that's not an FQDN (for example, ContosoMail), you must also use the ExtendedProtectionTokenChecking parameter with the AllowDotlessSPN value. You specify the domain in SPN format. The SPN format is <protocol>/<FQDN>. For example, a valid entry could be HTTP/mail.contoso.com.

ExtendedProtectionTokenChecking

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ExtendedProtectionTokenCheckingMode

The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the specified Exchange virtual directory. Extended Protection for Authentication isn't enabled by default. The available settings are:

None Extended Protection for Authentication won't be used. Connections between the client and Exchange won't use Extended Protection for Authentication on this virtual directory. This is the default setting.
Allow Extended Protection for Authentication will be used for connections between the client and Exchange on this virtual directory if both the client and server support Extended Protection for Authentication. Connections that don't support Extended Protection for Authentication on the client and server will work, but may not be as secure as a connection using Extended Protection for Authentication.

Note:
If you have a proxy server between the client and the Client Access server that's configured to terminate the client-to-proxy SSL channel, you must also configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter.

Require Extended Protection for Authentication will be used for all connections between clients and Exchange servers for this virtual directory. If either the client or server doesn't support Extended Protection for Authentication, the connection between the client and server will fail. If you set this option, you must also set a value for the ExtendedProtectionSPNList parameter.

Note:
If you have a proxy server between the client and the Client Access server that's configured to terminate the client-to-proxy SSL channel, you must also configure one or more SPNs using the parameter ExtendedProtectionSPNList.

ExternalUrl

Optional

System.Uri

The ExternalUrl parameter specifies the external URL that the OAB virtual directory points to.

InternalUrl

Optional

System.Uri

The InternalUrl parameter specifies the internal URL that the OAB virtual directory points to.

Path

Optional

System.String

The Path parameter specifies the path to the folder that hosts the OAB virtual directory.

PollInterval

Optional

System.Int32

The PollInterval parameter specifies the time interval (in minutes) that the distribution service should poll the generation server for new updates.

Recovery

Optional

System.Management.Automation.SwitchParameter

The Recovery parameter specifies whether to support Setup recovery mode and is used implicitly by Setup when recovery is performed. It's never necessary to specify this parameter.

RequireSSL

Optional

System.Boolean

The RequireSSL parameter specifies whether to require Secure Sockets Layer (SSL) to access the OAB virtual directory. If set to $true, the RequireSSL parameter requires SSL to access the OAB virtual directory.

Role

Optional

Microsoft.Exchange.Management.SystemConfigurationTasks.VirtualDirectoryRole

The Role parameter specifies the configuration that should be used when the virtual directory is created. The following are the values that can be used with this parameter:

FrontEnd Configure the virtual directory for use on a Client Access server.
BackEnd Configure the virtual directory for use on a Mailbox server.

Server

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Server parameter specifies the name of the server to connect. Enter the Server parameter as a host name or an FQDN. If this parameter isn't used, the local server is queried.

WebSiteName

Optional

System.String

The WebSiteName parameter specifies the name of the Internet Information Services (IIS) website under which to create the virtual directory.

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.

Input Types

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.

Return Types

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.