The mclient.conf file contains the default client options for configuring CLIs. Most of the cell configuration options also can be specified for CLIs.
For more information about cell configuration, see Managing a Knowledge Base.
The configuration options use the following syntax: option=value
, where value
equals one of the following:
Boolean: Yes | On | No | Off
Number
String
- Path
The following table describes the CLI configuration parameters:
CLI configuration parameters
Option | Description | Default value |
---|
AuthenticationServerAddress
| Specifies the host name or IP address of an authentication server, optionally followed by a port number, using the following syntax: Host [/ Port ] | If no value is entered, the default IAS port number on the local host is used. |
ServerName
| Specifies the name of the cell; an alternative for the -n cellName option | Host |
ServerLocation
| The host name or IP address of the cell | Host |
ServerDirectoryName
| Specifies the name of the cell directory file | mcell.dir |
ServerPort
| Specifies the TCP/IP port number where the cell listens for all in-bound requests from sources, such as the administration console, CLIs, and adapters | 1828
|
Encryption
| Enables or disables encryption to and from the cell | Yes
|
EncryptionKey
| Used by encryption process as part of the encoding key | no default |
ConnectionSetupTimeOut
| The maximum time, in seconds, that a CLI command attempts to establish a connection to a cell If the connection with the cell cannot be completely established within this time, the command aborts. Note: If the cell is busy with a database cleanup, it might be impossible to connect the CLI with the default values. A database cleanup has a duration limit defined by the EventDBCleanupDurationLimit option, with a default value of 30 seconds. With a default ConnectionSetupTimeOut of 10 seconds, the connection cannot be established within the first 20 seconds of a cleanup. | 10 (seconds)
|
ConnectionPortRange
| Specifies the range of ports to use for outgoing connections It is the port used on the client side. This is useful only to pass the event through firewalls with high restrictions. Most firewall configurations ignore source port information but require destination port information. However, firewall configuration usually can restrict the source ports as well. The syntax is PortRange = PortSequence {, PortSequence} PortSequence = Port [- Port]. Warning: On Windows platforms, when using ConnectionPortRange for a CLI running on the same computer as the cell, it is possible that the CLI will not be able to connect. This can occur when the CLI needs more than one attempt to connect (for instance, because the cell was too busy during the first attempt). Subsequent connection attempts will fail due to limitations of the OS. | empty |
ConnectionPortReuse
| Indicates whether or not the ports specified in ConnectionPortRange must be reused as much as possible By default, the cell tries to reuse ports from the specified range, in the given order. When ConnectionPortReuse=No , for every new connection within the same session, the next free port from the specified range is used. Only when it reaches the end of the range will it restart at the beginning of the range. | Yes
|
MessageBufferSize
| The number of messages, or events, retained in the buffer when the cell is unable to send, or when waiting for an answer; a message that is not sent because the destination is down, for example, or a message that was sent but not yet answered, remains in the buffer | 2000
|
MessageBufferCleanupPercentage
| | 10
|
MessageBufferReconnectInterval
| The time interval, in seconds, in which the cell attempts reconnection to a destination if the original connection failed | 600
|
MessageBufferKeepWait
| The amount of time, in seconds, that messages are retained in the buffer until they can be sent After the specified time elapses, the retained messages are removed from the buffer. | 3600
|
MessageBufferKeepSent
| The time, in seconds, to keep sent messages buffered while waiting for an answer | 300
|
MessageBufferResendCount
| The number of times to resend unanswered messages | 1
|