New-OABVirtualDirectory
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
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>] [-ExternalUrl <Uri>] [-InternalUrl <Uri>] [-Path <String>] [-PollInterval <Int32>] [-Recovery <SwitchParameter>] [-RequireSSL <$true | $false>] [-Server <ServerIdParameter>] [-TemplateInstance <PSObject>] [-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 will have to manually create the file system folder on the server that will host the OAB files.
To run the New-OABVirtualDirectory cmdlet, the account you use must be delegated the following:
- Exchange Server Administrator role and local Administrators group for the target server
For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm parameter causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You do not have to specify a value with the Confirm parameter. |
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. |
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 will host the OAB virtual directory. |
PollInterval |
Optional |
System.Int32 |
The PollInterval parameter specifies the time interval that the distribution service should poll the generation server for new updates (in minutes). |
Recovery |
Optional |
System.Management.Automation.SwitchParameter |
The Recovery parameter is used to support Setup recovery mode and is used implicitly by Setup when recovery is performed. It is never necessary to specify this parameter. |
RequireSSL |
Optional |
System.Boolean |
If set to $true, the RequireSSL parameter requires Secure Sockets Layer (SSL) to access the OAB virtual directory. |
Server |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
Use the Server parameter to specify the name of the server to connect. Enter the Server parameter as a host name or a fully qualified domain name (FQDN). If this parameter is not used, the local server is queried. |
TemplateInstance |
Optional |
System.Management.Automation.PSObject |
When an existing object is supplied to the TemplateInstance parameter, the command will use that object's configuration to create an exact duplicate of the object on a local or target server |
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 parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. You do not have to specify a value with the WhatIf parameter. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
Exceptions
| Exceptions | Description |
|---|---|
Example
This example configures the distribution service to poll the generation server every two hours.
New-OABVirtualDirectory -PollInterval 120