Set-OABVirtualDirectory
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Set-OABVirtualDirectory cmdlet to change configuration settings for an offline address book (OAB) virtual directory.
Syntax
Set-OabVirtualDirectory -Identity <VirtualDirectoryIdParameter> [-BasicAuthentication <$true | $false>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-InternalUrl <Uri>] [-PollInterval <Int32>] [-RequireSSL <$true | $false>] [-WhatIf [<SwitchParameter>]] [-WindowsAuthentication <$true | $false>]
Set-OabVirtualDirectory [-BasicAuthentication <$true | $false>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-Instance <ADOabVirtualDirectory>] [-InternalUrl <Uri>] [-PollInterval <Int32>] [-RequireSSL <$true | $false>] [-WhatIf [<SwitchParameter>]] [-WindowsAuthentication <$true | $false>]
Detailed Description
This Set-OABVirtualDirectory cmdlet allows you to change the configuration of an OAB web distribution point on a Client Access server.
To run the Set-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 Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter |
Use the Identity parameter to specify the GUID, distinguished name or offline address book virtual directory name that represents a specific offline address book virtual directory. You can also include the path by using the format Server\OfflineAddressBookVirtualDirectoryName. You can omit the parameter label Identity so that only the offline address book virtual directory name or GUID is supplied. |
BasicAuthentication |
Optional |
System.Boolean |
The BasicAuthentication parameter specifies whether Basic authentication is enabled on the OAB virtual directory. |
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 don't have to specify a value with the Confirm parameter. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name of the domain controller that retrieves data from Active Directory, include the DomainController parameter in the command. |
ExternalUrl |
Optional |
System.Uri |
This parameter specifies the external URL that the OAB virtual directory points to. |
Instance |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.ADOabVirtualDirectory |
The Instance parameter enables you to pass an entire object to the command to be processed. It is mainly used in scripts where an entire object must be passed to the command. |
InternalUrl |
Optional |
System.Uri |
This parameter specifies the internal URL that the OAB virtual directory points to. |
PollInterval |
Optional |
System.Int32 |
The time interval which the distribution service should poll the generation server for new updates (in minutes). |
RequireSSL |
Optional |
System.Boolean |
When set to |
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 don't have to specify a value with the WhatIf parameter. |
WindowsAuthentication |
Optional |
System.Boolean |
The WindowsAuthentication parameter specifies whether Windows authentication is enabled on the OAB virtual directory. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
Exceptions
| Exceptions | Description |
|---|---|
Example
This example sets the OAB virtual directory external web address.
Set-OABVirtualDirectory -Identity "Server1\OAB (Default Web Site)" -ExternalURL "https://www.contoso.com/OAB"