Deploying the new OneDrive sync client in an enterprise environment

This article will provide IT administrators detailed information on the steps required to deploy the new OneDrive for Business sync client for their business users in an enterprise environment.

Note: Before reading this article, we recommend that you read Plan to deploy the OneDrive for Business Next Generation Sync Client in an enterprise environment. It will provide information about planning considerations you need to make before deploying.

In this article:

Overview of the deployment process

The goal of the IT administrator in deploying the new OneDrive sync client to their enterprise users is to install OneDrive.exe to each user’s machine and assist users in signing in to OneDrive using their Office 365 business accounts. This will enable them to use the new OneDrive sync client.

There are three steps in this process that an IT administrator needs to understand:

  1. Deploy OneDrive.exe by running the installer (OneDriveSetup.exe) with the /silent command line parameter.

  2. Run OneDrive.exe with desired command line parameters to launch the process.

  3. Set the desired update cadence of the client (optional).

Important: If your users are currently using the OneDrive for Business Sync Client (Groove.exe) for their work and business files, and you want to move them to the new OneDrive sync client, see Transition from the previous OneDrive for Business sync client before proceeding. You will need to make some additional considerations to ensure that the transition is successful.

Step 1: Deploy OneDrive.exe using the OneDriveSetup.exe installer

The first step is to run the OneDriveSetup.exe installer on each machine. The installer will install the OneDrive executable file under the directory %localappdata%\Microsoft\OneDrive.

If you are running Windows 10 or Office 2016, or if you're already using the consumer OneDrive client, you already have the new OneDrive for Business sync client and you can skip to Step 2 below.

The OneDriveSetup.exe installer for Windows can be saved to a local network share for deployment through the Microsoft System Center Configuration Manager. Click here to download the OneDriveSetup.exe installer for Windows.

Tip: Try the sample SCCM package. Just update the OneDrive.exe path and the application owner.

Note: OneDriveSetup.exe installs OneDrive only within the current user account. OneDriveSetup.exe will need to be run once per each user account on the machine.

There are two options for deploying the OneDriveSetup.exe installer:

  • OneDriveSetup.exe (no command line parameter)

  • OneDriveSetup.exe /silent

Deploying without a command line parameter

Deploying OneDriveSetup.exe with no command line parameters will install OneDrive.exe with installation status that will be visible to the user.

OneDrive Installation Status

Additionally, after installation, OneDriveSetup.exe will automatically execute OneDrive.exe located at %localappdata%\Microsoft\OneDrive. This will automatically start the OneDrive Setup for the user.

Deploying with the /silent command line parameter

Deploying OneDriveSetup.exe /silent will install OneDrive.exe transparently to the user, in which the user will not be displayed an installation status screen.

Additionally, OneDriveSetup.exe will not launch OneDrive.exe automatically after installation completes. The IT administrator will need to launch OneDrive.exe through an additional command. Deploying OneDriveSetup.exe /silent has the benefit of allowing you to control when to launch OneDrive.exe and pass any additional command line parameters to OneDrive.exe.

Note: See Administrative settings for the OneDrive for Business Next Generation Sync Client to add additional administrative controls to help manage your OneDrive.exe users through Group Policy settings after it is deployed.

Step 2: Launch OneDrive.exe

After OneDrive.exe has been installed through the OneDriveSetup.exe installer, the OneDrive process can be launched by running OneDrive.exe along with one of the following configurations:

  • %localappdata%\Microsoft\OneDrive\OneDrive.exe (no command line parameter)

  • %localappdata%\Microsoft\OneDrive\OneDrive.exe /configure_business:<tenantId>

Note: When using System Center Configuration Manager, make sure OneDrive.exe is run with User's Right permissions (not run as an Administrator). An error will display if it is run with elevated permissions.

Launching OneDrive.exe without a command line parameter

Launching OneDrive.exe with no command line parameters starts up the OneDrive process. Your users experience will depend on whether a OneDrive account has been configured previously on the device:

Scenario

Result

If no accounts have yet been configured for OneDrive.exe on the device

OneDrive.exe will display OneDrive Setup. User will sign in with the desired account.

If one or more accounts (business or personal) have already been configured for OneDrive.exe on the device

OneDrive.exe will start up all OneDrive processes and OneDrive Setup will not display to the user.

Launching OneDrive.exe /configure_business:<tenantID>

Launching OneDrive.exe with the command line parameter /configure_business:<tenantId> will check to see if an account associated with a specific tenant has already been configured on the machine. Only in the case where an account of that tenant has not yet been configured will OneDrive Setup displayed to the user.

When OneDrive.exe is launched, it will check for the presence of ConfiguredTenantId in the system registry under HKEY_CURRENT_USER\SOFTWARE\Microsoft\OneDrive\Accounts\Business1 (or Business2, Business3, etc.) for a value matching the one provided in the /configure_business:<tenantId> parameter. If the user has not yet signed in to OneDrive.exe with the specified tenant, OneDrive Setup will open for the user.

For example, running OneDrive.exe /configure_business:12345678-1234-1234-1234-123456789012 will have the following effects:

  1. The system registry will be checked for the presence of ConfiguredTenantID under HKey_Current_User\Software\Microsoft\OneDrive\Accounts\Business1 (or Business2, Business3, etc).

  2. If this key exists, it will check to see if it has a value of 12345678-1234-1234-1234-123456789012.

  3. If step #2 is true, nothing will happen.

  4. If step #2 is false, OneDrive Setup will launch.

Running OneDrive.exe /configure_business:<TenantId> is a great way to target only the users who have not yet signed in with a desired account without bothering users who have already set up OneDrive.

Note: If you need help about finding your TenantID for your organization in Office 365, see Find your Office 365 tenant ID.

Step 3: Set your update cadence to Enterprise Tier (Optional)

For large enterprises, you may find you would like to delay updates to the OneDrive.exe client. Administrators have the ability to set the update cadence of their organizations to Enterprise Tier. Machines on the Enterprise Tier are delayed updates to the OneDrive.exe client until updates have been fully rolled out and validated against Production (1-2 weeks).

You can set your update cadence by configuring the Delay updating OneDrive.exe until the second release wave policy in the OneDrive.admx template file included in the OneDrive Deployment Package. For more information, see Administrative settings for the OneDrive for Business Next Generation Sync Client.

Additional resources

For additional resources about the new OneDrive sync client:

Title

Description

Plan to deploy the OneDrive for Business Next Generation Sync Client in an enterprise environment

Learn planning considerations you need to make when deploying the Next Generation Sync Client to an enterprise environment.

Get started with the new OneDrive sync client in Windows

Learn how Windows users can configure the Next Generation Sync Client.

Get started with the OneDrive for Business Next Generation Sync Client on Mac OS X

Learn how Mac users can configure the Next Generation Sync Client.

Deploying the OneDrive Next Generation Sync Client on OS X and configuring work or school accounts

Learn how administrators can use options for configuring the OneDrive Next Generation Sync Client on Mac OS X computers.

Transition from the previous OneDrive for Business sync client

Learn how Windows users can transition from the previous OneDrive for Business Sync Client to the Next Generation Sync Client.

Administrative settings for the OneDrive for Business Next Generation Sync Client

Learn how administrators can control and manage the Next Generation Sync Client for their users through Group Policy.

Which OneDrive sync client am I using?

Learn how to easily tell which OneDrive sync client you are using.

Restrictions and limitations when you sync OneDrive for Business libraries through OneDrive for Business

Knowledge base article with release notes, limits, and restrictions (such as invalid characters in file names).

Share Facebook Facebook Twitter Twitter Email Email

Was this information helpful?

Great! Any other feedback?

How can we improve it?

Thank you for your feedback!

×