configure syslog add

configure syslog add [ipaddress {udp-port {udp_port}} | ipPort | ipaddress tls_port {tls_port}] {vr vr_name} [local0...local7]

Description

Configures the remote Syslog server host address, and filters messages to be sent to the remote Syslog target.

Syntax Description

ipaddress Specifies the remote Syslog server IP address.
ipPort Specifies the UDP port number for the Syslog target.
tls_port Specifies remote Syslog server Transport Layer Security (TLS) for connection type.
tls_port TLS port number (default is 6514).
vr_name

Specifies the virtual router that can reach the server IP address.

Note: User-created VRs are supported only on the platforms listed for this feature in the ExtremeXOS 22.7 Feature License Requirements document.
local0 ... local7 Specifies the local Syslog facility.

Default

If a virtual router is not specified, VR-Mgmt is used. If UDP port is not specified, 514 is used. If TLS port is not specified, 6514 is used.

Usage Guidelines

Options for configuring the remote Syslog server include:
  • ipaddress—The IP address of the remote Syslog server host
  • ipPort—The UDP port
  • vr_name—The virtual router that can reach the Syslog host
  • local0-local7—The Syslog facility level for local use

The switch log overwrites existing log messages in a wrap-around memory buffer, which may cause you to lose valuable information once the buffer becomes full. The remote Syslog server does not overwrite log information, and can store messages in non-volatile files (disks, for example).

The enable syslog command must be issued in order for messages to be sent to the remote Syslog server(s). Syslog is disabled by default. A total of four Syslog servers can be configured at one time.

When a Syslog server is added, it is associated with the filter DefaultFilter. Use the configure log target filter command to associate a different filter.

The Syslog facility level is defined as local0 – local7. The facility level is used to group Syslog data.

Example

The following example adds the remote Syslog server with an IP address of 10.0.0.1:
configure syslog add 10.0.0.1 local1
The following example adds the remote Syslog server with an IP address of 2001:11::123:
configure syslog add 2001:11::123 local1

History

This command was first available in ExtremeXOS 10.1.

The ipPort parameter was first available in ExtremeXOS 11.0.

The udp-port parameter and support for the EMS (Event Management System) to send log messages to Syslog servers having IPv6 address was added in ExtremeXOS 21.1.

Transport Layer Security (TLS) option added in ExtremeXOS 22.1.

Platform Availability

This command is available on the Summit X450-G2, X460-G2, X670-G2, X770, and ExtremeSwitching X440-G2, X590, X620, X690, X870 series switches.