Export (0) Print
Expand All

Set-OfflineAddressBook

 

Applies to: Exchange Server 2013

This cmdlet is available only in on-premises Exchange Server 2013.

Use the Set-OfflineAddressBook cmdlet to modify offline address book (OAB) settings.

For information about the parameter sets in the Syntax section below, see Syntax.

Set-OfflineAddressBook -Identity <OfflineAddressBookIdParameter> [-AddressLists <AddressBookBaseIdParameter[]>] [-ApplyMandatoryProperties <SwitchParameter>] [-ConfiguredAttributes <MultiValuedProperty>] [-Confirm [<SwitchParameter>]] [-DiffRetentionPeriod <Unlimited>] [-DomainController <Fqdn>] [-GeneratingMailbox <MailboxIdParameter>] [-GlobalWebDistributionEnabled <$true | $false>] [-IsDefault <$true | $false>] [-MaxBinaryPropertySize <Int32>] [-MaxMultivaluedBinaryPropertySize <Int32>] [-MaxMultivaluedStringPropertySize <Int32>] [-MaxStringPropertySize <Int32>] [-Name <String>] [-PublicFolderDistributionEnabled <$true | $false>] [-Schedule <Schedule>] [-UseDefaultAttributes <SwitchParameter>] [-Versions <MultiValuedProperty>] [-VirtualDirectories <VirtualDirectoryIdParameter[]>] [-WhatIf [<SwitchParameter>]]

This example changes the name of the OAB.

Set-OfflineAddressBook -Identity "\Default Offline Address Book" -Name "My Offline Address Book"

The Set-OfflineAddressBook cmdlet modifies the settings of an existing OAB. An OAB is valuable for users who spend 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 doesn't stop even if more time is required than specified in the Schedule parameter.

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.

By default in Exchange Online, the Address List role isn’t assigned to any role groups. To use any cmdlets that require the Address List role, you need to add the role to a role group. For details, see the “Add a role to a role assignment policy” section of Manage role assignment policies.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.OfflineAddressBookIdParameter

The Identity parameter specifies the GUID, distinguished name (DN), or OAB name that represents a specific OAB. You can also include the path by using the format Server\OfflineAddressBookName.

You can omit the parameter label so that only the OAB name or GUID is supplied.

AddressLists

Optional

Microsoft.Exchange.Configuration.Tasks.AddressBookBaseIdParameter[]

The AddressLists parameter specifies an array of address list identities included in the OAB.

ApplyMandatoryProperties

Optional

System.Management.Automation.SwitchParameter

The ApplyMandatoryProperties parameter specifies whether to modify the mandatory properties of a legacy OAB to the version in Microsoft Exchange Server 2013.

ConfiguredAttributes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConfiguredAttributes parameter specifies the attributes to be displayed for the OAB.

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.

GeneratingMailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The GeneratingMailbox parameter specifies the OABGenCapability arbitration mailbox where the offline address books will be generated. This allows on-premises admins to load balance OAB generation.

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. If you have GlobalWebDistributionEnabled set to $true, you can't add values to the VirtualDirectories parameter.

IsDefault

Optional

System.Boolean

The IsDefault parameter specifies whether this OAB is the default OAB for all new mailbox stores.

MaxBinaryPropertySize

Optional

System.Int32

The MaxBinaryPropertySize parameter specifies the maximum size for binary attributes before they're truncated.

MaxMultivaluedBinaryPropertySize

Optional

System.Int32

The MaxMultivaluedBinaryPropertySize parameter specifies the maximum size for multivalued binary attributes before they're truncated.

MaxMultivaluedStringPropertySize

Optional

System.Int32

The MaxMultivaluedStringPropertySize parameter specifies the maximum size for multivalued string attributes before they're truncated.

MaxStringPropertySize

Optional

System.Int32

The MaxStringPropertySize parameter specifies the maximum size for string attributes before they're truncated.

Name

Optional

System.String

The Name parameter specifies the new name of the OAB. A Name parameter value can include up to 64 characters.

PublicFolderDistributionEnabled

Optional

System.Boolean

The PublicFolderDistributionEnabled parameter specifies whether the OAB is to be distributed via public folders. 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.

You can use the following values for the start and end days:

  • Full name of the day

  • Abbreviated name of the day

  • Integer from 0 through 6, where 0 = Sunday

The start time and end time must be at least 15 minutes apart. Minutes will be rounded down to 0, 15, 30, or 45. If you specify more than one interval, there must be at least 15 minutes between each interval.

The following are examples:

  • "Sun.11:30 PM-Mon.1:30 AM"

  • 6.22:00-6.22:15 (The assistant will run from Saturday at 10:00 PM until Saturday at 10:15 PM.)

  • "Monday.4:30 AM-Monday.5:30 AM","Wednesday.4:30 AM-Wednesday.5:30 AM" (The assistant will run on Monday and Wednesday mornings from 4:30 until 5:30.)

  • "Sun.1:15 AM-Monday.23:00"

UseDefaultAttributes

Optional

System.Management.Automation.SwitchParameter

The UseDefaultAttributes parameter specifies whether to revert the OAB attributes to the default list.

Versions

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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 Outlook 2003 Service Pack 2 (SP2) or later clients. Version3 is for Outlook clients that support Unicode.

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.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft