Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2012-11-15
Use the New-OABVirtualDirectory cmdlet to configure a server as a Web distribution point for an offline address book (OAB).
Syntax
New-OabVirtualDirectory [-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>]
[-Server <ServerIdParameter>] [-WebSiteName <String>]
[-WhatIf [<SwitchParameter>]]
|
Detailed Description
The New-OABVirtualDirectory cmdlet configures a Client Access server as 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 "OAB virtual directory" entry in the Mailbox Permissions topic.
Parameters
Parameter | Required | Type | Description | ||||
---|---|---|---|---|---|---|---|
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:
|
||||
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:
|
||||
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:
To learn more about Extended Protection for Authentication, see Understanding Extended Protection for Authentication. |
||||
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 |
||||
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) Web site 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.
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 |