This section assumes that TCP/IP is functional on the client and DB2 Connect server workstations. See "Software Requirements" for the communication protocol requirements for your platform. See "Possible Client-to-DB2 Connect Gateway Connectivity Scenarios" for the supported communication protocols for your particular client and server.
The following steps are required to set up a DB2 client to use TCP/IP communications:
As you proceed through the configuration steps, complete the
Your Value column in the following table. You can fill in
some of the values before you start configuring this protocol.
Table 32. TCP/IP Values Required at the Client
Parameter | Description | Sample Value | Your Value |
---|---|---|---|
Hostname (hostname)
or IP address (ip_address) |
Use the hostname or ip_address of the remote server workstation. To resolve this parameter:
| serverhost
or 9.21.15.235 | |
Connection Port
|
Values required in the services file. The Connection Service name is an arbitrary name used to represent the Port number (Port_number) on the client. The Port number for the client must be the same as the Port number that the
svcename parameter maps to in the services file at the server.
(The svcename parameter is located in the database manager
configuration file on the DB2 Connect server.) This value must not be
in use by another application and must be unique within the services
file.
|
server1
3700/tcp
| |
Node name (Node_name) |
A local alias, or nickname, that describes the DB2 Connect server to the
node where the database resides. You can choose any name you want,
however, all Node name values within your local node directory must be
unique.
| db2node |
The following steps describe how to configure this protocol on the client. Replace the sample values with your worksheet values.
![]() |
If your network has a name server, or you are planning to directly specify
the IP address (ip_address) of the server, skip this step and proceed
to "Step B. Update the Services File".
|
The client workstation must know the address of the server to which it is
attempting to establish communications. If a name server does not exist
on your network, you may directly specify a hostname that maps to the IP
address (ip_address) of the host in the local hosts file. See Table 33 for the location of the hosts file for your particular
platform.
![]() | If you are planning on supporting a UNIX client that is using Network Information Services (NIS), and you are not using a name server on your network, you must update the hosts file located on your NIS master server. |
Table 33. Location of the Local Hosts and Services Files
Platform | Location | ||
---|---|---|---|
Macintosh |
The hosts file is located in the folder called System Folder.
| ||
OS/2 | Specified by the etc environment variable.
Issue the set etc command to determine the location of your local hosts or services files.
| ||
Windows 3.x | Typically in the tcpip_product\etc directory, but it depends on the
products that you have installed.
Refer to your TCP/IP documentation for more information. | ||
Windows 95 | windows directory | ||
Windows NT | winnt\system32\drivers\etc directory | ||
UNIX | /etc directory |
Using a local text editor, add an entry to the client's hosts file for the server's hostname. For example:
9.21.15.235 serverhost # host address for serverhost
where:
Notes:
![]() |
If you are planning to catalog the TCP/IP node using the Port number (Port_number), skip this step and go to "Step C. Catalog the TCP/IP Node". If you are configuring a DB2 for Macintosh client, you must catalog the
TCP/IP node using the Port number (Port_number). Go to "Step C. Catalog the TCP/IP Node" to catalog the node.
|
Using a local text editor, add the Connection Service name and Port number to the client's services file for TCP/IP support. For example:
server1 3700/tcp # DB2 connection service port
where:
The Port number used on the client must match the Port number used on the
server.
![]() |
If you are planning on supporting a UNIX client that is using Network Information Services (NIS), you must update the services file located on your NIS master server. The file called services is located in the same directory as the local hosts file that you may have edited in "Step A. Resolve the DB2 Connect Server's Host Address". See Table 33 for the location of the services file for your particular platform.
|
You must add an entry to the client's node directory to describe the remote node.
This entry specifies the chosen alias (Node_name), the hostname (or ip_address), and the svcename (or Port_number) that are to be used to access the remote server.
To catalog the TCP/IP node, perform the following steps:
![]() |
If you have trouble logging on to the system, see "Logging on to the System".
|
![]() |
If you are configuring communications for a Windows 3.x client, you
can use the Client Setup tool to complete this task. Go to "Using the Client Setup Tool to Configure a Windows 3.x Client" to catalog a node using the Client Setup tool.
|
. INSTHOME/sqllib/db2profile (for Bourne or Korn shell) source INSTHOME/sqllib/db2cshrc (for C shell)
where INSTHOME is the home directory of the instance
catalog tcpip node Node_name remote [ hostname | ip_address ] server [ svcename | Port_number ] terminate
For example, to catalog the remote server serverhost on the node called db2node, using the service name server1, use:
catalog tcpip node db2node remote serverhost server server1 terminate
To catalog a remote server with the IP address 9.21.15.235 on the node called db2node, using the Port number 3700, use:
catalog tcpip node db2node remote 9.21.15.235 server 3700 terminate
![]() |
If you need to change values that were set with the catalog node command, first run the uncatalog node command in the command line processor as follows: uncatalog node Node_name Recatalog the node with the value that you want to use.
|
Before a client application can access a remote database, the database must be cataloged on the server node and on any client nodes that will connect to it. When you create a database, it is automatically cataloged on the server with the Database alias (Database_alias) the same as the Database name (Database_name). The information in the database directory, along with the information in the node directory, is used on the client to establish a connection to the remote database.
To catalog a database on the client, perform the following steps.
![]() |
If you have trouble logging on to the system, see "Logging on to the System".
|
Table 34. Parameter Values for Cataloging Databases
Parameter | Description | Sample Value | Your Value |
---|---|---|---|
Database name (Database_name) | The Database alias (Database_alias) of the remote database. When you create a database, it is automatically cataloged on the server with the Database alias name (Database_alias) the same as the Database name (Database_name). | sample | |
Database alias (Database_alias) | An arbitrary local nickname for the remote database, on the client. If you do not provide one, the default is the same as the Database name (Database_name). This is the name that you use when connecting to a database from a client. | tor1 | |
Node name (Node_name) | The name of the node directory entry that describes where the database resides. Use the same value for Node name (Node_name) that you used to catalog the node in the previous step. | db2node |
![]() |
If you are configuring communications for a Windows 3.x client, you
can use the Client Setup tool to complete this task. Go to "Using the Client Setup Tool to Configure a Windows 3.x Client" to catalog a database node using the Client Setup tool.
|
. INSTHOME/sqllib/db2profile (for Bourne or Korn shell) source INSTHOME/sqllib/db2cshrc (for C shell)where INSTHOME is the home directory of the instance
catalog database Database_name as Database_alias at node Node_name terminateFor example, to catalog a remote database called sample so that it has the alias tor1, on the node db2node, use:
catalog database sample as tor1 at node db2node terminate
![]() |
If you need to change values that were set with the catalog database command, first run the uncatalog database command in the command line processor as follows: uncatalog database Database_alias Recatalog the database with the value that you want to use.
|
When the configuration of the server and client is complete,
use the following steps to verify that you can access data from a remote
database:
![]() |
You will need to connect to a remote database to test the
connection.
|
connect to Database_alias user userid using password
The values for userid and password must be valid for the system on which they are authenticated. Authentication for connecting to host databases is set while configuring the DB2 Connect server. Refer to the DB2 Connect User's Guide for more information.
If the connection is successful, you will get a message showing the name of the database to which you have connected. You are now able to retrieve data from that database. For example, to retrieve a list of all the table names listed in the system catalog table, enter the following SQL command in the Command Center or command line processor:
"select tabname from syscat.tables" (for UNIX-based platforms) select tabname from syscat.tables (for other platforms)
When you are finished using the database connection, issue the connect
reset command to end the database connection.
![]() |
You are ready to start using the DB2 server. See Chapter 35. "Getting Started with the DB2 Universal Database" for details.
|
If the connection fails, check the following items:
At the server:
![]() |
Check the settings for the DB2COMM registry value by issuing the
db2set DB2COMM command. For more information, see Chapter 39. "Controlling Your DB2 Environment".
|
![]() |
If there are problems starting a protocol's connection managers, a warning message is displayed and the error messages are logged in the db2diag.log file. The location of this file depends on your operating system.
Refer to the Troubleshooting Guide for information on the db2diag.log file.
|
At the client:
After you verify these items, refer to the Troubleshooting Guide if the connection still fails.