Cataloging a TCP/IP node from a client using the CLP

Cataloging a TCP/IP node adds an entry to the Data Server Client node directory that describes the remote node. This entry specifies the chosen alias (node_name), the hostname (or ip_address), and the svcename (or port_number) that the client uses to access the remote host.

Before you begin

You must have System Administrative (SYSADM) or System Controller (SYSCTRL) authority, or have the catalog_noauth option set to ON. You cannot catalog a node using root authority.


To catalog a TCP/IP node:

  1. Log on to the system as a user with System Administrative (SYSADM) or System Controller (SYSCTRL) authority.
  2. If you are using a Linux® or UNIX client, set up the instance environment.
    Run the startup script:
    For bash, Bourne or Korn shell
       . INSTHOME/sqllib/db2profile
    For C shell
       source INSTHOME/sqllib/db2cshrc
    where INSTHOME represents the home directory of the instance.
  3. Start the Db2® command line processor. On Windows, issue the db2cmd command from a command prompt. On Linux or UNIX, issue the db2 command from a command prompt.
  4. Catalog the node by entering the following commands in the command line processor:
    db2 => catalog tcpip node node_name remote hostname|ip_address
      server service_name|port_number [remote_instance instance_name]
      [system system_name] [ostype os_type]
    db2 => terminate
    • node_name represents a local nickname you can set for the computer that has the database you want to catalog.
    • remote_instance represents the name of the server instance on which the database resides.
    • system_name represents the Db2 system name that is used to identify the server.
    • ostype_name represents the operating system type of the server.
    1. The terminate command is needed to refresh the directory cache.
    2. Although remote_instance, system, and ostype are optional, they are required for users who want to use the Db2 tools.
    3. The service_name used on the client does not have to be the same as the one on the server. However, the port numbers that they map to must match
    4. While not shown here, the catalog tcpip node command provides the option to explicitly specify the version of IP, namely IPv4 or IPv6.


To catalog a node that you want to call db2node on a remote server that is using port number 50000, you would enter the following from a db2 prompt:
db2 => catalog tcpip node db2node remote myserver server 50000
DB20000I  The CATALOG TCPIP NODE command completed successfully.
DB21056W  Directory changes may not be effective until the directory cache is

db2 => terminate
DB20000I  The TERMINATE command completed successfully.