set server 

set server parameter=value [parameter=value ...]

The set server command can control many parameters. Multiple parameters are separated by spaces. The following table describes the parameters you can set with this command.

Parameter Description
password [= string] Sets server password used by the server to connect to other routed servers. If the value is omitted it is prompted for by the administration tool. Entered value will be stored in the main server configuration file in mangled form (but not encrypted).

To reset this password, enter the empty string twice at the prompt.

authorization=enabled|disabled Sets the authorization mode in the tibemsd.conf file.

After a transition from disabled to enabled, the server checks ACL permissions for all subsequent requests. While the server requires valid authentication for existing producers and consumers, it does not retroactively reauthenticate them; it denies access to users without valid prior authentication.

log_trace=trace-items Sets the trace preference on the file defined by the logfile parameter. If logfile is not set, the values are stored but have no effect.

The value of this parameter is a comma-separated list of trace options. For a list of trace options and their meanings, see Server Tracing Options.

You may specify trace options in three forms:

  • plain  A trace option without a prefix character replaces any existing trace options.
  • +  A trace option preceded by + adds the option to the current set of trace options.
  • -  A trace option preceded by - removes the option from the current set of trace options.

Examples

The following example sets the trace log to only show messages about access control violations. 

log_trace=ACL

The next example sets the trace log to show all default trace messages, in addition to TLS messages, but ADMIN messages are not shown. 

log_trace=DEFAULT,-ADMIN,+SSL
console_trace=console-trace-items Sets trace options for output to stderr. The values are the same as for log_trace. However, console tracing is independent of log file tracing.

If logfile is defined, you can stop console output by specifying: 

console_trace=-DEFAULT

Note that important error messages (and some other messages) are always output, overriding the trace settings.

Examples

See log_trace above.
client_trace={enabled|disabled}
 [target=location] [filter=value] Administrators can trace a connection or group of connections. When this property is enabled, the client generates trace output for opening or closing a connection, message activity, and transaction activity. This type of tracing does not require restarting the client program.

The client sends trace output to location, which may be either stderr (the default) or stdout.

You can specify a filter to selectively trace specific connections. The filter can be user, connid or clientid. The value can be a user name or ID (as appropriate to the filter).

When the filter and value clause is absent, the default behavior is to trace all connections.

Setting this parameter using the administration tool does not change its value in the configuration file tibemsd.conf.

max_msg_memory=value Maximum memory the server can use for messages.

For a complete description, see max_msg_memory in tibemsd.conf.

Specify units as KB, MB or GB. The minimum value is 8MB. Zero is a special value, indicating no limit.

Lowering this value will not immediately free memory occupied by messages.

msg_swapping=enabled|disabled Enables or disables the ability to swap messages to disk.
track_message_ids=enabled|disabled Enables or disables tracking messages by MessageID.
track_correlation_ids=enabled|disabled Enables or disables tracking messages by CorrelationID.
ssl_password[=string] This sets a password for TLS use only.

Sets private key or PKCS#12 file password used by the server to decrypt the content of the server identity file. The password is stored in mangled form.

ft_ssl_password[=string] This sets a password for TLS use with Fault Tolerance.

Sets private key or PKCS#12 file password used by the server to decrypt the content of the FT identity file. The password is stored in mangled form.

server_rate_interval=num Sets the interval (in seconds) over which overall server statistics are averaged. This parameter can be set to any positive integer greater than zero.

Overall server statistics are always gathered, so this parameter cannot be set to zero. By default, this parameter is set to 1.

Setting this parameter allows you to average message rates and message size over the specified interval.

statistics=enabled|disabled Enables or disables statistic gathering for producers, consumers, destinations, and routes. By default this parameter is set to disabled.

Disabling statistic gathering resets the total statistics for each object to zero.

rate_interval=num Sets the interval (in seconds) over which statistics for routes, destinations, producers, and consumers are averaged. By default, this parameter is set to 3 seconds. Setting this parameter to zero disables the average calculation.
detailed_statistics= NONE |  PRODUCERS,CONSUMERS,ROUTES Specifies which objects should have detailed statistic tracking. Detailed statistic tracking is only appropriate for routes, producers that specify no destination, or consumers that specify wildcard destinations. When detailed tracking is enabled, statistics for each destination are kept for the object.

Setting this parameter to NONE disables detailed statistic tracking. You can specify any combination of PRODUCERS, CONSUMERS, or ROUTES to enable tracking for each object. If you specify more than one type of detailed tracking, separate each item with a comma.

statistics_cleanup_interval=num Specifies how long (in seconds) the server should keep detailed statistics if the destination has no activity. This is useful for controlling the amount of memory used by detailed statistic tracking. When the specified interval is reached, statistics for destinations with no activity are deleted.
max_stat_memory=num Specifies the maximum amount of memory to use for detailed statistic gathering. If no units are specified, the amount is in bytes, otherwise you can specify the amount using KB, MB, or GB as the units.

Once the maximum memory limit is reached, the server stops collecting detailed statistics. If statistics are deleted and memory becomes available, the server resumes detailed statistic gathering.