Configuration Guide for Cisco Unified MeetingPlace Release 8.6
Using the Command-Line Interface (CLI) on the Application Server
Downloads: This chapterpdf (PDF - 233.0KB) The complete bookPDF (PDF - 7.28MB) | Feedback

Using the Command-Line Interface (CLI) on the Application Server

Table Of Contents

Using the Command-Line Interface (CLI) on the Application Server

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

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

Creating Additional Administrator User Accounts on Cisco Unified MeetingPlace Application Servers

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


Using the Command-Line Interface (CLI) on the Application Server


You can use the command-line interface (CLI) on the Application Server to perform functions that cannot be performed in the Administration Center.


Note The CLI on the Application Server is not the same as the CLI on the Cisco WebEx Node. For information about the latter, see Using the Command-Line Interface (CLI) on the Cisco WebEx Node for MCS.


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

Creating Additional Administrator User Accounts on Cisco Unified MeetingPlace Application Servers

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:

Enter Operating System Commands for the Application Server, though pseudo (sudo) root access can also be used.

Enter Database Replication Commands for the Application Server or Failover Commands for the Application Server.

Reset the root or mpxadmin user passwords.

Uninstall the system.

To get to the root user level, do one of the following:

Sign in as the mpxadmin user, and enter su - at the command line.

Sign in directly as the root user—this is possibly only by Signing in to the CLI on the Application Server By Using the Console.


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

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


Step 1 Connect the monitor, keyboard, and mouse to the Application Server.

The Cisco Unified MeetingPlace operating system sign-in page is displayed.

Step 2 For the username, enter mpxadmin.

Step 3 Enter the password for the mpxadmin user.

This was established during installation.

Step 4 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" section for information about the operating system commands.

Step 5 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

Application Server Command Reference

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 -.


Note If you incorrectly type the mpxadmin password 3 times when starting a SSH session to the Application Server, then the mpxadmin account is locked. To unlock the account, sign in directly (not remotely) on the command-line interface of the Application Server as the root user, and enter faillog -r. Once the command completes, sign out and retry the SSH session.


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


Step 1 From your computer, go to Start > Programs > SSH Secure Shell > Secure Shell Client.

Step 2 Select Quick Connect.

Step 3 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>


Step 4 Select Connect.

Step 5 In the Enter Password window, enter the password for the mpxadmin user.

This was established during installation.

Step 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

Creating Additional Administrator User Accounts on Cisco Unified MeetingPlace Application Servers

This procedure shows you how to mitigate security concerns by creating multiple accounts with root access and an audit trail on the Application Server.

Set up and add new users with the root account. Limit knowledge of the root password so you will know the actions of each user. Once these accounts are set up, you will have user-level accounting of all actions through syslog in the /var/log/secure file.

In this procedure, we are adding user, user123.


Step 1 Sign in to the Application Server command-line interface as the root user.

Step 2 Create additional users with root access and set their passwords.

[root@mp_appserver ~]# useradd <user123>
[root@mp_appserver ~]# passwd <user123>
Changing password for user user123.
New UNIX password: 
Retype new UNIX password: 
passwd: all authentication tokens updated successfully.
 
   

Step 3 Add the users to the mpx group. (In the next step, you will enable the mpx group to run the same commands as the mpxadmin user.)

[root@mp_appserver ~]# usermod -G mpx <user123>
 
   

Step 4 Use the visudo command to add group mpx to the /etc/sudoers file. Add the following lines to this file to give the mpx group access to the same commands as the mpxadmin user:

%mpx ALL=(root) NOPASSWD:/opt/cisco/meetingplace/database/db-maintenance/archive.sh
%mpx ALL=(root) NOPASSWD:/opt/cisco/meetingplace/database/db-maintenance/backup.sh
%mpx ALL=(root) NOPASSWD:/opt/cisco/meetingplace/database/db-maintenance/restore.sh
%mpx ALL=(root) 
NOPASSWD:/opt/cisco/meetingplace/database/db-maintenance/update_statistics.sh
%mpx ALL=(root) NOPASSWD:/opt/cisco/meetingplace/application/current/bin/sim
%mpx ALL=(root) NOPASSWD:/opt/cisco/meetingplace/application/current/bin/gyromain
%mpx ALL=(root) NOPASSWD:/opt/cisco/meetingplace/application/current/bin/sysdown
%mpx ALL=(root) NOPASSWD:/opt/cisco/meetingplace/application/current/bin/startup
%mpx ALL=(root) NOPASSWD:/opt/cisco/meetingplace/application/current/bin/net
%mpx ALL=(root) NOPASSWD:/opt/cisco/meetingplace/bin/mpx_sys
%mpx ALL=(root) NOPASSWD:/opt/cisco/meetingplace/bin/mpx_version
%mpx ALL=(root) NOPASSWD:/etc/init.d/mpx_app
%mpx ALL=(root) NOPASSWD:/etc/init.d/mpx_axlds
%mpx ALL=(root) NOPASSWD:/etc/init.d/mpx_db
%mpx ALL=(root) NOPASSWD:/etc/init.d/mpx_fo
%mpx ALL=(root) NOPASSWD:/etc/init.d/mpx_lm
%mpx ALL=(root) NOPASSWD:/etc/init.d/mpx_rssctrl
%mpx ALL=(root) NOPASSWD:/etc/init.d/mpx_snmp
%mpx ALL=(root) NOPASSWD:/etc/init.d/mpx_tomcat
%mpx ALL=(root) NOPASSWD:/etc/init.d/mpx_tomcatmon
%mpx ALL=(root) NOPASSWD:/etc/init.d/mpx_webx
%mpx ALL=(root) NOPASSWD:/etc/init.d/mpx_rmi
%mpx ALL=(root) NOPASSWD:/opt/cisco/meetingplace/application/current/bin/resetmsapassword
 
   

Step 5 The users you added to the mpx group can now sign in to their own account, and run any of the commands listed in the previous step, by using the sudo command. For example:

$ ssh <user123>@<a.b.c.d>
<user123>@<a.b.c.d>'s password: 
[<user123>@mp_appserver ~]$ sudo mpx_sys
 
   
We trust you have received the usual lecture from the local System
Administrator. It usually boils down to these two things:
 
   
#1) Respect the privacy of others.
#2) Think before you type.
 
   
Password:
[<user123>@mp_appserver ~]$ sudo /opt/cisco/meetingplace/bin/mpx_version
 
   
List Cisco Unified Communications Product
==============================================
Cisco Unified MeetingPlace "8.6.<x.y>" ...
Cisco Unified MeetingPlace "8.6.<a.b>" ...
.
.
.
 
   

After a user executed the preceding commands, the following would be logged in /var/log/secure:

Sep 11 23:50:48 mp_appserver sshd[6944]: Accepted password for user123 from 
::ffff:198.18.30.67 port 48623 ssh2
Sep 11 23:41:35 mp_appserver sudo:  user123 : TTY=pts/0 ; PWD=/home/user123 ; USER=root ; 
COMMAND=/opt/cisco/meetingplace/bin/mpx_version

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 1 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.

Parameters:

-p—Displays all ports, port status, and ports in use.

Syntax: activity

Alias: vuimon

alarm

Displays the Alarm Table:

REFNO—Reference number used with the clearalarm command to clear a specific alarm table entry.

SEV—Severity, either major (MAJ) or minor (MIN). See "Alarm Severity Levels".

CODE—See Code.

COUNT —See Count.

FIRST—See First Time.

LAST—See Last Time.

UNIT—See Unit.

SW MODULE—See Express Media Module.

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.

Syntax: alarm

ccamon

Monitors the Call Control Agent. Allows you to view the call statistics, set the log tracing level, and lists current system resource usage on EMS systems.

Syntax: ccamon

checklic

Shows the type and number of licenses installed.

Note The system can 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.

If there are any major alarms in the alarm table, the system can be configured to call the system administrator after every restart until all major alarms are deleted from the alarm table. See "Configuring the System to Call You If There is a Major Alarm".

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

Syntax: clearalarm {reference-number | all}

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 signed in as a root user, 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.


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 Application Server.

Use this command only in these situations:

Cisco TAC instructs you to do so.

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, all 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".

errorlog

Displays the Exception Log output one screen at a time:

Date of the event

Time of the event

Severity (major, minor, informational, or warning)

Exception code

Brief description

In contrast, the viewexlog command provides the entire Exception Log output all at once.

Syntax: errorlog

eventlog

Displays the system event log.

Note This command has many parameter options; only the most commonly used parameters are listed below.

Syntax: eventlog [-b [YY][MMDD]hhmm] [-e [YY][MMDD]hhmm] [-G | -C] [-t] [| more]

Parameters:

-b—Specifies a start time for the log events to include in the output.

-e—Specifies an end time for the log events to include in the output.

Note To show events for the current day, you can omit the YY, MM, and DD parameters from the start and end times.

YY—Calendar year, specified by two digits. Typically, this parameter is included only when troubleshooting issues around the start of a new calendar year.

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

-G—Shows the telephony and conference events and control messages from the Call Processing-Media Control Protocol (CPMCP) component, which is a proxy for the Media Server.

-C—Limits log output to events for the conference scheduler (ConfSchd) component.

-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.

-T—Displays SIP call trace.

-v—Shows an event log for VUI events and displays the text of prompts that are being played.

-v7—Shows a detailed event log for VUI events and displays the text of prompts that are being played.

-n—Displays NMP agent trace.

i6

exc

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

Syntax: exc [-v] exception-code

hastatus

Displays the status of all the nodes in a multinode deployment. It also shows the status of the conferencing resource on each node, the status of TSP connections and the status of the Meeting Director resource.

Syntax: hastatus

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.

Restrictions:

You must be signed in as the root user to run this command.

You can also get this information by completing "Obtaining and Viewing the System Information Capture (Infocap) Log". Use this command only if you are unable to get the information from the Cisco Unified MeetingPlace Administration Center.

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.

The maximum size of an individual log file inside the infocap is 100 MB. This applies to logs created from an individual log file on your application server, a log created by patching multiple logs from your application server, and logs created by running commands such as eventlog or viewexlog on your application server CLI.

Syntax: infocap -b begin-date-and-time -e end-date-and-time

Parameters:

-b—The beginning date and time.

-e—The ending date and time.

infocap2

Captures configuration details and logs from a multinode 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.

Restrictions:

You must be signed in as the root user to run this command.

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: infocap2 -b begin-date-and-time -e end-date-and-time -h host -s

Parameters:

-b—The beginning date and time.

-e—The ending date and time.

-h—The hostname.

-s—Limits log collection to the current node only.

infocapmtg

Gathers a system information capture file around the time of a meeting.

Syntax: infocapmtg [meetingID] [-S | -P | -B minutes] [-n username | -p profilename] [-b beginning-time -e ending-time]

Parameters:

meetingID—Captures information about a specific meeting ID.

-S—Captures information about the specified meeting ID when it was scheduled.

-P—Stops the capture when the meeting was purged.

-B minutes—Adds a buffer of minutes before or after the start or stop of the capture.

-n username—Captures information about the first meeting where the specified user was a participant.

-p profilename—Captures information about the first meeting where the specified user profile was a participant.

-b beginning-time -e ending-time—Captures information about the meeting between the beginning and ending time.

Examples:

infocapmtg 1212 Gathers a system information capture file starting at the time meeting 1212 began and ending when meeting 1212 ended.

infocapmtg 1212 -S Gathers a system information capture file starting at the time someone scheduled meeting 1212 and ending when meeting 1212 ended.

infocapmtg 1212 -B 5 Gathers a system information capture file starting 5 minutes before meeting 1212 began and ending 5 minutes after meeting 1212 ended.

infocapmtg -n username -b 0950 -e 1400 Gathers a system information capture file starting for a meeting scheduled by or attended by username where the meeting started between 9:50 a.m. and 2:00 p.m. today.

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

maintmode

Configures your maintenance mode settings.

Syntax: maintmode [ on | restrict | off | clear | hour | halfhour | help | ? ]

Parameters:

on—Turn maintenance override on.

restrict—Turn maintenance override to restrict activity with no time limit.

off—Turn maintenance override off but do not change maintenance windows. This command does not trigger a restart. To restart run the normal CLI commands to restart the application.

clear—Turn maintenance override off and clear all maintenance windows.

hour—Create a maintenance window for the next hour. Applies this value to the first empty maintenance window available.

halfhour—Create a maintenance window for the next half hour. Applies this value to the first empty maintenance window available.

?—help

No parameters: Displays current maintenance windows and status.

mbdstatus

Displays a list of meetings and resource status on each node, as seen by the active Meeting Broker Director node.

Syntax: mbdstatus [-a]

Parameters:

-a—Includes the current active meeting list from each of the active nodes in the system.

mpstatus

Configures your Cisco Unified MeetingPlace status settings.

Syntax: mpstatus [ all | help | ? | g | h | m | s | t ]

all—Show everything.

help—Show help.

?—Show help.

g—Include gwstatus.

h—Include HA status.

m—Include MBD status.

s—Include application software status.

t—Include topology map.

w—Include web TSPP status.

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.

Syntax: mtginfo -a  time -c unique-conf-id -e end-time -m meeting-id -s start-time -t time -u unique-user-id

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.

Examples:

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.

You must be signed in as root before running this command.


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

Use the net command to set the following:

Port configuration parameters, including:

Application Server (eth0) hostname, IP address, subnet mask, and default gateway

Virtual (eth0:0) hostname, IP address, subnet mask, and default gateway—the eth0:0 virtual interface is used in Application Server Failover deployments

MTU and link parameters (auto-negotiation, speed, duplex).

Domain name

DNS servers

NTP servers

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

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

Restart the application by entering either the mpx_sys restart operating system command or the reboot Linux command.

If you enabled SSL for the Application Server, complete the "Generating a Certificate Signing Request and Obtaining the Certificate" and "Uploading the Certificate File and Enabling SSL" sections.

If you installed MeetingPlace Conference Manager, complete the "Editing an Existing Server" section.

If your system includes a Web Server, complete the "Changing the Cisco Unified MeetingPlace Application Server Connection Configured in the Gateway SIM" section.

If you integrated the system with Cisco WebEx, notify the Cisco WebEx administrator to update the Cisco Unified MeetingPlace hostname that is configured in the Cisco WebEx license manager.

Syntax: net

ntpdate

Sets the Application Server date and time to match the time obtained by polling an NTP2 server.

Syntax: ntpdate [-u] ntp-server

Parameters:

-u—Specifies to send packets through an unprivileged port to communicate with the NTP server. Use this option when you want to reach an NTP server that is beyond a firewall.

ntp-server—Hostname or IP address of the NTP server.

ReplStatus

Displays the entries in the Remote Server table. The display should show all the nodes in the deployment.

Syntax: ReplStatus -l

Parameters:

-l—Lists the entries in the Remove Server table.

swstatus

Displays information about Cisco Unified MeetingPlace, including the following:

Version number

System mode

Status of the power supplies

List of software modules loaded in to memory, their version number, and their status

Syntax: swstatus

taccli

Displays details on the mixer status, active meetings, participant details, and general statistics, including the following:

Cisco Unified MeetingPlace request statistics

Statistics or status for one or all channels

Statistics or details for one or all conferences

Mixer status, request failures, and mixer return code table

Video resolution and frame rate of each connection that is made to the Express Media Server

Also does the following:

Resets Cisco Unified MeetingPlace request statistics

Enables and disables tracing

Shows the current date and time

Starts and stops channel RTP recording

Starts and stops voice activity detection (VAD)

Syntax: taccli

userinfo

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

Username

Profile number

Unique user ID (such as 0x65). The unique user ID is output by certain commands. It uniquely identifies a user but does not display the name of the user.

Syntax: userinfo {user-id | profile-number | unique-user-id}

userutil

Performs administrative functions for any user profile.

Restriction: You cannot set the admin user to inactive, locked, or the group default.

Syntax: userutil {-q | [-p | -P] [-n | -N] [-a | -i | -l | -g]} userid [password]

Parameters:

-q—Displays user profile information and status.

-p—Reset the User password. Requires a password entry.

-P—Reset the User password and force it to expire. This forces the user to change the password at the next sign-in attempt. Requires a password entry.

-n—Reset the Profile PIN (PIN for authentication over the phone). Requires a password entry.

-N—Reset the Profile PIN and force it to expire. Requires a password entry.

-a—Set User status to active.

-i—Set User status to inactive.

-l—Set User status to locked.

-g—Set User status to group default setting.

useridUsername.

pasword—New User password or Profile PIN. Required if you enter -p, -P, -n, or -N.

viewexlog

Provides the entire Exception Log output all at once:

Date of the event

Time of the event

Severity (major, minor, informational, or warning)

Exception code

Brief description

In contrast, the errorlog command displays the Exception Log output one screen at a time:

Syntax: viewexlog

vuimon

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.

Parameters:

-p—Displays all ports and port status.

Syntax: vuimon

Alias: activity

1 DNS = Domain Name System

2 NTP = Network Time Protocol


Related Topics

Using the Command-Line Interface (CLI) on the Application Server

Using Alarms and Logs on Cisco Unified MeetingPlace

Operating System Commands for the Application Server

In addition to the commands listed in Table 2, 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 2 Command Reference: Operating System Commands for the Application Server 

Command
Description

mpx_app

Starts, stops, or restarts all Cisco Unified MeetingPlace application services.

Syntax: mpx_app {start | stop | restart | status} [-v]

mpx_axlds

Starts, stops, or restarts Directory Service and external AXL authentication through Cisco Unified Communications Manager.

Syntax: mpx_axlds {start | stop | restart | status} [-v]

mpx_db

Starts, stops, or restarts Cisco Unified MeetingPlace database services.

Syntax: mpx_db {start | stop | restart | status} [-v]

mpx_lm

Starts, stops, or restarts Cisco Unified MeetingPlace license manager services.

Syntax: mpx_lm {start | stop | restart | status} [-v]

mpx_rmi

Starts, stops, or restarts messaging integration services for Cisco Unified MeetingPlace Click-to-Conference for IBM Lotus Sametime Instant Messaging.

Syntax: mpx_rmi {start | stop | restart | status} [-v]

mpx_rssctrl

Starts, stops, or restarts the Cisco Unified MeetingPlace recording and streaming service.

Syntax: mpx_rssctrl {start | stop | restart | status} [-v]

mpx_snmp

Starts, stops, or restarts SNMP services.

Syntax: mpx_snmp {start | stop | restart | status} [-v]

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.

Syntax: mpx_sys {stop | restart | status} [-v]

mpx_tomcat

Starts, stops, or restarts Apache Tomcat services.

Syntax: mpx_tomcat {start | stop | restart | status} [-v]

mpx_tomcatmon

Starts, stops, or restarts Apache Tomcat monitoring services.

Syntax: mpx_tomcatmon {start | stop | restart | status} [-v]

mpx_va

Starts, stops, or restarts Media Server services on the Application Server.

If all other Cisco Unified MeetingPlace services continue running, then entering this command does not interrupt meetings that are active.

Syntax: mpx_va {start | stop | restart | status} [-v]

mpx_version

Lists all installed versions of Cisco Unified MeetingPlace.

Syntax: mpx_version

mpx_webx

Starts, stops, or restarts all Cisco WebEx integration services on the Application Server.

Syntax: mpx_webx {start | stop | restart | status} [-v]

resetmsapassword

Resets the Hardware Media Server Administration password to "cisco".

Syntax: resetmsapassword

shutdown

Shuts down the Application Server.

For a graceful shutdown, we recommend that you enter the command using the syntax below. You can see which other options are available by entering shutdown without any parameters.

Syntax: shutdown -h now


Related Topics

Using the Command-Line Interface (CLI) on the Application Server

Configuring Application Server Failover on MeetingPlace-Scheduled and Audio-Only Deployments

Changing the Media Server Administration Password for the Hardware Media Server in the "Changing Values for the Hardware Media Server" section of the Installation, Upgrade, and Migration Guide for Cisco Unified MeetingPlace

Database Replication Commands for the Application Server


Note To enter the database replication commands in Table 3:

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 3 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.

Syntax: mp_replication init -n node -r remote-server [-v]

Parameters:

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

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

-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.

Syntax: mp_replication switchON [-S -F from-sync] [-v]

Parameters:

-S -F from-sync—Indicates data synchronization between the two Application Servers.


Note Both Application Servers must be in standby mode when the -S -F options are used.


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

-v—Specifies verbose output.

mp_replication status

Displays the status of replication between the specified servers.

Syntax: mp_replication status [-v]

Parameter: -v—Specifies verbose output.

In the output, if the replication is not working, the queue size will be either a fixed value or keep increasing with database changes in any server.

The State shows the connection status, for example, dropped, disconnected, and so forth.

mp_replication switchOFF

Stops replication, but does not restore configuration changes.

Run this command on node 1 only.

To restart replication, use the mp_replication switchON command.

To restore the configuration changes done by the mp_replication init command, use the mp_replication teardown command.

Syntax: mp_replication switchOFF [-v]

Parameters: See the mp_replication init command.

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.

Syntax: mp_replication teardown [-l local-server] -r remote-server [-v] [-f]

Parameters: See the mp_replication init command.


Related Topics

Using the Command-Line Interface (CLI) on the Application Server

Configuring Directory Service on MeetingPlace-Scheduled and Audio-Only Deployments

Configuring Application Server Failover on MeetingPlace-Scheduled and Audio-Only Deployments

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 4.


Table 4 Command Reference: Failover Commands for the Application Server 

Command
Description

failoverUtil copyConfigFiles

Transfers configuration files from one Application Server to the other, specifically:

1. Compresses the configuration files and user prompts on the local server.

2. Transfers the compressed files to the remote server.

After you enter this command on the local server, you need to enter the failoverUtil restoreConfigFiles on the remote server.

The following files and directories are transferred by this command:

Directory Service:

/opt/cisco/meetingplace/axlds/current/etc/config.properties

Recorded user names and custom voice prompts:

Everything under /opt/cisco/meetingplace/afs/custom

Microsoft Outlook integration files:

Everything under /opt/cisco/meetingplace/var/outlook

/opt/cisco/meetingplace/var/admin/outlook.config

Everything under /opt/cisco/meetingplace/var/mail

Cisco WebEx integration files:

/usr/local/enrollment

/opt/cisco/meetingplace/web/current/etc/conf/keyinfo.properties

/opt/cisco/meetingplace/web/current/etc/conf/keystore.jks

/opt/cisco/meetingplace/web/current/etc/conf/cert.cer

/opt/cisco/meetingplace/web/current/bases/main/conf/server.xml

Syntax: failoverUtil copyConfigFiles

failoverUtil restoreConfigFiles

Completes the transfer of configuration files from one Application Server to the other, specifically:

1. Decompresses the configuration files and user prompts that were transferred from the remote server.

2. Places the transferred files into the correct directories, overwriting any existing local files with those from the remote server.

Note The failoverUtil copyConfigFiles and failoverUtil restoreConfigFiles commands are entered on separate Application Servers.

Syntax: failoverUtil restoreConfigFiles

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.

Syntax: failoverUtil setDeployment failover

failoverUtil setDeployment singleServer

Restores a failover-deployed Application Server to a single-server deployment.

Syntax: failoverUtil setDeployment singleServer

failoverUtil setServer

Sets a failover-deployed Application Server to either active or standby mode.

Enter this command only after running the failoverUtil setDeployment failover command on the server.

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.

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.

Syntax: failoverUtil status


Related Topics

Using the Command-Line Interface (CLI) on the Application Server

Configuring Application Server Failover on MeetingPlace-Scheduled and Audio-Only Deployments