Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server
From DocWiki
Main page: Cisco Unified MeetingPlace, Release 8.0
Up one level: Reference Information
You can use the command-line interface (CLI) on the Application Server to perform functions that cannot be performed in the Administration Center.
CAUTION : The CLI is a diagnostic interface designed to perform diagnostic and operational tasks, and is not designed for use as persistent operating environment monitoring tool. If such a need exists please consult Cisco TAC or your Cisco Professional Services partners for further guidance
Note: The CLI on the Application Server is not the same as the CLI on the Cisco WebEx Node for MCS. For information about the latter, see the Using the Command-Line Interface (CLI) on the Cisco WebEx Node for MCS module.
- CLI User Level Options on the Application Server
- Restrictions for the CLI on the Application Server
- How to Sign in to the CLI on the Application Server
- Application Server Command Reference
CLI User Level Options on the Application Server
CLI User Level | Description |
---|---|
mpxadmin |
We recommend that you use this user level whenever possible. |
root |
Highest authority, enabling you to do the following:
Caution! For security reasons, we do not recommend signing in directly as the root user, unless you need to reset the root user or mpxadmin user passwords or uninstall the system. |
Related Topics
- Signing in to the CLI on the Application Server By Using the Console
- Signing in to the CLI on the Application Server By Using SSH
- Password Recovery for the Cisco Unified MeetingPlace Application Server module
Restrictions for the CLI on the Application Server
- The CLI and its commands are available only in English.
- The CLI accepts only the standard 128 ASCII characters.
- Many commands you enter might prompt you for information. If the Backspace key does not delete characters in this interactive mode, use one of the following options:
- Press the Delete key to delete the previous character.
- Press Ctrl-W to delete the previous word.
- Press Ctrl-U to delete the entire line.
How to Sign in to the CLI on the Application Server
- Signing in to the CLI on the Application Server By Using the Console
- Signing in to the CLI on the Application Server By Using SSH
Signing in to the CLI on the Application Server By Using the Console
You can sign in to the CLI from the console by using either the mpxadmin or root usernames. This is the only way you can sign in directly as the root user. You can enter operating system commands here.
Procedure
- Connect the monitor, keyboard, and mouse to the Application Server.
- The Cisco Unified MeetingPlace operating system sign-in page is displayed.
- For the username, enter mpxadmin.
- Enter the password for the mpxadmin user.
- This was established during installation.
- Right-click the desktop and select Open Terminal.
- A command window appears. You can start entering commands. This is a Linux operating system so all commands should be either Linux commands or Cisco Unified MeetingPlace operating system commands. See the Operating System Commands for the Application Server for information about the operating system commands.
- When you are finished with the command window, either enter exit or select the X in the top right corner.
- Note: Always sign out of the Cisco Unified MeetingPlace operating system when you are finished.
Related Topics
Signing in to the CLI on the Application Server By Using SSH
This section provides one method of signing in to the CLI by using SSH. Other methods might be available for you.
Restriction
Only the mpxadmin user can sign in to the CLI remotely using SSH. If needed, you can later switch to the root user by entering su.
Before You Begin
You need a remote connection with a non-configurable terminal emulation program, such as the Windows SSH client, to sign in to the CLI remotely using SSH.
Procedure
- From your computer, go to Start > Programs > SSH Secure Shell > Secure Shell Client.
- Select Quick Connect.
- In the Connect to Remote Host window, enter these values:
Field | Value |
---|---|
Host Name |
IP address of your Cisco Unified MeetingPlace system |
User Name |
mpxadmin |
Port Number |
22 |
Authentication Method |
leave as <Profile Settings> |
- 4. Select Connect.
- 5. In the Enter Password window, enter the password for the mpxadmin user.
- This was established during installation.
- 6. Select OK.
- The system displays the command line, and you can now enter commands.
Related Topics
- Signing in to the CLI on the Application Server By Using the Console
- Application Server Command Reference
Application Server Command Reference
- Command Syntax Conventions
- Application Commands for the Application Server
- Operating System Commands for the Application Server
- Database Replication Commands for the Application Server
- Failover Commands for the Application Server
Command Syntax Conventions
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. |
[x | y] |
Square brackets enclosing parameters separated by a pipe indicate an optional choice. |
{x | y} |
Braces enclosing parameters separated by a pipe indicate a required choice. |
[x {y | z}] |
Braces and a pipe within square brackets indicate a required choice within an optional element. |
Application Commands for the Application Server
Table: Command Reference: Application Commands for the Application Server
Command | Description |
---|---|
activity |
Displays a quick, verbose, or complete status of all ports or a range of ports. Allows you to make a test call and show all meetings.
|
alarm |
Displays the Alarm Table:
Note: The brief description in the alarm table entry might contain values that are specific to one alarm occurrence, such as an IP address. These values might differ in all alarms that are combined into one table entry, but only the values for the most recent alarm are displayed. To see the individual alarms, use the errorlog command or the viewexlog command.
|
ccamon |
Monitors the Call Control Agent. Allows you to view the call statistics and set the log tracing level.
|
checklic |
Shows the type and number of licenses installed. Note: The system can take up to 15 seconds to process this information.
|
clearalarm |
Clears either all the alarms in the alarm table or just the alarm specified.
|
cleardb |
Clears the following Application Server data:
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.
|
cptrace |
Lists selected portions of the call processing trace log.
|
date |
Displays the time and date for the Application Server.
|
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. Caution! Deleting all database entries is an irreversible operation. Before you run the dbupdate command, consider backing up and archiving the database. See Backing Up, Archiving, and Restoring Data on the Cisco Unified MeetingPlace Application Server module.
|
errorlog |
Displays the Exception Log output one screen at a time:
|
eventlog |
Displays the system event log. Note: This command has many parameter options; only the most commonly used parameters are listed below.
Note: To show events for the current day, you can omit the YY, MM, and DD parameters from the start and end times.
|
exc |
Displays the meaning of an exception code that was listed in the errorlog or viewexlog command output.
|
hostname |
Displays the hostname of the Application Server.
|
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.
|
infocapmtg |
Gathers a system information capture file around the time of a meeting.
|
langinfo |
Displays information about all installed locales including the following:
|
mtginfo |
Displays information about a specific meeting. Searches for a meeting based on any of these:
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. Note: Start and end times in the command output are adjusted for the Meeting ID start guard time (minutes) and Meeting ID end guard time (minutes) fields on the Meeting Configuration Page.
|
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: If you change the Application Server hostname (for eth0), then you must also perform these actions:
|
ntpdate |
Sets the Application Server date and time to match the time obtained by polling an NTP (2) server.
|
swstatus |
Displays information about Cisco Unified MeetingPlace, including the following:
|
taccli |
Displays details on the mixer status, active meetings, participant details, and general statistics, including the following:
|
techui |
Displays statistics for the Media Server, ports, and conferences.
|
userinfo |
Displays information about a specific user. Searches for a user based on any of these:
|
userutil |
Performs administrative functions for any user profile.
|
viewexlog |
Provides the entire Exception Log output all at once:
|
Footnote 1: DNS = Domain Name System
Footnote 2: NTP = Network Time Protocol
Related Topics
Operating System Commands for the Application Server
In addition to the commands listed in Table: Command Reference: Operating System Commands for the Application Server, the CLI supports the standard Linux operating system commands. You can use the vim command to view or modify text files if necessary.
These are the 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 might cause unpredictable results.
- If you are not signed 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 this command:
- 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, instead enter this command:
- 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:
- To the mpx_app, mpx_sys, and mpx_va commands.
- If the Application Server crashes and is reloaded.
- If you enter the shutdown or reboot Linux command on the Application Server.
Table: Command Reference: Operating System Commands for the Application Server
Command | Description |
---|---|
mpx_app |
Starts, stops, or restarts all Cisco Unified MeetingPlace application services.
|
mpx_axlds |
Starts, stops, or restarts Directory Service and external AXL authentication through Cisco Unified Communications Manager.
|
mpx_db |
Starts, stops, or restarts Cisco Unified MeetingPlace database services.
|
mpx_lm |
Starts, stops, or restarts Cisco Unified MeetingPlace license manager services.
|
mpx_rmi |
Starts, stops, or restarts messaging integration services for Cisco Unified MeetingPlace Click-to-Conference for IBM Lotus Sametime Instant Messaging.
|
mpx_rssctrl |
Starts, stops, or restarts the Cisco Unified MeetingPlace recording and streaming service.
|
mpx_snmp |
Starts, stops, or restarts SNMP services.
|
mpx_sys |
Starts, stops, or restarts all Cisco Unified MeetingPlace services. 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: If the restart process is interrupted, you will have to reenter the mpx_sys restart command. For example, the restart process might be interrupted by a power outage, by closing the SSH connection, or by another restart process that is initiated from a different terminal.
|
mpx_tomcat |
Starts, stops, or restarts Apache Tomcat services.
|
mpx_tomcatmon |
Starts, stops, or restarts Apache Tomcat monitoring services.
|
mpx_va |
Starts, stops, or restarts Media Server services on the Application Server.
|
mpx_version |
Lists all installed versions of Cisco Unified MeetingPlace.
|
mpx_webx |
Starts, stops, or restarts all Cisco WebEx integration services on the Application Server.
|
resetmsapassword |
Resets the Hardware Media Server Administration password to "cisco".
|
shutdown |
Shuts down the Application Server.
|
Related Topics
- Configuring Application Server Failover for Cisco Unified MeetingPlace module
- Changing the Media Server Administration Password for the Hardware Media Server in the Changing Values for the Hardware Media Server module
Database Replication Commands for the Application Server
Note: To enter the database replication commands in Table: Command Reference: Database Replication Commands for the Application Server:
- The MeetingPlace Database services must be running on the Application Server.
- You must be signed in to the Application Server CLI as the root user.
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 for the Application Server
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.
|
mp_replication switchON |
Starts replication between two Application Servers.
|
mp_replication status |
Displays the status of replication between the specified servers.
|
mp_replication switchOFF |
Stops replication, but does not restore configuration changes.
|
mp_replication teardown |
Removes configuration changes made on the local server for replication with the specified remote server. Run this command on each node involved in replication to undo the configuration changes.
|
Related Topics
- Configuring Cisco Unified MeetingPlace Directory Service module
- Configuring Application Server Failover for Cisco Unified MeetingPlace module
Failover Commands for the Application Server
Note: You must be signed in to the Application Server CLI as the root user to enter the failover commands in Table: Command Reference: Failover Commands for the Application Server.
Table: Command Reference: Failover Commands for the Application Server
Command | Description |
---|---|
failoverUtil copyConfigFiles |
Transfers configuration files from one Application Server to the other, specifically:
|
failoverUtil restoreConfigFiles |
Completes the transfer of configuration files from one Application Server to the other, specifically:
Note: The failoverUtil copyConfigFiles and failoverUtil restoreConfigFiles commands are entered on separate Application Servers.
|
failoverUtil setDeployment failover |
Sets up an Application Server for failover deployment, including the configuration of the virtual network interface (eth0:0) hostname, IP address, subnet mask, and default gateway.
|
failoverUtil setDeployment singleServer |
Restores a failover-deployed Application Server to a single-server deployment.
|
failoverUtil setServer |
Sets a failover-deployed Application Server to either active or standby mode.
Note: The mode setting might 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, sign in to the Administration Center. If the wrong failover deployment mode appears at the top of the page, enter the mpx_sys restart command, followed by the failoverUtil setServer command.
|
failoverUtil status |
Displays the current modes of the Application Server, specifically:
|