This article applies to TeamViewer users with Windows or macOS. Customers with a Remote Access license cannot establish a remote control connection via command line.
Some parameters are only available with TeamViewer version 13.2.
Command line parameters on Windows
How to use?
Parameters with and without value
There are two types of parameters, with value and without value.
Example for a parameter without value:
TeamViewer.exe --noInstallation
Example for a parameter with value:
TeamViewer.exe --id 123456789
In most cases, only one value is expected, if multiple are given, only the first one is used.
If the value of a parameter contains a space, the value must be enclosed in "".
Miscellaneous Info
A long parameter is called like this (with two “-“ -> “--“): TeamViewer.exe --Minimize
If the parameter has a short variant, it can also be called with only one “-“: TeamViewer.exe -n
However, using “--n” is also possible on some platforms. Multiple parameters can be combined in one call and parameters are case-sensitive.
Command Line Tasks
Usually when command line parameters are passed, TeamViewer will keep running. However, there are some "tasks" which can be triggered via command line, after which TeamViewer will close itself.
Tasks:
- Device Assignment
- COM API Installation
Application
Following options are supported:
Device assignment
On Windows the assignment task is started like this:
TeamViewer.exe assign <options>
On macOS it is started like this:
Host version:
sudo /Applications/TeamViewerHost.app/Contents/Helpers/TeamViewer_Assignment <options>
Full version:
sudo /Applications/TeamViewer.app/Contents/Helpers/TeamViewer_Assignment <options>
"sudo" is required to obtain admin rights, because AssignmentData.json is written with restricted rights by TeamViewer_Service. The tool can only be executed from within the app bundle, otherwise the tool cannot find its required frameworks.
If the value (e. g. group) contains a space, the value must be enclosed in "", or each space must be encapsulated with "\" on macOS.
Use “--" for Windows in front of each option and “-“ for macOS in front of each option.
Following options are supported:
Examples
Windows
Basic assignment:
TeamViewer.exe assign --api-token 12345678 --group SomeGroup
Using an alias & grant easy access:
TeamViewer.exe assign --api-token 12345678 --group "Some Group" --alias %COMPUTERNAME% --grant-easy-access
Using a proxy with authentication:
TeamViewer.exe assign --api-token 12345678 --group SomeGroup --reassign --proxy testproxy:3201 --proxy-user someuser --proxy-pw passwd
macOS
Examples are for Host version. For the full version just replace TeamViewerHost.app with TeamViewer.app)
Basic assignment:
sudo /Applications/TeamViewerHost.app/Contents/Helpers/TeamViewer_Assignment assign YES -api-token 12345678 -group SomeGroup
Using an alias & grant easy access:
sudo /Applications/TeamViewerHost.app/Contents/Helpers/TeamViewer_Assignment assign YES -api-token 12345678 -group "Some Group" -alias $USER -grant-easy-access
Using a proxy with authentication:
sudo /Applications/TeamViewerHost.app/Contents/Helpers/TeamViewer_Assignment assign YES -api-token 12345678 -group SomeGroup -reassign -proxy testproxy:3201 -proxy-user someuser -proxy-pw passwd
COM API
On Windows the COM API could be used like this:
TeamViewer.exe api <options>
How to verify successful installation
Via logfile
Open TV logfile from %appdata%\TeamViewer find following entries:
CommandLineTasks: initializing...
CommandLineTasks: installing COM-API
API: Installing API ...
API: ... successfully installed, calling SignalServiceParamChange ...
API: ... SignalServiceParamChange finished
CommandLineTasks: installing COM-API successful
CommandLineTasks: finished
Via Windows Powershell
Use the following Powershell commands:
$tv = new-object -com TeamViewer.Application
$tv.ApiVersion
Verify that any version will be written in the Windows Powershell for example:
How to verify successful un-installation
Via logfile
Open TV logfile from %appdata%\TeamViewer find following entries:
CommandLineTasks: initializing...
CommandLineTasks: uninstalling COM-API
API: Uninstalling API ...
API: ... successfully uninstalled, calling SignalServiceParamChange ...
API: ... SignalServiceParamChange finished
CommandLineTasks: uninstalling COM-API successful
CommandLineTasks: finished
Via Windows Powershell
Use the following Powershell commands:
$tv = new-object -com TeamViewer.Application
Verify that an error will be printed in the Powershell
