Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation  Back up to About Overview 
  
[+] Expand All
[-] Collapse All

authReportUnknownClient.ini File

The authReportUnknownClient.ini initialization file specifies options for the unknown authentication client report, which is an ASCII comma-delimited file produced by the Steel-Belted Radius Carrier server that identifies requests received from unknown RADIUS clients.

If the MaxMinutesPerFile parameter is set to 0, the file name of the unknown authentication client report isunknownClient_yyyymmdd.csv (where yyyymmdd identifies the date the report was generated.) If the MaxMinutesPerFile parameter is set to a value greater than 0, the file name of the report is unknownClient_yyyymmdd_hhmm.csv (where yyyymmdd identifies the date and hhmm identifies the time the report was generated.)

[Attributes] Section

The [Attributes] section of authReportUnknownClient.ini lists the attributes logged in the unknown client report.

You can configure what is logged to the unknown client log by entering attributes in the [Attributes] section in the sequence you want them to appear. This lets you design the content and column order of any spreadsheets that you plan to create based upon the unknown client log.

The syntax of the [Attributes] section is:

[Attributes]
AttributeName=
AttributeName=

For example:

[Attributes]
User-Name=

The [Attributes] section lists one AttributeName on each line. You must ensure that an equal sign (=) immediately follows each AttributeName, with no spaces in between. Improperly formatted entries are considered invalid and are ignored.

Each AttributeName in the [Attributes] section must be defined in a standard RADIUS dictionary file (.dct file), a subattribute dictionary file (.jdict file), or vendor-specific dictionary file (.dct) installed on the Steel-Belted Radius Carrier server.

Note: The first six attributes in each unknown client report entry (Date, Time, Source-IP-Address, Source-UDP-Port, Target-IP-Address, and Target-UDP-Port) are always enabled, and cannot be reordered or deleted. Therefore, these attributes do not appear in the [Attributes] section of the authReportUnknownClient.ini file.

[Settings] Section

The [Settings] section of authReportUnknownClient.ini specifies the operational characteristics of the unknown authentication client report. Sample syntax is:

[Settings]
BufferSize = 131072
DaysToKeep = 1
LineSize = 4096
LogfilePermissions = user:1007 rw-r- - - - -
MaxMinutesPerFile = 0
QuoteBinary = 1
QuoteInteger = 1
QuoteIpAddress = 1
QuoteText = 1
QuoteTime = 1
UTC = 0

Table 51: authReportUnknownClient.ini [Settings] Syntax

Parameter

Function

BufferSize

The size of the buffer used in the logging process, in bytes.

Default value is 131072.

DaysToKeep

Specifies the number of days the Steel-Belted Radius Carrier server retains each unknown client report.

Default value is 1 (one day).

LineSize

The maximum size of a single log line. The allowable range is 1024 to 32768.

Default value is 4096.

Note: Logging will fail if this value is exceeded.

LogFilePermissions

 

Specifies the owner and access permission setting for the unknown authentication client report (unknownClient_yyyymmdd_hhmm.csv) file.

Enter a value for the LogFilePermissions setting in owner:group permissions format, where:

  • owner specifies the owner of the file in text or numeric format.
  • group specifies the group setting for the file in text or numeric format.
  • permissions specifies what privileges can be exercised by Owner/Group/Other with respect to the file in text or numeric format.

For example, user:1007 rw-r- - - - - specifies that the file owner (user) can read and edit the log file, members of group 1007 can read (but not edit) the log file, and that other users cannot access the log file.

MaxMinutesPerFile

Specifies how often the current report is closed and a new file opened.

  • If set to n (where n is a number greater than 0), a new report file is generated every n minutes.
  • If set to 0, a new report file is generated once every 24 hours, at midnight local time.

Note: The value entered for MaxMinutesPerFile determines the file name of the generated report.

Default value is 0.

QuoteBinary

  • If set to 1, binary values written to the report are enclosed in quotes.
  • If set to 0, quotes are not used.

Set this value according to the format expected by the application that processes the entries.

Default value is 1.

QuoteInteger

  • If set to 1, integer values written to the report are enclosed in quotes.
  • If set to 0, quotes are not used.

Set this value according to the format expected by the application that processes the entries.

Default value is 1.

QuoteIPAddress

  • If set to 1, IP addresses written to the report are enclosed in quotes.
  • If set to 0, quotes are not used.

Set this value according to the format expected by the application that processes the entries.

Default value is 1.

QuoteText

  • If set to 1, text strings written to the report are enclosed in quotes.
  • If set to 0, quotes are not used.

Set this value according to the format expected by the application that processes the entries.

Default value is 1.

QuoteTime

  • If set to 1, time and date values written to the report are enclosed in quotes.
  • If set to 0, quotes are not used.

Set this value according to the format expected by the application that processes the entries.

Default value is 1.

UTC

  • If set to 1, time and date values are provided according to UTC (GMT).
  • If set to 0, time and date values reflect local time.

Default value is 0.

Modified: 2017-09-27