Deploy TeamViewer (Host or full client) - 9/10

Modified on Tue, 12 Nov at 10:56 AM

Deploy TeamViewer (Host or full client) - 9/10

We recommend using a specific script to deploy TeamViewer successfully on your devices.

In this article, we will show you our recommended script and explain the meaning of each parameter.

This article applies to Corporate and Tensor license holders who want to deploy TeamViewer (version 15 or newer) on their Windows devices.

Recommended scripts

Important note: Please make sure to replace [your_xxx] with your own values.

This script processes the deployment in two steps:

Installation of the package
Account assignment

Script for the TeamViewer Host:

start /wait MSIEXEC.EXE /i "PATH_TO_MSI_FILE\TeamViewer_Host.msi" /qn CUSTOMCONFIGID=YOUR_CUSTOM_CONFIG_ID timeout /t 30 /nobreak "C:\Program Files (x86)\TeamViewer\TeamViewer.exe" assignment --id YOUR_ASSIGNMENT_ID

Script for the Full client (64-bit):

start /wait MSIEXEC.EXE /i "PATH_TO_MSI_FILE\TeamViewer_Full.msi" /qn timeout /t 30 /nobreak "C:\Program Files\TeamViewer\TeamViewer.exe" assignment --id YOUR_ASSIGNMENT_ID

Script for the Full client (32-bit):

start /wait MSIEXEC.EXE /i "PATH_TO_MSI_FILE\TeamViewer_Full.msi" /qn timeout /t 30 /nobreak "C:\Program Files (x86)\TeamViewer\TeamViewer.exe" assignment --id YOUR_ASSIGNMENT_ID

Main parameters

We will explain here the parameters we used in our recommended scripts:

▹msiexec.exe /i

Installs the package.

▹/qn

Allows the silent installation.

▹“PATH_TO_MSI_FILE\TeamViewer_Host.msi”

Defines the installation path.

Note: It can also be on a network path.

▹CUSTOMCONFIGID=xxxxxx

Applies your module's customization.

Note: This only applies to the TeamViewer Host.

▹SETTINGSFILE=”YOURPATH\yourfilename.tvopt”

Imports TeamViewer options.

For more information, please read the following article:

Export settings for deployment

Note: The value must be a valid absolute local path or a path to a network share.

Don't use this parameter in combination with IMPORTREGFILE.

▹ENABLEOUTLOOKPLUGIN=true or false

Controls the de-/activation of the Outlook plugin

true: The TeamViewer Outlook plugin is activated after installation (default)

false: The TeamViewer Outlook plugin is deactivated after the installation

▹INSTALLSECURITYKEYREDIRECTION= 0 or 1

Installs a virtual device driver required for the security key redirection feature that allows the use of smart cards and fido-based devices through a TeamViewer session

0: Does not install the driver (Default)

1: Installs the driver

Optional command line options

There are additional options you can add to your command line:

Alias

For Windows:

--device-alias=[<name>]

For macOS:

-device_alias [<name>]

For Linux:

--device-alias=[<name>]

Alias for the new device in the Device list. No alias will be applied if the device is already in the contact list. The property can take the following values:

--alias (without value)
- alias of the computer will be the TeamViewer ID
--alias hello
- alias of the computer will be "hello"
Alias parameter not specified
- alias of this computer will be %computername%
--alias %systemvariable%
- alias will be the used system variable e.g. %username%

Example:

"C:\Program Files\TeamViewer\TeamViewer.exe" assignment --id 123 --device-alias=%COMPUTERNAME%-%USERNAME%

Hint: If you want to use spaces, you have to put everything in "..." like in the following example:

"C:\Program Files\TeamViewer\TeamViewer.exe" assignment --id 123 --device-alias=“%COMPUTERNAME% Test %USERNAME%“

Desktop Shortcut

It will prevent the desktop shortcuts from being installed.

msiexec /i "Path\To\TeamViewer.msi" /qn ADDLOCAL=ALL REMOVE=f.DesktopShortcut

Note: If you deployed the TeamViewer Host in the past using the MSI file with the option DESKTOPSHORTCUTS=0, and now want to get rid of the shortcut, use the following command:

msiexec /i "Path\To\TeamViewer.msi" /qn REMOVE=f.DesktopShortcut

Retries

--retries

The assignment is retried in case of temporary errors. Note that there is a waiting time of 1 second between each try.

Timeout

--timeout

Set the overall timeout in seconds used for all assignment tries.

Example:

TeamViewer.exe assignment --id YOUR_ASSIGNMENT_ID --retries=3 --timeout=120

Install the TeamViewer VPN

Install the TeamViewer VPN driver with the following parameter:

INSTALLVPN=1

Error codes

Error code	Description	Problem/solution
1	Invalid command line arguments	You seem to have misspelled or used a wrong command. Check your command and try again.
2	Signature verification error	-
3	Product not installed	TeamViewer is not installed. Install TeamViewer before doing an assignment.
4	Service config - access failed	// ComAPI The assignment configuration could not be verified against the TeamViewer Cloud. Please try again later.
400 (40 under Linux/FreeBSD)	MDv2Assignment - invalid argument	There seems to be an error in the command line syntax or an invalid assignment ID is used. Please check your overall command line syntax and verify that the copied assignment ID is a valid configuration from the Management Console.
401 (41 under Linux/FreeBSD)	MDv2Assignment - service not running	The assignment can't be done because TeamViewer is not running properly. Please verify that the TeamViewer service is running.
402 (42 under Linux/FreeBSD)	MDv2Assignment - service incompatible version	The TeamViewer service is incompatible with the executed TeamViewer client version. It seems that the installation wasn't completed properly. Please check the installation and if necessary re-install TeamViewer again.
403 (43 under Linux/FreeBSD)	MDv2Assignment - not online	The TeamViewer client could not connect to the TeamViewer cloud in order to assign your device. Please check if the client is online and if your internet connection works properly and re-try the assignment. Consider using the retries option on the command line interface if that happens frequently.
404 (44 under Linux/FreeBSD)	MDv2Assignment - already running	Another assignment process is already running. Please check the status of that assignment. You can do that for example by checking if the device is already registered as a managed device in the Management Console.
405 (45 under Linux/FreeBSD)	MDv2Assignment - timeout	Your assignment attempt was timed out. Please try again. Consider increasing the timeout on the command line interface in case this happens frequently and/or the network is unstable e.g. mobile ones.
406 (46 under Linux/FreeBSD)	MDv2Assignment - failed	Your assignment failed due to unknown reasons. Please save your logs and contact support.
407 (47 under Linux/FreeBSD)	MDv2Assignment - access denied	You don't have the necessary permission to execute an assignment. Ensure that your user has local administrator rights.
408 (48 under Linux/FreeBSD)	MDv2Assignment - Denied by policy	The TeamViewer policy active on this device prevents removing the existing assignment state. Please disable the policy in the Management Console. Note: Reassigning implicitly removes the existing state and is therefore also denied.