avatar  

Log out

Recently viewed tickets

SiteManager GUI - GateManager & Device Relays

The Device Relay functionality of this SiteManager co-operates with the GateManager to allow remote management systems to access the native services of devices connected to this SiteManager. A Device Relay is a non-interactive version of the Go To Appliance feature of some GateManager Agents, where an application running on the GateManager Console PC can communicate with the remote device through the GateManager.

To access a service (identified by a dedicated TCP or UDP port) on an device attached to this SiteManager, we create a Device Relay which listens for connections on a virtual device address on the central GateManager. When a management system connects to the service's port (or some other well-defined port) on the GateManager, the connection and associated traffic is automatically forwarded through the GateManager and this SiteManager to the device's local IP address and the defined service port number.

The Status column shows the status for each of the configured Device Relays. The following status codes may occur:

  • IDLE, UP:nn - the Device Relay is operational and ready to relay traffic.
    The UP:nn status indicates that there are nn active connections.
  • ERROR - local configuration error; see the System Log for details.
  • Attaching - the Device Relay is being created.
  • DUP - the specified Device Virtual Address (and Port) is in use by some other Device in the network.
  • BLOCKED - the specified Device Virtual Address is outside the pool of addresses defined in the GateManager's domain relay configuration.
  • BUSY - the GateManager has no free resources to create the Device Virtual Address.

To create and start a Device Relay for an attached device, click on the New button, and fill in the new Relay settings:

  • Disable
    You can disable a Relay if you want to temporarily block remote access to the service on the attached Device.

  • Type
    Here you select the type of protocol to be handled by the Device Relay.
    If you select TCP/UDP, the relay will support both TCP and UDP on the specified port(s) .

  • Serial Number
    Here you must enter a unique identification for this Device Relay. This is the identity that the GateManager uses internally to distinguish this specific Device Relay from any of the other Device Relays known by the same GateManager. If more than one Device Relay has the same Serial Number, only one of them will be visible in the GateManager.

    When you create a new Relay, a Serial Number is automatically generated for the Relay based on the serial number of this SiteManager followed by # and a sequence number. For example, if the SiteManager's own serial number is 00:00:24:12:34:56, an automatically proposed Relay Serial Number might be 000024123456#03.

    You may use the proposed serial number or overwrite it. If you overwrite it, be sure to use a string that you know will uniquely identify the Device Relay, e.g. the Ethernet MAC address of the device itself. If what you enter starts with #, the string will be used together with this SiteManager's serial number. For example, if you enter #wiggly, and SiteManager's own serial number is 00:00:24:12:34:56, the Agent Serial Number will be 000024123456#wiggly.



  • Relay Name
    Enter the name or other ID (maximum 47 characters) used by the GateManager Administrator to identify this particular Device Relay, corresponding to the %n field code in the Relay Name Format .
    With the default Relay Name Format, %n (%M) , the GM Appliance Name for this SiteManager is automatically appended to the specified Relay Name to create a GateManager Appliance Name for the Relay. This makes it easy for the GateManager Administrator to identify the SiteManager that hosts this Relay. For example, if this SiteManager's GM Appliance Name is test94 and you enter device-17 as the Relay Name on this page, the GateManager Appliance Name for the Relay will show up as device-17 (test94).

  • Device Virtual Address
    The virtual address (and port number) corresponding to the device on the central GateManager.

    You may also specify a service type in this field service://ip:port ; if you do so, the specified service will be used as the Go To Appliance protocol for this Device in the GateManager Console. If there is no service specified, you cannot use Go To Appliance for this Device via this Device Relay instance.

    For a new device relay, the default virtual address is "0.0.0.0:0" - which means that the address has to be specified on the GateManager.

    Note: You can only use addresses that have been approved for use as device virtual addresses on the GateManager, and all devices (attached to any SiteManager) must use a unique device virtual address, or if they share an address, they must use unique port numbers for that address. The approved addresses are specified in the Device Pool section of the GateManager's domain relay configuration.

    Note 2: It is possible to restrict which management systems can connect to a device target via the GateManager, by creating a Device Access section in the GateManager's domain relay configuration, listing the approved (source) addresses for connections to the remote device addresses. Specifically, if you want to allow device attached to other SiteManagers to use a Server Relay to connect via a Device Relay to a device on this SiteManager, the GateManager Administrator must allow access from the GateManager server itself (by adding 127.0.0.1 to the Device Access section).



  • Device Target Address
    The local address (and port number) of the device. The SiteManager connects to the Device using this address when a management system connects to the device virtual address.

  • MaxC
    The maximum number of concurrent connections to the device. For a TCP based relay, a blank field means system limit (currently 20); for an UDP based relay, a blank field means one connection .

  • Idle
    The maximum idle time for any connection to the device; if a connection is idle (no data received or transmitted) for the specified period, the connection is closed without further notice. A blank field means no timeout . A bare number, e.g. 90 is measured in seconds. To specify a number of minutes or hours, add an m or h to the number, e.g. 10m or 1h .

  • Ping
    Send periodic "ping" requests to the device to test whether it is powered on. When this option is selected, the Device Relay is only attached to the GateManager for as long as it responds to the ping. If you don't select this option, it is assumed that the device is always operational.

  • Comment
    You can enter a comment further identifying this Relay or the attached device.

  • [Wastebin icon]
    Press this icon to delete this Relay entry.
Creation date: 11/12/2019 13:18 (skr@secomea.com)      Updated: 16/01/2020 10:40 (skr@secomea.com)