Log System Management Commands
This chapter describes the command-line interface (CLI) commands that you can use to debug the Broadband Access Center (BAC) Device Provisioning Engine (DPE), and monitor and manage the BAC log system.
Note Before using any debug command, ensure that DPE debugging is enabled. Run the debug on command to enable this function.
The commands described in this chapter are:
•clear logs
•debug dpe
–debug dpe cache
–debug dpe connection
–debug dpe dpe-server
–debug dpe event-manager
–debug dpe exceptions
–debug dpe framework
–debug dpe messaging
–debug dpe tftp
•debug on
•no debug
•log level
•show log
•show syslog
•syslog log-server
•no syslog log-server
•syslog mode
clear logs
Use this command to remove historic (out-of-date) log files that exist on the system. These files include:
•DPE logs
•hardware
•Syslog
Over time, historic log files accumulate within the DPE. The support bundle state command is used to bundle these logs. We recommend that you create a bundle before clearing logs. This ensures that no necessary files are lost accidently.
Usage Guidelines
Use this command on both hardware and Solaris DPEs.
Syntax Description
No keywords or arguments.
Examples
Clearing historic log files...
+ Removing 1 DPE log files...
debug dpe
Use this general command form to debug the various services on the DPE.
Note If you run the following commands on an unlicensed DPE, a message similar to this one appears:
This DPE is not licensed. Your request cannot be serviced.
Please check with your system administrator for a DPE license.
Table 6-1 describes the specific commands you can use to debug the DPE.
Table 6-1 List of debug dpe Commands
|
|
|
|
|
debug dpe cache no debug dpe cache |
Enables DPE cache debug logging, which involves messages pertaining to the DPE cache including: •Logging requests for cache entries •Updates to the cache •Other interactions by DPE subsystems To disable DPE cache debug logging, use the no form of this command. |
P |
P |
|
debug dpe connection no debug dpe connection |
Enables the debugging of the DPE connection, which logs communication subsystem status and error messages. Use this command to identify communication problems between the DPE and the RDU. To disable the debugging of the DPE connection, use the no form of this command. |
P |
P |
dpe# debug dpe connection
dpe# no debug dpe connection
|
debug dpe dpe-server no debug dpe dpe-server |
Enables debugging of the DPE server, which involves logging messages about the overall status and issues of the DPE server. To disable the debugging of the DPE server, use the no form of this command. |
P |
P |
dpe# debug dpe dpe-server
dpe# no debug dpe dpe-server
|
debug dpe event-manager no debug dpe event-manager |
Enables debugging of the DPE event manager, which involves logging messages and conditions showing the state of the event manager. Debugging of the DPE event manager is enabled by default. To disable debugging of the DPE event manager, use the no form of this command. |
P |
P |
dpe# debug dpe event-manager
dpe# no debug dpe event-manager
|
debug dpe exceptions no debug dpe exceptions |
Enables the debugging of DPE exceptions, which involves logging full stack traces for exceptions occurring during system operation. In unusual situations, such as when the system is apparently corrupt or behaving abnormally, running this command reveals valuable information for the Cisco TAC support. Debugging of DPE exceptions is enabled by default. To disable the debugging of DPE exceptions, use the no form of this command. |
P |
P |
dpe# debug dpe exceptions
dpe# no debug dpe exceptions
|
debug dpe framework no debug dpe framework |
Enables the debugging of the DPE framework, which involves logging information about the underlying framework of the DPE server. This infrastructure provides for all the various servers in BAC. Debugging of the DPE framework is enabled by default. To disable the debugging of the DPE framework, use the no form of this command. |
P |
P |
dpe# no debug dpe framework
|
debug dpe messaging no debug dpe messaging |
Enables debugging of DPE messaging, which involves logging details about the DPE messaging subsystem. This subsystem is used primarily for communication between the DPE and the RDU. To disable the debugging of DPE messaging, use the no form of this command. |
P |
P |
% OK
dpe# no debug dpe messaging
|
debug dpe tftp no debug dpe tftp |
Enables the debugging of TFTP transfers. To disable the debugging of TFTP transfers, use the no form of this command. |
P |
P |
|
debug on
Use this command to enable debug logging, which can be helpful when troubleshooting possible system problems. Additionally, you must separately enable specific debugging categories with commands such as debug dpe cache.
Caution
Enabling debug logging may have a severe impact on DPE performance. Do not leave the DPE running with debug turned on for an extended period of time.
If you run this command on an unlicensed DPE, a message similar to this one appears:
This DPE is not licensed. Your request cannot be serviced.
Please check with your system administrator for a DPE license.
To disable debug logging, run the no debug command. See no debug.
Usage Guidelines
Use this command on both hardware and Solaris DPEs.
Syntax Description
No keywords or arguments.
Examples
no debug
Use this command to disable all debug logging.
If you run this command on an unlicensed DPE, a message similar to this one appears:
This DPE is not licensed. Your request cannot be serviced.
Please check with your system administrator for a DPE license.
To enable debug logging, see debug on.
Usage Guidelines
Use this command on both hardware and Solaris DPEs.
Syntax Description
No keywords or arguments.
Examples
log level
Use this command to set the level of minimum DPE log messages that are saved, as described in the Cisco Broadband Access Center Administrator Guide, 2.7.1.
If you run this command on an unlicensed DPE, a message similar to this one appears:
This DPE is not licensed. Your request cannot be serviced.
Please check with your system administrator for a DPE license.
Usage Guidelines
Use this command on both hardware and Solaris DPEs.
Syntax Description
log level number
number—Identifies the logging level, by number, to be saved. Table 6-2 describes the log levels that BAC supports.
Table 6-2 DPE Log Levels
|
|
0-emergency |
Saves all emergency messages |
1-alert |
Saves all activities that need immediate action and those of a more severe nature |
2-critical |
Saves all critical conditions and those of a more severe nature |
3-error |
Saves all error messages and those of a more severe nature |
4-warning |
Saves all warning messages and those of a more severe nature |
5-notification |
Saves all notification messages and those of a more severe nature |
6-info |
Saves all logging messages available |
Note Setting a specific log level saves messages less than or equal to the configured level. For example, when you set the log level at 5-notification, all events generating messages with a log level of 4 or less are written into the log file.
The logging system's log levels are used to identify the urgency with which you might want to address log issues. The 0-emergency setting is the most severe level of logging, while 6-info is the least severe, saving mostly informational log messages.
Examples
show log
Use this command to show all recent log entries for the DPE. These logs contain general DPE process information, including logging all system errors or severe problems. Check this log when the system is experiencing difficulties. If the log contains insufficient information, enable the debug logging function and experiment with the different categories related to the problem.
Usage Guidelines
Use this command on both hardware and Solaris DPEs.
Syntax Description
show log [last 1..999 | run]
•last 1..999—Shows the specified number of recent log entries for the DPE, with 1..999 specifying the number of log entries that you want to display. This keyword is optional.
•run—Displays the running DPE log, which starts showing all messages logged to the DPE log. The command continues to run until you press Enter. This keyword is optional.
Examples
Example 1
dpe.cisco.com: 2006 12 21 11:22:20 GMT: %BPR-DPE-5: DPE-0: Device Provisioning Engine
starting up
Note The output presented in this example has been trimmed for demonstration purposes.
Example 2
dpe.cisco.com: 2006 12 21 11:28:17 GMT: %BPR-DPE-5: DPE-0: Device Provisioning Engine
starting up
Example 3
dpe.cisco.com: 2006 12 21 11:43:43 GMT: %BPR-DPE-5: DPE-0: Device Provisioning Engine
starting up
dpe.cisco.com: 2006 12 21 11:43:44 GMT: %BPR-DPE-5: Info DPE: Attempt to connect to RDU
BPR_host.cisco.com:49187 failed;
dpe.cisco.com: 2006 12 21 11:43:44 GMT: %BPR-DPE-5: Info TFTP: Ready to service requests
show syslog
Use this command to show all recent DPE syslog entries. The syslog file contains information about the general DPE system, including alerts from various processes related to the DPE. Check this log when the system is experiencing difficulties.
Usage Guidelines
Use this command only on a hardware DPE.
Syntax Description
show syslog [last 1..999 | run]
•last 1..999—Shows the specified number of recent syslog log entries, with 1..999 specifying the number of log entries that you want to display. This keyword is optional.
•run—Displays the running syslog log, which starts showing all messages logged to the syslog file. The command continues to run until you press Enter. This keyword is optional.
Examples
Example 1
Feb 8 14:44:38 test-dpe3 syslogd 1.4.1: restart.
Feb 8 14:49:38 test-dpe3 anacron[1654]: Job `cron.weekly' started
Feb 8 14:49:38 test-dpe3 anacron[3069]: Updated timestamp for job `cron.weekly' to
2007-02-08
Feb 8 14:49:38 test-dpe3 anacron[1654]: Normal exit (2 jobs run)
Note The output presented in this example has been trimmed for demonstration purposes.
Example 2
Feb 8 14:49:38 test-dpe3 anacron[1654]: Normal exit (2 jobs run)
Example 3
Jan 2 16:27:37 test-dpe2 BPR: %DPE-1-109: Failed to connect to RDU
syslog log-server
Use this command to configure the log server to send syslog messages whenever the syslog is set in:
•Remote mode, which configures the syslog subsystem to send messages remotely.
•Both mode, which configures the syslog subsystem to send messages to a remote server and a local file system.
When you configure the log server in local mode, changing this setting has no effect. For information on logging the syslog messages in remote, local, or both modes, see syslog mode.
After you use this command, run the reload command so that the changes take effect. See
reload, page 2-16.
To clear the settings assigned to the syslog server, use the no form of this command. See
no syslog log-server.
Usage Guidelines
Use this command only on a hardware DPE.
Syntax Description
syslog log-server x.x.x.x
x.x.x.x—Identifies the IP address of the log server.
Examples
dpe# syslog log-server 10.10.10.15
% OK (Requires appliance restart "> reload")
no syslog log-server
Use this command to clear the settings assigned to the syslog server. When the syslog mode is set to both or remote, clearing the syslog log server results in the log mode being automatically set back to local mode until a new log server is configured.
After you use this command, run the reload command so that the changes take effect. See
reload, page 2-16.
To configure the log server to send syslog messages whenever the syslog is set in remote or both mode, see syslog log-server.
Usage Guidelines
Use this command only on a hardware DPE.
Syntax Description
No keywords or arguments.
Examples
dpe# no syslog log-server
% OK (Requires appliance restart "> reload")
syslog mode
Use this command to configure the syslog subsystem to send messages to a remote server, a local file system, or both.
After you use this command, run the reload command so that the changes take effect. See
reload, page 2-16.
Usage Guidelines
Use this command only on a hardware DPE.
Syntax Description
syslog mode {remote | local | both}
•remote—Configures the syslog subsystem to log messages to a remote server and not to a local server. The remote system must be configured to accept syslog messages.
•local—Configures the syslog subsystem to log messages to a local file server only.
•both—Configures the syslog subsystem to send messages to a remote server and also to the local file server.
Examples
Example 1
% OK (Requires appliance restart "> reload")
Example 2
% OK (Requires appliance restart "> reload")
Example 3
% OK (Requires appliance restart "> reload")