Configuring System Message Logging

This chapter describes how to configure system message logging on the Catalyst 4500 series switch.

This chapter consists of these sections:

•Understanding System Message Logging

•Configuring System Message Logging

•Displaying the Logging Configuration

Note For complete syntax and usage information for the commands used in this chapter, see the
Cisco IOS Configuration Fundamentals Command Reference

http://www.cisco.com/en/US/docs/ios/fundamentals/command/reference/cf_book.html

and related publications at this location:

http://www.cisco.com/en/US/products/ps6350/index.html

Understanding System Message Logging

By default, a switch sends the output from system messages and debug privileged EXEC commands to a logging process. The logging process controls the distribution of logging messages to various destinations, such as the logging buffer, terminal lines, or a UNIX syslog server, depending on your configuration. The process also sends messages to the console.

Note The syslog format is compatible with 4.3 BSD UNIX.

When the logging process is disabled, messages are sent only to the console. The messages are sent as they are generated, so message and debug output are interspersed with prompts or output from other commands. Messages are displayed on the console after the process that generated them has finished.

You can set the severity level of the messages to control the type of messages displayed on the consoles and each of the destinations. You can time-stamp log messages or set the syslog source address to enhance real-time debugging and management. For information on possible messages, see the system message guide for this release.

You can access logged system messages by using the switch command-line interface (CLI) or by saving them to a properly configured syslog server. The switch software saves syslog messages in an internal buffer on the switch. If the switch fails, the log is lost unless you had saved it to flash memory.

You can remotely monitor system messages by viewing the logs on a syslog server or by accessing the switch through Telnet or through the console port.

Configuring System Message Logging

These sections describe how to configure system message logging:

•System Log Message Format

•Default System Message Logging Configuration

•Disabling Message Logging (optional)

•Setting the Message Display Destination Device (optional)

•Synchronizing Log Messages (optional)

•Enabling and Disabling Timestamps on Log Messages (optional)

•Enabling and Disabling Sequence Numbers in Log Messages (optional)

•Defining the Message Severity Level (optional)

•Limiting Syslog Messages Sent to the History Table and to SNMP (optional)

•Configuring UNIX Syslog Servers (optional)

System Log Message Format

System log messages can contain up to 80 characters and a percent sign (%), which follows the optional sequence number or time-stamp information, if configured. Messages are displayed in this format:

seq no:timestamp: %facility-severity-MNEMONIC:description

The part of the message preceding the percent sign depends on the setting of the service sequence-numbers, service timestamps log datetime, service timestamps log datetime [localtime] [msec] [show-timezone], or service timestamps log uptime global configuration command.

Table 40-1 describes the elements of syslog messages.

Table 40-1 System Log Message Elements 

Element
Description

seq no:

Stamps log messages with a sequence number only if the service sequence-numbers global configuration command is configured.

For more information, see the "Enabling and Disabling Sequence Numbers in Log Messages" section.

timestamp formats:

mm/dd hh:mm:ss

or

hh:mm:ss (short uptime)

or

d h (long uptime)

Date and time of the message or event. This information appears only if the service timestamps log [datetime | log] global configuration command is configured.

For more information, see the "Enabling and Disabling Timestamps on Log Messages" section.

facility

The facility to which the message refers (for example, SNMP, SYS, and so forth). For a list of supported facilities, see Table 40-4.

severity

Single-digit code from 0 to 7 that is the severity of the message. For a description of the severity levels, see Table 40-3.

MNEMONIC

Text string that uniquely describes the message.

description

Text string containing detailed information about the event being reported.


This example shows a partial switch system message: 

00:00:46: %LINK-3-UPDOWN: Interface Port-channel1, changed state to up

00:00:47: %LINK-3-UPDOWN: Interface GigabitEthernet1/0/1, changed state to up

00:00:47: %LINK-3-UPDOWN: Interface GigabitEthernet1/0/2, changed state to up

00:00:48: %LINEPROTO-5-UPDOWN: Line protocol on Interface Vlan1, changed state to down

00:00:48: %LINEPROTO-5-UPDOWN: Line protocol on Interface GigabitEthernet1/0/1, changed 
state to down 2

*Mar  1 18:46:11: %SYS-5-CONFIG_I: Configured from console by vty2 (10.34.195.36)

18:47:02: %SYS-5-CONFIG_I: Configured from console by vty2 (10.34.195.36)

*Mar  1 18:48:50.483 UTC: %SYS-5-CONFIG_I: Configured from console by vty2 (10.34.195.36)

Default System Message Logging Configuration

Table 40-2 shows the default system message logging configuration.

Table 40-2 Default System Message Logging Configuration 

Feature
Default Setting

System message logging to the console

Enabled.

Console severity

Debugging (and numerically lower levels; see Table 40-3).

Logging file configuration

No filename specified.

Logging buffer size

4096 bytes.

Logging history size

1 message.

Timestamps

Disabled.

Synchronous logging

Disabled.

Logging server

Disabled.

Syslog server IP address

None configured.

Server facility

Local7 (see Table 40-4).

Server severity

Informational (and numerically lower levels; see Table 40-3).


Disabling Message Logging

Message logging is enabled by default. It must be enabled to send messages to any destination other than the console. When enabled, log messages are sent to a logging process, which logs messages to designated locations asynchronously to the processes that generated the messages.

To disable message logging, perform this task:

 
Command
Purpose

Step 1  

Switch# configure terminal

Enters global configuration mode.

Step 2  

Switch(config)# no logging on

Disables message logging.

Step 3  

Switch(config)# end

Returns to privileged EXEC mode.

Step 4  

Switch# show running-config

or

show logging

Verifies your entries.

Step 5  

Switch# copy running-config 
startup-config

(Optional) Saves your entries in the configuration file.

Disabling the logging process can slow down the switch because a process must wait until the messages are written to the console before continuing. When the logging process is disabled, messages are displayed on the console as soon as they are produced, often appearing in the middle of command output.

The logging synchronous global configuration command also affects the display of messages to the console. When this command is enabled, messages appear only after you press Return. For more information, see the "Synchronizing Log Messages" section.

To re-enable message logging after it has been disabled, use the logging on global configuration command.

Setting the Message Display Destination Device

If message logging is enabled, you can send messages to specific locations in addition to the console.

To specify the locations that receive messages, perform this task:

 
Command
Purpose

Step 1  

Switch# configure terminal

Enters global configuration mode.

Step 2  

Switch(config)# logging buffered 
[size]

Logs messages to an internal buffer on the switch. The default buffer size is 4096. The range is 4096 to 2147483647 bytes.

If the switch, the log file is lost unless you previously saved it to flash memory. See Step 4.

Note Do not make the buffer size too large because the switch could run out of memory for other tasks. Use the show memory privileged EXEC command to view the free processor memory on the switch. However, this value is the maximum available, and the buffer size should not be set to this amount.

Step 3  

Switch(config)# logging host

Logs messages to a UNIX syslog server host.

For host, specify the name or IP address of the host to be used as the syslog server.

To build a list of syslog servers that receive logging messages, enter this command more than once.

For complete syslog server configuration steps, see the "Configuring UNIX Syslog Servers" section.

Step 4  

Switch(config)# end

Returns to privileged EXEC mode.

Step 5  

Switch# terminal monitor

Logs messages to a nonconsole terminal during the current session.

Terminal parameter-setting commands are set locally and do not remain in effect after the session has ended. You must perform this step for each session to see the debugging messages.

Step 6  

Switch# show running-config

Verifies your entries.

Step 7  

Switch# copy running-config 
startup-config

(Optional) Saves your entries in the configuration file.

The logging buffered global configuration command copies logging messages to an internal buffer. The buffer is circular, so newer messages overwrite older messages after the buffer is full. To display the messages that are logged in the buffer, use the show logging privileged EXEC command. The first message displayed is the oldest message in the buffer. To clear the contents of the buffer, use the
clear logging privileged EXEC command.

To disable logging to the console, use the no logging console global configuration command. To disable logging to a file, use the no logging file [severity-level-number | type] global configuration command.

Synchronizing Log Messages

You can synchronize unsolicited messages and debug privileged EXEC command output with solicited device output and prompts for a specific console port line or virtual terminal line. You can identify the types of messages to be output asynchronously based on the level of severity. You can also configure the maximum number of buffers for storing asynchronous messages for the terminal after which messages are dropped.

When synchronous logging of unsolicited messages and debug command output is enabled, unsolicited device output appears on the console or printed after solicited device output appears or printed. Unsolicited messages and debug command output appears on the console after the prompt for user input is returned. Therefore, unsolicited messages and debug command output are not interspersed with solicited device output and prompts. After the unsolicited messages are displayed, the console again displays the user prompt.

To configure synchronous logging, perform this task:

 
Command
Purpose

Step 1 

configure terminal

Enters global configuration mode.

Step 2 

line [console | vty] line-number [ending-line-number]

Specifies the line to be configured for synchronous logging of messages.

•Use the console keyword for configurations that occur through the switch console port.

•Use the line vty line-number command to specify which vty lines are to have synchronous logging enabled. You use a vty connection for configurations that occur through a Telnet session. The range of line numbers is from 0 to 15.

You can change the setting of all 16 vty lines at once by entering:

line vty 0 15

Or you can change the setting of the single vty line being used for your current connection. For example, to change the setting for vty line 2, enter:

line vty 2

When you enter this command, the mode changes to line configuration.

Step 3 

logging synchronous [level [severity-level | all] | limit number-of-buffers]

Enables synchronous logging of messages.

•(Optional) For level severity-level, specify the message severity level. Messages with a severity level equal to or higher than this value are printed asynchronously. Low numbers mean greater severity and high numbers mean lesser severity. The default is 2.

•(Optional) Specifying level all means that all messages are printed asynchronously regardless of the severity level.

•(Optional) For limit number-of-buffers, specify the number of buffers to be queued for the terminal after which new messages are dropped. The range is 0 to 2147483647. The default is 20.

Step 4 

end

Returns to privileged EXEC mode.

Step 5 

show running-config

Verifies your entries.

Step 6 

copy running-config startup-config

(Optional) Saves your entries in the configuration file.

To disable synchronization of unsolicited messages and debug output, use the
no logging synchronous [level severity-level | all] [limit number-of-buffers] line configuration command.

Enabling and Disabling Timestamps on Log Messages

Note By default, log messages are not time-stamped.

To enable time-stamping of log messages, perform this task:

 
Command
Purpose

Step 1 

configure terminal

Enters global configuration mode.

Step 2 

service timestamps log uptime

or

service timestamps log datetime [msec] [localtime] [show-timezone]

Enables log time-stamps.

The first command enables time-stamps on log messages, showing the time since the system was rebooted.

The second command enables time-stamps on log messages. Depending on the options selected, the timestamp can include the date, time in milliseconds relative to the local time zone, and the time zone name.

Step 3 

end

Returns to privileged EXEC mode.

Step 4 

show running-config

Verifies your entries.

Step 5 

copy running-config startup-config

(Optional) Saves your entries in the configuration file.

To disable time-stamps for both debug and log messages, use the no service timestamps global configuration command.

This example shows part of a logging display with the service timestamps log datetime global configuration command enabled: 

*Mar  1 18:46:11: %SYS-5-CONFIG_I: Configured from console by vty2 (10.34.195.36)

This example shows part of a logging display with the service timestamps log uptime global configuration command enabled: 

00:00:46: %LINK-3-UPDOWN: Interface Port-channel1, changed state to up

Enabling and Disabling Sequence Numbers in Log Messages

Because more than one log message can have the same timestamp, you can display messages with sequence numbers so that you can unambiguously refer to a single message. By default, sequence numbers in log messages are not displayed.

To enable sequence numbers in log messages, perform this task. This procedure is optional.

 
Command
Purpose

Step 1 

configure terminal

Enters global configuration mode.

Step 2 

service sequence-numbers

Enables sequence numbers.

Step 3 

end

Returns to privileged EXEC mode.

Step 4 

show running-config

Verifies your entries.

Step 5 

copy running-config startup-config

(Optional) Saves your entries in the configuration file.

To disable sequence numbers, use the no service sequence-numbers global configuration command.

This example shows part of a logging display with sequence numbers enabled: 

000019: %SYS-5-CONFIG_I: Configured from console by vty2 (10.34.195.36)

Defining the Message Severity Level

You can limit messages displayed to the selected device by specifying the severity level of the message, which are described in Table 40-3.

To define the message severity level, perform this task. This procedure is optional.

 
Command
Purpose

Step 1 

configure terminal

Enters global configuration mode.

Step 2 

logging console level

Limits messages logged to the console.

By default, the console receives debugging messages and numerically lower levels (see Table 40-3).

Step 3 

logging monitor level

Limits messages logged to the terminal lines.

By default, the terminal receives debugging messages and numerically lower levels (see Table 40-3).

Step 4 

logging trap level

Limits messages logged to the syslog servers.

By default, syslog servers receive informational messages and numerically lower levels (see Table 40-3).

For complete syslog server configuration steps, see the "Configuring UNIX Syslog Servers" section.

Step 5 

end

Returns to privileged EXEC mode.

Step 6 

show running-config

or

show logging

Verifies your entries.

Step 7 

copy running-config startup-config

(Optional) Saves your entries in the configuration file.

Note Specifying a level causes messages at that level and numerically lower levels to be displayed at the destination.

To disable logging to the console, use the no logging console global configuration command. To disable logging to a terminal other than the console, use the no logging monitor global configuration command. To disable logging to syslog servers, use the no logging trap global configuration command.

Table 40-3 describes the level keywords. It also lists the corresponding UNIX syslog definitions from the most severe level to the least severe level.

Table 40-3 Message Logging Level Keywords 

Level Keyword
Level
Description
Syslog Definition

emergencies

0

System unstable

LOG_EMERG

alerts

1

Immediate action needed

LOG_ALERT

critical

2

Critical conditions

LOG_CRIT

errors

3

Error conditions

LOG_ERR

warnings

4

Warning conditions

LOG_WARNING

notifications

5

Normal but significant condition

LOG_NOTICE

informational

6

Informational messages only

LOG_INFO

debugging

7

Debugging messages

LOG_DEBUG


The software generates four other categories of messages:

•Error messages about software or hardware malfunctions, displayed at levels warnings through emergencies. These types of messages mean that the functionality of the switch is affected. For information on how to recover from these malfunctions, see the system message guide for this release.

•Output from the debug commands, displayed at the debugging level. Debug commands are typically used only by the Technical Assistance Center.

•Interface up or down transitions and system restart messages, displayed at the notifications level. This message is only for information; switch functionality is not affected.

•Reload requests and low-process stack messages, displayed at the informational level. This message is only for information; switch functionality is not affected.

Limiting Syslog Messages Sent to the History Table and to SNMP

If you enabled syslog message traps to be sent to an SNMP network management station by using the snmp-server enable trap global configuration command, you can change the level of messages sent and stored in the switch history table. You also can change the number of messages that are stored in the history table.

Messages are stored in the history table because SNMP traps are not guaranteed to reach their destination. By default, one message of the level warning and numerically lower levels (see Table 40-3) are stored in the history table even if syslog traps are not enabled.

To change the level and history table size defaults, perform this task. This procedure is optional.

 
Command
Purpose

Step 1 

configure terminal

Enters global configuration mode.

Step 2 

logging history level1

Changes the default level of syslog messages stored in the history file and sent to the SNMP server.

See Table 40-3 for a list of level keywords.

By default, warnings, errors, critical, alerts, and emergencies messages are sent.

Step 3 

logging history size number

Specifies the number of syslog messages that can be stored in the history table.

The default is to store one message. The range is 0 to 500 messages.

Step 4 

end

Returns to privileged EXEC mode.

Step 5 

show running-config

Verifies your entries.

Step 6 

copy running-config startup-config

(Optional) Saves your entries in the configuration file.

1 Table 40-3 lists the level keywords and severity level. For SNMP usage, the severity level values increase by 1. For example, emergencies equal 1, not 0, and critical equals 3, not 2.

When the history table is full (it contains the maximum number of message entries specified with the logging history size global configuration command), the oldest message entry is deleted from the table to allow the new message entry to be stored.

To return the logging of syslog messages to the default level, use the no logging history global configuration command. To return the number of messages in the history table to the default value, use the no logging history size global configuration command.

Configuring UNIX Syslog Servers

The next sections describe how to configure the UNIX server syslog daemon and how to define the UNIX system logging facility.

Logging Messages to a UNIX Syslog Daemon

Before you can send system log messages to a UNIX syslog server, you must configure the syslog daemon on a UNIX server. This procedure is optional.

Log in as root, and perform these steps:

Note Some recent versions of UNIX syslog daemons no longer accept by default syslog packets from the network. If this is the case with your system, use the UNIX man syslogd command to decide what options must be added to or removed from the syslog command line to enable logging of remote syslog messages.

Step 1 Add a line such as the following to the file /etc/syslog.conf: 

local7.debug /usr/adm/logs/cisco.log

The local7 keyword specifies the logging facility to be used; see Table 40-4 for information on the facilities. The debug keyword specifies the syslog level; see Table 40-3 for information on the severity levels. The syslog daemon sends messages at this level or at a more severe level to the file specified in the next field. The file must already exist, and the syslog daemon must have permission to write to it.

Step 2 Create the log file by entering these commands at the UNIX shell prompt: 

$ touch /var/log/cisco.log

$ chmod 666 /var/log/cisco.log

Step 3 Make sure the syslog daemon reads the new changes: 

$ kill -HUP `cat /etc/syslog.pid`

For more information, see the man syslog.conf and man syslogd commands on your UNIX system.

Configuring the UNIX System Logging Facility

When sending system log messages to an external device, you can cause the switch to identify its messages as originating from any of the UNIX syslog facilities.

Beginning in privileged EXEC mode, follow these steps to configure UNIX system facility message logging. This procedure is optional.

 
Command
Purpose

Step 1 

configure terminal

Enters global configuration mode.

Step 2 

logging host

Logs messages to a UNIX syslog server host by entering its IP address.

To build a list of syslog servers that receive logging messages, enter this command more than once.

Step 3 

logging trap level

Limits messages logged to the syslog servers.

Be default, syslog servers receive informational messages and lower. See Table 40-3 for level keywords.

Step 4 

logging facility facility-type

Configures the syslog facility. See Table 40-4 for facility-type keywords.

The default is local7.

Step 5 

end

Returns to privileged EXEC mode.

Step 6 

show running-config

Verifies your entries.

Step 7 

copy running-config startup-config

(Optional) Saves your entries in the configuration file.

To remove a syslog server, use the no logging host global configuration command, and specify the syslog server IP address. To disable logging to syslog servers, enter the no logging trap global configuration command.

Table 40-4 lists the UNIX system facilities supported by the software. For more information about these facilities, consult the operator's manual for your UNIX operating system.

Table 40-4 Logging Facility-Type Keywords 

Facility Type Keyword
Description

auth

Authorization system

cron

Cron facility

daemon

System daemon

kern

Kernel

local0-7

Locally defined messages

lpr

Line printer system

mail

Mail system

news

USENET news

sys9-14

System use

syslog

System log

user

User process

uucp

UNIX-to-UNIX copy system


Displaying the Logging Configuration

To display the logging configuration and the contents of the log buffer, use the show logging privileged EXEC command. For information about the fields in this display, see the Cisco IOS Configuration Fundamentals Command Reference, Release 12.3.