Proxy server properties and command-line options
The proxy server reads its properties file when it starts. If a property is not specified in this file, the default value is used unless a command-line option is used to override it. The default location of the properties file is $NCHOME/omnibus/etc/proxyserver.props.
ServerName: "NCO_PROXY"Command-line options for the proxy server use the following format:
nco_proxyserv [ -option [ value ] ... ]In this command, -option is the command-line option and value is the value that you are setting the option to. Not every option requires you to specify a value.
If you do not specify a properties file when you start a proxy server, the default file is used. Use the -propsfile command-line option to specify the full path and file name of an alternative properties file.
The following table lists the proxy server properties and command-line options.
| Property | Command-line option | Description |
|---|---|---|
| AuthPassword string | N/A | The password that is associated with the user
name used to authenticate the proxy server when it connects to an
ObjectServer running in secure mode. The default is ''. When in FIPS 140–2 mode, the password can either be specified in plain text, or can be encrypted with the nco_aes_crypt utility. If you are encrypting passwords by using nco_aes_crypt in FIPS 140–2 mode, you must specify AES_FIPS as the encryption algorithm. When in non-FIPS 140–2 mode, the password can be encrypted with the nco_g_crypt or nco_aes_crypt utilities. If you are encrypting passwords by using nco_aes_crypt in non-FIPS 140–2 mode, you can specify either AES_FIPS or AES as the encryption algorithm. Use AES only if you need to maintain compatibility with passwords that were encrypted using the tools provided in versions earlier than Tivoli Netcool/OMNIbus V7.2.1. |
| AuthUserName string | N/A | The user name that is used to authenticate the proxy server when it connects to an ObjectServer running in secure mode. The default is root. |
| ConfigCryptoAlg string | N/A | Specifies the
cryptographic algorithm to use for decrypting string values (including
passwords) that were encrypted with the nco_aes_crypt utility
and then stored in the properties file. Set the string value
as follows:
The value that you specify must be identical to that used when you ran nco_aes_crypt with the -c setting, to encrypt the string values. Use this property in conjunction with the ConfigKeyFile property. |
| ConfigKeyFile string | N/A | Specifies the path and name of the key file that contains the key used to decrypt encrypted string values (including passwords) in the properties file. The key is used at run time to decrypt string values that were encrypted with the nco_aes_crypt utility. The key file that you specify must be identical to the file used to encrypt the string values when you ran nco_aes_crypt with the -k setting. Use this property in conjunction with the ConfigCryptoAlg property. |
| ConnectionRatio integer | -ratio integer | Sets the ratio of incoming connections from probes to outgoing connections to an ObjectServer. The default value of 10 creates a 10:1 ratio of incoming to outgoing connections. |
| N/A | -help | Displays the supported command-line options and exits. |
| N/A | -logfile string | Sets the name of the file to which the proxy server writes messages, including errors. By default, the file is $NCHOME/omnibus/log/servername.log , where the servername is defined by the -name option. |
| Connections integer | -connections integer | Sets the maximum number of available connections
for probes. The default value is 256 and the maximum
is 1024. Note: The Connections property and -connections command-line option are aliases for the MaxConnections property and -max command-line
option.
|
| NetworkTimeout integer | -networktimeout integer | Specifies a time in seconds after which a login attempt or connection to the ObjectServer times out, if a network failure occurs. After the specified timeout period, the proxy server attempts to reconnect to the ObjectServer. If the connection is unsuccessful after a second timeout period, the proxy server attempts to connect to a backup ObjectServer, where available. The default is 20 seconds. |
| OldTimeStamp TRUE | FALSE | -oldtimestamp TRUE | FALSE | Specifies the timestamp format to use in the log file. Set the value to TRUE to display the timestamp format that is used in Tivoli Netcool/OMNIbus V7.2.1, or earlier. For example: dd/MM/YYYY hh:mm:ss AM or dd/MM/YYYY hh:mm:ss PM when the locale is set to en_GB on a Solaris 9 computer. Set the value to FALSE to display the ISO 8601 format in the log file. For example: YYYY-MM-DDThh:mm:ss, where T separates the date and time, and hh is in 24-hour clock. The default is FALSE. |
| N/A | -propsfile string | Sets the proxy server properties file name. The default name is $NCHOME/omnibus/etc/servername.props, where the servername is defined by the -name option. |
| RemoteServer string | -server string | Sets the name of the ObjectServer to which the proxy server connects. The default is NCOMS. |
| SecureMode TRUE | FALSE | -secure | Sets the security mode of the proxy server. If enabled, the proxy server authenticates probe connection requests with a user name and password. If disabled (the default), probes can connect to the proxy server without a user name and password. |
| ServerName string | -name string | Sets the proxy server name. This name is the name that is configured in the Server Editor. The default is NCO_PROXY. |
| N/A | -version | Displays version information about the proxy server and exits. |