We recommend using specific command lines to deploy TeamViewer successfully on your devices.
In this article, we will show you our recommended command lines and explain the meaning of each parameter.
Recommended command lines
Important note: Please make sure to replace [your_xxx] with your own values.
Command line for the TeamViewer Host
start /wait MSIEXEC.EXE /i "PATH_TO_MSI_FILE\TeamViewer_Host.msi" /qn CUSTOMCONFIGID=YOUR_CUSTOM_CONFIG_ID ASSIGNMENTID=YOUR_ASSIGNMENT_ID
Command line for the TeamViewer Full client
start /wait MSIEXEC.EXE /i "PATH_TO_MSI_FILE\TeamViewer_Full.msi" /qn CUSTOMCONFIGID=YOUR_CUSTOM_CONFIG_ID ASSIGNMENTID=YOUR_ASSIGNMENT_ID
Note: If a custom Host configuration ID is used with the assignment parameter and includes a rollout configuration:
Main parameters
We will explain here the parameters we used in our recommended command lines:
▹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.
▹ASSIGNMENTID=YOUR_ASSIGNMENT_ID
Assigns the device or endpoint to your tenant or company profile.
▹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 as it will appear in the Device list; this 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