Applies to: Exchange Server 2007
Topic Last Modified: 2007-06-05
Use the Set-OfflineAddressBook cmdlet to modify offline address book (OAB) settings.
Syntax
Set-OfflineAddressBook -Identity
<OfflineAddressBookIdParameter> [-AddressLists
<AddressBookBaseIdParameter[]>] [-DiffRetentionPeriod
<Nullable>] [-DomainController <Fqdn>] [-IsDefault
<$true | $false>] [-Name <String>]
[-PublicFolderDistributionEnabled <$true | $false>]
[-Schedule <Schedule>] [-Versions <Collection>]
[-VirtualDirectories <VirtualDirectoryIdParameter[]>]
|
Set-OfflineAddressBook [-AddressLists
<AddressBookBaseIdParameter[]>] [-DiffRetentionPeriod
<Nullable>] [-DomainController <Fqdn>] [-Instance
<OfflineAddressBook>] [-IsDefault <$true | $false>]
[-Name <String>] [-PublicFolderDistributionEnabled <$true
| $false>] [-Schedule <Schedule>] [-Versions
<Collection>] [-VirtualDirectories
<VirtualDirectoryIdParameter[]>]
|
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.OfflineAddressBookIdParameter |
Use the Identity parameter to specify the GUID, distinguished name or offline address book name that represents a specific offline address book. You can also include the path by using the format Server\OfflineAddressBookName. You can omit the parameter label Identity so that only the offline address book name or GUID is supplied. |
|
AddressLists |
Optional |
Microsoft.Exchange.Configuration.Tasks.AddressBookBaseIdParameter[] |
The AddressLists parameter specifies an array of address list identities that are included in the OAB. |
|
DiffRetentionPeriod |
Optional |
System.Nullable |
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 |
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. |
|
Instance |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.OfflineAddressBook |
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. |
|
IsDefault |
Optional |
System.Boolean |
The IsDefault parameter sets this OAB as the default OAB for all new mailbox stores. |
|
Name |
Optional |
System.String |
The Name parameter sets the new name of the OAB. The name appears in the Exchange Management Console. A Name can include up to 64 characters. |
|
PublicFolderDistributionEnabled |
Optional |
System.Boolean |
Setting the PublicFolderDistributionEnabled parameter to a value of $true sets the OAB to be distributed via public folders. The default value is $true. |
|
Schedule |
Optional |
Microsoft.Exchange.Data.Schedule |
The Schedule parameter specifies the interval scheduled for generating the OAB. The Schedule parameter takes the following format and must include a range: Weekday.Hour:Minute[AM/PM]-Weekday.Hour:Minute[AM/PM]. |
|
Versions |
Optional |
System.Collections.ObjectModel.Collection |
The Versions parameter specifies the OAB versions that are generated for client download. The available options are Version4, Version3, and Version2. Version4 is for Microsoft Office Outlook 2007 or Office Outlook 2003 Service Pack 2 (SP2) clients. Version3 is for Outlook clients that support Unicode. Version2 is for Microsoft Exchange Server 2007, Exchange Server 2003, Exchange 2000 Server, and Exchange Server version 5.5 clients. |
|
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. |
Detailed Description
The Set-OfflineAddressBook cmdlet modifies the settings of an existing OAB. An OAB is invaluable for users who spend a considerable amount of time disconnected from the network. An OAB is a snapshot of one or more address lists, which MAPI clients can download to provide access to the address lists while offline.
The generation of an OAB does not stop even if more time is required than specified in the Schedule parameter.
To run the Set-OfflineAddressBook cmdlet, the account you use must be delegated the following:
- Exchange Organization Administrator role
For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
This example changes the name of the offline address book.
 Copy Code |
|
|---|---|
Set-OfflineAddressBook -Identity "\Default Offline Address Book" -Name "My Offline Address Book" |
|