This article applies to all TeamViewer customers with a Corporate or Enterprise license.

Windows

Installation of TeamViewer via executable

TeamViewer provides executables for Windows setup for several TeamViewer client types.
There are several possibilities of installing the TeamViewer client via the executable:

  • Manual installation via exe file
    • Start the installation process by double clicking onto the exe file.
  • Automated installation
    • Start the setup process via command prompt of Windows, or execute via a script (batch, etc.).

    • (warning) Command prompt must be started with elevated rights / as administrator
    • You can provide some parameters after installation for configuring TeamViewer via command line
    • Example: 

      TeamViewer_Setup.exe
      TeamViewer.exe --ProxyIP <Host>:<Port> --ProxyUser <ProxyUser> --ProxyPassword <ProxyPWD>

        

Installation of TeamViewer via Windows Installer (msi)

TeamViewer provides a Windows Installer for the full (TeamViewer.msi) and host (TeamViewer_host.msi) version.

Possibilities for Installation

There are several possibilities of installing TeamViewer via Windows Installer:

  • Manual installation via graphical user interface
    • Start the setup process by double clicking onto the msi file
    • Follow the instructions to install the full or host version depending on your selected file
      massdeployment1 (2).png

       

  • Automated installation via graphical user interface
    • Start the setup process via command prompt of Windows or execute msi via a script (batch, etc.).

    • Command prompt must be started as administrator
    • Example:

      msiexec.exe /i "X:\TeamViewer_Host.msi"
  • Automated and silent installation

    • Start the setup process via command prompt of Windows or execute msi via a script (batch, etc.).

    • Command prompt must be started as administrator
    • Example: 

      msiexec.exe /i "X:\TeamViewer_Host.msi" /qn

      Help for Windows Installer: There are more parameters of the Windows installer available to control the installation, just type the following into the command prompt: msiexec.exe /?

Settings

If you want to provide some TV-settings for your installation, you can save a file called "TeamViewer_Settings.reg" (file name is mandatory) in the same directory as the msi file.

You can get this .reg file through a settings export from TeamViewer: Install TeamViewer on a single computer and configure it to your needs. In the Options dialog (Extras | Options) in the category "Advanced" use the Button Export… labeled with Export options to a *.reg file. In the following Dialog Export Options you can also specify your license key.

For TeamViewer_Host.msi with a version 13.2 or higher the following command parameter "IMPORTREGFILE" with value 1 is necessary (value 0 is the default for not importing).

Example: 

msiexec.exe /i "X:\TeamViewer_Host.msi" /qn IMPORTREGFILE=1

 

Customization

It is possible to customize TeamViewer host with your own branding, including logo and text. Visit the Design & Deploy page to setup 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.

massdeployment2.png

You can provide this ID via the parameter CUSTOMCONFIGID to the command line call:

Example: 

msiexec.exe /i "X:\TeamViewer_Host.msi" /qn CUSTOMCONFIGID=<YOUR_CUSTOMCONFIG_ID>

(warning) If a custom Host is already installed, it is not possible to install another custom Host, if the ConfigurationID changes, without uninstalling the old one first.

Assignment

You can customize a TeamViewer Host module in such a way, that the Host module is added automatically to a TeamViewer account when installed. You can do the assignment within the installation process. Please see the Assignment options section for further information.

Summary for parameters

Parameter Description
CUSTOMCONFIGID

Configuration ID as provided in the TeamViewer ManagementConsole to install a custom Host.

DESKTOPSHORTCUTS

Controls if a desktop shortcut will be created to start / show TeamViewer.

0: Don't create shortcut
1: Create shortcut (Default)

APITOKEN

ApiToken as provided in the TeamViewer Management Console to assign to an account.

ASSIGNMENTOPTIONS Possibility for additional parameters.
IMPORTREGFILE

1: settings are imported from the TeamViewer_Settings.reg-file.

0: no settings to be imported

 

Update of TeamViewer

As there were some major changes in the Windows Installer for the Host with version 13.2, you have to consider your former and new TeamViewer version for the update handling.

In general for an update you should make sure that TeamViewer (full version) and TeamViewer Host won’t get mixed. If you want to change the TeamViewer variant, you should uninstall the existing one first.

Auto update in TeamViewer is not longer available, if you are using the msi file for installation. It must be updated with the Windows Installer again.

Changing settings by just reinstalling the same version with other parameters is not possible. Please uninstall the current version first and reinstall with new parameters.

New and old TeamViewer up to version 13.1 or full version

If you have already deployed a TeamViewer msi version before, you can simply install the newer version. The older version will be replaced automatically, even if it's a lower major version (4.x or higher supported).

New TeamViewer version 13.2 and higher and host version

If you have already deployed a TeamViewer msi with version 13.1 or lower, please first uninstall the TeamViewer wrapper and TeamViewer application. Please do not mix up the former and current version.

If you have already deployed a TeamViewer msi with version 13.2 or higher, you can simply install the newer version. The older version will be replaced automatically.

Uninstalling TeamViewer

You can uninstall your TeamViewer if necessary (e.g. if you want to switch from a host to a full version) either with operating system functionality or automated with the Windows installer.

Manual uninstallation

Go to your Apps and features settings of your operating system, click on the TeamViewer entry and select uninstall.

Depending on your way of installing the TeamViewer and the version there might be also a TeamViewer Wrapper be installed. Please do not miss to also uninstall this Wrapper.

Automated uninstallation via Windows Installer

You can use the uninstall command of Windows Installer (/uninstall or /x). Make sure you use the right msi (Full or Host) for uninstallation. Admin rights are necessary when starting the command line.

Example: 

msiexec.exe /uninstall "X:\TeamViewer_Host.msi"

 

macOS

Installation

Use the right file depending on your necessary version - full (TeamViewer.dmg, including the Install TeamViewer.pkg) or host (TeamViewerHost.dmg, including the Install TeamViewerHost.pkg).

Installation of TeamViewer (full or host version)

sudo installer -pkg "Install TeamViewer.pkg" -target /
sudo installer -pkg "Install TeamViewerHost.pkg" -target /


Settings

It is not supported to provide settings within the installation process.

Customization

It is possible to customize TeamViewer host with your own branding, including logo and text. Visit the Design & Deploy page to setup 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.

massdeployment3.png

For installation please add your ConfigurationID to the file name on the command line

Installation of a custom host 
 
sudo installer -pkg "Install TeamViewerHost-idc<ConfigurationID>.pkg" -target /

Assignment

You can customize a TeamViewer Host module in such a way, that the Host module is added automatically to a TeamViewer account. On macOS you first have to install TeamViewer before you can start the assignment process. Please see the Assignment section for further information.

Uninstallation

Manual uninstallation

Easy way: For uninstalling drag the application from your Applications folder to the trash. If prompted, enter your password and click OK.

Thorough way: Download and install AppCleaner from the Mac App Store.

  1. Open AppCleaner and click the Finder icon.
  2. Click Applications in the left menu.
  3. Drag an application into AppCleaner.
  4. Click Remove.
  5. Enter your password and click OK.
  6. The program has been uninstalled.

Assignment

You can customize a TeamViewer Host module in such a way, that the Host module is added automatically to a TeamViewer account when installed. The assignment optionally does not have to be confirmed manually at the client device. 

Up to version 13.1

Up to TeamViewer version 13.1 (included) it is recommended to use the Assignment Tool provided in the Management Console to do the assignment (for Windows and macOS). This method works on Windows with the msi package as well as the executable version of TeamViewer Host.

For further information see Deploy TeamViewer Host MSI Package with Assignment Tool

Version 13.2 and higher

You can do the assignment of a device to a predefined TeamViewer account either directly with the Windows Installer or start the TeamViewer executable afterwards with some assignment parameters.

For the assignment you need the API token provided by your custom host. The API token is only provided if you have checked the option Allow account assignment via the Assignment Tool on creation.

If the device had been assigned to another account before, you must use the reassign parameter. Each device can be assigned to only one account at a time.

You can choose if the access has to be confirmed each time or if the device is accessible without confirmation.

Example:

msiexec.exe /i "X:\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="--group Test_Group --grant-easy-access"

If the assignment was executed successfully on a device, the device is assigned to the account that created the custom TeamViewer Host module and easy access is activated for the device.

If a device is already assigned to an account you cannot change some settings like the group by just reinstalling. The assign parameters are only executed if the device is not yet assigned to any account or it's beeing reassigned.

Assignment with the Windows Installer

You can do your assignment within your installation command for the msi.

For this include the API token ("APITOKEN") of the custom Host module in your command line call as well as ASSIGNMENTOPTIONS= to provide some additional settings.

Example:

msiexec.exe /i "X:\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="<YOUR OPTIONAL SETTINGS>"

Help for assignment options

  • If you need to specify parameter values with blanks (e.g. for the group name) use '<GROUP_NAME_WITH_BLANK>' instead of "<GROUP_NAME_WITH_BLANK>". Example:  
    msiexec.exe /i "X:\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="–group 'Test group'"
  • Parameter names are case sensitive
  • 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.

Assignment with the TeamViewer executable

You can also do the assignment after the TeamViewer Host module has already be installed (either via the executable or the Windows installer). It's important that TeamViewer is already started on the machine, if you want to do the assignment.

Call the TeamViewer.exe or just Teamviewer with the command assign followed by necessary options.

The --api-token is mandatory to provide information about the account to be assigned to. The other parameters are optional regarding your requirements.

Example:

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>
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>

Please do not forget to replace the placeholders in <>

Assignment on macOS

TeamViewer must already be installed before you can do the assignment on macOS. The assignment tool is installed with the application under /Applications/TeamViewerHost.app/Contents/Helpers/TeamViewer_Assignment.

Start the TeamViewer service process (necessary if no user is logged in):

sudo launchctl load /Library/LaunchDaemons/com.teamviewer.teamviewer_service.plist

Give execution rights to the AssignmentTool (this step might or might not be necessary):

sudo chmod +x ./TeamViewer_Assignment

Run the assignment tool with sudo privileges on all devices that should be assigned. You can run a script to call up the assignment tool with the required parameters on the devices after the installation of the TeamViewer Host module was successful.

If the assignment tool was executed successfully on a device, the device is assigned to the account that created the custom TeamViewer Host module and easy access for the device is (optionally) activated.

Example:

sudo /Applications/TeamViewerHost.app/Contents/Helpers/TeamViewer_Assignment assign YES -api-token 12345678 -group "Some Group" -alias %COMPUTERNAME% -grant-easy-access


Assignment options

The following table shows the possible options for the assignment (they are all optional). There are some parameters that need a value (–alias MyAlias) or do not need a value (--reassign).

Please add them on the command line

  • For the Windows installer within <YOUR_OPTIONS> "msiexec /i "X:\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="<YOUR_OPTIONS>""
  • For the TeamViewer executable after assign --api-token <YOUR_APITOKEN>"(precondition: TeamViewer is already installed)
  • For assignment on macOS after 
    • Full version: 

      sudo /Applications/TeamViewer.app/Contents/Helpers/TeamViewer_Assignment -api-token <YOUR_APITOKEN>
       
    • Host version: 

      sudo /Applications/TeamViewerHost.app/Contents/Helpers/TeamViewer_Assignment -api-token <YOUR_APITOKEN>
       
    • (warning) Be careful: on macOS options must be used with - instead of --. Example: -alias (not --alias)
Option Value necessary Description

--alias

yes

Alias for the new device in the computers & contacts list. If the device is already in the contact list, no alias will be applied.

--grant-easy-access

no

 Grants easy access after assignment (same as the "Grant easy access" option in the TeamViewer main window)

--reassign

no

Assigns the device to the account even if the device is already assigned to an account.

--group

yes

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.

*Only required if no custom host is used, as there is already a default group defined in the custom configuration.

--group-id

yes

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.

--proxy

yes

Url of your proxy (only for the assignment) in the format <name>:<port>, e. g. --proxy yourproxy:3201

(warning) URL without http://

--proxy-user

yes

 Username which is used for authentication against the proxy (only for the assignment).

--proxy-pw

yes

 Password which is used for authentication against the proxy (only for the assignment).

--proxy-pw-base64

yes

 Same as --proxy-pw, but the password needs to be entered as a Base64 encoded string. Might for passwords with special characters.

 

Assignment error codes

Error Code Description Platform
200 Internal error during device assignment

Windows, macOS

201

Access is denied

 Windows, macOS
202

Service is not available / installed

Windows, macOS
203 Failed to parse an assignment data file Windows, macOS
204 API returned an error during device assignment Windows, macOS
205 Internal assignment step failed Windows, macOS

 

Usage of environment variables

You can also insert environment variables to your commands for installation/assignment to add dynamic values, e.g. for the alias.

On Windows

On Windows you can use environment variables by using %%.

Example:

msiexec.exe /i "X:\TeamViewer_Host.msi" /qn APITOKEN=<YOUR_APITOKEN> ASSIGNMENTOPTIONS="--alias %COMPUTERNAME%"

On macOS

On macOS you can use environment variables by using $-notation.

The following characters should not be contained in the variables: $, @, `, ´ and variables should always be used within quotes.

Example:

1 export GROUP="MyGroup"
2 export ALIAS="MyDevicename"
3 sudo /Applications/TeamViewer.app/Contents/Helpers/TeamViewer_Assignment -api-token <YOAPITOKEN> -group "UR_$GROUP" -alias "$ALIAS"
 
Version history
Revision #:
13 of 17
Last update:
a month ago
Updated by: