Change the offline address book generation schedule in Exchange 2016

 

Applies to: Exchange Server 2016

Topic Last Modified: 2016-11-10

Learn how to configure the offline address book (OAB) update interval in Exchange 2016.

An offline address book (OAB) is a copy of an address book that's been downloaded so that an Outlook user can access the information it contains while disconnected from the server. By default, a new OAB is generated every 8 hours in Exchange Server 2016, but you can change the interval by using the Exchange Management Shell.

For additional management tasks related to OABs, see Offline address book procedures.

tipTip:
Having problems? Ask for help in the Exchange forums. Visit the forums at: Exchange Server, Exchange Online, or Exchange Online Protection.

Use the following syntax in the Exchange Management Shell.

New-SettingOverride -Name <UniqueOverrideName> -Component <Component> -Section OABGeneratorAssistant -Parameters @("WorkCycle=<Timespan>") -Reason <DescriptiveReason> [-Server <ServerName>]

Notes:

  • The value that's required for the Component parameter depends on your version Exchange 2016:

    • Exchange 2016 CU3 or earlier   MailboxAssistants

    • Exchange 2016 CU4 or later   TimeBasedAssistants

  • To specify a <TimeSpan> value, use the syntax d.hh:mm:ss, where d = days, hh = hours, mm = minutes, and ss = seconds.

  • To configure the same settings on all Exchange 2016 servers in the Active Directory forest, don't use the Server parameter.

  • To configure the settings on a specific Exchange 2016 server, use the Server parameter and the name of the server (don't use the fully qualified domain name or FQDN). This method is useful when you need to specify different settings on different Exchange servers.

These example specify that the offline address book is generated every two hours on all Exchange 2016 servers in the organization that are responsible for generating offline address books.

  • Setting override name   "OAB Generation Override" (must be unique)

  • WorkCycle   02:00:00 (2 hours)

  • Override reason   Generate OAB every 2 hours

Exchange 2016 CU3 or earlier:

New-SettingOverride -Name "OAB Generation Override" -Component MailboxAssistants -Section OABGeneratorAssistant -Parameters @("WorkCycle=02:00:00") -Reason "Generate OAB every 2 hours"

Exchange 2016 CU4 or later:

New-SettingOverride -Name "OAB Generation Override" -Component TimeBasedAssistants -Section OABGeneratorAssistant -Parameters @("WorkCycle=02:00:00") -Reason "Generate OAB every 2 hours"

These examples specify the same offline address book generation schedule, but only on the server named Mailbox01.

Exchange 2016 CU3 or earlier:

New-SettingOverride -Name "Mailbox01 OAB Generation Override" -Component MailboxAssistants -Section OABGeneratorAssistant -Parameters @("WorkCycle=02:00:00") -Reason "Generate OAB every 2 hours" -Server Mailbox01

Exchange 2016 CU4 or later:

New-SettingOverride -Name "Mailbox01 OAB Generation Override" -Component TimeBasedAssistants -Section OABGeneratorAssistant -Parameters @("WorkCycle=02:00:00") -Reason "Generate OAB every 2 hours" -Server Mailbox01

To verify that you've configured the OAB generation schedule on an Exchange 2016 server, replace <ServerName> with the name of the server (not the FQDN), and run either of the following commands and verify the value of the WorkCycle property:

  • Exchange 2016 CU3 or earlier:

    [xml]$diag=Get-ExchangeDiagnosticInfo -Server <ServerName> -Process Microsoft.Exchange.Directory.TopologyService -Component VariantConfiguration -Argument Config; $diag.Diagnostics.Components.VariantConfiguration.Configuration.MailboxAssistants.OABGeneratorAssistant
    
  • Exchange 2016 CU4 or later:

    [xml]$diag=Get-ExchangeDiagnosticInfo -Server <ServerName> -Process MSExchangeMailboxAssistants -Component VariantConfiguration -Argument "Config,Component=TimeBasedAssistants"; $diag.Diagnostics.Components.VariantConfiguration.Configuration.TimeBasedAssistants.OABGeneratorAssistant
    
 
Show: