Environment variables affecting behavior and configuration

Variable Description
SSXDIR, TLSDIR UNIX and Windows.

Set by the ssxenv and tlsenv scripts. They contain the full path to the base directory of the respective product.
HOME UNIX only.

Fallback location to look for the ssxconfig file as well as for the OpenLDAP client configuration. See TLS/SSL configuration and common defaults for multiple LDAP servers.

LANG, LC_CTYPE, LC_ALL UNIX and Windows.

Default locale setup. SSX uses operating system functions to convert various character string values. These functions are affected by the content of these variables.

PATH UNIX and Windows.

Affects the search path for executables. Is amended through ssxenv.sh/ssxenv.bat.

Windows only: Also affects the search path for DLLs.

LD_LIBRARY_PATH UNIX only.

Affects the search path for shared libraries. Is amended through ssxenv.sh.

Note:

Unless the environment variable FORCE_LIBPATH_USAGE is set to the value true, the OpenSSL library directory is not amended to this variable. See Preparing the environment.
SSX_CONFIG UNIX and Windows.

May contain a fully qualified name of a directory containing an ssxconfig file. Is set through ssxenv.sh/ssxenv.bat to the default location. See TLS/SSL configuration and common defaults for multiple LDAP servers.

SSX_LDAP_TRACELEVEL UNIX only.

Sets the OpenLDAP configuration parameter LDAP_OPT_DEBUG_LEVEL. Can be used if LDAP client issues need to be investigated.

SSX_GET_ALL_DOMAINS_ALT Windows only.

If set and not empty, use an alternative way to enumerate all domains.

SAGENV_VERBOSE UNIX and Windows.

If not empty, activates verbose output of the ssxenv and tlsenv scripts.
OPENSSL_CONF UNIX and Windows.

Defaults to ${TLSDIR}/openssl.cnf and is set through tlsenv.sh/tlsenv.bat.

Note:

Override to operate the FIPS 140-2 module, see Using OpenSSL's FIPS 140-2 certified provider.
OPENSSL_MODULES UNIX and Windows.

Defaults to ${TLSDIR}/lib/ossl_modules or ${TLSDIR}/lib64/ossl_modules and is set through tlsenv.sh/tlsenv.bat.

Note:

On UNIX, this variable is not set unless the environment variable FORCE_LIBPATH_USAGE is set to the value true. If this variable is set, it may interfere with a system-provided OpenSSL installation.

Must be set to operate the FIPS 140-2 module, see Using OpenSSL's FIPS 140-2 certified provider.
SSL_CERT_FILE UNIX and Windows.

Defaults to ${TLSDIR}/cert.pem and is set through tlsenv.sh/tlsenv.bat.
SASL_CONF_PATH UNIX only.

The SSX library contains an OpenLDAP client library and an Cyrus SASL library. This Cyrus SASL library is used by the built-in OpenLDAP client library and may under certain circumstances require special configuration.

Defaults to /opt/softwareag/common/security/ssx/etc/sasl2.

LDAPCONF or LDAPRC UNIX only.

The SSX library contains an OpenLDAP client library and may under certain circumstances require special configuration.

Defaults to /opt/softwareag/common/security/ssx/etc/openldap/ldap.conf or ${HOME}/.ldaprc.