IBM Tivoli Netcool/OMNIbus, Version 7.4

Setting Tivoli Netcool/OMNIbus environment variables (UNIX and Linux)

When the installation or upgrade is complete, you might need to set a number of environment variables.

The following table describes the environment variables that you might need to set. The POSIX syntax format is deprecated.

Table 1. Netcool/OMNIbus environment variables
Environment variable	Description
NCHOME	This environment variable specifies the home location for Tivoli Netcool/OMNIbus. It is not mandatory that you manually set this environment variable before running the Tivoli Netcool/OMNIbus installation program. Provision is made for this environment variable to be automatically set when you run a Tivoli Netcool/OMNIbus application that has the nco_ prefix. Note: If you are using more than one Netcool® installation, do not set this variable. This variable can cause programs in one installation to use files in the other installation. However, it is useful to set this variable when using some utilities that are not part of an installation. Examples of these utilities include the installer itself, or patch bundles.
OMNIHOME	This environment variable was previously used to specify the location of a Tivoli Netcool/OMNIbus installation. It is now used to provide legacy support for scripts, third-party applications, and probes that continue to use the $OMNIHOME environment variable. When using such applications with Tivoli Netcool/OMNIbus V7.4, $OMNIHOME is automatically changed to $NCHOME/omnibus.
PATH	This environment variable specifies the path to executable files. To run Tivoli Netcool/OMNIbus programs without entering their full path each time, add the directory locations of these programs to your PATH environment variable. Path values that you can add include: $NCHOME/omnibus/bin and $NCHOME/omnibus/probes.
LIBPATH SHLIB_PATH LD_LIBRARY_PATH	This environment variable is operating system-specific. It specifies the path to shared libraries that are used to provide a smaller total distribution size for Tivoli Netcool/OMNIbus. The runtime dynamic loader module automatically looks for shared libraries in the following default directory: On 32-bit operating systems: $NCHOME/platform/`arch`/lib On 64-bit operating systems: $NCHOME/platform/`arch`/lib64 Where `arch` is the directory that corresponds to your operating system. For example, the default installation location of the shared libraries on a 32-bit Solaris operating system is /opt/IBM/tivoli/netcool/platform/solaris2/lib. Typically, you do not typically need to check or modify this environment variable setting. However, if another user or application modified the environment variable, Tivoli Netcool/OMNIbus can function incorrectly or fail. In this situation, check the shared library paths. The Netcool/OMNIbus installation provides dynamic (rather than static) links to the Open Motif 2.2.3 library. If this library is installed within its default system directory (for example, /usr/X11R6/lib/libXm.so.3), the LD_LIBRARY_PATH environment variable is automatically set to this path. However, if the library is installed in a different location, you must manually update the environment variable with this location. As with other UNIX operating systems, you can check the shared library paths.
NDE_LOGFILE_MAXSIZE	This environment variable controls the maximum size of log files, in bytes, for the ObjectServer, the ObjectServer Gateway, proxy servers, the nco_postmsg utility, and the nco_bridgeserve utility. When the log file reaches the maximum size specified, the application, for example the ObjectServer, renames the log file, for example `servername`.log, to `servername`.log_old. Then, it starts a new `servername`.log file. When the new `servername`.log file reaches the maximum size, `servername`.log_old is overwritten, and so on. As an alternative to the NDE_LOGFILE_MAXSIZE environment variable, you can use the NDE_LOGFILE_ROTATION_FORMAT and NDE_LOGFILE_ROTATION_TIME environment variables to enforce log file rotation.
NDE_LOGFILE_ROTATION_FORMAT	This environment variable specifies whether a log file rotation takes place for the ObjectServer, the ObjectServer Gateway, proxy servers, the nco_postmsg utility, and the nco_bridgeserve utility. This environment variable also specifies a timestamp that is appended to the old log file after rotation took place. Use this environment variable in conjunction with the NDE_LOGFILE_ROTATION_TIME environment variable. If you set the NDE_LOGFILE_ROTATION_FORMAT variable to a non-null value, a daily log rotation is enforced. If you specify a value in POSIX format syntax, or Local Data Markup Language (LDML) syntax format, a timestamp is appended to the old log file after rotation. The timestamp ensures that each old log file has a unique name and so is not overwritten. A timestamp generates a log file name as per the following example: `objectservername`.log_201004301356. For more information about LDML format syntax, see http://userguide.icu-project.org/formatparse/datetime. If you do not require a timestamp, you can set the value of the NDE_LOGFILE_ROTATION_FORMAT variable to literal characters, for example "rotation." After rotation, this value is appended to the old log file, and generates a log file name as per the following example: `objectservername`.log_rotated. If you set the variable to literal values then the old rotated files are overwritten by newly rotated files, at the time specified by the NDE_LOGFILE_ROTATION_TIME environment variable. Important: Literal characters must be escaped by quotation marks (' ') as described in http://userguide.icu-project.org/formatparse/datetime. If you set the NDE_LOGFILE_ROTATION_FORMAT environment variable, the NDE_LOGFILE_MAXSIZE environment is ignored.
NDE_LOGFILE_ROTATION_TIME	This environment variable specifies the time at which a log file rotation occurs, if you set the NDE_LOGFILE_ROTATION_FORMAT environment variable to enforce a log file rotation. This environment variable affects the ObjectServer, the ObjectServer Gateway, proxy servers, the nco_postmsg utility, and the nco_bridgeserve utility, The NDE_LOGFILE_ROTATION_TIME variable is set to indicate the time of day of log file rotation in hours and minutes. The format is `hhmm`, where hh is in the 24-hour time format.

Examples

The following examples show how to manually set the NCHOME, OMNIHOME, PATH, NDE_LOGFILE_MAXSIZE, and NDE_LOGFILE_ROTATION_FORMAT and NDE_LOGFILE_ROTATION_TIME environment variables. These examples assume that the Netcool home directory /opt/IBM/tivoli/netcool is used for Solaris, HP-UX, and Red Hat Linux, and /usr/IBM/tivoli/netcool is used for AIX®.

Example: Setting NCHOME, OMNIHOME, and PATH on Solaris, HP-UX, and Red Hat Linux

Each csh user can add the following lines to their $HOME/.login file:

setenv NCHOME /opt/IBM/tivoli/netcool
setenv OMNIHOME $NCHOME/omnibus
setenv PATH $NCHOME/omnibus/bin:$PATH

Each ksh and sh user can add the following lines to their $HOME/.profile file:

NCHOME=/opt/IBM/tivoli/netcool;export NCHOME
OMNIHOME=$NCHOME/omnibus;export OMNIHOME
PATH=$PATH:$NCHOME/omnibus/bin;export PATH

Example: Setting NCHOME, OMNIHOME, and PATH on AIX

Each csh user can add the following lines to their $HOME/.login file:

setenv NCHOME /usr/IBM/tivoli/netcool
setenv OMNIHOME $NCHOME/omnibus
setenv PATH $NCHOME/omnibus/bin:$PATH

Each ksh and sh user can add the following lines to their own $HOME/.profile file:

NCHOME=/usr/IBM/tivoli/netcool;export NCHOME
OMNIHOME=$NCHOME/omnibus;export OMNIHOME
PATH=$PATH:$NCHOME/omnibus/bin;export PATH

Example: Setting NDE_LOGFILE_MAXSIZE

The following example shows how to set the maximum file size for the ObjectServer to 102,400 bytes:

setenv NDE_LOGFILE_MAXSIZE 102400
nco_objserv

Example: Setting NDE_LOGFILE_ROTATION_FORMAT and NDE_LOGFILE_ROTATION_TIME using POSIX

The following example shows how to rotate the log files at midnight each day, and append the old log file name with the year, month, day of month, hour and minute by using POSIX format syntax:

setenv NDE_LOGFILE_ROTATION_FORMAT %Y%m%d-%H%M
setenv NDE_LOGFILE_ROTATION_TIME 0000

Example: Setting NDE_LOGFILE_ROTATION_FORMAT and NDE_LOGFILE_ROTATION_TIME using LDML

The following example shows how to rotate the log files at midnight each day, and append the old log file name with the year, month, day of month, hour and minute by using LDML format syntax:

setenv NDE_LOGFILE_ROTATION_FORMAT yyyyMMdd-HHmm
setenv NDE_LOGFILE_ROTATION_TIME 0000

Example: Setting NDE_LOGFILE_ROTATION_FORMAT and NDE_LOGFILE_ROTATION_TIME with a literal string

The following example shows how to rotate the log files at midnight each day, and append the old log file name with the literal character string "old":

setenv NDE_LOGFILE_ROTATION_FORMAT \'old\'
setenv NDE_LOGFILE_ROTATION_TIME 0000