Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-12-03

Use the New-OfflineAddressBook cmdlet to create an offline address book (OAB).

Syntax


New-OfflineAddressBook -Name <String> -AddressLists <AddressBookBaseIdParameter[]> [-Confirm [<SwitchParameter>]] [-DiffRetentionPeriod <Unlimited>] [-DomainController <Fqdn>] [-GlobalWebDistributionEnabled <$true \| $false>] [-IsDefault <$true \| $false>] [-Organization <OrganizationIdParameter>] [-PublicFolderDatabase <DatabaseIdParameter>] [-PublicFolderDistributionEnabled <$true \| $false>] [-Schedule <Schedule>] [-Server <ServerIdParameter>] [-SkipPublicFolderInitialization <SwitchParameter>] [-Versions <MultiValuedProperty>] [-VirtualDirectories <VirtualDirectoryIdParameter[]>] [-WhatIf [<SwitchParameter>]]

New-OfflineAddressBook -Name <String> -AddressLists
<AddressBookBaseIdParameter[]> [-Confirm
[<SwitchParameter>]] [-DiffRetentionPeriod <Unlimited>]
[-DomainController <Fqdn>] [-GlobalWebDistributionEnabled
<$true | $false>] [-IsDefault <$true | $false>]
[-Organization <OrganizationIdParameter>]
[-PublicFolderDatabase <DatabaseIdParameter>]
[-PublicFolderDistributionEnabled <$true | $false>]
[-Schedule <Schedule>] [-Server <ServerIdParameter>]
[-SkipPublicFolderInitialization <SwitchParameter>]
[-Versions <MultiValuedProperty>] [-VirtualDirectories
<VirtualDirectoryIdParameter[]>] [-WhatIf
[<SwitchParameter>]]

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 Mailbox 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 `unlimited`.
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 `$true`, distribution occurs to all virtual directories in the organization and the VirtualDirectories parameter can't be used.
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 `$true`, the OAB is set as the default OAB for all new mailbox databases. If the value is `$false`, the OAB isn't set as the default OAB.
Organization	Optional	Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter	This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support. The Organization parameter specifies the organization in which you'll perform this action. This parameter doesn't accept wildcard characters, and you must use the exact name of the organization.
PublicFolderDatabase	Optional	Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter	The PublicFolderDatabase parameter specifies the identity of the public folder database being used to distribute the OAB. To use this parameter, the PublicFolderDistributionEnabled parameter must be set to `$true`.
PublicFolderDistributionEnabled	Optional	System.Boolean	The PublicFolderDistributionEnabled parameter specifies whether the OAB is distributed via public folders. If the value of the PublicFolderDistributionEnabled parameter is `$true`, the OAB is distributed via public folders.
Schedule	Optional	Microsoft.Exchange.Data.Schedule	The Schedule parameter specifies the interval scheduled for generating the new OAB. The Schedule parameter takes the following format and must include a range: Weekday.Hour:Minute[AM/PM]-Weekday.Hour:Minute[AM/PM].
Server	Optional	Microsoft.Exchange.Configuration.Tasks.ServerIdParameter	The Server parameter specifies which server the new OAB is created on.
SkipPublicFolderInitialization	Optional	System.Management.Automation.SwitchParameter	The SkipPublicFolderInitialization parameter specifies whether to skip the immediate creation of the OAB public folders if you're creating an OAB that uses public folder distribution. The OAB isn't available for download until the next site folder maintenance cycle has completed. You don't have to specify a value with the SkipPublicFolderInitialization parameter. Omitting this parameter may cause the task to pause while it contacts the responsible public folder server to create the necessary public folders. If the server is presently unreachable, or is otherwise costly to contact, the pause could be significant.
Versions	Optional	Microsoft.Exchange.Data.MultiValuedProperty	The Versions parameter specifies what version of OAB to generate. The allowed values are: `Version1` `Version2` `Version3` `Version4`
VirtualDirectories	Optional	Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter[]	The VirtualDirectories parameter specifies the array of OABVirtualDirectory objects. If the VirtualDirectories parameter is specified, `Version4` of the OAB must be generated.
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 uses two commands to create the OAB named OAB_AgencyB that includes all address lists in which AgencyB is part of the name. By using the settings shown, an OAB is generated by myserver.contoso.com on Mondays and Wednesdays from 01:00 (1 A.M.) to 02:00 (2 A.M.). This example 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)"

EXAMPLE 3

This example creates the OAB Legacy OAB that uses public folder distribution for Outlook 2003 Service Pack 1 (SP1) and Outlook 98 Service Pack 2 (SP2) clients on SERVER01.

	Copy Code
New-OfflineAddressBook -Name "Legacy OAB" -AddressLists "\Default Global Address List" -Server SERVER01 -PublicFolderDatabase "PFDatabase" -PublicFolderDistributionEnabled $true -Versions Version1,Version2

Copy Code

New-OfflineAddressBook -Name "Legacy OAB" -AddressLists "\Default Global Address List" -Server SERVER01 -PublicFolderDatabase "PFDatabase" -PublicFolderDistributionEnabled $true -Versions Version1,Version2

Note:
If you configure OABs to use public folder distribution, but your organization doesn't have any public folder infrastructure, an error will be returned. For more information, see Managing Public Folders.