Applies to: Exchange Server 2013
Topic Last Modified: 2012-07-12
Use the New-OfflineAddressBook cmdlet to create an offline address book (OAB).
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
New-OfflineAddressBook -AddressLists
<AddressBookBaseIdParameter[]> -Name <String> [-Confirm
[<SwitchParameter>]] [-DiffRetentionPeriod <Unlimited>]
[-DomainController <Fqdn>] [-GlobalWebDistributionEnabled
<$true | $false>] [-IsDefault <$true | $false>]
[-Organization <OrganizationIdParameter>]
[-VirtualDirectories <VirtualDirectoryIdParameter[]>]
[-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example uses two commands to create the OAB named OAB_AgencyB that includes all address lists where AgencyB is part of the name. With the settings shown, an OAB is generated by myserver.contoso.com on Mondays and Wednesdays from 01:00 (1:00 A.M.) to 02:00 (2:00 A.M.). The command also creates the default OAB for the organization.
 Copy Code |
|
|---|---|
$a = Get-AddressList | Where {$_.Name -Like "*AgencyB*"
New-OfflineAddressBook -Name "OAB_AgencyB" -Server myserver.contoso.com -AddressLists $a -Schedule "Mon.01:00-Mon.02:00, Wed.01:00-Wed.02:00"
|
|
EXAMPLE 2
This example creates the OAB New OAB that uses Web-based distribution for Microsoft Office Outlook 2007 or later clients on SERVER01 by using the default virtual directory.
| Copy Code |
|
|---|---|
New-OfflineAddressBook -Name "New OAB" -AddressLists "\Default Global Address List" -Server SERVER01 -VirtualDirectories "SERVER01\OAB (Default Web Site)" |
|
Detailed Description
The New-OfflineAddressBook cmdlet allows administrators to create OABs. For example, if you uninstall a Client Access server that contains an OAB, you need to re-create it on another Client Access server.
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 books" entry in the Email Address and Address Book Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
AddressLists |
Required |
Microsoft.Exchange.Configuration.Tasks.AddressBookBaseIdParameter[] |
The AddressLists parameter specifies an array of address list identities included in the OAB. |
|
Name |
Required |
System.String |
The Name parameter specifies the name that describes the OAB object in Exchange System Manager. This value can contain a maximum of 64 characters. |
|
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. |
|
DiffRetentionPeriod |
Optional |
Microsoft.Exchange.Data.Unlimited |
The DiffRetentionPeriod parameter specifies the length of
time, in days, that the OAB difference files are retained on the
OAB-generating server and the Client Access server. To retain the
OAB difference files indefinitely, use the value
|
|
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. |
|
GlobalWebDistributionEnabled |
Optional |
System.Boolean |
The GlobalWebDistributionEnabled parameter specifies
whether distribution occurs to all virtual directories in the
organization. If the value of the
GlobalWebDistributionEnabled parameter is
|
|
IsDefault |
Optional |
System.Boolean |
The IsDefault parameter specifies whether the OAB is set
as the default OAB for all new mailbox databases. If the value of
the IsDefault parameter is |
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
This parameter is reserved for internal Microsoft use. |
|
VirtualDirectories |
Optional |
Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter[] |
The VirtualDirectories parameter specifies the array of
OABVirtualDirectory objects. If the
VirtualDirectories parameter is specified,
|
|
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.