Connection Test Tool User Guide

Tehama provides a Connection Test tool that you can use to test connections through your room's Gateway Agent. This tool is available from both the Tehama Client UI and the Desktop Agent on your room's desktops.

How do I access the Connection Test tool?

From the Tehama Client UI:

  • Click on the ROOMS tab and select your room from the list.
  • Click on the CONNECTION tab.
  • Select the CONNECTION TEST sidebar item.

Rooms Connection Test Page

From the Desktop Agent:

  • Click on the CONNECTION TEST tab.

Desktop Agent Connection Test Page

How do I test a connection?

  • Enter the target you wish to test into the field.


    This must have the form: <ip-address or domain-name>:<port>

    where:

    • a domain name is, for example, www.google.com or tehama.io
    • an ip-address is, for example, 123.456.789.001
    • the port can be any value from 0 to 65535.
        The :<port> is optional. The default port is '80'.

      Examples of targets:
      • 123.001.001.098:3306
      • 123.001.001.098
      • www.mytargetdomain.com
      • www.mytargetdomain.com:8080
  • Click the TEST button.

The results of the test will be displayed below the TEST button.

For example: Connection Test Results Success

How do I interpret the connection test results?

The connection test is divided into stages. There are three stages when running it from the Tehama Client UI and four stages when running it from the Desktop Agent. Each stage reports a 'Success' or "Failure' result in the test results. If a stage succeeds, the test moves on to the next stage. If a stage fails, the test stops. Read the results to see if the test ended in success or failure and, if failure, at what stage.

Here is a synopsis of the connection test stages.

  • Stage 1 Verify that the Gateway Agent for your room is running.

    In this stage the connection test checks that the Gateway Agent for the room, which runs inside your organization's network, is running. Success means the agent is running. Failure means it is not. All connectivity from a Desktop in a Tehama Room goes through the Gateway Agent for that room. If the agent is not running, then no connectivity is possible. (See the Gateway Agent User Guide for more details.) If this stage fails, contact your organization's network support to get the agent running again.

    Note, older versions of the Gateway Agent do not support the connection test. If this stage detects one of these older versions, it will suggest that you update the agent for your room and stop the test.

  • Stage 2 Analyse the Firewall Rules to check that the target is included in the rules.

    In this stage the connection test goes through the firewall rules specified for the room and checks for a rule that allows access to the target. If such a rule exists, then this stage of the test is successful and you are allowed to access the target. If no such rule exists, then this stage of the test fails and you are refused access to the target. If this stage fails, contact your room's Admin user (owner) to update the firewall rules appropriately for this target. (See the Firewall Rules for more details.)

  • Stage 3 Verify that the target is reachable from the Gateway Agent machine.

    In this stage the connection test sends a TCP ping to the target from the machine on which the Gateway Agent for the room is running and checks the reply. A successful reply to the ping means that the target exists and is accepting connections from the agent's machine. An unsuccessful reply to the ping means that the target either does not exist, or cannot accept connections from the agent's machine. If this stage fails, make sure you have specified your target correctly, then contact your organization's network support to look into this situation.

  • Stage 4 Verify that the target is reachable from the desktop (AKA workspace).
    This stage is only run the test is initiated from the Desktop Agent in a desktop.

    In this stage the connection test sends a TCP ping to the target from the desktop on which the test was initiated and checks the reply. A successful reply to the ping means that the target exists and is accepting connections from the desktop. An unsuccessful reply to the ping means that the target cannot accept connections from the desktop. If this stage fails, contact Tehama support with the test id for the test.

Note that each test that is run is assigned a unique test id. This is a string of letters, number and dashes. For example: 'fa752dcf-4a8e-430f-b1a5-40fb490b2e1b'. This is displayed at the top of the test results. You can use this test id to find references to this test in the Activity Stream or in the Tehama logs.