Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

Before

...

continuing troubleshooting, make sure you

...

understand pairing by reading this article.

This

...

Establishing Trust between Terminal and Server - Terminal Pairing

We assume you're running at least server version 20230801.

Quick jump

My Terminal firmware version is:

Terminal with version 20230801 and newer

...

article contains a list of recommended steps to pair a terminal.
The recommended steps differ based on the terminal's current state and the version installed on it.

This guide assumes your server version is at least 20230801.

Jump here to the right section that applies to your case:

Table of Contents

My terminal has version 20230801 and higher

Pairing steps

Deployment Scenario

Terminal

State

state

Actions to

TakeSet the terminal server's host/IP via advanced admin. Look for

take

Notes

Terminal operates in Deployment Scenario A

Previously paired, VPN configured

Terminal was paired in past to this server and has VPN configuration already generated.

  1. Set on terminal server’s host/ip via advanced administration. Terminal should show error screen with pairing code displayed.

In
  1. On server in CAS

, approve
  1. new pairing request will appear on terminal list page.

  2. Approve the pairing request.

  3. Terminal will pair and connect to master service via VPN channel.

If terminal displays “VPN connection error” it means that you probably didn’t generate VPN configuration.

Terminal operates in Deployment Scenario A

Never paired, No VPN

Terminalhasnever been paired to this server and doesn’t have VPN configuration generated yet.

This case applies for example to new terminals that has been purchased.

  1. Create terminal on server

, generate VPN config. Set host/IP.

As above.

Scenario B

Never paired

Create terminal on server, set host/IP.

As above.

Scenario B

Previously paired

Set host/IP.

As above.

Unpairing Steps

Deployment Scenario

Terminal State

Actions to Take

Scenario A

Paired and connected

Unpair via terminal list action menu.

Scenario B

Paired and connected

As above.

Terminal with a version newer than 20190130 but older than 20230801

Pairing Steps

...

  1. .

  2. Generate VPN configuration for terminal.

  3. Set on terminal server’s host/ip via advanced administration. Terminal should show error screen with pairing code displayed.

  4. On server in CAS new pairing request will appear on terminal list page.

  5. Approve the pairing request.

  6. Terminal will pair and connect to master service via VPN channel.

If terminal displays “VPN connection error” it means that you probably didn’t generate VPN configuration.

Terminal operates in Deployment Scenario B

Terminalhasnever been paired to this server.

This case applies for example to new terminals that has been purchased.

  1. Create terminal on server.

  2. Set on terminal server’s host/ip via advanced administration. Terminal should show error screen with pairing code displayed.

  3. On server in CAS new pairing request will appear on terminal list page.

  4. Approve the pairing request.

  5. Terminal will pair and connect to master service.

Terminal operates in Deployment Scenario B

Terminal was paired in past to this server.

  1. Set on terminal server’s host/ip via advanced administration. Terminal should show error screen with pairing code displayed.

  2. On server in CAS new pairing request will appear on terminal list page.

  3. Approve the pairing request.

  4. Terminal will pair and connect to master service.

Unpairing steps

Note

Unpairing should only be done when necessary. Currently, there are two reasons for unpairing: when the terminal is stolen or when the server is changed.

Deployment Scenario

Terminal state

Actions to take

Terminal operates in Deployment Scenario A

Terminal is paired and connected to VPN and master service

  1. Unpair terminal via action menu in list of terminals.

  2. Terminal will unpair and show error screen with pairing code displayed.

Terminal operates in Deployment Scenario B

Terminal is paired and connected to master service

  1. Unpair terminal via action menu in list of terminals.

  2. Terminal will unpair and show error screen with pairing code displayed.

My terminal has a newer version than 20190130 but has an older version than 20230801

Pairing steps

The machine will need to undergo terminal upgrade to version 20230801 before it can be paired. The good news is that gate service should take care of it automatically.

Deployment Scenario

Terminal

State

state

Actions to

TakeSet the terminal server's host/IP via advanced admin. Look for

take

Notes

Terminal operates in Deployment Scenario A

Previously paired, VPN configured

Terminal was paired in past to this server and has VPN configuration already generated.

  1. Set on terminal server’s host/ip via advanced administration.

  2. Terminal contacts server and displays following Error: Terminal unpaired

  3. After a while gate service automatically upgrades terminal to a newer version. This step will be performed automatically.

  4. Terminal should after a while start showing error screen with pairing code displayed.

In
  1. On server in CAS

, approve new pairing request.

Scenario A

Never paired, No VPN
  1. new pairing request will appear on terminal list page.

  2. Approve the pairing request.

  3. Terminal will pair and connect to master service via VPN channel.

If terminal displays “VPN connection error” it means that you probably didn’t generate VPN configuration.

Terminal operates in Deployment Scenario A

Terminalhasnever been paired to this server and doesn’t have VPN configuration generated yet.

This case applies for example to new terminals that has been purchased.

  1. Create terminal on server

, generate VPN config. Set host/IP.

As above.

Scenario B

Never paired

Create terminal on server, set host/IP.

As above.

Scenario B

Previously paired

Set host/IP.

As above.

Terminal with version 20190130 or older

Pairing Steps

You're working with a pretty old machine here. Upgrade the terminal twice. Again, the gate service should handle this.

Deployment Scenario

Terminal State

Actions to Take

Notes

Scenario A

Previously paired, VPN configured

Set the terminal server's host/IP via advanced admin. Look for error screen with pairing code.

In CAS, approve new pairing request.

Scenario A

Never paired, No VPN

Create terminal on server, generate VPN config. Set host/IP.

As above.

Scenario B

Never paired

Create terminal on server, set host/IP.

As above.

Scenario B

Previously paired

Set host/IP.

As above.

...

  1. .

  2. Generate VPN configuration for terminal.

  3. Set on terminal server’s host/ip via advanced administration.

  4. Terminal contacts server and displays following Error: Terminal unpaired

  5. After a while gate service automatically upgrades terminal to a newer version. This step will be performed automatically.

  6. Terminal should after a while start showing error screen with pairing code displayed.

  7. On server in CAS new pairing request will appear on terminal list page.

  8. Approve the pairing request.

  9. Terminal will pair and connect to master service via VPN channel.

If terminal displays “VPN connection error” it means that you probably didn’t generate VPN configuration.

Terminal operates in Deployment Scenario B

Terminalhasnever been paired to this server.

This case applies for example to new terminals that has been purchased.

  1. Create terminal on server.

  2. Set on terminal server’s host/ip via advanced administration.

  3. Terminal contacts server and displays following Error: Terminal unpaired

  4. After a while gate service automatically upgrades terminal to a newer version. This step will be performed automatically.

  5. Terminal should after a while start showing error screen with pairing code displayed.

  6. On server in CAS new pairing request will appear on terminal list page.

  7. Approve the pairing request.

  8. Terminal will pair and connect to master service.

Terminal operates in Deployment Scenario B

Terminal was paired in past to this server.

  1. Set on terminal server’s host/ip via advanced administration.

  2. Terminal contacts server and displays following Error: Terminal unpaired

  3. After a while gate service automatically upgrades terminal to a newer version. This step will be performed automatically.

  4. Terminal should after a while start showing error screen with pairing code displayed.

  5. On server in CAS new pairing request will appear on terminal list page.

  6. Approve the pairing request.

  7. Terminal will pair and connect to master service.

My terminal is version 20190130 and older

Pairing steps

Terminal with this version is an archaic piece of machine.
The machine needs to undergo two subsequent terminal upgrades. The good news is that gate service should take care of it automatically.

Deployment Scenario

Terminal state

Actions to take

Notes

Terminal operates in Deployment Scenario A

Terminal was paired in past to this server and has VPN configuration already generated.

  1. Set on terminal server’s host/ip via advanced administration.

  2. Terminal contacts server and displays following Error: Terminal unpaired

  3. After a while gate service automatically upgrades terminal to a newer version. This step will be performed twice automatically.

  4. Terminal should after a while start showing error screen with pairing code displayed.

  5. On server in CAS new pairing request will appear on terminal list page.

  6. Approve the pairing request.

  7. Terminal will pair and connect to master service via VPN channel.

If terminal displays “VPN connection error” it means that you probably didn’t generate VPN configuration.

Terminal operates in Deployment Scenario A

Terminalhasnever been paired to this server and doesn’t have VPN configuration generated yet.

This case applies for example to new terminals that has been purchased.

  1. Create terminal on server.

  2. Generate VPN configuration for terminal.

  3. Set on terminal server’s host/ip via advanced administration.

  4. Terminal contacts server and displays following Error: Terminal unpaired

  5. After a while gate service automatically upgrades terminal to a newer version. This step will be performed twice automatically.

  6. Terminal should after a while start showing error screen with pairing code displayed.

  7. On server in CAS new pairing request will appear on terminal list page.

  8. Approve the pairing request.

  9. Terminal will pair and connect to master service via VPN channel.

If terminal displays “VPN connection error” it means that you probably didn’t generate VPN configuration.

Terminal operates in Deployment Scenario B

Terminalhasnever been paired to this server.

This case applies for example to new terminals that has been purchased.

  1. Create terminal on server.

  2. Set on terminal server’s host/ip via advanced administration.

  3. Terminal contacts server and displays following Error: Terminal unpaired

  4. After a while gate service automatically upgrades terminal to a newer version. This step will be performed twice automatically.

  5. Terminal should after a while start showing error screen with pairing code displayed.

  6. On server in CAS new pairing request will appear on terminal list page.

  7. Approve the pairing request.

  8. Terminal will pair and connect to master service.

Terminal operates in Deployment Scenario B

Terminal was paired in past to this server.

  1. Set on terminal server’s host/ip via advanced administration.

  2. Terminal contacts server and displays following Error: Terminal unpaired

  3. After a while gate service automatically upgrades terminal to a newer version. This step will be performed twice automatically.

  4. Terminal should after a while start showing error screen with pairing code displayed.

  5. On server in CAS new pairing request will appear on terminal list page.

  6. Approve the pairing request.

  7. Terminal will pair and connect to master service.