This article applies to all TeamViewer customers with a Corporate or Tensor license.
This article applies to TeamViewer version 13.2 or newer.
Supported Windows versions: Win 7, Win 8 and Win 10
This article explains how you can deploy TeamViewer Host and TeamViewer Full in a mass deployment scenario on Windows.
Installation
For Windows TeamViewer offers 2 MSI installers:
1) TeamViewer_Host.msi: this will install the (customized) Host module of TeamViewer
2) TeamViewer_Full.msi: this will install the full version of TeamViewer
Standard Host client
In order to install TeamViewer in a mass deployment scenario without user interaction, you just need to use the following command from within your script, directly from command line or in your deployment solution:
- msiexec.exe /i "<path to your TeamViewer_Host.msi>" /qn
- The property /i indicates that you want to make an installation
- The property /qn forces the installation to be quiet. This means no user interaction during installation will be required.
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn
The TeamViewer installation requires admin rights. There are more properties for the Windows installer available to control the installation. Just type the following into the command prompt: msiexec.exe /?
Customized Host client
When you want to install a customized Host without user interaction, you need to follow these steps:
1) Create a new customization or open an existing one
💡How to customize your Host: Visit the Design & Deploy page to set up your customization within the TeamViewer Management Console. After you created the Host customization a ConfigurationID will be generated. You can find it by clicking on edit for the corresponding module entry at the bottom of the opened page.
2) Copy the ConfigurationID from your customized Host
3) Open the Windows command prompt (CMD) with admin rights or execute the MSI via a script (batch, etc.).
💡The command prompt must be started as administrator. If you execute the MSI within a script, the script also needs to be executed with admin rights.
4) Type into the command prompt: msiexec.exe /i "Path\To\TeamViewer_Host.msi>" /qn CUSTOMCONFIGID=<YOUR_CUSTOMCONFIG_ID>
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn CUSTOMCONFIGID=<YOUR_CUSTOMCONFIG_ID>
5) Below is an example of what is needed to get the device assigned and with the customizations.
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn CUSTOMCONFIGID=YOURIDCCODE
ping -n 31 127.0.0.1>nul
Path\To\TeamViewer.exe assign --api-token=YOURTOKEN --grant-easy-access
Full client
In order to install TeamViewer in a mass deployment scenario without user interaction, you need to follow these steps:
1) Open the Windows command prompt (CMD) with admin rights or execute the MSI via a script (batch, etc.).
💡The command prompt must be started as administrator. If you execute the MSI within a script, the script also needs to be executed with admin rights.
2) Type into the command prompt: msiexec.exe /i "Path\To\TeamViewer_Full.msi>" /qnThe property /i indicates that you want to make an installation
The property /qn forces the installation to be quiet. This means no user interaction during installation will be required
msiexec.exe /i "Path\To\TeamViewer_Full.msi" /qn
💡Help for Windows Installer: There are more properties for the Windows installer available to control the installation, just type the following into the command prompt: msiexec.exe /?
Custom Full Client
Please read this article to learn more.
Configuration of installation
Apply TeamViewer options (recommended)
1) Export a settings file from a TeamViewer client. Since version 15.4, you will receive a *.tvopt file. In previous versions TeamViewer exported a *.reg file. For the import, you can use both file types, but we recommend you to use the *.tvopt file.
💡How to get the settings file:
Install TeamViewer on a single computer and configure it to fit your needs.
1) Go to dialog (Extras | Options) in the category "Advanced", click "Export…" to export the options file and give your file a name (in our example, we will name this file my_settingsfile).
2)Add the property SETTINGSFILE="ABSOLUTE_PATH/TO/SETTINGSFILE" to your command when installing TeamViewer_Host.msi or TeamViewer_Full.msi. The path given needs to be either a local path or a path to a network share.
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn SETTINGSFILE="C:/my_settingsfile.tvopt"
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn SETTINGSFILE="\\share\my_settingsfile.tvopt"
⚠Please make sure to use the exact name of the .tvopt file in your command line.
Apply TeamViewer settings (deprecated)
The parameter IMPORTREGFILE is deprecated since version 15.4. It can currently still be used with version 15.3 or lower, but the parameter will be removed with an upcoming version. Thus we recommend to switch to the parameter SETTINGSFILE.
1) Put the settings file "TeamViewer_Settings.reg" (file name is mandatory) in the same directory as the MSI file.
💡How to get the settings file: Install TeamViewer on a single computer and configure it to your needs. In the Options dialog (Extras | Options) in the category "Advanced", click "Export…" to export the settings file.
2) Add the property IMPORTREGFILE=1 to your command when installing TeamViewer_Host.msi (version 13.2 or higher) or TeamViewer_Full.msi (version 14.0 or higher). 0 is the default value for IMPORTREGFILE and will not import the settings.
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn IMPORTREGFILE=1
Assign your Host or Full client to an account
In the mass deployment process, it might be useful to assign the new TeamViewer installation to an existing account. You can do this the following way:
1) Install TeamViewer via MSI
2) After installation wait until TeamViewer can get online
3) Call TeamViewer.exe and add your API-Token and your assignment properties to the command line task "assign":
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn
ping -n 31 127.0.0.1>nul
Path\To\TeamViewer.exe assign --api-token=YOURTOKEN --grant-easy-access
Summary of MSI configuration properties
Here the lines for COPY/PASTE purposes:
msiexec.exe /i "Path\To\TeamViewer_Host.msi" ENABLEOUTLOOKPLUGIN="false"
📌Note: Once you have deployed TeamViewer successfully, please read our article on how to set up TeamViewer policies. Settings policies provide you with the ability to set options for all your installed TeamViewer clients centrally via the TeamViewer Management Console. This way, you can deploy and enforce the same settings to all your clients. Please learn how to proceed here:
Update of TeamViewer
TeamViewer_Host.msi
If you want to install the TeamViewer Host client and already have a TeamViewer version installed, you need to verify that the specific upgrade path is supported. The following table explains when an installation is possible and when you have to uninstall your previous version before:
TeamViewer.msi
If you want to install the TeamViewer Full client and already have a TeamViewer version installed, you need to regard that the TeamViewer_Full.msi (TV 14.0 or higher) is not compatible with any previously installed version of TeamViewer:
The auto-update in TeamViewer is no longer available if you are using the MSI file for installation. It must be updated with the Windows Installer again.
Uninstalling TeamViewer
You can uninstall your TeamViewer if necessary (e.g. if you want to switch from a host to a full version) either
1) Using the exact same Windows MSI installer you also used for installation
2) Using operating system functionality
Uninstallation via Windows Installer
You can use the uninstall command from the Windows MSI installer (/uninstall or /x). Make sure you use the right MSI (Full or Host) for uninstallation.
msiexec.exe /uninstall "Path\To\TeamViewer_Host.msi"
💡Admin rights are necessary when starting the command line.
Assignment
Introduction
You can configure a TeamViewer Host or Full client in such a way, that it is assigned to a TeamViewer account. You can do this during the installation process.
This description is valid for TeamViewer 14.x (or higher) and additionally for the Host v13.2.
You can do the assignment of a device to a TeamViewer account in two ways:
- (recommended) With the TeamViewer executable after an installation (TeamViewer.exe)
- With the Windows MSI Installer (TeamViewer_Full.msi or TeamViewer_Host.msi)
💡If you have an older version of TeamViewer, you need to do the account assignment with the assignment tool. More information about this can be found here.
How to do the assignment
For doing an assignment you need:
1) (required) a valid API Token
2) (optional) assignment options in order to more precisely define, how the device should be assigned
💡 An API Token can be retrieved in 2 ways:
1) From your Custom Host or Custom Full Client configuration, if you have checked the option Allow account assignment via the Assignment Tool on creation.
2) You can create a script-token in your user profile > Apps. This script token needs at least the following permissions:
- Group management → View, create, delete, edit and share groups
- Computers & Contacts → View, add, edit and delete entries
Assignment with the TeamViewer executable (recommended)
You should do the assignment after the TeamViewer Host or Full client has been installed. It's important that TeamViewer is started on the machine you want to assign.
Call TeamViewer.exe (or just Teamviewer) with the command assign, followed by the property --api-token and your assignment options:
TeamViewer.exe assign --api-token <APITOKEN> [--group-id <GROUP_ID> --grant-easy-access --reassign --proxy <YOUR_PROXY> --proxy-user <YOUR_PROXY_USER> --proxy-pw <PASSWORD>]
Assignment with the Windows MSI installer
You can also do the assignment during the installation process with the MSI. You just need to run your MSI installer and add the property APITOKEN and optionally the property ASSIGNMENTOPTIONS
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> [ASSIGNMENTOPTIONS="<YOUR OPTIONAL SETTINGS>"]
msiexec.exe /i "Path\To\TeamViewer_Full.msi" /qn APITOKEN=<YOUR_APITOKEN> [ASSIGNMENTOPTIONS="<YOUR OPTIONAL SETTINGS>"]
Assignment options
--alias [<name>]
Alias for the new device in the computers & contacts list. If the device is already in the contact list, no alias will be applied. The property can take the following values:
1) --alias (without value) ➜ alias of the computer will be the teamviewerID
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="--alias --group MyGroup"
2) --alias hallo ➜ alias of the computer will be "hallo"
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="--alias hello --group MyGroup"
3) Alias parameter not specified ➜ alias of this computer will be %computername%
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="--group MyGroup"
4) --alias %systemvariable% alias will be the used system variable e.g. %username%
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="--alias %systemvariable% --group MyGroup"
--grant-easy-access
If you set this option easy access is granted after assignment (same as the "Grant easy access" option in the TeamViewer main window).
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="--grant-easy-access --group MyGroup"
--reassign
Assigns the device to the account even if the device is already assigned to an account.
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="--reassign --group MyGroup"
--group <name>
Name of the group in which the device will be added. When the group doesn't exist it will be automatically created. If the device is already present in the computers & contacts list in a different group, it won't be moved to the group. If you however use the parameter "--reassign", also the group will be moved.
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="--group MyGroup"
💡Not required if a custom host is used, as there is already a default group defined in the custom configuration.
--group-id <ID>
This option is an alternative to use the --group parameter if the id of the group is known. This might be useful in very large customer environments as it speeds up the assignment process. Usually using --group is sufficient.
📌Note: The ID must be prepended with a literal "g".
You can find the group-id when logging into the Management Console, clicking on the group and checking the URL. At the end of the URL you will find "g/12345678".
📌Note: Please remove the "/" in order to get your group-id.
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="--group-id g123"
--proxy <name>:<port>
Url of your proxy (only for the assignment) in the format <name>:<port>, e. g. --proxy yourproxy:3201
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="--proxy yourproxy:3201 --proxy-user FooBar --proxy-pw mypass --group MyGroup"
⚠URL without http://
--proxy-user <name>
Username which is used for authentication against the proxy (only for the assignment).
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="--proxy yourproxy:3201 --proxy-user FooBar --proxy-pw mypass --group MyGroup"
--proxy-pw <password>
Password which is used for authentication against the proxy (only for the assignment).
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="--proxy yourproxy:3201 --proxy-user FooBar --proxy-pw mypass --group MyGroup"
--proxy-pw-base64 <encoded_password>
Same as --proxy-pw, but the password needs to be entered as a Base64 encoded string. Useful for passwords with special characters.
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="--proxy yourproxy:3201 --proxy-user FooBar --proxy-pw-base64 bXlwYXNz --group MyGroup"
--monitoring-policyid <policy_id>
This option is only available when installing TeamViewer_Full.msi. It specifies the policy id for Remote Management Monitoring that should be applied after assignment has successfully been finished. This also requires --patchmanagement-policyid.
msiexec.exe /i "Path\To\TeamViewer_Full.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="--monitoring-policyid <YOUR_MONITORING_POLICYID> --patchmanagement-policyid <YOUR_PATCHMANAGEMENT_POLICYID> --group MyGroup"
--patchmanagement-policyid <policy_id>
This option is only available when installing TeamViewer_Full.msi. It specifies the policy id for Remote Management Monitoring that should be applied after assignment has successfully been finished. This also requires --monitoring-policyid.
msiexec.exe /i "Path\To\TeamViewer_Full.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="--monitoring-policyid <YOUR_MONITORING_POLICYID> --patchmanagement-policyid <YOUR_PATCHMANAGEMENT_POLICYID> --group MyGroup"
Help for assignment options
- If you have parameter values with blanks (e.g. for the group name) use two double quotes (not single double quotes!) to frame them.
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="--group ""Test group"""
Assignment parameter names are case insensitive (since version 14.0)
- Proxy settings can be specified for the assignment within the ASSIGNMENTOPTIONS. There are additional proxy settings for the TeamViewer connection itself (as defined in the TeamViewer client options). These have to be set outside of the ASSIGNMENTOPTIONS.
- You can also insert environment variables to your commands for installation/assignment to add dynamic values, e.g. for the alias. You can use environment variables by using %%.
msiexec.exe /i "Path\To\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="--alias %COMPUTERNAME%"
