Assigning the IBM Z Database Assistant network ports

Edit online

Configure the network ports that IBM Z Database Assistant needs to communicate with clients and other systems and services.

Before you begin

This task requires z/OS® network administrator authority.

About this task

After you assign the ports, ensure that all component systems in the IBM Z Database Assistant installation can communicate with each other.

In addition to configuring the required ports and opening them up in your firewall before the installation of IBM Z Database Assistant, ensure that you open your Db2® DDF ports on the metadata Db2 and the target Db2s for connectivity to the IBM Z Database Assistant user interface.

For more information about TCP/IP in Db2, see Connecting Db2 for z/OS distributed database systems with TCP/IP.

Ports used by IBM Z Database Assistant

System or service	Port number	Number of ports needed	Outbound	Inbound	Protocol	Default address space
IBM Z Database Assistant user interface	< user-assigned >	1	NodeJS server or IBM Z Database Assistant Liberty	Browser client	HTTPS	ZDBAND*
IBM Z Database Assistant Liberty server	< user-assigned >	1	NodeJS server, IBM Z Database Assistant Liberty, z/OS Spark	NodeJS server or IBM Z Database Assistant Liberty	HTTPS	ZDBALBTY
IBM Z Database Assistant SPARK driver	< random or user assigned range of ports >	(see below)	None	IBM Z Database Assistant Liberty	TCP/IP	ZDBALBTY

You can choose to let Spark randomly select the ports it needs when you run the config.sh script. Alternatively, you can enter an initial starting port that serves as the beginning port in the range of ports needed by Spark.

An example of the PORT section of the TCP/IP profile when "random" is specified for the Spark starting port is shown below. Note that no port is reserved for Spark as it will choose the port randomly:

  7000 TCP ZDBAND              ; NodeJS port
  7001 TCP ZDBALBTY            ; Liberty port

An example of the PORT section of the TCP/IP profile when the Spark starting port is 7002 and the specified value for retry attempts is 7 is shown below. Note that the BlockManager port is assigned automatically:

  7002 TCP ZDBALBTY            ; Spark port
  7003 TCP ZDBALBTY            ; Spark retry port
  7004 TCP ZDBALBTY            ; Spark retry port
  7005 TCP ZDBALBTY            ; Spark retry port
  7006 TCP ZDBALBTY            ; Spark retry port
  7007 TCP ZDBALBTY            ; Spark retry port
  7008 TCP ZDBALBTY            ; Spark retry port
  7009 TCP ZDBALBTY            ; Spark retry port
  7010 TCP ZDBALBTY            ; Blockmanager port
  7011 TCP ZDBALBTY            ; Blockmanager retry port
  7012 TCP ZDBALBTY            ; Blockmanager retry port
  7013 TCP ZDBALBTY            ; Blockmanager retry port
  7014 TCP ZDBALBTY            ; Blockmanager retry port
  7015 TCP ZDBALBTY            ; Blockmanager retry port
  7016 TCP ZDBALBTY            ; Blockmanager retry port
  7017 TCP ZDBALBTY            ; Blockmanager retry port

You can later modify the assigned ports by running the following command from the $ZDBA_INSTALLATION/configuration/scripts directory:

./config.sh -a migrate

Alternatively, you can update the network information by modifying the INI file with the new port details and then running the script using the file option. For example:

./config.sh -a migrate -f /zdba_home/config/deploy.ini