QuickStart Guide
...
Industrial Systems Connection ...
Network Utility

Syslog Server

10min

Review the following information for setting up and configuring the Syslog Server driver.

See Syslog Server Reference for more information.

Litmus Edge Compatible Series

Compatibility parameter

Compatible items

Driver type

Ethernet

Validated devices/series

Configure Syslog Server

Configure the following parameters. Update the default values to your specific setup.

Parameter

Value

Type

Network Utility

Driver

Syslog Server

Log Protocol

Select BSD Syslog (RFC3164) or Syslog (RFC5424)

Configure the remaining settings as needed if they are enabled.

UDP Settings

Note: If you choose UDP mode, the device will begin listening on the interface you specified. Its status will be DISCONNECTED until it receives a valid syslog message from any client. You can modify how long the device remains CONNECTED after receiving a message by adjusting the UDP Timeout setting.

Parameter

Value

UDP Interface

0.0.0.0

UDP Port

514

UDP Max PDU

4096

UDP Timeout

30 seconds

TCP Settings

Parameter

Value

TCP Interface

0.0.0.0

TCP Port

6514

TCP Parsing

Select one of the following:

  • Non-Transparent Framing (RFC6587)
  • Octet Counting (RFC5425)
  • Single Message (RFC5426)

TLS Settings

Parameter

Value

UDP Interface

0.0.0.0

UDP Port

6514

TLS Parsing

Select one of:

  • Non-Transparent Framing (RFC6587)
  • Octet Counting (RFC5425)
  • Single Message (RFC5426)

Server Certificate

Update or copy as needed

Server Private Key

Update or copy as needed

Min TLS Version

Select one of:

  • TLS 1.0
  • TLS 1.1
  • TLS 1.2
  • TLS 1.3

Require Client Certificate

If enabled, upload the certificate.

Advanced Settings

Parameter

Value

Allow Multi Match

Enable or Disable

Stringify In Fields

Enable or Disable

Replace Empty Fields

Complete as needed

Minimum Clients

1

Max Workers

1

Note: The Minimum Clients setting is not applicable when UDP is enabled. If UDP is enabled, do not change this setting.

Configure the List of Registers

When you Add Tags to the Syslog Server, refer to the following register table and tag parameters.

Register Table

Name

Value Type

Access Type

Match (String Publish)

string

R/W

Match (JSON Publish)

json

R/W

Ignore Match (No Publish)

null

R/W

Tag Parameters

  • Name: Select a register name from the drop-down list. The available options depend on the names in the register table.
  • Value Type: Select a data type from the drop-down list. The available options depend on the register name selected.
  • Tag Name: Enter a name for the tag.
  • Description (Optional): Enter a description for the tag.
  • Severity: Select the severity limit.
  • Facility: Select the facility.
  • Wildcard: Select the wildcard character.
  • Hostname: Configure the hostname (String Match).
  • Appname: Configure the appname (String Match).
  • Msg ID: Configure the MessageID (String Match).
  • Message: Configure the Message (String Match).
  • Structured Data: Configure the Structured Data (Field Match).
  • Client Address: Configure the Client CIDR Address (Address Match).
  • Order: Enter a value for match process ordering.
  • Format: Configure the JSON Publish Format. This is not available if you select the Name Ignore Match (No Publish).