Command Syntax Conventions

CAUTION : The CLI is a diagnostic interface designed to perform diagnostic and operational tasks and functions, and is not designed for use as a persistent operating environment monitoring tool. If you need to perform persistent continuous monitoring please consult Cisco TAC or your Cisco Professional Services partners for further guidance.

This document uses these command syntax conventions.

Convention

Description

bold

Bold text indicates commands and parameters that you enter as shown.

italic

Italic text indicates parameters for which you supply values.

<x>

Angle brackets enclose a parameter for which you supply values. This is typically used instead of italic text when there is no space between adjacent parameters.

[x]

Square brackets enclose an optional parameter.

|

A vertical line, called a pipe, indicates a choice within a set of parameters.

Note: The brief description in the alarm table entry may contain values that are specific to one alarm occurrence, such as an IP address. These values may differ in all alarms that are combined into one table entry, but only the values for the first alarm are displayed. To see the individual alarms, use the errorlog command or the viewexlog command.

Syntax: alarm

checklic

Shows the type and number of licenses installed.

Note: The system may take up to 15 seconds to process this information.

Syntax: checklic

clearalarm

Clears either all the alarms in the alarm table or just the alarm specified.

Running this command stops the system from calling the system administrator (if it has been configured to do so).

Syntax: clearalarm {reference-number | all}

cleardb

Clears the following Application Server data:

All user profiles except the admin and guest user profiles

All user groups except the System group

All user recordings

All conference recordings

You must be signed in to the Application Server CLI as the root user to enter this command.

Use this command for specific situations; as instructed in the documentation or as recommended by Cisco TAC. It first clears the database, then restarts all Cisco Unified MeetingPlace services. Upon restarting, ConfSchd service executes a ConfSchd db table rebuild to clean up other dependent tables. When the ConfSchd db table rebuild is completed and all other MeetingPlace services are up, then the prompt returns.

Note: If the Application Server is in a failover or in a RSNA deployment, then turn off replication before running this command. Be sure that the Application Server is in active mode before running this command.

Syntax: cleardb

cpstatus

Displays information about each active call, including the associated meeting ID, whether the system dialed out to the endpoint, and whether the call uses video.

Syntax: cpstatus

cptrace

Lists selected portions of the call processing trace log.

Syntax: cptrace

date

Displays the time and date for the Application Server.

If you are logged in as a root user, then you can also set the date and time based on the local time zone.

Syntax: date [MMDDhhmm[YYYY][.ss]]

Parameters (available only to root users):

MM -- month, specified by two digits

DD -- day, specified by two digits

hh -- hour, specified by two digits in 24-hour format

mm -- minute, specified by two digits

YYYY -- calendar year, specified by four digits

.ss -- second, specified by two digits and a preceding period (.)

dbupdate

Deletes all entries in the Cisco Unified MeetingPlace database, so that the database is the equivalent of that in a newly installed Cisco Unified MeetingPlace system. This means that all user groups, user profiles, video terminal profiles, remote servers, meeting categories, and all meeting records are deleted from the system except the standard, preconfigured items, such as the System user group.

You configured Directory Service on your system, and you need to change the LDAP directory with which Cisco Unified Communications Manager is integrated. If you do not clear the database before switching from one LDAP directory to another, then all the user profiles from the first LDAP directory will remain in the Cisco Unified MeetingPlace database until you manually delete them.

The automatic Directory Service deletion of user profiles does not apply when you change the LDAP directory. For details about when and how the system automatically deletes Directory Service user profiles, see Directory Service User Profile Deletion.

-t -- Displays the log output in real time. This option is useful for troubleshooting issues in real time. For example, you can enter eventlog -G -t and then place a test call to the system to see how the system responds to the incoming call and to any subsequent user input.

| more -- Displays the log output one screen at a time.

exc

Displays the meaning of an exception code that was listed in the errorlog or viewexlog command output.

Syntax: exc [-v] exception-code

hostname

Displays the hostname of the Application Server.

Syntax: hostname

infocap

Captures configuration details and logs from the system for a particular time period. The output file is a zip file that is stored in the /tmp directory. The system gives the exact location after compiling the information.

The begin and end dates and times must be in the format [YY]MMDDhhmm. The YY is optional and if not specified, the system uses the current year. For format details, see the parameters for the date command.

Syntax: infocap -bbegin-date-and-time-eend-date-and-time

langinfo

Displays information about all installed locales including the following:

Locale ID

Language code

Locale order

Locale name

Country code

Locale version number

Syntax: langinfo

mtginfo

Displays information about a specific meeting. Searches for a meeting based on any of these:

Unique conference ID (such as 125). (This number is output by certain commands such as cptrace -C and errorlog. It uniquely identifies a meeting.)

Meeting ID (such as 1278). Can optionally use any of the time arguments.

Unique user ID (such as 0x65). (This number is output by certain commands such as userinfo. It uniquely identifies a user.) Searches for all meetings that a user has attended or been invited to.

Activity. Searches only for active meetings.

Time. Searches for all meetings valid at a certain time with the -t argument or between two times when the -s and -e arguments are used together.

Note: The start and end times must be in the format YYMMDDhhmm. All parameters are optional. If they are not all present, the system starts processing from the right. For format details, see the parameters for the date command.

mtginfo -m 1234 Looks for the meeting with the ID of 1234 at the current time

mtginfo -m 1234 -t 11 Looks for meeting with the ID of 1234 at 11 minutes after the current hour

mtginfo -m 1234 -t 1111111111 Looks for meeting with the ID of 1234 at 11:11am on Nov 11, 2011

mtginfo -a 1430 Looks for meetings that are active at 2:30pm today

mtginfo -s 1430 -e 1530 Looks for meetings that started or ended between 2:30 and 3:30pm today

mtginfo -c 123 Looks for meeting with the unique conference ID of 123

mtginfo -u 123 -t 1111 -e 1211 Looks for meetings that the user with the unique user ID of 123 is invited to between 11:11 and 12:11 today

net

Lists the current network configuration settings and allows you to change them after the system has been installed. Most changes take affect after restarting the system.

Caution! A system restart terminates all existing call connections. Proceed only during a scheduled maintenance period or during a period of extremely low usage. NOTE: When you restart the Web Server, all manual changes made to the registry are lost.

Note: If you change the Application Server hostname (for eth0), then you must also perform the following actions:

Configure the DNS server to point the old hostname to the new hostname.

Restart the application by entering either the mpx_sysrestart operating system command or the reboot Linux command. NOTE: When you restart the Web Server, all manual changes made to the registry are lost.

Note the following requirements and restrictions for operating system commands:

With the exception of the mpx_sys command, use the operating system commands to start or stop services only when you have been explicitly told to do so by Cisco TAC. Use of these commands may cause unpredictable results.

If you are not logged in as the root user, you must enter sudo before you can run any of these commands. For example, to stop all application services, go to the command line and enter the following:

sudo ./mpx_app stop

The preceding example assumes that you are already in the /etc/init.d directory. If you are not in that directory, you instead enter the following:

sudo /etc/init.d/mpx_app stop

Existing call connections will not be terminated by stopping services on the Application Server. However, starting or restarting services will terminate those calls. This behavior applies:

Caution! A system restart terminates all existing call connections. Proceed only during a scheduled maintenance period or during a period of extremely low usage.

NOTE: When you restart the Web Server, all manual changes made to the registry are lost.

Note: If the restart process is interrupted, you will have to reenter the mpx_sys restart command. For example, the restart process may be interrupted by a power outage, by closing the SSH connection, or by another restart process that is initiated from a different terminal.

The output messages from each command execution are displayed on the screen and stored in a log file under the directory $MP_LOGDIR/database/replication/logs. The log file names have the format mp_replication_log.<YYYY-MM-DD_hh-mm-ss>.

Table: Command Reference: Database Replication Commands

Command

Description

mp_replication init

Makes necessary changes in configuration files and database to enable the Application Server to use database replication. Run this command on each node involved in replication.

-ssite -- Specifies the site of the node on which you run this command. Valid values for site are 1 and 2.

-nnode -- Specifies the node (within the specified site) on which you run the command. Valid values for node are 1 and 2.

-llocal-server -- (Optional) Specifies the hostname or IP address of the Application Server on which you run this command.

For intra-site replication, which is used for Application Server Failover, specify the hostname or IP address of the virtual network interface eth0:0.

By default, the (eth0 hostname) value returned by the hostname command is used.

-rremote-server -- Specifies the hostname or IP address of the other Application Server with which to establish replication.

-h -- Specifies intra-site replication, which is used for replication between the active and standby Application Server in a single-site active/standby failover deployment.

-m -- Specifies inter-site replication, which is used for replication between two singleServer mode Application Servers (i.e, site 1 and site 2) in Reservationless Single Number Access (RSNA) deployment.

-v -- Specifies verbose output.

mp_replication switchON

Starts replication between two Application Servers.

Run this command on node 1 only.

Run this command only after running the mp_replication init command on each node involved in replication.

Note: The mode setting may not be successful if this process is interrupted, for example, by a power outage, by closing the SSH connection, or by a system restart. To view the failover mode, log in to the Administration Center. If the wrong failover deployment mode appears at the top of the page, enter the mpx_sysrestart command, followed by the failoverUtil setServer command.

NOTE: When you restart the Web Server, all manual changes made to the registry are lost.

Syntax: failoverUtil setServer {active | standby}

failoverUtil status

Displays the current modes of the Application Server, specifically:

Whether the server is deployed for failover or as a single server.

If deployed for failover, then whether the server is in active or standby mode.