Updated 10/28/2011
Often times, its necessary to access a CUCM server via the CLI instead of the web server. If you've not done much of this yet, the command structure may seem a little awkward. It's nothing like IOS and can give many voice and network engineers pause when they first encounter it. I've compiled a list of commands that are quite useful to keep in your toolbelt in this post.
While working with TAC on various issues, I've run into a couple gems that I will add to this list. If you have some that you'd like to add here - I'd love to hear from you!
Initiate the CLI
First and foremost, you remotely access the CLI via a secure SSH session to the CUCM. If you do not have remote access to the CUCM via SSH, you can also gain access to the CLI via a locally attached keyboard and monitor.
Delete Commands
delete account : deletes an administrator account, use with caution!
delete process : delete a specific process
File Commands
file check : Checks the /usr directory for files or directories that have changed in size since installation
file delete : Like it sounds, deletes a file or files
file dump : Dumps the contents of a file to the screen
file get : Sends the file to another system by using SFTP
file list : Lists log files in one of various log directories
file search : Searches the contents of a file
file tail : Shows the last few lines of a log file
file view : Displays the contents of a file
Run Commands
run sql : Allows user to run an SQL query
Set Commands
set account : Creates a new account on the operating system
set cli pagination : Turns pagination on or off for the current CLI session
set logging : Allows you to enable or disable CLI Admin logs.
set network status : Allows you to shutdown Ethernet 0, or enable it if previously shutdown.
set password : Changes the administrator password. 'Security' refers to the security password that authenticates communication between servers - requires servers be restarted following this change.
Show Commands
show account : Lists current administrator accounts, except the master administrator account.
show cli pagination : Displays the status of automatic CLI pagination
show ctl : Displays the contents of the Certificate Trust List (CTL) file on the server. This is useful as it also determines if the CTL is invalid.
show diskusage : See information about disk usage on the server for various directories, i.e., activelog, common, inactivelog, install, tftp, tmp
show environment : Displays information about the server hardware
show hardware : Displays useful information related to hardware type, serial numbers, etc.
show logins : Displays recent logins to the server
show memory : Displays information about the systems memory
show myself : Shows information about the current account
show network : Very useful information when trying to troubleshoot network information, shows various aspects of the server's network configuration
show network ipprefs : Another useful command when verifying that a server application should be accessible
show open : Displays open files and ports on the system, could be useful when trying to diagnose bugs the result in ports being hung open
show packages active * : Displays all active packages installed on the system
show perf : There is a collection of commands that begin with "show perf" that provide access to the performance counters collected by the server. (Rather extensive to explain here, perhaps another blog entry in the future?)
show process : Displays information about processes running on the server. There is a large number of parameters and options available with this command. See full Cisco documentation for more details (listed at bottom of blog)
show risdb : Allows user to query the Realtime Information Service (RIS) database on the server
show status : Shows basic platform status and information
show tech all : Displays output of all 'show tech' commands - may be requested by TAC in some rare cases
show version : Displays the software version on either the active or inactive partition
Unset Commands
unset network : Allows user to unset various DNS options
Utils Commands
utils create report : Creates reports about the server in the platform/log directory
utils csa disable : Stops the Cisco Security Agent (CSA)
utils csa enable : Starts the Cisco Security Agent (CSA)
utils csa status : Indicates the current status of the Cisco Security Agent (CSA)
utils dbreplication : There are a collection of commands related to cluster replication and synchronization. PROCEED WITH CAUTION. There is a much more extensive discussion of replication needed to explain these commands and when/how to use them.
utils diagnose test : Runs all diagnostic commands but does not attempt to fix problems. I've used this command to diagnose a known bug related to the Tomcat server failing while server accepts no additional connections, for example.
utils network arp : Displays content of the server's arp table
utils network capture eth0 : Captures network traffic for later analysis
utils ntp restart : Restarts the NTP service
utils reset_ui_administrator_name : Changes main administrator username on CUCM system
utils reset_ui_administrator_password : Resets the main administrator password
utils service : Allows the user to list services and their status as well as restart, stop, start, etc.
utils snmp hardware-agents restart : Restarts the snmp hardware-agents on the server, including the snmp service itself.
utils snmp hardware-agents status : Displays the status of the hardware agents on the server.
utils system restart : Restarts the system, does not disconnect your SSH connection
Full CLI documentation can be found here.
