15.4. Appendix D: Resolving Network Port Conflicts

Engineering Knowledge Manager

Installation Guide | Chapter 15: Appendices |

15.3. Appendix C: Email Configuration |  | 15.5. Appendix E: Changing the JBoss HTTP Port
Prev |  | Next

## 15.4. Appendix D: Resolving Network Port Conflicts

EKM cluster nodes use the JBoss application server. JBoss uses multiple TCP/IP network ports to provide network services. Some of these ports may conflict with other software or services on the server host where EKM is installed. In particular, network port conflicts are likely to occur if another instance of JBoss is installed on the server host where EKM is installed. This scenario arises when multiple EKM cluster nodes are installed on the same server host.

In the event of network port conflicts, it is possible to conveniently change all network ports used by JBoss with a single configuration change. This is done by changing the port offset used by JBoss.

JBoss uses socket binding groups to define and control the network port assignments of services within JBoss. Socket binding groups make it possible to reconfigure all network ports used by JBoss at once by assigning a port offset to the socket binding group. The port offset is a numerical offset that is applied to the base value of a network port to determine its runtime value. The default value of the port offset is 0, which means runtime values of network port numbers is not changed. A port offset of 100 would increment all network port numbers by 100.

Note: When changing the port offset, you should use increments of 100, such as 100, 200, 300 and so on.

To set the JBoss port offset on an EKM cluster node:

1. Edit `EKM_NODE_ROOT182/bin/ekm_env.(cmd|sh)` and set the value of the `JBOSS_PORT_OFFSET` environment variable (value shown in bold).

   Windows:

       rem JBoss socket binding group port offset
       set JBOSS_PORT_OFFSET=0

   Linux:

       # JBoss socket binding group port offset
       export JBOSS_PORT_OFFSET=0

2. (Windows only) Edit `JBOSS_HOME/domain/configuration/wrapper.conf` and set the value of the `JBOSS_PORT_OFFSET` environment variable (value shown in bold):

       JBOSS_PORT_OFFSET=0

3. If the EKM cluster node whose JBoss port offset is being changed is the JBoss domain controller, it is necessary to change the JBoss configuration of each slave. Follow these steps on each slave:

   1. Edit the JBoss host controller configuration (see JBoss Domain Mode and Configuration).

   2. Find the `domain-controller` element, then find its `remote` child element.

   3. Modify the `port` attribute to reflect the updated value of the JBoss management native port on the JBoss domain controller:

          <remote host="192.168.1.3" port="${jboss.domain.master.port:9999}" security-realm="ManagementRealm" />

      For example, if the JBoss port offset was changed from 0 to 100 on the JBoss domain controller, each slave would be modified as follows:

          <remote host="192.168.1.3" port="${jboss.domain.master.port:10099}" security-realm="ManagementRealm" />

4. If the EKM server is a single-node server, edit `EKM_HOME/conf/ekm.xml` and update the value of `ekmUrl` (shown in bold) to the new URL for EKM:

       <ekmUrl>http://ekm.mycompany.com:8080/ekm</ekmUrl>

   Old URL: `http://ekm.mycompany.com:8080/ekm`

   New URL: `http://ekm.mycompany.com:`NNNN`/ekm`

   where NNNN is the new EKM server HTTP port.

   If the EKM server is a multi-node server, `ekmUrl` is set to the URL of the front-end webserver, which is not affected by changes to the JBoss port offset of the EKM cluster nodes.

5. Refer to Appendix I: Updating EKM Server Objects and update any server objects in EKM workspaces on remote EKM servers that refer to this EKM server.

Contains proprietary and confidential information of ANSYS, Inc. and its subsidiaries and affiliates.

Prev | Up / Contents | Next

Release 18.2 - © ANSYS, Inc. All rights reserved.