Section 3.131. <MessageLog FILE>

3.131. <MessageLog FILE>

This clause logs RADIUS, Diameter, or TACACS+ messages to a file. You can define as many <MessageLog FILE> clauses as you wish at the top level configuration. Each clause can specify different logging conditions and a different log file.

# This message logger logs to a file
<MessageLog FILE>
      Identifier myauthlogger
      Format text
      #Encoding hex
      Filename %L/messagelog-%0-%1
</MessageLog>

<MessageLog FILE> understands also the same parameters as all MessageLogs. For more information, see Section 3.130. <MessageLog xxxxxx>.

3.131.1. Filename

This optional parameter specifies the name of the file where messages log entries are written. You can use any of the special characters defined. For more information about special characters, see Section 3.3. Special formatters. The default value is %L/messagelog.

The special characters are replaced as follows:

%0 is replaced by the protocol.
For the supported protocols, see Section 3.7.51. GlobalMessageLog .
%1 is replaced by the log format value.
For the supported log format values, see Section 3.131.2. Format.
%2 is replaced by the encoding.
For the supported encodings, see Section 3.131.3. Encoding .

If the Filename parameter starts with a vertical bar character (‘|’), the rest of the filename is assumed to be a program to which the output is to be piped. Otherwise the output appends to the named file:

# Example file name: messagelog-radius-text-hex
Filename %L/messagelog-%0-%1-%2

3.131.2. Format

This optional parameter specifies the format for the message log entries. Possible values are: text and text2pcap. Unknown values default to text, which is also the default value. Format value supports format specifiers, such as %{GlobalVar:name}, which are evaluated when the configuration is loaded.

# Prepare for possible conversion to pcap format
Format text2pcap

3.131.3. Encoding

This optional parameter specifies the encoding for the message log entries. Encoding is done after the message has been formatted. Possible values are: none and hex. Unknown values default to none, which is also the default value. Encoding value supports format specifiers, such as %{GlobalVar:name}, which are evaluated when the configuration is loaded.

# Might be useful if using a binary Format
Encoding hex