Optional parameters for CO-sysmsg.cnf
The following configuration entries in the CO-sysmsg.cnf file are optional:
Parameter | Description |
|---|---|
AuxAddress | You can include zero or more AuxAddress parameters as part of the header. This parameter specifies an auxiliary address that receives syslog messages generated by the agent. The AuxAddress value does allow remote configuration and does not encrypt the syslog messages. To disable this function, remove the AuxAddress parameter, or set the value to a non-valid address, such as -1. For more information, see Alternate-and-auxiliary-Syslog-destinations |
CompleteEventText | If you set this parameter to True, the product uses wide-character parsing functions and sends complete Windows event log messages to BMC Defender Server. The default value is False, which uses the default parsing logic. By using the default parsing logic, the product truncates event log messages and sends incomplete messages to BMC Defender Server. |
MessagePrefix | This is a single word that is prefixed to any messages that the system sends. If you omit this parameter, the message is not prefixed by any special text. You can use this to distinguish the messages, such as by placing a keyword, the device name, the organization, or some other keyword at the beginning of any message. For more information, see MessagePrefix. |
MsgDelayMsecs | This is an integer number in the range 10–5000, that indicates the number of milliseconds to wait after sending a message. This is a way to throttle the number of messages that can be sent, that range from 100 per second to only 12 per minute. This prevents any single syslog process from flooding a syslog message receiver. The default value, if this parameter gets omitted, is 10 Msecs. |
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 is ignored unless the value of MarkerMinutes (described further) is set to a positive integer value. The message must be under 256 characters and can contain static text. The message can also contain environmental variables (delimited by % characters), date and time specification, or both. By default, no periodic syslog message is sent. You should use this parameter only with BMC Version 3.5.1 or later. For more information, see MarkerMessage. |
MarkerMinutes | This value is an integer number in the range 1–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). To send a marker message, this parameter must exist in the configuration file, the value must be a positive integer value and the MarkerMessage must be defined. By default, no periodic syslog message gets sent. Remote configuration of this directive requires BMC Version 3.5.1 or later. |
LogLocal | This value can set to either True or False. If the value is True, 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). This provides a simple way to verify whether UDP messages are needed to be dropped. Since the CO-sysmsg.log file restarts each time the service starts, the file does not grow without bounds. If this parameter gets omitted, it is interpreted to be False. |
EncryptData | This value is set to either True or False. If the value is True, then by default, the message data is encrypted before it is transmitted. 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 parameter is omitted, it is interpreted to be False. For more information, see Event-message-encryption. |
OutputDelimiter | The value sets the output field delimiter that is appended to each for the syslog message event log field. The delimiter value affects all output messages. Uncomment the configuration entry to change the delimiter to a single character or word. A space is automatically added before and after the character or word. The following values have specific meaning:
The default delimiter is a dash character with a space before and after ( - ). |
SendJsonMessages | If set to true, all output messages are formatted as JSON with the event message strings and data used to populate the fields. The setting affects all output messages. If you send JSON messages, the normal syslog-formatted messages are not sent. The default value is false. |