Log messages to the syslog server

If a syslog server is configured on the phone through the use of the parameters, the resync and upgrade operations send messages to the syslog server. A message can be generated at the start of a remote file request (configuration profile or firmware load), and at the conclusion of the operation (indicating either success or failure).

You can also configure the parameters in the phone configuration file with XML(cfg.xml) code.

Before you begin

A syslog server is installed and configured.

1

Access the phone administration web page.

2

Click Voice > System.

3

In the Optional Network Configuration section, enter the server IP in Syslog Server and optionally specify a Syslog Identifier as defined in the System log parameters table below.

4

Optionally define the content of the syslog messages using Log Request Msg, Log Success Msg, and Log Failure Msg as defined in the System log parameters table below.

The fields defining syslog message content are located in the Configuration Profile section on the Voice > Provisioning tab. If you don't specify the message content, the default settings in the fields are used. If any of the fields are cleared, the corresponding message is not generated.

5

Optionally define the log messages for firmware update using Log Upgrade Request Msg, Log Upgrade Success Msg, and Log Upgrade Failure Msg as defined in the System log parameters table below.

6

Click Submit All Changes to apply the configuration.

7

Verify the validity of the configuration.

  1. Perform a TFTP resync.

    The device generates two syslog messages during the resync. The first message indicates that a request is in progress. The second message marks the success or failure of the resync.

  2. Verify that your syslog server received messages similar to the following:

    CP-8875-K9 00:0e:08:ab:cd:ef –- Requesting resync tftp://192.168.1.200/basic.txt

    CP-8875-K9 00:0e:08:ab:cd:ef –- Successful resync tftp://192.168.1.200/basic.txt

    DP-9851-K9 A4:00:4e:ab:cd:ef –- Requesting resync tftp://192.168.1.200/basic.txt

    DP-9851-K9 A4:00:4e:ab:cd:ef –- Successful resync tftp://192.168.1.200/basic.txt

System log parameters

Table 1. Syslog Parameters

Parameter Name

Parameter navigation

Description and Default Value

Syslog Server

Voice > System

Specify the server for logging the phone system information and critical events. If both Debug Server and Syslog Server are specified, Syslog messages are also logged to the Debug Server.

Configure this parameter with one of the methods:

  • In the phone configuration file with XML(cfg.xml), enter a string in this format: <Syslog_Server ua="na">10.74.30.84</Syslog_Server>
  • In the phone administration web page, specify the Syslog server.

Syslog Identifier

Voice > System

Select the device identifier to include in syslog messages that are uploaded to the syslog server. The device identifier appears after the timestamp in each message. The options for the identifiers are:

  • None: No device identifier.

  • $MA: The MAC address of the phone, expressed as continuous lower case letters and digits. Example: c4b9cd811e29

  • $MAU: The MAC address of the phone, expressed as continuous upper case letters and digits. Example: C4B9CD811E29

  • $MAC: The MAC address of the phone in the standard colon-separated format. Example: c4:b9:cd:81:1e:29

  • $SN: The product serial number of the phone.

Default: None

Configure this parameter with one of the methods:

  • In the phone configuration file with XML(cfg.xml), enter a string in this format: <Syslog_Identifier ua="na">$MAC</Syslog_Identifier>

  • In the phone administration web page, select an identifier from the list.

Log Request Msg

Voice > Provisioning

The message that is sent to the syslog server at the start of a resync attempt. If no value is specified, the syslog message is not generated.

The default value is $PN $MAC -- Requesting resync $SCHEME://$SERVIP:$PORT$PATH

Configure this parameter with one of the methods:

  • In the phone configuration file with XML(cfg.xml), enter a string in this format: <Log_Request_Msg ua="na">$PN $MAC -- Requesting resync $SCHEME://$SERVIP:$PORT$PATH</Log_Request_Msg>

  • In the phone administration web page, customize the parameter as needed.

Log Success Msg

Voice > Provisioning

The syslog message that is issued upon successful completion of a resync attempt. If no value is specified, the syslog message is not generated.

Configure this parameter with one of the methods:

  • In the phone configuration file with XML(cfg.xml), enter a string in this format: <Log_Success_Msg ua="na">$PN $MAC -- Successful resync $SCHEME://$SERVIP:$PORT$PATH</Log_Success_Msg>

  • In the phone administration web page, customize the parameter as needed.

Log Failure Msg

Voice > Provisioning

The syslog message that is issued after a failed resync attempt. If no value is specified, the syslog message is not generated.

The default value is $PN $MAC -- Resync failed: $ERR

Configure this parameter with one of the methods:

  • In the phone configuration file with XML(cfg.xml), enter a string in this format: <Log_Failure_Msg ua="na">$PN $MAC -- Resync failed: $ERR</Log_Failure_Msg>

  • In the phone administration web page, customize the parameter as needed.

Log Upgrade Request Msg

Voice > Provisioning

Syslog message issued at the start of a firmware upgrade attempt.

Default: $PN $MAC -- Requesting upgrade $SCHEME://$SERVIP:$PORT$PATH

Configure this parameter with one of the methods:

  • In the phone configuration file with XML(cfg.xml), enter a string in this format: <Log_Upgrade_Request_Msg ua="na">$PN $MAC -- Requesting upgrade $SCHEME://$SERVIP:$PORT$PATH</Log_Upgrade_Request_Msg>

  • In the phone administration web page, customize the parameter as needed.

Log Upgrade Success Msg

Voice > Provisioning

Syslog message issued after a firmware upgrade attempt completes successfully.

The default value is $PN $MAC -- Successful upgrade $SCHEME://$SERVIP:$PORT$PATH -- $ERR

Configure this parameter with one of the methods:

  • In the phone configuration file with XML(cfg.xml), enter a string in this format: <Log_Upgrade_Success_Msg ua="na">$PN $MAC -- Successful upgrade $SCHEME://$SERVIP:$PORT$PATH -- $ERR</Log_Upgrade_Success_Msg>

  • In the phone administration web page, customize the parameter as needed.

Log Upgrade Failure Msg

Voice > Provisioning

Syslog message issued after a failed firmware upgrade attempt.

The default value is $PN $MAC -- Upgrade failed: $ERR

Configure this parameter with one of the methods:

  • In the phone configuration file with XML(cfg.xml), enter a string in this format: <Log_Upgrade_Failure_Msg ua="na">$PN $MAC -- Upgrade failed: $ERR</Log_Upgrade_Failure_Msg>

  • In the phone administration web page, customize the parameter as needed.