This document describes the procedure to find, view and download logs from a Unified Contact Center Express(UCCX) using the Command Line Interface(CLI).
There are no specific requirements for this document.
This document is not restricted to specific software and hardware versions.
The information in this document was created from the devices in a specific lab environment. All of the devices used in this document started with a cleared (default) configuration. If your network is live, ensure that you understand the potential impact of any command.
Find/View/Download Logs from the UCCX
Following are the commands to find, view and download UCCX logs from the CLI via Secure Shell(SSH):
reltime—Relative time period, specified as minutes | hours | days | weeks | months value
abstime—Absolute time period, specified as hh:mm:MM/DD/YY hh:mm:MM/DD/YY
match—Match a particular string in the filename, specified as string value
recurs—Get all files, including subdirectories
compress option allows you to download the files in a zipped format.
Note: In order to download the files, ensure that external Secure File Transfer Protocol (SFTP) server is configured and accessible.
Tip: recurs option allows you to traverse the directory for all subdirectories and files. This is used if you want to pull all logs from a directory.
View Realtime Logs
You can use the command : show open files regexp <logfile-expression-to-match> to get the currently written log(s) in realtime on the CLI. This method is useful to troubleshoot live - you can view the current log being written in memory, and then accordingly tail, view or get (download) that file from the CLI for investigation.
The command can match a regular expression that matches any log file name allowing you to troubleshoot issues in realtime (that can be reproduced live).
1. Troubleshoot an error on the Appadmin to get or view the current log while you reproduce the problem in realtime
show open files regexp MADM
Copy the path of that current file from the current directory /uccx/log/MADM/<file.log>
2. Troubleshoot an issue with Call failure on the Engine due to a step in the script while you reproduce the problem in realtime
show open files regexp MIVR
Copy the path of that current file from the current directory /uccx/log/MIVR/<file.log>
3. Troubleshoot an issue with Finesse or CUIC while you reproduce the problem in realtime
Finesse - show open files regexp Desktop-webservices
CUIC - show open files regexp CCBU-cuic
Here are a few examples of how these commands are used:
In order to view just the Finesse tomcat logs: file view activelog /desktop/finesse/logs/catalina.out
In order download the Finesse tomcat logs: file get activelog /desktop/finesse/logs/catalina.out
In order download ALL Finesse logs: file get activelog /desktop recurs compress
In order to view the system-history logs to find out the last reboot: file view install /system-history.log
Note: you don't need the '/'. Alternatively: file view install system-history.log will work as well
In order to troubleshoot NTP issues: file view activelog /syslog/sd_ntp.log
In order to download the Voice Operating System (VOS) platform database replication logs (including sysmaster, sysutils, sysuser, sysadmin, syscdr, db_phx_config, cuic_data, ccm_X_Y_Z_aaaaa_bb): file get activelog /cm/log/informix/ccm.log
In order to download the UCCX Engine (MIVR) logs: file get activelog /uccx/log/MIVR recurs compress
In order to download all of the logs from the active partition (except the install logs): file get activelog / recurs compress
In order to collect a packet capture that you took on UCCX where the name of the capture is UCCxPackets: file get activelog /platform/cli/UCCxPackets.cap
In order to view all of the service manager logs, you use a wildcard to filter only the servm logs: file list activelog /platform/log/servm*.log