Knowledge Base

To assign a Windows device via command line, please follow the instructions below:

1. Open the CMD.
2. Navigate to your TeamViewer installation folder.
3. Enter the following command (indicated below) into the command line.
4. Press Enter on your keyboard.
5. (optional) Type 

echo %errorlevel%

into the command line to verify if the process was successful:

• If the assignment was successful, the value "0" should be returned to the command line.
• Any other return value indicates a problem that occurred during the assignment. For more information, please refer to the Error codes section.

TeamViewer.exe assignment --id paste_your_assignment_id_here --offline 

Example: 

TeamViewer.exe assignment --id 0001CoBBChARKJtw_okR6o_fJ7AisynpEigIACAfAgAJAOjwtNCVK_JiM5lVdgdfguSk-gQ= --offline 

Optional command line options

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

Alias

--device-alias=[<name>]

Alias for the new device as it will appear in the Device list; this property can take the following values:

1. --alias (without value)
   • alias of the computer will be the TeamViewer ID
2. --alias hello
   • alias of the computer will be "hello"
3. Alias parameter not specified
   • alias of this computer will be %computername%
4. --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%“

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

For offline devices

--offline

To handle devices that are offline during the assignment, it stores the assignment in the registry as an encrypted property and executes it automatically when the device comes online. This property is deleted once the device is successfully assigned.

For reassignment with the same assignment ID

--reassign

This parameter allows you to reassign a device using the same assignment ID. By default, devices reject reassignment attempts if the assignment ID has not changed. Using --reassign enforces the existing assignment ID on the device, which can be useful in scenarios where the assignment needs to be re-applied without generating a new assignment ID.

Error codes

Prerequisites:

• TeamViewer is already installed.
• For TeamViewer full client, the option Start with macOS needs to be enabled.

To assign a macOS device via command line, please follow the instructions below:

1. Open the Terminal.
2. Enter the following command (indicated below) into the command line.
3. Press Enter on your keyboard.

Optional command line option

This is an additional option you can add to your command line:

Alias

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

1. --alias (without value)
   • alias of the computer will be the TeamViewer ID
2. --alias hello
   • alias of the computer will be "hello"

--offline

To handle devices that are offline during the assignment, it stores the assignment in the registry as an encrypted property and executes it automatically when the device comes online. This property is deleted once the device is successfully assigned.

For reassignment with the same assignment ID

--reassign

This parameter allows you to reassign a device using the same assignment ID. By default, devices reject reassignment attempts if the assignment ID has not changed. Using --reassign enforces the existing assignment ID on the device, which can be useful in scenarios where the assignment needs to be re-applied without generating a new assignment ID.

sudo teamviewer assignment --id paste_your_assignment_id_here --offline 

Example:

sudo teamviewer assignment --id 0001CoABChARKJtw_okR6o_fJ7AisynpEigIACAfAgAJAO4PLaOBrqNDgr6jwtNCVK_JiM5lVdgdfgYo3uQ3pGkAbX8bo_VqPw1Rt61-RLe9AKSwZ14uwOXtUN7FYflrHbWAqRKBF0h8V18ldMcVT1rLF --offline

Optional command line option

This is an additional option you can add to your command line:

Alias

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

1. --alias (without value)
   • alias of the computer will be the TeamViewer ID
2. --alias hello
   • alias of the computer will be "hello"

--offline

To handle devices that are offline during the assignment, it stores the assignment in the registry as an encrypted property and executes it automatically when the device comes online. This property is deleted once the device is successfully assigned.

For reassignment with the same assignment ID

--reassign

This parameter allows you to reassign a device using the same assignment ID. By default, devices reject reassignment attempts if the assignment ID has not changed. Using --reassign enforces the existing assignment ID on the device, which can be useful in scenarios where the assignment needs to be re-applied without generating a new assignment ID.

Error codes