The Parameter file (or config file - these expressions are equivalent in context of this document) SYSDAT.CLIP.<ver>, is provided with CLIP and includes presets for the key CLIP operands. The Parameter file location cannot be altered or renamed.
This file is utilized during the loading of CLIP with DSSM. If there are any errors in the parameter file, loading will continue and default values be set, except for incorrect server address value or inability to read server address. If that occured message GLP1020 will be shown on operator console:
Reading server address from config file failed
The configuration file for this version of CLIP is written in JSON format, which will be explained in detail in this manual.
Changing the presettings.
The file uses a specific JSON format, making it precise and clear. It can be edited by humans or parsed by external software.
Most of the parameters have default values and can be omitted.
Example of Configuration file:
{
"#":"--------MANDATORY CONFIG PARAMETERS---------",
"LOGSERVER":"xxx.xxx.xxx.xxx",
"#":"--------REST OF CONFIG PARAMETERS-----------",
"#PROTOCOL":"TCP",
"#PORT":"514",
}A simplified JSON format is utilized. Keys beginning with '#' represent comments.
There are multiple configurable parameters:
- PROTOCOL - specifies the data transfer protocol between the BS2000 machine and rsyslog server. Only the TCP protocol is currently supported, which is the only valid option ("tcp"). If an incorrect value is provided or the parameter is not provided at all, the default value of "tcp" will be used. In the provided example, the key (and value) is commented out and the default value is used.
- LOGSERVER (mandatory) - Enter the IPv4/IPv6/FQDN (Fully Qualified Domain Name) of the rsyslog server to which messages must be sent. In case of IPv4 the address must consist of four numeric values separated by dots, each ranging from 0 to 255 (xxx.xxx.xxx.xxx e.g. "192.168.1.99"). In case of IPv6, both shortened and full notations are accepted(e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334 and 2001:db8:85a3::8a2e:370:7334) . In case that the inputted value is erroneous, CLIP program will generate an error message and terminate, as there is no valid server configuration available for processing.
- IP - Interchangable with LOGSERVER.
- HOSTNAME - The "hostname" parameter is optional, as it can be gathered from the system if not provided. Its purpose is to indicate the name of the BS2000 system where the CLIP is installed and to identify the system that sends logs to the rsyslog server. The parameter should consist of a valid alphanumeric sequence of labels concatenated by dots.
- PORT - The “port” parameter specifies the port to be used when communicating with the rsyslog server. This port must be a valid open port in the 1-65535 range on the rsyslog server that is accessible by the BS2000 machine. The default port for rsyslog traffic is 514, as listed in the /etc/services and /etc/rsyslog.conf files on the server. If no parameter is specified, this port will be used by default.
The CLIP Batch job will create a POSIX socket and attempt to connect with it. If successful, the socket configuration will be completed and the CLIP Batch job will begin listening for incoming calls.
Order of the parameters is unimportant.
Due to the origin of the BS2000 operating system, all keys and values will be treated case-insensitively and changed to uppercase internally.
The only required parameter is the IP address, which the system administrator must provide for the rsyslog server.