avatar  

Log out

Recently viewed tickets

SiteManager GUI - GateManager & Server Relays

The Server Relay functionality of this SiteManager co-operates with the GateManager to allow devices attached to this SiteManager to access remote servers through the GateManager. The Server Relay facility is like the Device Relay facility, but is used for connections in the opposite direction.

To access a service (identified by a dedicated TCP or UDP port) on a remote Server (which can be reached from the GateManager), we create a Server Relay which listens for connections on a virtual Local address on this SiteManager. When a device connects to the service's port (or some other well-defined port) on the SiteManager, the connection and associated traffic is automatically forwarded through the SiteManager and the GateManager to the remote Server.

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

  • IDLE, UP:nn - the Server 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 Server Relay is being created.

Other error codes related to Server Relay may appear in the System Log for specific connections:

  • REFUSED - the specified Server refused the connection on the given port.
  • TIMEOUT - the specified Server recognized the connection request, but did not accept it in a timely manner.

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

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

  • Type
    Here you select the type of protocol to be handled by the Server 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 Server Relay. This is the identity that the GateManager uses internally to distinguish this specific Server Relay from any of the other Server Relays known by the same GateManager. If more than one Server 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 Server Relay, e.g. the Ethernet MAC address of the Server 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 Server 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 Server-17 as the Relay Name on this page, the GateManager Appliance Name for the Relay will show up as Server-17 (test94).

  • Server Target Address
    The remote server's address (and port number) used by the GateManager to reach that server. You can specify a remote server with a numeric IP address, like "1.2.3.4", or using a symbolic server name, like "S1" or "ALARM_RECEIVER", which is defined on the GateManager to point to a suitable target IP address. Using a symbolic name makes it easier to change the IP address of a central server, as the GateManager Administrator then only need to change the IP address on the GateManager, rather than pushing a configuration update to all attached SiteManagers.

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

    Note: You can only use numeric and symbolic remote server addresses that have been approved as such on the GateManager. Of course, multiple devices may sepcify the same server address or name. The approved addresses are specified in the Server Targets section of the GateManager's domain relay configuration.



  • Server Virtual Address
    The local virtual address and port number on this SiteManager corresponding to the remote Server. The specified address must be a local address on one of the Device network ports, either the primary address, or defined as an IP Alias .

    If no port number is specified, the port number from the Server Address field is used.

    If no IP address is specified (the field is left blank or contains just :port ), any of this SiteManager's primary or IP Alias addresses can be used by an attached device as the Server Virtual Address. This method can only be used if no other Server Relay or SiteManager built-in service (such as the Web GUI or networked serial port) uses the same port number.

    Note: Each Server Relay on this SiteManager must use a unique server virtual address, or if they share an address, they must use unique port numbers for that address.



  • MaxC
    The maximum number of concurrent connections to the Server. 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 Server; 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 .

  • Restr
    Select this option to restrict access through this Server Relay. If selected, only devices that are the target for a Device Relay (Device Address field) or a Device Agent (Target Address field) are granted access; if deselected, any source is granted access.

  • 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:24 (skr@secomea.com)      Updated: 16/01/2020 09:41 (skr@secomea.com)