Deploy OneDrive apps using Microsoft Endpoint Configuration Manager

You can use Microsoft Endpoint Configuration Manager to deploy the new OneDrive sync app (OneDrive.exe), as well as the mobile apps for iOS and Android. Before you begin deploying, make sure you have reviewed the planning information and deployment options in the OneDrive guide for enterprises.

Deploy the OneDrive sync app for Windows

The OneDrive sync app (OneDrive.exe) can be installed on Windows 7 and later. It can also be installed on macOS. For info about deploying the OneDrive sync app on macOS, see Configure the new OneDrive sync app on macOS

The new OneDrive sync app can be used with SharePoint Server 2019, but not earlier versions of SharePoint Server. For more information about the restrictions and limitations of the OneDrive sync app, see Invalid file names and file types in OneDrive and SharePoint.

Important

If your users are currently using the OneDrive sync app (Groove.exe), and you want to move them to the OneDrive sync app, see Transition from the previous OneDrive for Business sync app before proceeding.

Make sure that WNS is set up correctly

The OneDrive sync app uses Windows Push Notification Services (WNS) for optimum performance and battery life. Make sure you allow access from your network to the endpoints that OneDrive uses.

Check if users already have the OneDrive sync app

If the computers in your organization are running Windows 10, they already have the new sync app installed. If the computers have Office 2016 or Office 2013 (Home & Student, Home & Business, Professional, Personal, Home, or University) installed, they might also have the new sync app.

Note

Office is installed per machine, whereas OneDrive is installed per user by default. Learn about installing OneDrive per machine

Deploy any administrative settings

To set registry keys on computers in your domain, install OneDrive and copy the OneDrive.admx and OneDrive.adml files from %localappdata%\Microsoft\OneDrive\BuildNumber\adm\ to your Group Policy central store. For more info, see Use Group Policy to control OneDrive sync app settings.

Use Microsoft Endpoint Configuration Manager to deploy the OneDrive sync app

  1. In Configuration Manager, select Create Device Collection, and follow the steps in the Create Device Collection wizard.

  2. Save the OneDriveSetup.exe installer for Windows to your local computer or a network share. Download the Production ring OneDriveSetup.exe installer for Windows or download the Deferred ring OneDriveSetup.exe installer for Windows.

  3. Download the sample Configuration Manager package. It's a .zip file that contains the script installer deployment type. For more information about packages and programs in Configuration Manager, see Packages and programs in Configuration Manager.

Note

The script installer deployment type already has a detection method script and will correctly assess the installation. Also, there is an uninstall switch, which means that you can easily remove the OneDrive sync app, if necessary.

  1. Copy the installer to a folder in the Configuration Manager source content share.

  2. In Configuration Manager, select the Software Library workspace. Under Application Management, right-click Applications, and then select Import Application.

Importing an application

  1. Select the sample package.

  2. On the bottom of Configuration Manager, select the Deployment Types tab, right-click the deployment, and to update the Content location, edit the properties.

  3. Right-click the package, select Deploy, and follow the steps in the Deploy Software Wizard.

If you don't use the sample package, run the following command using Microsoft Endpoint Configuration Manager:

Execute <pathToExecutable>\OneDriveSetup.exe /silent

(where pathToExecutable is a location on the local computer or an accessible network share).

Note

This command must be run at user logon and using Administrator permissions. It must be run for each user on a machine. For an example of how to deploy an .exe on every user account, see How to deploy the OneDrive sync app with Configuration Manager.
If you run the command with no command line parameter, users will see the installation status. After installation, OneDriveSetup.exe will automatically execute OneDrive.exe and display OneDrive Setup to users. If you run the command with the /silent parameter, OneDrive.exe will be installed transparently and OneDrive Setup won't appear. You'll need to run OneDrive.exe with an additional command. If you want to control the launch of OneDrive across your organization, we recommend using the /silent parameter.

Learn more about application management in Configuration Manager. The installer will install the OneDrive executable file under %localappdata%\Microsoft\OneDrive.

Deploy the RMS client to enable syncing IRM-protected files

The new OneDrive sync app for Windows now supports syncing IRM-protected SharePoint document libraries and OneDrive locations. To create a seamless IRM sync experience for your users, deploy to your users' computers the latest Rights Management Service (RMS) client from the Microsoft Download Center. Even if these computers have the Azure Information Protection client installed, which includes the RMS client, the OneDrive sync app still needs a separate installation of the RMS client from the Microsoft Download Center.

To silently install the RMS client on computers, use the /qn switch as part of the command-line options of the Microsoft Windows Installer Tool (Msiexec.exe). For example, the following command shows the silent mode installation (assuming the RMS Client installer package is already downloaded to C:\Downloads)

msiexec /qn c:\downloads\setup.msi

You can have the setup file on a network share and use managed software deployment to run the msiexec command.

Note

The sync app does not support IRM policies that expire document access rights.

Help users sign in

To help users sign in, you can use silent account configuration or one of these methods:

  • Use the following URL to start OneDrive Setup on users' computers. When users click to begin Setup, a sign-in window will appear for users can enter email address.

    odopen://launch
    
  • Use the following URL with each user's email address to start Setup and prepopulate user email addresses in the sign-in window.

    odopen://sync?useremail=youruseremail@organization.com
    
  • Run the following command using Configuration Manager script:

    %localappdata%\Microsoft\OneDrive\OneDrive.exe 
    

    It starts the OneDrive process. If users haven't set up any accounts, it displays OneDrive Setup. To display OneDrive Setup specifically to users who haven't set up an account for your organization, use the command line parameter:

    /configure_business:<tenantId>
    

Note

When you use Microsoft Endpoint Configuration Manager, make sure you run OneDrive.exe with User permissions (not as an Administrator).
For help finding your tenant ID, see Find your Microsoft 365 tenant ID.

Auto-configure SharePoint site synchronization

If you want to auto-configure a SharePoint site to be synced, you can use the URL below as a guide to build the path to the SharePoint site you want to sync automatically:

odopen://sync/?siteId=<siteId>&webId=<webId>&webUrl=<webURL>&listId=<listId>&userEmail=<userEmail>&webTitle=<webTitle>&listTitle=<listTitle>

where:

  • <siteId> is the SharePoint site siteId GUID, enclosed in curly brackets. You can get this GUID visiting https://<TenantName>.sharepoint.com/sites/<SiteName>/_api/site/id.
  • <webId> is the SharePoint site webId GUID, enclosed in curly brackets. You can get this GUID visiting https://<TenantName>.sharepoint.com/sites/<SiteName>/_api/web/id.
  • <webUrl> is the SharePoint site URL. You can get this URL visiting https://<TenantName>.sharepoint.com/sites/<SiteName>/_api/web/url.
  • <listId> is the SharePoint site documents library GUID, enclosed in curly brackets. You can get this GUID visiting the document library in the browser, click in the gear icon and choosing "Library Settings". The URL will show the listId GUID at the end of URL, i.e. https://<tenant>.sharepoint.com/sites/<SiteName>/_layouts/15/listedit.aspx?List=%7Bxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx%7D (a GUID with escaped curly brackets).
  • <userEmail> is the OneDrive's user email address used to sign in into OneDrive.
  • <webTitle> and <listTitle> are used to compose the name of the local folder where the OneDrive content is synchronized. By default, when you use the "Sync" button when in the browser to synchronize a document library, OneDrive uses the SharePoint site name and the document library name to compose the local folder name, in the form of %userprofile%\<TenantName>\<SiteName> - <DocumentLibraryName>. You could use any other values if you prefer to. If you do not use these parameters, the local folder will be named " - Documents", despite of site and library names.

For example, if you want to synchronize https://contoso.sharepoint.com/sites/SalesTeam-01/ProjectX, where "ProjectX" is the documents library to synchronize, to "%userprofile%\Contoso\Sales - Unicorn" folder, you will need the following parameters to compose the odopen:// URL:

  • siteId: {ssssssss-ssss-ssss-ssss-ssssssssssss}
  • webId: {wwwwwwww-wwww-wwww-wwww-wwwwwwwwwwww}
  • webUrl: https://contoso.sharepoint.com/sites/SalesTeam-01
  • listId: {llllllll-llll-llll-llll-llllllllllll}
  • userEmail: user@contoso.com
  • webTitle: Sales (you would use SalesTeam-01 to mimic Sync button behavior instead)
  • listTitle: Unicorn (you would use ProjectX to mimic Sync button behavior instead)

The resulting odopen:// URL will be:

odopen://sync/?siteId={ssssssss-ssss-ssss-ssss-ssssssssssss}&webId={wwwwwwww-wwww-wwww-wwww-wwwwwwwwwwww}&webUrl=https://contoso.sharepoint.com/sites/SalesTeam&listId={llllllll-llll-llll-llll-llllllllllll}&userEmail=user@contoso.com&Title=Sales&listTitle=Unicorn

Note

You will need Client Side Object Model (CSOM) knowledge if you want to automate quering the team site to determine the appropriate siteId, webId and listId to build the appropriate URL.

Deploy the OneDrive app on mobile devices running iOS or Android

You can use Microsoft Endpoint Configuration Manager to deploy apps to mobile devices. Before you do, however, you need to complete a few prerequisite steps because integration with Intune is required to manage mobile devices in Configuration Manager. For information about managing mobile devices with Configuration Manager and Intune, see Manage Mobile Devices with Configuration Manager and Microsoft Intune.

Deploy the OneDrive app for iOS

  1. In Configuration Manager, on the Home ribbon, select Create Application.

  2. In the Type box, select App Package for iOS from App Store.

  3. In the Location box, enter the app store URL, https://itunes.apple.com/us/app/onedrive/id823766827?mt=12.

Entering the App Store URL

  1. Target the app to users.

For more info, see Create iOS applications with Configuration Manager, and use as the app location, as shown below.

Deploy the OneDrive app for Android

  1. In Configuration Manager, on the Home ribbon, select Create Application.

  2. In the Type box, select App Package for Android on Google Play.

  3. In the Location box, enter the app store URL, https://play.google.com/store/apps/details?id=com.microsoft.skydrive&hl=en.

Entering the Google Play URL

  1. Target the app to users.

For more info, see Create Android applications with Configuration Manager.

See also

Invalid file names and file types in OneDrive and SharePoint