Category filter

Configure OneDrive sync app on Mac using custom profiles

This document provides a detailed guide on creating and implementing a configuration profile to configure the OneDrive sync app on Macs.

Organizations can ensure that all Mac users have a standardized configuration for their OneDrive sync app by deploying a custom configuration profile. This profile configures settings such as file path locations, sync restrictions, or network usage limits. Deploying a custom configuration profile eliminates the need for users to manually configure these settings.

This configuration profile for the OneDrive sync app can be deployed to Macs via Hexnode’s Deploy Custom Configuration feature.

Disclaimer:


The sample configuration profile provided below is adapted from third-party open-source sites.

Notes:

  • Ensure that the organization has an active Microsoft 365 Business subscription, which includes access to OneDrive for Business.
  • Ensure that the OneDrive sync app is installed on macOS devices across the organization.
  • Replace all placeholders in the XML configuration file with your organization-specific values.

Configure OneDrive sync app

You can set up the OneDrive sync app for Mac by configuring the following settings.

1. Automatic Upload Bandwidth Percentage

Key: AutomaticUploadBandwidthPercentage

Supported value: Integer

This setting allows the sync app to automatically determine the amount of bandwidth used for uploading files, based on the available network bandwidth. To turn it on, specify a value between 1 and 99, which represents a percentage out of the total available network bandwidth that the sync app can use.

2. Block External Sync

Key: BlockExternalSync

Supported value: Boolean

This setting restricts syncing libraries and folders shared from unknown sources. The value True restricts syncing OneDrive, SharePoint libraries, and folders with unknown sources other than the user’s organization.

3. Default Folder Location

Key: DefaultFolderLocation

Supported value: Array

This setting defines the default location of the OneDrive folder for the organization. The parameters are TenantID and DefaultFolderPath. Replace Enter-Tenant-ID and /Path/to/the/Folder in the XML file with your organization’s Tenant ID and the desired location of the OneDrive folder.

4. Default to Business FRE

Key: DefaultToBusinessFRE

Supported value: Boolean

This setting defaults OneDrive to the business version.

5. Disable Hydration Toast

Key: DisableHydrationToast

Supported value: Boolean

This setting prevents notifications (toasts) from appearing when apps cause to download file contents.

6. Disable Tutorial Screens

Key: DisableTutorial

Supported value: Boolean

This setting blocks the tutorial displayed after the user sets up OneDrive. Set this value to True to prevent the tutorial from being displayed.

7. Maximum Download Bandwidth

Key: DownloadBandwidthLimited

Supported value: Integer

This setting specifies the maximum download throughput rate in kilobytes per second (KB/sec) for devices running the OneDrive sync app. Set this value to an integer between 50 and 100,000 KB/sec to limit the download bandwidth.

8. Enable Add Accounts

Key: EnableAddAccounts

Supported value: Boolean

This setting allows users to add additional accounts to OneDrive.

9. Enable All Osci Clients

Key: EnableAllOcsiClients

Supported value: Boolean

This setting allows multiple users to use Microsoft 365 Apps for Enterprise, Office 2019, or Office 2016 desktop apps to simultaneously edit an Office file stored in OneDrive. It also enables file sharing from the Office desktop apps.

Note:


If this setting is True or not set, the option Use Office applications to sync Office files that I open is selected by default on the device.

10. OneDrive Sync Ignore Rules

Key: EnableODIgnore

Supported value: Array

This setting allows you to enter keywords to prevent the OneDrive sync app from uploading certain files to OneDrive or SharePoint. If you configure this setting, the sync app won’t upload new files that match the specified keywords. You can enter full names like “install.exe” or use the asterisk (*) as a wildcard, such as *.pst. Keywords are not case-sensitive.

Note that no errors will appear for these files, and they’ll stay in the local OneDrive folder. A message in the OneDrive activity center will explain why the files aren’t syncing.

11. Enable Files On-Demand

Key: FilesOnDemandEnabled

Supported value: Boolean

OneDrive Files On-Demand allows you to access all your cloud-stored files in OneDrive without downloading them, saving storage space on your device. Enabling this setting activates Files On-Demand.

12. Hide Dock Icon

Key: HideDockIcon

Supported value: Boolean

This setting determines whether a dock icon for OneDrive is shown. If set to True, the OneDrive dock icon is hidden even if the app is running.

13. Block Opt-in

Key: KFMBlockOptIn

Supported value: Integer

This setting prevents users from moving their documents and desktop folders to any OneDrive account. Setting the value to:

  • 0: Does not block opt-in (Users are allowed to move their documents and desktop folders to OneDrive).
  • 1: Prevents folder backup.
  • 2: Redirects previously backed-up folders back to the user’s device and stops the setting KFMBlockOptIn from running further.

14. Block KFM Opt-out

Key: KFMBlockOptOut

Supported value: Boolean

This setting forces users to keep their documents and desktop folders directed to OneDrive, preventing them from redirecting these folders back to their Mac.

15. Prompt Users to Move Known Folders

Key: KFMOptInWithWizard

Supported value: String

This setting displays a wizard prompting users to move their documents and/or desktop folders to OneDrive. If enabled and the tenant ID is provided, users will see the Folder Backup wizard window when they sign in. If they close the window, a reminder notification appears in the Sync Activity Center until they move their folders.

16. Silently Move Known Folders

Key: KFMSilentOptIn

Supported value: String

This setting redirects and moves users’ documents and/or desktop folders to OneDrive without requiring any user interaction. It facilitates the simultaneous transfer of both the documents and desktop folders to OneDrive while providing users the choice to select which folder they wish to move.

After a folder has been moved, this setting will have no further impact on it. To enable this setting, the tenant ID must be provided during the configuration.

17. Silently Opt-in Desktop to Known Folders

Key: KFMSilentOptInDesktop

Supported value: Boolean

Enable this setting to silently opt-in and move the user’s desktop folder to OneDrive without any user interaction.

18. Silently Opt-in Documents to Known Folders

Key: KFMSilentOptInDocuments

Supported value: Boolean

Enable this setting to silently opt-in and move the user’s documents folder to OneDrive without any user interaction.

19. Silently Opt-in with Notification

Key: KFMSilentOptInWithNotification

Supported value: Boolean

If enabled, this setting displays a notification to users after their folders have been redirected.

20. Open at Login

Key: OpenAtLogin

Supported value: Boolean

This setting specifies whether OneDrive starts automatically when the user logs in. Set this value to True to enable OneDrive to start automatically upon login.

21. SharePoint Server Front Door URL

Key: SharePointOnPremFrontDoorUrl

Supported value: String

This setting specifies the SharePoint Server on-premises URL that the OneDrive sync app must try to authenticate and sync against. Define a string containing the URL of the on-premises SharePoint Server to enable this setting.

22. SharePoint OnPrem Prioritization

Key: SharePointOnPremPrioritizationPolicy

Supported value: Integer

This setting determines whether the sync app should prioritize syncing with SharePoint Server on-premises or SharePoint in Microsoft 365 during the first-run scenario when the account is the same for both in a hybrid setup. Set this value to 1 for SharePoint Server and 0 for SharePoint in Microsoft 365.

23. SharePoint Server Tenant Name

Key: SharePointOnPremTenantName

Supported value: String

This setting allows you to specify the name of the folder created for syncing the SharePoint Server files specified in the Front Door URL.

24. Maximum Upload Bandwidth

Key: UploadBandwidthLimited

Supported value: Integer

This setting defines the maximum upload throughput rate in kilobytes per second (KB/sec) for computers running the OneDrive sync app. Set a value between 50 and 100,000 KB/sec to specify the maximum upload bandwidth.

25. Tier (Standalone Version Only)

Key: Tier

Supported value: String

This setting allows you to specify the sync app update ring for users in your organization. The OneDrive sync app updates through three rings:

  • Insiders: Users receive builds that preview new features.
  • Production (default): Users obtain the latest features when they are available.
  • Enterprise: Users receive new features, bug fixes, and performance improvements last. This ring allows updates from an internal network location and control over the timing of the deployment within 60 days.

What happens at the device end?

Upon the successful deployment of the configuration profile, the OneDrive sync app on the device will automatically adapt to the pre-defined settings within the configuration profile.

For example, consider the upload and download bandwidth settings. If the Maximum Upload Bandwidth and Maximum Download Bandwidth values in the configuration profile are 99 KB/s each, this will be reflected in the OneDrive app, under the Network tab. These values will be displayed in a greyed-out state, which means they are currently set and controlled by the configuration profile.

After deploying the configuration profile to configure the OneDrive sync app on Mac, the options to adjust the upload and download rates are disabled

Notes:

  • To create and customize configuration profiles, you can use tools like Apple Configurator, Profile Manager or manually create them using text editors.
  • Use non-encrypted .mobileconfig, .xml, or plist files to deploy profiles across devices.
  • Ensure that you do not associate conflicting configurations with the devices.
  • Use wildcards to fetch key values from the portal.
  • It is recommended to manually validate the configuration profile on a system before executing it in bulk.
  • Hexnode will not be responsible for any damage/loss to the system on the behavior of the configuration profile.

  • Configuration Profile Repository