Update Internet Protocol in runtime environment (Configuration Manager)

Edit online

Update the Internet Protocol (IPv4, IPv6) that is used for communication in your runtime environment using Configuration Manager.

Before you begin

To update the communication used between the components in an OMEGAMON runtime environment, you must define the communication protocol and ports for each component. You might also have to update the host setting and the list of network interfaces. This topic describes how to modify the settings for the Internet Protocol that is used, focusing on the migration from IPv4 to IPv6.

Before you can update your OMEGAMON runtime environment from IPv4 to IPv6, your mainframe environment must be enabled for IPv6. You must have the name of the IPv6-enabled z/OS host and IP address available. Your site might reconfigure an existing host from IPv4 to IPv6, or it might add a new host with a different host name.

If you are using distributed components, your distributed environment must also be configured to communicate using IPv6. IPv6 communication over IPv4-only networks is not supported.

Note: If a component needs to communicate using IPv6 with some components and IPv4 with others, the host must be enabled for dual-stack operation. For more information, see IBM Tivoli Monitoring Installation and Setup Guide: Choose between IPv6 and IPv4.

Note: IPv6 is not supported for sending EIF events from the hub monitoring server or from monitoring agents.

To update your configuration, you must modify the settings for the runtime environment using Configuration Manager or PARMGEN. This task describes this process using Configuration Manager.

Note: If you use PARMGEN, see Update Internet Protocol in runtime environment (PARMGEN).

Related links:

IBM Tivoli Monitoring 6.3.0.1 Installation Guide: Configuring IBM Tivoli Monitoring components for IPv6 communication
Configuration Manager: Communication between monitoring components
OMEGAMON shared documentation: Decision 6: How to set up communications between components
OMEGAMON shared documentation: Managing multiple network interfaces

About this task

The communication protocol and ports for any monitoring server and all monitoring agents must be the same for communication to be successful.

If you are updating the communication protocol for the runtime environment or plan to use a port number that is different from the default port for the protocol, you must update the values for all communication protocols and ports specified within the profile. You might also have to update the host and the list of network interfaces.

To change the communication protocol that your runtime environment uses, you modify the communication protocol setting for any monitoring servers and the monitoring agents. You might also have to update the name of the host, if it is different; and you can also modify the ports that are used, if you want to use a port other than the default port for the protocol.

You will use the following parameters when updating the Internet Protocol for your runtime environment:

Table 1. Parameters for setting IP protocol using Configuration Manager
Component	Parameter	Description
Tivoli Enterprise Monitoring Server Monitoring agents	RTE_TCP_HOST	Specifies the TCP/IP host name or IP address of the z/OS system where the runtime environment is defined. If you configure a monitoring server as part of your runtime environment, the RTE_TCP_HOST parameter value sets the value of the KDS_TEMS_TCP_HOST parameter. Depending on other settings in the runtime environment, the RTE_TCP_HOST parameter might also set the value for the Kpp_TEMS_TCP_HOST parameters.
	RTE_COMM_PROTOCOLn	Sets the communication protocol of all components in the runtime environment, where `n` corresponds to a number between `1` and `7` to indicate the priority sequence for the communication protocols. The RTE_COMM_PROTOCOLn (n: 1 - 7) parameters set the value of the KDS_TEMS_COMM_PROTOCOLn and Kpp_AGT_COMM_PROTOCOLn parameters.
	IPv4 ports: RTE_TCP_PORT_NUM RTE_TCP_PIPES_PORT_NUM RTE_TCP_UDP_PORT_NUM	Ports for all components in the runtime environment that communicate over IPv4.
	IPv6 ports: RTE_TCP_PIPE6_PORT_NUM RTE_TCP_PIPE6S_PORT_NUM RTE_TCP_UDP6_PORT_NUM	Ports for all components in the runtime environment that communicate over IPv6.
Remote monitoring server	KDS_HUB_TCP_HOST	Specifies the TCP/IP host name or IP address of the z/OS system where the hub monitoring server is installed. This parameter applies only to a remote monitoring server that uses TCP/IP for communications.
	IPv4 ports: KDS_HUB_TCP_PIPE_PORT_NUM KDS_HUB_TCP_PIPES_PORT_NUM KDS_HUB_TCP_UDP_PORT_NUM	Well-known ports for the hub monitoring server over IPv4, specified during configuration of a remote monitoring server.
	IPv6 ports: KDS_HUB_TCP_PIPE6_PORT_NUM KDS_HUB_TCP_PIPE6S_PORT_NUM KDS_HUB_TCP_UDP6_PORT_NUM	Well-known ports for the hub monitoring server over IPv6, specified during configuration of a remote monitoring server.
Network interface lists	IPv4 communication: RTE_TCP_KDEB_INTERFACELIST	Directs all components in the runtime environment to connect to a specific TCP/IP local interface for IPv4 communication.
	IPv6 communication: KDEB_INTERFACELIST_IPV6 (embed override parameter)	Contains a list of interface addresses in the order for which these interface addresses should be discovered and used for IPv6 communication.

The following procedure describes how to change the IP protocol, such as from IPv4 to IPv6, for your runtime environment using Configuration Manager.

Procedure

Update the settings for the monitoring server and monitoring agents to use to communicate, as follows:
1. In member RTEDEF(rte_name), make the following updates:
  - Assign the communication protocol as the first priority protocol. The following example sets the first priority protocol to use the IP6.SPIPE communication protocol (the TCP/IP protocol that supports Secure Sockets Layer communications over IPv6):
```
RTE_COMM_PROTOCOL1              IP6SPIPE  * Secure TCP over IPv4
```
  - Specify the port number using the corresponding parameter for the specified protocol. The following example sets the port for the IP6.SPIPE communication protocol; in this case, it is the default port number:
```
RTE_TCP_PIPE6S_PORT_NUM         3660      * Secure IP.PIPE for IPv6
```
    Important: For all port parameters that are not related to the defined communication protocol, remove the parameter value, if defined. Otherwise, parameter validation will fail.
  - Specify the host.
    Note: If you are migrating from IPv4 to IPv6, the host must be IPv6-enabled. Your site might reconfigure the existing host to enable IPv6, or it might add a new host with a different host name or IP address.
```
RTE_TCP_HOST                    "SYSA"
```
2. If this monitoring server is a remote monitoring server, in member RTEDEF(KDS$PARM) or RTEDEF(KDS$lpar), specify the port number of the hub monitoring server by using the corresponding parameter for the specified protocol (IPv4 or IPv6):
```
KDS_HUB_TCP_PIPE6S_PORT_NUM     3660      * Secure IP.PIPE for IPv6
```
3. Update the interface lists for the runtime environment. If you are migrating from IPv4 to IPv6, you must update the settings as follows:
  - Set the interface list parameter that is used for IPv4 communication to the hyphen (-) character:
```
RTE_TCP_KDEB_INTERFACELIST      "-"
```
  - Specify the list of interface addresses for IPv6 communication in the KDEB_INTERFACELIST_IPV6 embed override parameters by editing embed override member EMBEDS(KDS$PENV) for the monitoring server and EMBEDS(KAG$PENV) for the monitoring agents. By default, this parameter is commented out; you must remove the asterisk (*) that precedes the parameter name to enable the parameter setting.
```
KDEB_INTERFACELIST_IPV6=\
(2002:930:9b04:305:9:48:133:98)\
(2002:930:9b04:305:9:48:133:100)
```
  For more information about configuring interface lists, see Managing multiple network interfaces.
Run the GENERATE action.
Recycle the started tasks for the monitoring server and the monitoring agents.