How to change an IP address on a CA API Gateway

Document ID : KB000009788
Last Modified Date : 14/02/2018
Show Technical Document Details
Introduction:

An IP address may need to be changed to match network changes in an environment, or will be a task for a cloned virtual appliance of the CA API Gateway. This article describes the considerations that must be taken after changing the IP address.

Environment:
This article applies to all CA API Gateway versions.
Instructions:

To change an IP address of a CA API Gateway ("Gateway"), an administrator must work through the network configuration script in the ssgconfig menu, as documented. Once the settings are updated (i.e. DHCP to static, new IP address, etc.), the administrator will need to restart the node completely.

After the IP address has changed, there are a few other items and files that should be considered:

  1. There may be Hostname-to-IP mappings set in the /etc/hosts file for localhost and others. This file should will need to be edited manually to ensure that the IP addresses located in there are accurate, particulary with any new IP address that may have just been assigned to the Gateway.
  2. If this node is part of a cluster and each node has contents in the /etc/hosts file for every node in the cluster (often done to avoid DNS issues in a static network), then the /etc/hosts file will need to be edited on all nodes which refer to the old IP address of the Gateway which just had the IP address change completed.
  3. It is advised to review the configuration of the interface that was modified/updated, to ensure it is completely accurate. This can be found at /etc/sysconfig/network-scripts/ifcfg-eth# (where eth# represents the interface name and number). Inside that file will be various fields and their values such as DEVICE (the name of the interface), HWADDR (the MAC address of the interface), IPADDR (the IP address if static), ONBOOT (whether or not this interface is active on boot), BOOTPROTO (i.e. DHCP or static), HOSTNAME (the FQDN of the host for the interface). Ensure all the fields and their values are accurate.

It is important to understand that the network configuration script found in the ssgconfig menu manually edits system configuration files. Any files listed below are not Gateway-specific, but are files present in most operating systems such as Red Hat Enterprise Linux and CentOS. As such, an administrator may manually run through the various operating system configuration files for changing the IP address, however for ease-of-use it is recommended to stick to the network configuration script within the ssgconfig menu on the Gateway.