set trace

Purpose

Configures a Digi device server for tracing and displays tracing information.

WARNING! Important: The set trace command should be used when working with Digi Technical Support. Enabling tracing can have an impact on system performance. Digi provides no guarantee that trace output is the same across firmware revisions.

Required permissions

For Digi products with two or more users, permissions must be set to set permissions s-trace=read to display tracing information, and to set permissions s-trace=rw to display tracing information and configure trace options. See set permissions for details on setting user permissions for commands.

Syntax

Display latest command options

The syntax and available options for set trace vary by product and product release. Enter the following command to view the current list of options:

help set trace

Configure trace options

set trace [state={off|on|dump}] 
[mode={historical|concurrent}]
[syslog={on|off}
[loghost=ip address]
[mask=type:severity]

Display tracing information

set trace

Options

state={off|on|dump}

Sets the state of the tracing function.

off

Turns the tracing function off.

on

Turns the tracing function on.

dump

Displays historical trace messages, when mode is set to historical.

mode={historical|concurrent}

Sets handling of trace messages.

historical

All trace messages stored in the buffer are displayed by issuing the command:

#> set trace state=dump

concurrent

All trace messages are printed to the administrative terminal.

syslog={on|off}

Enables or disables sending trace messages to the syslog server identified by the loghost=ip address option.

loghost=ip address

The IP address of a host to which trace messages should be sent. This host must be running the syslog daemon.

mask=type:severity

Identifies the type and nature of events that should be traced, and the severity level of the events.

type

The type of events that should be traced. Available type keywords vary among Digi devices. Enter set trace ? to view the list of types supported in the Digi device. Some commonly used trace types for diagnosing connection problems are modem and ppp. Contact Digi Technical Support for assistance in using the appropriate type keyword.

severity={assert|critical|warning|info|debug}

The severity level of events traced.

assert

Tracing applies to assert lines only. This severity level is for Digi-internal use only.

critical

Tracing applies to only the most severe events. This is the default severity level. This level produces the least amount of trace data.

warning

Tracing applies to critical events and on less severe events as well. This level produces more trace data than critical, but less than info.

info

Tracing applies to many events. It produces more trace data than assert, critical, and warning levels.

debug

Used for Digi-internal debugging purposes only.

Examples

#> set trace

trace is currently off, using historical mode
syslog is currently off, loghost is 0.0.0.0
system  : ac___     ADDP    : ac___     fwupd   : ac___     config  : ac___
printf  : ac___     inetd   : ac___     simplepw: ac___     webui   : ac___
snmp    : ac___     rciser  : ac___     portsw  : ac___     connect : ac___
sertcp  : ac___     i2c     : ac___     pmodem  : ac___     acl     : ac___
router  : ac___     nat     : ac___     edp     : ac___     dhcps   : ac___
ddns    : ac___     alarm   : ac___     user1   : ac___     user2   : ac___
user3   : ac___     user4   : ac___     user5   : ac___     user6   : ac___
user7   : ac___     user8   : ac___     user9   : ac___     user10  : ac___
ppp     : ac___     chat    : ac___     ssh     : ac___     modem   : ac___
ssi     : ac___     dns     : ac___     vpn     : ac___     treck   : ac___
address : ac___     usb     : ac___     pci     : ac___     tftp    : ac___
surelink: ac___     st      : ac___     ssl     : ac___

Output

See www.digi.com/support for descriptions and interpretations of trace output. Digi provides no guarantee that trace output is the same across firmware revisions.