Overview of the Office 2016 Deployment Tool

The Office 2016 Deployment Tool (ODT) is a command-line tool that you can use to download and deploy Office 365 ProPlus to your client computers. The ODT gives you more control over an Office installation: you can define which products and languages are installed, how those products should be updated, and whether or not to display the install experience to your users.

If you’re not an enterprise administrator and are looking to install Office 365 in your home or business, see Install Office with Office 365.

Download the Office 2016 Deployment Tool

Download the Office 2016 Deployment Tool from the Microsoft Download Center.

After downloading the file, run the self-extracting executable file, which contains the Office 2016 Deployment Tool executable (setup.exe) and a sample configuration file (configuration.xml).

Before using the ODT to download or install Office, we recommend making sure you have the latest version.

Get started with the Office 2016 Deployment Tool

The ODT consists of two files: setup.exe and configuration.xml. To work with the tool, you edit the configuration file to define what options you want, and then run setup.exe from the command line. For example, you can edit the configuration file to download the 32-bit English edition of Office, or you can edit the file to install the 32-bit English edition of Office with the EULA automatically accepted and without Publisher. For the full set of options, see Configuration options for the Office 2016 Deployment Tool.

When running the ODT, you provide the location of the configuration file and define which mode the ODT should run in:

  • To download Office 365 ProPlus products and languages, use download    mode. Example: setup.exe /download downloadconfig.xml

  • To install the downloaded Office 365 ProPlus products and languages on a client computer, use configure    mode. You also use configure mode to remove and update Office products and languages. Example: setup.exe /configure installconfig.xml

  • To create an App-V package from the downloaded Office 365 ProPlus products and languages, use packager    mode. Example: setup.exe /packager packageconfig.xml

You can also use help    mode to read command-line help for the tool.

Download the installation files for Office 365 ProPlus

Follow these steps to download installation files for Office 365 ProPlus from the Office Content Delivery Network (CDN).

Step 1: Create the configuration file   

When creating the configuration file, we recommend starting with an example file and updating it with the appropriate options for your environment. You can start by copying and pasting the example below into a text file, saving it with a name of your choosing, and then editing the XML elements and attributes to define the options you want.

In this example, the configuration file downloads the installation files for a 32 bit English edition of Office 365 ProPlus 2016 and Visio Pro for Office 365 to \\server\share on your network:

<Configuration> 
  <Add SourcePath="\\server\share" OfficeClientEdition="32"> 
   <Product ID="O365ProPlusRetail" > 
     <Language ID="en-us" />      
           
   </Product> 
   <Product ID="VisioProRetail" > 
     <Language ID="en-us" />      
   </Product> 
 </Add> 
</Configuration>

For more information about the configuration options and more examples, see Configuration options for the Office 2016 Deployment Tool.

Step 2: Run the ODT executable in download mode   

From a command prompt, run the ODT executable in download mode and with a reference to the configuration file you just saved. In this example, the configuration file is named downloadconfig.xml:   

setup.exe /download downloadconfig.xml

Step 3: Validate that the files have been downloaded   

After running the command, go to the download location you defined in the configuration file and look for an Office folder with the appropriate files in it. If you run into problems, make sure you have the newest version of the ODT. You can also troubleshoot issues by reviewing the log file in the %temp% directory.

Download the installation files for Office 365 ProPlus from a local source

You can use the Office 2016 Deployment Tool to download the installation files for Office 365 ProPlus from a local source on your network instead of from the Office Content Delivery Network (CDN). By doing so, you can store a central copy of multiple languages and products for Office and distribute just the languages and products that you need to other locations on your network.

To download from a local source, follow the steps for downloading Office with the ODT, but include in your configuration file the download path, which defines where the installation files are downloaded from. For example, this configuration file downloads a 32 bit English edition of Office 365 ProPlus 2016 from \\servera\share    (the DownloadPath) to \\serverb\share    (the SourcePath):

<Configuration> 
  <Add SourcePath="\\serverb\share" OfficeClientEdition="32" Version="16.0.6741.2056" DownloadPath="\\servera\share”> 
    <Product ID="O365ProPlusRetail" > 
      <Language ID="en-us" />      
    </Product> 
  </Add> 
</Configuration>

Note that you must specify a Version    when using DownloadPath.

Install Office 365 ProPlus 2016

After you download Office 365 ProPlus installation files, follow these steps to install Office on a client computer. As part of that installation, you can choose which products to install.

Step 1: Create the configuration file   

When creating the configuration file, we recommend starting with an example file and updating it with the appropriate options for your environment. You can start by copying and pasting the example below into a text file, saving it with a name of your choosing, and then editing the XML elements and attributes to define the options you want.

In this example, the configuration file installs a 32 bit English edition of Office 365 ProPlus 2016 without Publisher:

<Configuration> 
  <Add SourcePath="\\Server\share" OfficeClientEdition="32">
    <Product ID="O365ProPlusRetail" > 
      <Language ID="en-us" />        
      <ExcludeApp ID="Publisher" />
    </Product> 
  </Add> 
  <Display Level="None" AcceptEULA="TRUE" />
</Configuration> 

The location of the Office installation files is \\server\share   . The display level is set to None   , which means the user will not see any user interface during the install, and the AcceptEULA is set to TRUE   , which means your users will not have to click to accept the EULA during the installation.

For more information about the configuration options, see Configuration options for the Office 2016 Deployment Tool.

Step 2: Run the ODT executable in configure mode   

From a command prompt, run the ODT executable in configure mode with a reference to the configuration file you just saved. In the following example, the configuration file is named installconfig.xml   :

setup.exe /configure installconfig.xml

You must run the executable from the client computer on which you want to install Office and you must have local administrator permissions on that computer.

Step 3: Verify that installation was successful   

After running the command, you should see the Office installation start (unless you set display level to none). After installation is complete, the command prompt will display “Products configured successfully.” If you run into problems, make sure you have the newest version of the ODT. You can also troubleshoot issues by reviewing the log files in the %temp% and %windir%\temp directories.

Update Office 365 ProPlus

You can use the Office 2016Deployment Tool to make updates to your client computers after installing Office 365 ProPlus. There are two ways to do this:

  • Use the ODT to install Office 365 ProPlus again, which will update Office to the newest version. Only the files that have changed in the new version will be updated.

  • Use the ODT to download the Office installation files and then point your client computers to that location to receive their updates. (By default, clients are updated directly from the Office Content Delivery Network (CDN).)

To change where your client computers receive their updates, run the ODT in configure mode and specify an update path in the configuration file. For example, to have Office 365 ProPlus get updates automatically from a network share called \\server\updates   , include the following line in your configuration.xml file:

<Updates Enabled="TRUE" UpdatePath="\\server\updates" />

This article does not cover all the issues related to managing updates for Office in your organization. For more information on that end-to-end scenario, including using Group Policy, see Choose how to manage updates to Office 365 ProPlus.

Exclude or remove Office 365 ProPlus products from client computers

When installing Office 365 ProPlus, you can exclude specific products. To do so, follow the steps for installing Office with the ODT, but include the ExcludeApp element in your configuration file. For example, this configuration file installs all the Office 365 ProPlus products except Publisher:

<Add SourcePath="\\Server\share" Version="15.1.2.3" OfficeClientEdition="32">
    <Product ID="O365ProPlusRetail" >
      <Language ID="en-us" />
      <ExcludeApp ID="Publisher" />
    </Product>
</Add>

If you’ve already installed Office 365 ProPlus, you can also use the ExcludeApp element to remove a product that you've previously installed. For example, the configuration file above removes Publisher from the previous installation of Office.

You can also remove an entire language version of Office 365 ProPlus. To do so, follow the steps for excluding products for installing Office with the ODT, but replace the configuration file with one that uses the Remove    element. For example, this configuration file removes the Spanish language version of Office 365 ProPlus:

<Configuration> 
 <Remove>
    <Product ID="O365ProPlusRetail" > 
      <Language ID="es-es" />        
    </Product> 
 </Remove>
</Configuration> 

For more information about the options for excluding or removing apps, see Configuration options for the Office 2016 Deployment Tool.

Install Office in the same language as the client operating system

When using the ODT, you can automatically install the Office language that matches the display language of the client operating system. To do so, use <Language ID="MatchOS"> in the configuration file.

For example, this configuration file installs the 32-bit edition of Office 365 ProPlus in the same language as the client operating system--English for clients with the display language of English, Japanese for clients with Japanese, and so on:

<Configuration> 
  <Add OfficeClientEdition="32">
    <Product ID="O365ProPlusRetail" > 
      <Language ID="MatchOS" />        
    </Product> 
  </Add> 
</Configuration> 

Add languages to existing installations of Office 365 ProPlus

After installing Office, you can add use the ODT to install additional language packs for Office. To do so, you follow the steps for installing Office with the ODT, but use a new configuration file that indicates which languages to add. The new configuration file does not contain (and should not contain) any settings for Office, such as excluded apps or which channel to update. All those client settings are preserved when the new language packs are installed. If your clients are updated from a local source on your network, you must also download the Office installation files for the languages you want to add to that source.

Step 1: Download the Office installation files in the languages you want to add   

If Office in your organization is updated from a local source, you must download the Office installation files for the languages you want to add.

Step 2: Create the configuration file for adding the language packs   

When creating the configuration file, we recommend starting with an example file and updating it with the appropriate options for your environment. You can start by copying and pasting the example below into a text file, saving it with a name of your choosing, and then ensuring that the OfficeClientEdition and language IDs are what you want.

In this example, the configuration file installs the French and Japanese language packs:

<Configuration>
  <Add OfficeClientEdition="32">
    <Product ID="LanguagePack">
      <Language ID="fr-fr" />
      <Language ID="ja-jp" />
    </Product>
  </Add>  
</Configuration>

It's important to emphasize that all the settings defined when you deployed or updated Office are preserved. For example, the source for the language pack is not provided in this configuration file--instead, the ODT will look for it in the source path defined in the configuration file you used to deploy Office.

For a list of all languages, see Language identifiers.

Step 3: Run the ODT executable in configure mode   

From a command prompt, run the ODT executable in configure mode with a reference to the configuration file you just saved. In the following example, the configuration file is named installlanguage.xml   :

setup.exe /configure installlanguage.xml

You must run the executable from the client computer on which you want to install Office and you must have local administrator permissions on that computer.

Create an App-V package for Office 365 ProPlus

In addition to downloading and deploying Office 365 ProPlus, you can use the Office 2016 Deployment Tool to create App-V packages. To do so, update the configuration file and then run the ODT in packager mode. You must create App-V packages on a computer with a clean install of the operating system.

This article does not cover all the issues related to deploying App-V packages. For more information on that end-to-end scenario, see Deploying Microsoft Office 2016 by Using App-V.

Step 1: Create the configuration file   

When creating the configuration file, we recommend starting with an example file and updating it with the appropriate options for your environment. You can start by copying and pasting the example below into a text file, saving it with a name of your choosing, and then editing the XML elements and attributes to define the options you want.

In this example, the configuration file creates an App-V package from a 32-bit English edition of Office 365 ProPlus 2016 without Publisher:

<Configuration> 
 <Add SourcePath="\\Server\share" OfficeClientEdition="32">
    <Product ID="O365ProPlusRetail" > 
      <Language ID="en-us" />        
      <ExcludeApp ID="Publisher" />
    </Product> 
 </Add> 
</Configuration> 

The location of the Office installation files is \\server\share. For your configuration file, substitute the example values with the appropriate option for your environment. For more information about the options, see Configuration options for the Office 2016 Deployment Tool,

Step 2: Run the ODT executable in packager mode   

From a command prompt, run the ODT executable in packager mode with a reference to the configuration file you just saved and to the location where you want to save the App-V package. In the following example, the configuration file is named packageconfig.xml    and the App-V package will be saved to \\server\share\appv\   :

setup.exe /packager packageconfig.xml \\server\share\appv\

Step 3: Verify that the package was created   

After running the command, the package location should have an App-V Packages folder and a WorkingDir folder. You can troubleshoot issues by reviewing the log file in the %temp% directory.

Related Topics

Configuration options for the Office 2016 Deployment Tool

Expand your skills
Explore training
Get new features first
Join Office Insiders

Was this information helpful?

Thank you for your feedback!

Thank you for your feedback! It sounds like it might be helpful to connect you to one of our Office support agents.

×