This document describes CLI tools and commands on Unified Communications Operating System.The Command Line Interface (CLI) tool is used to execute CLI commands on the Unified Communications Operating System and help diagnose and troubleshoot problems with the CAD services.
Executing CLI Commands
The CLI tool framework automatically loads when the user logs into the Unified Communications Operating System as an administrator.
To execute CLI commands:-
1. Log into the Unified Communications Operating System as an administrator. CLI starts.
2. At the admin prompt, type the desired CLI command.
CLI Command Syntax
Pathkey, Key, and Value are mandatory fields and case sensitive.
If a key or value contains spaces, enclose the string with double quotes. For example:
set uccx cad prefs SiteSetup "LDAP Host 5" "cal lab.lab.com"
NOTE: All commands are case sensitive.
show uccx cad license usage
Displays the available and used license information.
Displays the description of the command.
help utils service list
utils service list
Displays the status of all services running on the Unified Communications Operating System.
utils uccx dump packets
Copies active span-based monitoring packets into the specified file.
• <Capturefile.cap>: Name of the file into which the packets must be copied. The file must have a CAP extension.
• <Time interval>: Captures the packets for the specified time. The value for time interval must be in seconds.
NOTE: Make sure the time interval specified is less than 180 seconds. If the time interval is longer than 180 seconds, the process continues without stopping, leading to more memory and space usage.
utils uccx dump packets capturefile.cap 5
show uccx cad prefs <pathkey>
Displays key value pairs for the specified preferences file.
Example: show uccx cad prefs SiteSetup
set uccx cad prefs
Sets the key value pairs with a new value.
• Pathkey: Name of the CAD service’s preferences.
• Key: The name of the key that you want to set with a new value.
• Value: Specify a new value.
set uccx cad prefs SiteSetup "LDAP Host 5" 0
show uccx recordings allowed
Displays the maximum amount of disk size allowed for
show uccx recordings space
Displays the total size of all the recording files.
utils uccx recordings
purge <size in MB>
Deletes the specified size of recording files on or before the cutoff date. No recordings newer than the cutoff
date will be purged.
• Size in MB: Value must be a positive real number.
• Cutoff date: Value can be any recognizable date as specified by the Unix system date command.
If users in our organization are on the phone (Cisco 7841's) and someone tries to call them 1 of 2 things will happen. If the user (receiving the call) has VM setup the incoming call goes directly to VM but there is NO indication that a call has bee...
Hello, Is there someplace that a step-by-step guide exists to do an upgrade of UCCX version 12.5 from SU1 to SU2? We just installed the system a few weeks ago and already see many bugs. We were told be a TAC engineer that upgrading to SU2 would solve...
Hello everyone,, i have Cisco 2900 running as a VOIP gateway that connected to E1 interface that provide ISDN service ,, and connected to the 3cx server as SIP gateway,, i need to add another E1 interface to use another voice number ...
Our IVRs are down, calls are not going to the IVR because the CUC trunk has no service (503). We have a cucm cluster.Site 1CUCM Pub and SubCUC pubSite 2CUCM subCUC sub Site 1 is down - The CUCM group works but I'm seeing the CUC sip trunk didn't...