Error When adding gateway process to the new nodes "An error occured while installing Gateway."

Issue

When trying to add gateway process the new nodes, the below error was displayed on TSM Web UI:
Error message:

"An error occured while installing Gateway."

User-added image

Gateway process is unstable and switch between between "Error" and "Busy" state.

The tabadmincontroller_node1-0.log shows the following error:

2023-01-15 12:13:18.378 +0900  pool-21-thread-1 : INFO  com.tableausoftware.tabadmin.webapp.impl.status.ServiceStatusWatcher - nodeX has 1 service that isn't stopped: gateway_0.<version> (deployment state: INSTALL_FAILED, process status: STATUS_UNAVAILABLE)

Moreover, the control_gateway log on issued nodes shows the following error:

2023-01-15 02:53:05.528 +0000 23832 main : INFO  com.tableausoftware.tabadmin.configuration.ports.PortSelectionHelper - Service gateway_0:primary is already registered to use port 8080 on node: node1.
2023-01-15 02:53:05.528 +0000 23832 main : INFO  com.tableausoftware.tabadmin.configuration.ports.PortSelector - User has specified 80 for the primary port for service gateway_0.
...
2023-01-15 02:53:05.639 +0000 23832 main : ERROR com.tableausoftware.gateway.GatewayControl - Exception while installing process.
java.util.NoSuchElementException: No value present

Environment

Tableau Server

Resolution

Remove the conflict gateway.port setting in tabsvc process by the following tsm command.

tsm stop
tsm configuration set -k gateway.port -d
tsm pending-changes apply

Cause

This issue can occur when you set the gateway port via "tsm configuration set" command upon adding/installting the new node whereas the correct process is to use "tsm topology set-ports."

If the gateway.port number set by using "tsm configuration set" or "tsm settings export -f <file name>" command was different from the one of existing gateway process, this error will occur, because the gateway port must be the same on all nodes in a multi-node cluster. please refer to Tableau Server Ports.

Additional Information

To change the gateway port number that the existing gateway process listens on, you need to run the following command for each node that is running the gateway process.

tsm topology set-ports --node-name <nodeX> --port-name gateway:primary --port-value <Port number>

You can use the following TSM command to check the gateway port number of existing gateway process.
tsm configuration get -k gateway.port

You can use the following command to get the nodeIDs.