REGISTER command

The REGISTER command registers the Db2® server in the network directory server.

Authorization

None

Required connection

None

Command syntax

Read syntax diagramSkip visual syntax diagramREGISTERDB2 SERVERINADMINLDAP path
LDAP path
Read syntax diagramSkip visual syntax diagramLDAPNODEASnodenamePROTOCOL TCPIPHOSTNAMEhostnameSVCENAMEsvcenameSECURITYSOCKSSSLSECURITYSSLTCPIP4HOSTNAMEhostnameSVCENAMEsvcenameSECURITYSOCKSSECURITYSSLTCPIP6HOSTNAMEhostnameSVCENAMEsvcenameSECURITYSSLNPIPE REMOTEcomputer-nameINSTANCEinstanceNODETYPESERVERMPPDCSOSTYPEostypeWITH"comment-string"USERusernamePASSWORDpassword

Command parameters

IN
Specifies the network directory server on which to register the Db2 server. The valid value is: LDAP for an LDAP (Lightweight Directory Access Protocol) directory server.
ADMIN
Specifies that an administration server node is to be registered.
NODE | AS nodename
Specify a short name to represent the Db2 server in LDAP. A node entry will be cataloged in LDAP using this node name. The client can attach to the server using this node name. The protocol associated with this LDAP node entry is specified through the PROTOCOL parameter.
PROTOCOL
Specifies the protocol type associated with the LDAP node entry. Since the database server can support more than one protocol type, this value specifies the protocol type used by the client applications. The Db2 server must be registered once per protocol. Valid values are: TCPIP, TCPIP4, TCPIP6, and NPIPE. Specify NPIPE to use Windows Named Pipes. NPIPE is only supported on Windows operating systems.
HOSTNAME hostname
Specifies the TCP/IP host name (or IP address). IP address can be an IPv4 or IPv6 address when using protocol, TCPIP. IP address must be an IPv4 address when using protocol, TCPIP4. IP address must be an IPv6 address when using protocol, TCPIP6.
SVCENAME svcename
Specifies the TCP/IP service name or port number.
SECURITY SOCKS
Specifies that TCP/IP SOCKS is to be used. This parameter is only supported with IPv4. When protocol TCPIP is specified, the underlying protocol used will be IPv4.
SECURITY SSL
Important: The register LDAP command using SSL security type is a fallback-incompatible feature. Querying Transport Layer Security (TLS) nodes from the LDAP server is only available in Db2 11.5.9 and later. 
SECURITY SSL
Specifies that the node is SSL enabled.
REMOTE computer-name
Specifies the computer name of the machine on which the Db2 server resides. Specify this parameter only if registering a remote Db2 server in LDAP. The value must be the same as the value specified when adding the server machine to LDAP. For Windows operating systems, this is the computer name. For UNIX based systems, this is the TCP/IP host name.
INSTANCE instance
Specifies the instance name of the Db2 server. The instance name must be specified for a remote instance (that is, when a value for the REMOTE parameter has been specified).
NODETYPE
Specifies the node type for the database server. Valid values are:
SERVER
Specify the SERVER node type for a Db2 Enterprise Server Edition. This is the default.
MPP
Specify the MPP node type for a Db2 Enterprise Server Edition - Extended (partitioned database) server.
DCS
Specify the DCS node type when registering a host database server.
OSTYPE ostype
Specifies the operating system type of the server machine. Valid values are: AIX, NT, HPUX, SUN, MVS, OS400, VM, VSE and LINUX. If an operating system type is not specified, the local operating system type will be used for a local server and no operating system type will be used for a remote server.
WITH "comment-string"
Describes the Db2 server. Any comment that helps to describe the server registered in the network directory can be entered. Maximum length is 30 characters. A carriage return or a line feed character is not permitted. The comment text must be enclosed by double quotation marks.

Usage notes

Register the Db2 server once for each protocol that the server supports.

The REGISTER command should be issued once for each Db2 server instance to publish the server in the directory server. If the communication parameter fields are reconfigured, or the server network address changes, update the Db2 server on the network directory server.

To update the Db2 server in LDAP, use the UPDATE LDAP NODE command after the changes have been made.

If any protocol configuration parameter is specified when registering a Db2 server locally, it will override the value specified in the database manager configuration file.

If the REGISTER command is used to register a local Db2 instance in LDAP, and one or both of NODETYPE and OSTYPE are specified, they will be replaced with the values retrieved from the local system. If the REGISTER command is used to register a remote Db2 instance in LDAP, and one or both of NODETYPE and OSTYPE are not specified, the default value of SERVER and Unknown will be used.

If the REGISTER command is used to register a remote Db2 server in LDAP, the computer name and the instance name of the remote server must be specified along with the communication protocol for the remote server.

When registering a host database server, a value of DCS must be specified for the NODETYPE parameter.