Broadcom: API Gateway - Error when install Platform Update patch due to rsyslog.conf invalid syntax

Products

• CA API Gateway

Issue/Introduction

While attempting to install a Platform Update patch, the patch output shows that the installation is in ERROR state.

Reviewing /var/log/layer7-patchlog log file, reveals the following to be the root cause:

+ echo -e Tue Oct 4 06:41:59 '2022: ERROR' - The rsyslog configuration file '(/etc/rsyslog.conf)' syntax is not valid. Exiting...
+ exit 1

 

Environment

Release : 10.1

Cause

In order to determine the misconfiguration in the rsyslog.conf file, we can issue the following command at the OS prompt:

# /sbin/rsyslogd -c3 -f /etc/rsyslog.conf -N 1

In this particular case, the output shows IMTCP module enabled but NO listener port was associated with it. Usually, this module is disabled in Gateway Appliance by default 

# /sbin/rsyslogd -c3 -f /etc/rsyslog.conf -N 1
rsyslogd: version 8.24.0-57.el7_9.1, config validation run (level 1), master config /etc/rsyslog.conf
rsyslogd: imtcp: module loaded, but no listeners defined - no input will be gathered [v8.24.0-57.el7_9.1 try http://www.rsyslog.com/e/2212]

Resolution

Edit /etc/rsyslog.conf file and add an # in front of the following line:

$ModLoad imtcp

It should look like this:

#$ModLoad imtcp

Save the change in rsyslog.conf and delete the patch status file:

rm -f /opt/SecureSpan/Controller/var/patches/<patch name>.status

For example, if the Platform Patch was in ERROR was "Layer7_API_PlatformUpdate_64bit_v10.1.00-CentOS"

# rm -f /opt/SecureSpan/Controller/var/patches/Layer7_API_PlatformUpdate_64bit_v10.1.00-CentOS.status

Re-upload and re-install the patch as usual.