Deploy and configure the new OneDrive sync client for Mac
This article is for IT administrators managing OneDrive for Business settings in work or school environments. If you're not an IT administrator, read Get started with the new OneDrive sync client on Mac OS X.
Manage OneDrive settings on macOS using property list (Plist) files
Use the following keys to preconfigure or change settings for your users. The keys are the same whether you run the store edition or the standalone edition of the sync client, but the property list file name and domain name will be different. When you apply the settings, make sure to target the appropriate domain depending on the edition of the sync client.
|Standalone||Mac App Store|
Deploy the sync client settings
Deploy the settings on macOS in the typical way:
Quit the OneDrive application.
Define the settings you want to change by creating a Plist with the values, or use a script to set the default values.
Deploy the settings onto the local computer.
Refresh the preferences cache.
On the next start of OneDrive, the new settings will be picked up.
Overview of settings
The following table lists all the settings that are currently exposed for the OneDrive sync client. You need to configure the parameters in parentheses.
|Setting||Description||Parameters||Example Plist Entry|
|Disable personal accounts
||Blocks users from signing in and syncing files in personal OneDrive accounts. If this key is set after a user has set up sync with a personal account, the user will be signed out.
||DisablePersonalSync (Bool): When set to true, this parameter prevents users from adding or syncing personal accounts.
|Default folder location
||Specifies the default location of the OneDrive folder for each organization
||TenantID (String): TenantID determines which accounts the default folder location setting should apply to. Find your Office 365 tenant ID
DefaultFolderPath (String): DefaultFolder specifies the default folder location.
Mac App Store:
The path must already exist when users set up the sync client.
The path will be created on users' computers if it doesn't already exist. Only with the Standalone sync client can you prevent users from changing the location.
|Automatic upload bandwidth percentage
||Enables the sync client to automatically set the amount of bandwidth used based on available bandwidth for uploading files
||AutomaticUploadBandwidthPercentage (int): This parameter determines the percentage of local upload bandwidth that the sync client can use. Accepted values are from 1 through 99.
|Set maximum upload throughput
||Sets the maximum upload throughput rate in kilobytes (KB)/sec for computers running the OneDrive sync client
||UploadBandwidthLimited (int): This parameter determines the upload throughput in KB/sec that the sync client can use. The minimum rate is 50 KB/sec and the maximum rate is 100,000 KB/sec.
<int>(Upload Throughput Rate in KB/sec)</int>
|Set maximum download throughput
||Sets the maximum download throughput rate in kilobytes (KB)/sec for computers running the OneDrive sync client
||DownloadBandwidthLimited (int): This parameter determines the download throughput in KB/sec that the sync client can use. The minimum rate is 50 KB/sec and the maximum rate is 100,000 KB/sec.
<int>(Download Throughput Rate in KB/sec)</int>
||Specifies whether a dock icon for OneDrive is shown
||HideDockIcon (Bool): When set to true, this parameter hides the OneDrive dock icon even when the application is running.
|Open at login
||Specifies whether OneDrive starts automatically when the user logs in
||OpenAtLogin (Bool): When set to true, OneDrive will start automatically when the user logs in on the Mac.
|Enable Files On-Demand
||Specifies whether Files On-Demand is enabled. If you don't set this setting, Files On-Demand will be enabled automatically as we roll out the feature, and users can turn the setting on or off
||FilesOnDemandEnabled (Bool): When set to true, new users who set up the sync client will download online-only files by default. When set to false, Files On-Demand will be disabled and users won't be able to turn it on.
|Disable download toasts
||Prevents toasts from appearing when applications cause file contents to be downloaded
||DisableHydrationToast (Bool): When set to true, toasts will not appear when applications trigger the download of file contents.
|Block apps from downloading online-only files
||Prevents applications from automatically downloading online-only files. You can use this setting to lock down applications that don't work correctly with your deployment of Files On-Demand.
||HydrationDisallowedApps (String): Json in the following format
"AppID" can be either the BSD process name or the bundle display name. MaxBuildVersion denotes the maximum build version of the application that will be blocked. MaxBundleVersion denotes the maximum bundle version of the application that will be blocked
|SharePoint Server Front Door URL
||Specifies the SharePoint Server 2019 on-premises URL that the OneDrive sync client should try to authenticate and sync against
||SharePointOnPremFrontDoorUrl (string): The URL of the on-premises SharePoint Server.
|SharePoint Server Tenant Name
||Specifies the name of the folder created for syncing the SharePoint Server 2019 files specified in the Front Door URL.
||SharePointOnPremTenantName (string): The name that will be used when creating a folder to sync the on-premises SharePoint Server files. If specified, the folder names will take the form of:
OneDrive – TenantName
If not specified, the folder names will use the first segment of the FrontDoorURL as the Tenant Name.
Example - https://Contoso.SharePoint.com will use Contoso as the Tenant Name
|SharePoint OnPrem Prioritization
||For hybrid scenarios where the email is the same for both SharePoint Server on-premises and SharePoint Online, determines whether or not the client should set up sync for SharePoint Server or SharePoint Online first during the first-run scenario.
||SharePointOnPremPrioritizationPolicy (int): This parameter determines which service to attempt to authenticate against for setting up sync.
1 indicates OneDrive should setup SharePoint Server on-premises first, followed by SharePoint Online.
<int>(0 or 1)</int>
You can also configure the OneDrive Standalone sync client to receive delayed updates.
|Setting||Description||Parameters||Example Plist Entry|
||Defines the update ring for the computer
||UpdateRing (String): This parameter has two different values.
Production - The default update ring for OneDrive updates.
Insiders - This update ring receives updates that are "pre-production" and will allow you to play with features before they are released. Note that builds from this ring may be less stable.
Enterprise - This update ring receives updates after they have rolled out through the Production ring. It also lets you control the deployment of updates. For more info about the update rings and how the sync client checks for updates, see The OneDrive sync client update process.
We'd love to hear your thoughts. Choose the type you'd like to provide:
Our feedback system is built on GitHub Issues. Read more on our blog.