Set-OfflineAddressBook

 

Applies to: Exchange Online, Exchange Server 2016

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

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

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 more information, see the "Add a role to a role group" section in the topic, Manage role groups.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet 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>] [-Schedule <Schedule>] [-ShadowMailboxDistributionEnabled <$true | $false>] [-UpgradeFromE14 <SwitchParameter>] [-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"

This example changes the arbitration mailbox that's responsible for generating the OAB.

Set-OfflineAddressBook -Identity "\Default Offline Address Book" -GeneratingMailbox OABGen2

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 this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.

 

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 current version of Exchange.

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 specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

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 OAB distribution server. To retain the OAB difference files indefinitely, use the value Unlimited.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

GeneratingMailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

This parameter is available only in on-premises Exchange 2016.

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.

This parameter replaces the functionality of the Move-OfflineAddressBook cmdlet that was used in Exchange 2010.

GlobalWebDistributionEnabled

Optional

System.Boolean

This parameter is available only in on-premises Exchange 2016.

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

This parameter is available only in on-premises Exchange 2016.

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

MaxMultivaluedBinaryPropertySize

Optional

System.Int32

This parameter is available only in on-premises Exchange 2016.

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

MaxMultivaluedStringPropertySize

Optional

System.Int32

This parameter is available only in on-premises Exchange 2016.

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

MaxStringPropertySize

Optional

System.Int32

This parameter is available only in on-premises Exchange 2016.

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.

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"

ShadowMailboxDistributionEnabled

Optional

System.Boolean

This parameter is available only in on-premises Exchange 2016.

The ShadowMailboxDistributionEnabled parameter enables an OAB generation mailbox to host a shadow copy of another OAB. The default value is $false.

UpgradeFromE14

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

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[]

This parameter is available only in on-premises Exchange 2016.

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 simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this 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.

 
Show: