Changing the default ports in the Appliance

Contents

Changing the default ports in the Appliance

Overview

The Engine listens to a set of default TCP and UDP port numbers to communicate with the rest of the Nexthink components and serve external requests. Some of these port numbers are configurable, namely the ports to communicate with the Collectors and the port of the Web API.

When rule-based Collector assignment is enabled, the Collector usually connects first to the Portal instead of an Engine to receive assignment information. The port number on which the Portal listens to the Collectors is configurable as well.

Changing the ports in the Engine

To change the configurable port numbers in the Engine:

  1. Log in to the Web Console of the Appliance that hosts the Engine.
  2. Select the APPLIANCE tab at the top of the Web Console.
  3. Click Security on the left-hand side menu.
  4. Under Nexthink Ports, find the following configurable ports:
    1. In Collector TCP port, type in the port number for the TCP connection of the Collector with the Engine that enables the Engage and Act features, as well as the automatic updates. For this connection, you must use a port that does not require root privileges; that is, the port number must be above 1024. Default is 8443.
    2. In Collector UDP port, type in the port number for the UDP connection that sends device information and user activity to the Engine. Default is 999.
    3. In Web API, type in the port number of the TCP connection used to integrate with the Engine via the NXQL language. This connection also requires a port number higher than 1024. Default is 1671 (changed to 1679 in the example below).
    NexthinkPortsWebConsole.png
  5. Click SAVE to make your changes permanent. The Engine restarts if you changed either the UDP port or the Web API port.

After saving your changes, remember to configure the Collectors with the new selected port numbers during their deployment or to update already deployed Collectors with the Collector Configuration Tool.

In the same way, adapt your integrations to use the new Web API port of the Engine and, to test your NXQL queries, include the new port number in the URL of the NXQL Editor.

Changing the ports in the Portal

To change the port number of the TCP connection between the Collector and the Portal:

  1. Log in to the Web Console of the Appliance that hosts the Portal.
  2. Select the APPLIANCE tab at the top of the Web Console.
  3. Click Security on the left-hand side menu.
  4. Under Nexthink Ports, find the only configurable port:
    1. In Collector TCP port, type in the port number for the TCP connection of the Collector with the Engine that enables the Engage and Act features, as well as the automatic updates. For this connection, you must use a port that does not require root privileges; that is, the port number must be above 1024. Default is 8443.
    NexthinkPortsPortalWebConsole.png
  5. Click SAVE to make your changes permanent.

Remember to configure the Collectors with the same TCP port number as set in the Portal either during their installation or later via the Collector Configuration tool.

Changing the ports in a single Appliance

If the Portal and the Engine are installed in a single Appliance, the Nexthink Ports section appears twice on the Security page of the Web Console:

  • The first holds the three ports to configure the Collector communication with the Engine.
  • The second holds the TCP port number for the Collector to connect to the Portal.

Follow the instructions in the two preceeding sections to change the port numbers accordingly.

The operations described in this article should only be performed by a Nexthink Engineer or a Nexthink Certified Partner.

If you need help or assistance, please contact your Nexthink Certified Partner.