Optional parameters section
Following the remote configuration directives (and Auxiliary syslog Destinations, if any) are a series of optional parameters. These can be commented out or deleted. The optional directives that can appear in the file are as follows:
MessagePrefix | This is a phrase that prefixes any messages sent by the system. If the directive gets omitted, the message is not prefixed by any special text. This can be used to distinguish the messages, such as by placing a keyword, or the device name, or the organization, or some other keyword at the very start of any message. The message prefix must be under 256 characters and can contain static text, environmental variables (delimited by % characters), date, time specification or both. |
MsgDelayMsecs | This is an integer number ranging from 10 to 5000, indicating the number of milliseconds to wait after sending a message. This is a way of throttling the number of messages that can be sent, ranging from 10 per second to only 12 per minute. This prevents any single syslog process from flooding a syslog message receiver. The default value, if this directive gets omitted, is 10 milliseconds. |
MaxMessageSize | This is an integer number ranging from 200 to 5000 bytes, indicating the maximum message size to be sent by the agent, including message prefix, facility and severity codes. If the value is omitted, the maximum message size is 500 bytes, that is sufficient to capture virtually all message information without taxing disk resources. (This value is particularly important for Windows 2008 platforms, that can generate highly verbose and non-pertinent messages that waste disk space and correlation CPU time.) |
LogLocal | This value is either true or false. If the value is true, then all syslog messages sent by the CO-sysmsg.exe program are also logged in the CO-sysmsg.log file (along with any error messages encountered by the program). Additionally, setting this value to true creates the system CO-sysmsg.dbg file, useful for diagnosing agent system errors. This provides a simple way to verify whether UDP messages are being dropped. |
EncryptData | This value is set to either true or false. If the value is true, then the message data is encrypted before it is transmitted, that is default. This setting makes the CO-sysmsg.exe program usable only with the BMC Defender Server. The program does not operate with any other syslog server if this value is set to true. If this directive is omitted, it is interpreted to be false. (See the notes in this section for more details.) |
MarkerMessage | This value is the content of a syslog message that is issued periodically to the receiving program, useful for generating a "heartbeat". The value gets ignored unless the value of MarkerMinutes is set to a positive integer value. The message must be under 256 characters and can contain static text, environmental variables (delimited by % characters), date, time specification or both. By default, no periodic syslog message is sent. This directive should be used only with BMC Version 3.5.1 or later. |
MarkerMinutes | This value is an integer number ranging from 1 to 65535 minutes, indicating how fast the MarkerMessage "heartbeat" is sent if any. A value of zero or less disables the marker message (the default condition). In order to send a marker message, this directive must exist in the configuration file, and the value must be a positive integer value, and the MarkerMessage must be defined. By default, no periodic syslog message is sent. Remote configuration of this directive requires BMC Version 3.5.1 or later. (See the notes in this section for more details.) |
Deduplicate | This value is an integer number ranging from 0 to 5 seconds, indicating the Deduplication seconds applied to messages generated by the agent. If this value does not exist, the agent Deduplicates messages that occur within 3 seconds. You can turn off the Deduplication filter by setting this value to zero, or increase the value to 5 seconds. |
MessageFormat | This value is a phrase or keyword flag that can be used to control the message format of all messages output by the agent program. Specific values include normal, RFC (or RFC3169), CEF, and LEEF, but other values might exist to support special message formats requested by you. (Contact support for other values and variants.) The MessageFormat directive is usually omitted from the configuration file. |
This section provides information about the following topics: