Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server

From DocWiki

(Difference between revisions)
Jump to: navigation, search
m
 
(2 intermediate revisions not shown)
Line 1: Line 1:
-
'''Main page:''' [[Cisco Unified MeetingPlace, Release 8.0]]
+
'''Main page:''' [[Cisco Unified MeetingPlace, Release 8.0]]  
-
'''Up one level:''' [[Cisco Unified MeetingPlace Release 8.0 -- Reference Information|Reference Information]]
+
'''Up one level:''' [[Cisco Unified MeetingPlace Release 8.0 -- Reference Information|Reference Information]]  
 +
<br>
 +
<br>
 +
You can use the command-line interface (CLI) on the Application Server to perform functions that cannot be performed in the Administration Center.<br>
-
== You can use the command-line interface (CLI) on the Application Server to perform functions that cannot be performed in the Administration Center. ==
+
<br>
-
== 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 ==
+
== '''CAUTION'''&nbsp;: 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==
 +
<br> <br>
-
'''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 [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco WebEx Node for MCS#Using the Command-Line Interface (CLI) on the Cisco WebEx Node for MCS|Using the Command-Line Interface (CLI) on the Cisco WebEx Node for MCS]] module.
+
'''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 [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco WebEx Node for MCS#Using_the_Command-Line_Interface_.28CLI.29_on_the_Cisco_WebEx_Node_for_MCS|Using the Command-Line Interface (CLI) on the Cisco WebEx Node for MCS]] module.  
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#CLI User Level Options on the Application Server|CLI User Level Options on the Application Server]]
+
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Restrictions for the CLI on the Application Server|Restrictions for the CLI on the Application Server]]
+
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#How to Sign in to the CLI on the Application Server|How to Sign in to the CLI on the Application Server]]
+
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Application Server Command Reference|Application Server Command Reference]]
+
 +
*[[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#CLI_User_Level_Options_on_the_Application_Server|CLI User Level Options on the Application Server]]
 +
*[[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Restrictions_for_the_CLI_on_the_Application_Server|Restrictions for the CLI on the Application Server]]
 +
*[[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#How_to_Sign_in_to_the_CLI_on_the_Application_Server|How to Sign in to the CLI on the Application Server]]
 +
*[[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Application_Server_Command_Reference|Application Server Command Reference]]
 +
<br>
== CLI User Level Options on the Application Server  ==
== CLI User Level Options on the Application Server  ==
-
 
+
{| border="1"
-
{| border = 1  
+
|-
|-
-
!CLI User Level
+
! CLI User Level  
-
!Description
+
! Description
|-
|-
-
|
+
|  
 +
mpxadmin
-
mpxadmin
+
|  
-
|
+
We recommend that you use this user level whenever possible.
-
We recommend that you use this user level whenever possible.
 
|-
|-
-
|
+
|  
 +
root
-
root
+
|  
-
|
+
Highest authority, enabling you to do the following:
-
Highest authority, enabling you to do the following:
+
*Enter [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Operating_System_Commands_for_the_Application_Server|Operating System Commands for the Application Server]], though pseudo (sudo) root access can also be used.  
-
* Enter [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Operating System Commands for the Application Server|Operating System Commands for the Application Server]], though pseudo (sudo) root access can also be used.
+
*Enter [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Database_Replication_Commands_for_the_Application_Server|Database Replication Commands for the Application Server]] or [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Failover_Commands_for_the_Application_Server|Failover Commands for the Application Server]].  
-
* Enter [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Database Replication Commands for the Application Server|Database Replication Commands for the Application Server]] or [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Failover Commands for the Application Server|Failover Commands for the Application Server]].
+
*Reset the root or mpxadmin user passwords.  
-
* Reset the root or mpxadmin user passwords.
+
*Uninstall the system.
-
* Uninstall the system.
+
 +
<br> To get to the root user level, do one of the following:
-
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 as the mpxadmin user, and enter '''su''' at the command line.  
+
*Sign in directly as the root user-this is possibly only by [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace 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 the Console]].
-
* Sign in directly as the root user-this is possibly only by [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace 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 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.  
-
'''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.
 
|}
|}
 +
<br>
 +
<br>
 +
===== Related Topics  =====
-
===== Related Topics =====
+
*[[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace 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 the Console]]  
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace 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 the Console]]
+
*[[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Signing_in_to_the_CLI_on_the_Application_Server_By_Using_SSH|Signing in to the CLI on the Application Server By Using SSH]]  
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Signing in to the CLI on the Application Server By Using SSH|Signing in to the CLI on the Application Server By Using SSH]]
+
*[[Cisco Unified MeetingPlace Release 8.0 -- Password Recovery for the Cisco Unified MeetingPlace Application Server#Password_Recovery_for_the_Cisco_Unified_MeetingPlace_Application_Server|Password Recovery for the Cisco Unified MeetingPlace Application Server]] module
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Password Recovery for the Cisco Unified MeetingPlace Application Server#Password Recovery for the Cisco Unified MeetingPlace Application Server|Password Recovery for the Cisco Unified MeetingPlace Application Server]] module  
+
-
 
+
 +
<br>
== Restrictions for the CLI on the 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 ==
 
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace 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 the Console]]
 
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Signing in to the CLI on the Application Server By Using SSH|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 ===
+
*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.
 +
<br>
-
You can sign in to the CLI from the console by using either the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#mpxadmin|mpxadmin]] or [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#root|root]] usernames. ''This is the only way you can sign in directly as the root user.''<span style="font-style: italic"> </span>You can enter operating system commands here.
+
== How to Sign in to the CLI on the Application Server ==
 +
*[[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace 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 the Console]]
 +
*[[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Signing_in_to_the_CLI_on_the_Application_Server_By_Using_SSH|Signing in to the CLI on the Application Server By Using SSH]]
-
===== Procedure =====
+
<br>
 +
=== Signing in to the CLI on the Application Server By Using the Console  ===
-
# Connect the monitor, keyboard, and mouse to the Application Server.
+
You can sign in to the CLI from the console by using either the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#mpxadmin|mpxadmin]] or [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#root|root]] usernames. ''This is the only way you can sign in directly as the root user.''<span style="font-style: italic"> </span>You can enter operating system commands here.  
-
#: 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 [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Operating System Commands for the Application Server|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.
+
 +
<br>
-
===== Related Topics =====
+
===== Procedure  =====
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Signing in to the CLI on the Application Server By Using SSH|Signing in to the CLI on the Application Server By Using SSH]]
+
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Application Server Command Reference|Application Server Command Reference]]
+
 +
#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 [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Operating_System_Commands_for_the_Application_Server|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.
-
=== Signing in to the CLI on the Application Server By Using SSH ===
+
<br>
 +
===== Related Topics  =====
-
This section provides one method of signing in to the CLI by using SSH. Other methods might be available for you.
+
*[[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Signing_in_to_the_CLI_on_the_Application_Server_By_Using_SSH|Signing in to the CLI on the Application Server By Using SSH]]
 +
*[[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Application_Server_Command_Reference|Application Server Command Reference]]
 +
<br>
-
===== Restriction =====
+
=== 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.
-
Only the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#mpxadmin|mpxadmin]] user can sign in to the CLI remotely using SSH. If needed, you can later switch to the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#root|root]] user by entering '''su'''.
+
<br>
 +
===== Restriction  =====
-
===== Before You Begin =====
+
Only the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#mpxadmin|mpxadmin]] user can sign in to the CLI remotely using SSH. If needed, you can later switch to the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#root|root]] user by entering '''su'''.
 +
<br>
-
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.
+
===== 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 =====
+
<br>
 +
===== Procedure  =====
-
# From your computer, go to '''Start > Programs > SSH Secure Shell > Secure Shell Client'''.  
+
#From your computer, go to '''Start &gt; Programs &gt; SSH Secure Shell &gt; Secure Shell Client'''.  
-
# Select '''Quick Connect'''.  
+
#Select '''Quick Connect'''.  
-
# In the Connect to Remote Host window, enter these values:
+
#In the Connect to Remote Host window, enter these values:
 +
<br>
-
{| border = 1  
+
{| border="1"
|-
|-
-
!Field
+
! Field  
-
!Value
+
! Value
|-
|-
-
|
+
|  
 +
Host Name
-
Host Name
+
|  
-
|
+
IP address of your Cisco Unified MeetingPlace system
-
IP address of your Cisco Unified MeetingPlace system
 
|-
|-
-
|
+
|  
 +
User Name
-
User Name
+
|  
-
|
+
mpxadmin
-
mpxadmin
 
|-
|-
-
|
+
|  
 +
Port Number
-
Port Number
+
|  
-
|
+
22
-
22
 
|-
|-
-
|
+
|  
 +
Authentication Method
-
Authentication Method
+
|  
-
|
+
leave as &lt;Profile Settings&gt;
-
leave as <Profile Settings>
 
|}
|}
-
+
<br>
 +
 
:4. Select '''Connect'''.  
:4. Select '''Connect'''.  
:5. In the Enter Password window, enter the password for the mpxadmin user.  
:5. In the Enter Password window, enter the password for the mpxadmin user.  
-
:: This was established during installation.
+
::This was established during installation.  
:6. Select '''OK'''.  
:6. Select '''OK'''.  
-
:: The system displays the command line, and you can now enter commands.
+
::The system displays the command line, and you can now enter commands.
 +
<br>
-
===== Related Topics =====
+
===== Related Topics =====
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace 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 the Console]]
+
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Application Server Command Reference|Application Server Command Reference]]
+
-
== Application Server Command Reference ==
+
*[[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace 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 the Console]]  
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Command Syntax Conventions|Command Syntax Conventions]]
+
*[[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Application_Server_Command_Reference|Application Server Command Reference]]
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Application Commands for the Application Server|Application Commands for the Application Server]]
+
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Operating System Commands for the Application Server|Operating System Commands for the Application Server]]
+
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Database Replication Commands for the Application Server|Database Replication Commands for the Application Server]]
+
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Failover Commands for the Application Server|Failover Commands for the Application Server]]
+
 +
== Application Server Command Reference  ==
-
=== Command Syntax Conventions ===
+
*[[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Command_Syntax_Conventions|Command Syntax Conventions]]
 +
*[[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Application_Commands_for_the_Application_Server|Application Commands for the Application Server]]
 +
*[[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Operating_System_Commands_for_the_Application_Server|Operating System Commands for the Application Server]]
 +
*[[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Database_Replication_Commands_for_the_Application_Server|Database Replication Commands for the Application Server]]
 +
*[[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Failover_Commands_for_the_Application_Server|Failover Commands for the Application Server]]
 +
<br>
-
This document uses these command syntax conventions.
+
=== Command Syntax Conventions  ===
 +
This document uses these command syntax conventions.
-
{| border = 1  
+
<br>
 +
 
 +
{| border="1"
|-
|-
-
!Convention
+
! Convention  
-
!Description
+
! Description
|-
|-
-
|
+
|  
-
 
+
'''bold'''  
'''bold'''  
-
|
 
 +
|
Bold text indicates commands and parameters that you enter as shown.  
Bold text indicates commands and parameters that you enter as shown.  
 +
|-
|-
-
|
+
|  
-
 
+
''italic''  
''italic''  
-
|
 
 +
|
Italic text indicates parameters for which you supply values.  
Italic text indicates parameters for which you supply values.  
 +
|-
|-
-
|
+
|  
 +
&lt;x&gt;
-
<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.
-
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]  
-
[x]
+
-
|
+
 +
|
Square brackets enclose an optional parameter.  
Square brackets enclose an optional parameter.  
 +
|-
|-
-
|
+
|  
-
 
+
<nowiki> | </nowiki>  
-
<nowiki> | </nowiki>
+
-
|
+
 +
|
A vertical line, called a pipe, indicates a choice within a set of parameters.  
A vertical line, called a pipe, indicates a choice within a set of parameters.  
 +
|-
|-
-
|
+
|  
 +
[x &#124; y]
-
[x | y]
+
|  
-
|
+
Square brackets enclosing parameters separated by a pipe indicate an optional choice.
-
Square brackets enclosing parameters separated by a pipe indicate an optional choice.
 
|-
|-
-
|
+
|  
-
 
+
{x &#124; y}  
-
{x | y}
+
-
|
+
 +
|
Braces enclosing parameters separated by a pipe indicate a required choice.  
Braces enclosing parameters separated by a pipe indicate a required choice.  
 +
|-
|-
-
|
+
|  
-
 
+
[x {y &#124; z}]  
-
[x {y | z}]  
+
-
|
+
 +
|
Braces and a pipe within square brackets indicate a required choice within an optional element.  
Braces and a pipe within square brackets indicate a required choice within an optional element.  
 +
|}
|}
-
=== Application Commands for the Application Server ===
+
=== Application Commands for the Application Server ===
-
 
+
===== Table: Command Reference: Application Commands for the Application Server  =====
===== Table: Command Reference: Application Commands for the Application Server  =====
-
{| border = 1  
+
{| border="1"
|-
|-
-
!Command
+
! Command  
-
!Description
+
! Description
|-
|-
-
|
+
|  
-
 
+
activity  
-
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.
+
|
 +
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.  
 +
<br> Syntax: '''activity'''
-
Syntax: '''activity'''
 
|-
|-
-
|
+
|  
 +
alarm
-
alarm
+
|
-
|
+
Displays the [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Alarm_Table|Alarm Table]]:
-
Displays the [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Alarm Table|Alarm Table]]:
+
*REFNO-Reference number used with the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#clearalarm|clearalarm]] command to clear a specific alarm table entry.  
-
* REFNO-Reference number used with the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#clearalarm|clearalarm]] command to clear a specific alarm table entry.
+
*SEV-Severity, either major (MAJ) or minor (MIN). See [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Alarm_Severity_Levels|Alarm Severity Levels]] in the [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Using_Alarms_and_Logs_on_Cisco_Unified_MeetingPlace|Using Alarms and Logs on Cisco Unified MeetingPlace]] module.  
-
* SEV-Severity, either major (MAJ) or minor (MIN). See [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Alarm Severity Levels|Alarm Severity Levels]] in the [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Using Alarms and Logs on Cisco Unified MeetingPlace|Using Alarms and Logs on Cisco Unified MeetingPlace]] module.
+
*CODE-See Code.  
-
* CODE-See Code.
+
*COUNT -See Count.  
-
* COUNT -See Count.
+
*FIRST-See First Time.  
-
* FIRST-See First Time.
+
*LAST-See Last Time.  
-
* LAST-See Last Time.
+
*UNIT-See Unit.  
-
* UNIT-See Unit.
+
*SW MODULE-See Software Module.
-
* SW MODULE-See Software 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 [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#errorlog|errorlog]] command or the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#viewexlog|viewexlog]] command.
+
'''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 [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#errorlog|errorlog]] command or the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#viewexlog|viewexlog]] command.  
 +
<br> Syntax: '''alarm'''
-
Syntax: '''alarm'''
 
|-
|-
-
|
+
|  
-
 
+
ccamon  
-
ccamon
+
-
|
+
 +
|
Monitors the Call Control Agent. Allows you to view the call statistics and set the log tracing level.  
Monitors the Call Control Agent. Allows you to view the call statistics and set the log tracing level.  
 +
<br> Syntax: '''ccamon'''
-
Syntax: '''ccamon'''
 
|-
|-
-
|
+
|  
 +
checklic
-
checklic
+
|  
-
|
+
Shows the type and number of licenses installed.
-
Shows the type and number of licenses installed.
+
'''Note: ''' The system can take up to 15 seconds to process this information.  
-
'''Note: ''' The system can take up to 15 seconds to process this information.
+
<br> Syntax: '''checklic'''  
-
 
-
Syntax: '''checklic'''
 
|-
|-
-
|
+
|  
 +
clearalarm
-
clearalarm
+
|  
-
|
+
Clears either all the alarms in the alarm table or just the alarm specified.
-
Clears either all the alarms in the alarm table or just the alarm specified.
+
<br> 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 [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Configuring_the_System_to_Call_You_If_There_is_a_Major_Alarm|Configuring the System to Call You If There is a Major Alarm]] in the [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Using_Alarms_and_Logs_on_Cisco_Unified_MeetingPlace|Using Alarms and Logs on Cisco Unified MeetingPlace]] module.  
 +
<br> Running this command stops the system from calling the system administrator (if it has been configured to do so).
-
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 [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Configuring the System to Call You If There is a Major Alarm|Configuring the System to Call You If There is a Major Alarm]] in the [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Using Alarms and Logs on Cisco Unified MeetingPlace|Using Alarms and Logs on Cisco Unified MeetingPlace]] module.
+
<br> Syntax: '''clearalarm''' {''reference-number'' &#124; '''all'''}
-
 
-
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:
-
|
 
-
 
-
cleardb
 
-
|
 
-
 
-
Clears the following Application Server data:
 
*All user profiles except the admin and guest user profiles  
*All user profiles except the admin and guest user profiles  
*All user groups except the System group  
*All user groups except the System group  
*All user recordings  
*All user recordings  
-
*All conference recordings  
+
*All conference recordings
You must be signed in to the Application Server CLI as the root user to enter this command.  
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.  
+
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.
+
'''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'''
+
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.
 +
<br> Syntax: '''cpstatus'''
-
 
-
 
-
 
-
|
 
-
 
-
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
-
cptrace
+
|  
-
|
+
Lists selected portions of the call processing trace log.
-
Lists selected portions of the call processing trace log.
+
<br> Syntax: '''cptrace'''
-
 
-
Syntax: '''cptrace'''
 
|-
|-
-
|
+
|  
 +
date
-
date
+
|  
-
|
+
Displays the time and date for the Application Server.
-
Displays the time and date for the Application Server.
+
<br> If you are signed in as a root user, you can also set the date and time based on the local time zone.  
 +
<br> Syntax: '''date''' [''MMDDhhmm''[''YYYY'']['''.'''''ss'']]
-
If you are signed in as a root user, you can also set the date and time based on the local time zone.
+
<br> 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 (.)
-
Syntax: '''date''' [''MMDDhhmm''[''YYYY'']['''.'''''ss'']]
+
|-
 +
|
 +
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.
-
Parameters (available only to root users):
+
'''Caution! ''' Deleting all database entries is an irreversible operation. Before you run the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#dbupdate|dbupdate]] command, consider backing up and archiving the database. See [[Cisco Unified MeetingPlace Release 8.0 -- Backing Up, Archiving, and Restoring Data on the Cisco Unified MeetingPlace Application Server#Backing_Up.2C_Archiving.2C_and_Restoring_Data_on_the_Cisco_Unified_MeetingPlace_Application_Server|Backing Up, Archiving, and Restoring Data on the Cisco Unified MeetingPlace Application Server]] module.  
-
* ''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.
+
<br> Use this command only in these situations:
-
'''Caution! ''' Deleting all database entries is an irreversible operation. Before you run the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#dbupdate|dbupdate]] command, consider backing up and archiving the database. See [[Cisco Unified MeetingPlace Release 8.0 -- Backing Up, Archiving, and Restoring Data on the Cisco Unified MeetingPlace Application Server#Backing Up, Archiving, and Restoring Data on the Cisco Unified MeetingPlace Application Server|Backing Up, Archiving, and Restoring Data on the Cisco Unified MeetingPlace Application Server]] module.
+
*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 [[Cisco Unified MeetingPlace Release 8.0 -- Configuring Cisco Unified MeetingPlace Directory Service#Directory_Service_User_Profile_Deletion|Directory Service User Profile Deletion]] in the [[Cisco Unified MeetingPlace Release 8.0 -- Configuring Cisco Unified MeetingPlace Directory Service#Configuring_Cisco_Unified_MeetingPlace_Directory_Service|Configuring Cisco Unified MeetingPlace Directory Service]] module.
-
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 [[Cisco Unified MeetingPlace Release 8.0 -- Configuring Cisco Unified MeetingPlace Directory Service#Directory Service User Profile Deletion|Directory Service User Profile Deletion]] in the [[Cisco Unified MeetingPlace Release 8.0 -- Configuring Cisco Unified MeetingPlace Directory Service#Configuring Cisco Unified MeetingPlace Directory Service|Configuring Cisco Unified MeetingPlace Directory Service]] module.
 
|-
|-
-
|
+
|  
 +
errorlog
-
errorlog
+
|
-
|
+
Displays the [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Exception_Log|Exception Log]] output one screen at a time:
-
Displays the [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Exception Log|Exception Log]] output one screen at a time:
+
*Date of the event  
-
* Date of the event
+
*Time of the event  
-
* Time of the event
+
*Severity (major, minor, informational, or warning)  
-
* Severity (major, minor, informational, or warning)
+
*Exception code  
-
* Exception code
+
*Brief description
-
* Brief description
+
 +
<br> In contrast, the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#viewexlog|viewexlog]] command provides the entire [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Exception_Log|Exception Log]] output all at once.
-
In contrast, the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#viewexlog|viewexlog]] command provides the entire [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Exception Log|Exception Log]] output all at once.
+
<br> Syntax: '''errorlog'''
-
 
-
Syntax: '''errorlog'''
 
|-
|-
-
|
+
|  
 +
eventlog
-
eventlog
+
|  
-
|
+
Displays the system event log.
-
Displays the system event log.
+
'''Note: ''' This command has many parameter options; only the most commonly used parameters are listed below.  
-
'''Note: ''' This command has many parameter options; only the most commonly used parameters are listed below.
+
<br> Syntax: '''eventlog''' ['''-b''' [''YY''][''MMDD'']''hhmm''] ['''-e''' [''YY''][''MMDD'']''hhmm''] ['''-G''' &#124; '''-C'''] ['''-t'''] ['''&#124; more''']
 +
<br> Parameters:
-
Syntax: '''eventlog''' ['''-b''' [''YY''][''MMDD'']''hhmm''] ['''-e''' [''YY''][''MMDD'']''hhmm''] ['''-G''' | '''-C'''] ['''-t'''] ['''| more''']
+
*'''-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.
-
Parameters:
+
*''YY''-Calendar year, specified by two digits. Typically, this parameter is included only when troubleshooting issues around the start of a new calendar year.
-
* '''-b'''-Specifies a start time for the log events to include in the output.
+
*''MM''-month, specified by two digits
-
* '''-e'''-Specifies an end time for the log events to include in the output.
+
*''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.
 +
*'''&#124; more'''-Displays the log output one screen at a time.
-
'''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.
 
|-
|-
-
|
+
|  
 +
exc
-
exc
+
|
-
|
+
Displays the meaning of an exception code that was listed in the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#errorlog|errorlog]] or [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#viewexlog|viewexlog]] command output.
-
Displays the meaning of an exception code that was listed in the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#errorlog|errorlog]] or [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#viewexlog|viewexlog]] command output.
+
<br> Syntax: '''exc''' ['''-v'''] ''exception-code''
-
 
-
Syntax: '''exc''' ['''-v'''] ''exception-code''
 
|-
|-
-
|
+
|  
-
 
+
hostname  
-
hostname
+
-
|
+
 +
|
Displays the hostname of the Application Server.  
Displays the hostname of the Application Server.  
 +
<br> Syntax: '''hostname'''
-
Syntax: '''hostname'''
 
|-
|-
-
|
+
|  
 +
infocap
-
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.
-
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.
+
<br> Restrictions:
 +
*You must be signed in as the root user to run this command.
 +
*You can also get this information by completing [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Obtaining_and_Viewing_the_System_Information_Capture_.28Infocap.29_Log|Obtaining and Viewing the System Information Capture (Infocap) Log]] in the [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Using_Alarms_and_Logs_on_Cisco_Unified_MeetingPlace|Using Alarms and Logs on Cisco Unified MeetingPlace]] module. 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 [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#date|date]] command.
-
Restrictions:  
+
<br> Syntax: '''infocap -b''' ''begin-date-and-time'' '''-e''' ''end-date-and-time''
-
* You must be signed in as the root user to run this command.
+
-
* You can also get this information by completing [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Obtaining and Viewing the System Information Capture (Infocap) Log|Obtaining and Viewing the System Information Capture (Infocap) Log]] in the [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Using Alarms and Logs on Cisco Unified MeetingPlace|Using Alarms and Logs on Cisco Unified MeetingPlace]] module. 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 [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#date|date]] command.
+
-
 
-
Syntax: '''infocap -b''' ''begin-date-and-time'' '''-e''' ''end-date-and-time''
 
|-
|-
-
|
+
|  
 +
infocapmtg
-
infocapmtg
+
|  
-
|
+
Gathers a system information capture file around the time of a meeting.
-
Gathers a system information capture file around the time of a meeting.
+
<br> Syntax: '''infocapmtg''' [''meetingID''] ['''-S &#124; -P &#124; -B'''''minutes''] ['''-n''' ''username &#124; '''''-p''' ''profilename''] ['''-b''' ''beginning-time'' '''-e''' ''ending-time'']
 +
<br> Parameters:
-
Syntax: '''infocapmtg''' [''meetingID''] ['''-S | -P | -B''''' minutes''] ['''-n''' ''username | '''''-p''' ''profilename''] ['''-b''' ''beginning-time'' '''-e''' ''ending-time'']
+
*''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.
 +
<br> Examples:
-
Parameters:
+
<br> '''infocapmtg 1212''' Gathers a system information capture file starting at the time meeting 1212 began and ending when meeting 1212 ended.  
-
* ''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.
+
 +
<br> '''infocapmtg 1212 -S''' Gathers a system information capture file starting at the time someone scheduled meeting 1212 and ending when meeting 1212 ended.
-
Examples:
+
<br> '''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.
 +
<br> '''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.
-
'''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
-
langinfo
+
|  
-
|
+
Displays information about all installed locales including the following:
-
Displays information about all installed locales including the following:
+
*Locale ID  
-
* Locale ID
+
*Language code  
-
* Language code
+
*Locale order  
-
* Locale order
+
*Locale name  
-
* Locale name
+
*Country code  
-
* Country code
+
*Locale version number
-
* Locale version number
+
 +
<br> Syntax: '''langinfo'''
-
Syntax: '''langinfo'''
 
|-
|-
-
|
+
|  
-
 
+
mtginfo  
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 [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#userinfo|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 [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#date|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 [[Cisco Unified MeetingPlace Release 8.0 -- Administration Center Page References for Cisco Unified MeetingPlace (M - P pages)#Meeting Configuration Page|Meeting Configuration Page]].
 
-
 
-
 
-
Examples:
 
 +
|
 +
Displays information about a specific meeting. Searches for a meeting based on any of these:
-
'''mtginfo -m 1234 '''Looks for the meeting with the ID of 1234 at the current time
+
*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 [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#userinfo|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.
 +
<br> Syntax: '''mtginfo''' '''-a''' ''time'' '''-c''' ''unique-conf-id'' '''-e''' ''end-time'' '''-m''' ''meeting-id'' '''-s''' ''start-time'' '''-t''' ''time'' '''-u''' ''unique-user-id''
-
'''mtginfo -m 1234 -t 11 '''Looks for meeting with the ID of 1234 at 11 minutes after the current hour
+
'''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 [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#date|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 [[Cisco Unified MeetingPlace Release 8.0 -- Administration Center Page References for Cisco Unified MeetingPlace (M - P pages)#Meeting_Configuration_Page|Meeting Configuration Page]].
-
'''mtginfo -m 1234 -t 1111111111 '''Looks for meeting with the ID of 1234 at 11:11am on Nov 11, 2011
+
<br> Examples:  
 +
<br> '''mtginfo -m 1234 '''Looks for the meeting with the ID of 1234 at the current time
-
'''mtginfo -a 1430 '''Looks for meetings that are active at 2:30pm today
+
<br> '''mtginfo -m 1234 -t 11 '''Looks for meeting with the ID of 1234 at 11 minutes after the current hour
 +
<br> '''mtginfo -m 1234 -t 1111111111 '''Looks for meeting with the ID of 1234 at 11:11am on Nov 11, 2011
-
'''mtginfo -s 1430 -e 1530 '''Looks for meetings that started or ended between 2:30 and 3:30pm today
+
<br> '''mtginfo -a 1430 '''Looks for meetings that are active at 2:30pm today  
 +
<br> '''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
+
<br> '''mtginfo -c 123 '''Looks for meeting with the unique conference ID of 123  
 +
<br> '''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
-
'''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
-
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.
-
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.
+
<br> 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.
-
You must be signed in as root before running this command.
+
<br> Use the '''net''' command to set the following:
-
'''Caution! ''' A system restart terminates all existing call connections. Proceed only during a scheduled maintenance period or during a period of extremely low usage.  
+
*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 [[Cisco Unified MeetingPlace Release 8.0 -- Configuring Application Server Failover for Cisco Unified MeetingPlace#Application_Server_Failover|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:
-
Use the '''net''' command to set the following:
+
**Configure the DNS (1) server to point the old hostname to the new hostname.
-
* Port configuration parameters, including:
+
**Restart the application by entering either the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#'''mpx_sys&#124;mpx_sys]]''''''restart''' operating system command or the '''reboot''' Linux command.
-
** Application Server (eth0) hostname, IP address, subnet mask, and default gateway
+
**If you enabled SSL for the Application Server, complete the [[Cisco Unified MeetingPlace Release 8.0 -- Configuring SSL for the Cisco Unified MeetingPlace Application Server#Generating_a_Certificate_Signing_Request_and_Obtaining_the_Certificate|Generating a Certificate Signing Request and Obtaining the Certificate]] and [[Cisco Unified MeetingPlace Release 8.0 -- Configuring SSL for the Cisco Unified MeetingPlace Application Server#Uploading_the_Certificate_File_and_Enabling_SSL|Uploading the Certificate File and Enabling SSL]] sections in the [[Cisco Unified MeetingPlace Release 8.0 -- Configuring SSL for the Cisco Unified MeetingPlace Application Server#Configuring_SSL_for_the_Cisco_Unified_MeetingPlace_Application_Server|Configuring SSL for the Cisco Unified MeetingPlace Application Server]] module.
-
** Virtual (eth0:0) hostname, IP address, subnet mask, and default gateway-the eth0:0 virtual interface is used in [[Cisco Unified MeetingPlace Release 8.0 -- Configuring Application Server Failover for Cisco Unified MeetingPlace#Application Server Failover|Application Server Failover]] deployments
+
**If you installed MeetingPlace Conference Manager, complete the [[Cisco Unified MeetingPlace Release 8.0 -- Using MeetingPlace Conference Manager#Editing_an_Existing_Server|Editing an Existing Server]] section in the [[Cisco Unified MeetingPlace Release 8.0 -- Using MeetingPlace Conference Manager#Using_MeetingPlace_Conference_Manager|Using MeetingPlace Conference Manager]] module.  
-
** MTU and link parameters (auto-negotiation, speed, duplex).
+
**If your system includes a Web Server, complete the [[Cisco Unified MeetingPlace Release 8.0 -- Configuring the Cisco Unified MeetingPlace Gateway System Integrity Manager#Changing_the_Cisco_Unified_MeetingPlace_Application_Server_Connection_Configured_in_the_Gateway_SIM|Changing the Cisco Unified MeetingPlace Application Server Connection Configured in the Gateway SIM]] section in the [[Cisco Unified MeetingPlace Release 8.0 -- Configuring the Cisco Unified MeetingPlace Gateway System Integrity Manager#Configuring_the_Cisco_Unified_MeetingPlace_Gateway_System_Integrity_Manager|Configuring the Cisco Unified MeetingPlace Gateway System Integrity Manager]] module.
-
* Domain name
+
**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.
-
* DNS servers
+
-
* NTP servers
+
-
'''Note: ''' If you change the Application Server hostname (for eth0), then you must also perform these actions:
+
<br> Syntax: '''net'''  
-
** Configure the DNS (1) server to point the old hostname to the new hostname.
+
-
** Restart the application by entering either the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#'''mpx_sys|mpx_sys]]'''''' restart''' operating system command or the '''reboot''' Linux command.
+
-
** If you enabled SSL for the Application Server, complete the [[Cisco Unified MeetingPlace Release 8.0 -- Configuring SSL for the Cisco Unified MeetingPlace Application Server#Generating a Certificate Signing Request and Obtaining the Certificate|Generating a Certificate Signing Request and Obtaining the Certificate]] and [[Cisco Unified MeetingPlace Release 8.0 -- Configuring SSL for the Cisco Unified MeetingPlace Application Server#Uploading the Certificate File and Enabling SSL|Uploading the Certificate File and Enabling SSL]] sections in the [[Cisco Unified MeetingPlace Release 8.0 -- Configuring SSL for the Cisco Unified MeetingPlace Application Server#Configuring SSL for the Cisco Unified MeetingPlace Application Server|Configuring SSL for the Cisco Unified MeetingPlace Application Server]] module.
+
-
** If you installed MeetingPlace Conference Manager, complete the [[Cisco Unified MeetingPlace Release 8.0 -- Using MeetingPlace Conference Manager#Editing an Existing Server|Editing an Existing Server]] section in the [[Cisco Unified MeetingPlace Release 8.0 -- Using MeetingPlace Conference Manager#Using MeetingPlace Conference Manager|Using MeetingPlace Conference Manager]] module.
+
-
** If your system includes a Web Server, complete the [[Cisco Unified MeetingPlace Release 8.0 -- Configuring the Cisco Unified MeetingPlace Gateway System Integrity Manager#Changing the Cisco Unified MeetingPlace Application Server Connection Configured in the Gateway SIM|Changing the Cisco Unified MeetingPlace Application Server Connection Configured in the Gateway SIM]] section in the [[Cisco Unified MeetingPlace Release 8.0 -- Configuring the Cisco Unified MeetingPlace Gateway System Integrity Manager#Configuring the Cisco Unified MeetingPlace Gateway System Integrity Manager|Configuring the Cisco Unified MeetingPlace Gateway System Integrity Manager]] module.
+
-
** 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  
-
ntpdate
+
-
|
+
 +
|
Sets the Application Server date and time to match the time obtained by polling an NTP (2) server.  
Sets the Application Server date and time to match the time obtained by polling an NTP (2) server.  
 +
<br> Syntax: '''ntpdate''' ['''-u'''] ''ntp-server''
-
Syntax: '''ntpdate''' ['''-u'''] ''ntp-server''
+
<br> 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.
-
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.
 
|-
|-
-
|
+
|  
 +
swstatus
-
swstatus
+
|  
-
|
+
Displays information about Cisco Unified MeetingPlace, including the following:
-
Displays information about Cisco Unified MeetingPlace, including the following:
+
*Version number  
-
* Version number
+
*System mode  
-
* System mode
+
*Status of the power supplies  
-
* Status of the power supplies
+
*List of software modules loaded in to memory, their version number, and their status
-
* List of software modules loaded in to memory, their version number, and their status
+
 +
<br> Syntax: '''swstatus'''
-
Syntax: '''swstatus'''
 
|-
|-
-
|
+
|  
-
 
+
taccli  
-
taccli
+
-
|
+
 +
|
Displays details on the mixer status, active meetings, participant details, and general statistics, including the following:  
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
 
 +
*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:  
+
<br> 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
+
 +
*Resets Cisco Unified MeetingPlace request statistics
 +
*Enables and disables tracing
 +
*Shows the current date and time
 +
*Starts and stops channel RTP recording
 +
 +
<br> Syntax: '''taccli'''
-
Syntax: '''taccli'''
 
|-
|-
-
|
+
|  
-
 
+
techui  
-
techui
+
-
|
+
 +
|
Displays statistics for the Media Server, ports, and conferences.  
Displays statistics for the Media Server, ports, and conferences.  
 +
<br> This technician user interface helps to diagnose and troubleshoot media and voice quality issues of active calls.
-
This technician user interface helps to diagnose and troubleshoot media and voice quality issues of active calls.
+
<br> Syntax: '''techui'''
-
 
-
Syntax: '''techui'''
 
|-
|-
-
|
+
|  
 +
userinfo
-
userinfo
+
|  
-
|
+
Displays information about a specific user. Searches for a user based on any of these:
-
Displays information about a specific user. Searches for a user based on any of these:
+
*User ID  
-
* User ID
+
*Profile number  
-
* 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.
-
* 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.
+
 +
<br> Syntax: '''userinfo''' {''user-id'' &#124; ''profile-number'' &#124; ''unique-user-id''}
-
Syntax: '''userinfo''' {''user-id'' | ''profile-number'' | ''unique-user-id''}
 
|-
|-
-
|
+
|  
 +
userutil
-
userutil
+
|  
-
|
+
Performs administrative functions for any user profile.
-
Performs administrative functions for any user profile.
+
<br> Restriction: You cannot set the admin user to inactive, locked, or the group default.  
 +
<br> Syntax: '''userutil''' {'''-q''' &#124; ['''-p''' &#124; '''-P] '''['''-n''' &#124; '''-N] '''['''-a''' &#124; '''-i''' &#124; '''-l''' &#124; '''-g]'''} ''userid'' [''password'']
-
Restriction: You cannot set the admin user to inactive, locked, or the group default.
+
<br> 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.
 +
*''userid''-User ID.
 +
*''pasword''-New User password or Profile PIN. Required if you enter '''-p''', '''-P''', '''-n''', or '''-N'''.
-
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.
 
-
* ''userid''-User ID.
 
-
* ''pasword''-New User password or Profile PIN. Required if you enter '''-p''', '''-P''', '''-n''', or '''-N'''.
 
|-
|-
-
|
+
|  
-
 
+
viewexlog  
-
viewexlog
+
-
|
+
-
Provides the entire [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Exception Log|Exception Log]] output all at once:
+
|
-
* Date of the event
+
Provides the entire [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Exception_Log|Exception Log]] output all at once:  
-
* Time of the event
+
-
* Severity (major, minor, informational, or warning)
+
-
* Exception code
+
-
* Brief description
+
 +
*Date of the event
 +
*Time of the event
 +
*Severity (major, minor, informational, or warning)
 +
*Exception code
 +
*Brief description
-
In contrast, the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#errorlog|errorlog]] command displays the [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Exception Log|Exception Log]] output one screen at a time:
+
<br> In contrast, the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#errorlog|errorlog]] command displays the [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Exception_Log|Exception Log]] output one screen at a time:  
 +
<br> Syntax: '''viewexlog'''
-
Syntax: '''viewexlog'''
 
|}
|}
 +
<br>
 +
<br> Footnote 1: DNS = Domain Name System
 +
<br> Footnote 2: NTP = Network Time Protocol
-
Footnote 1: DNS = Domain Name System
+
===== Related Topics  =====
 +
*[[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Using_Alarms_and_Logs_on_Cisco_Unified_MeetingPlace|Using Alarms and Logs on Cisco Unified MeetingPlace]] module
-
Footnote 2: NTP = Network Time Protocol
+
=== Operating System Commands for the Application Server  ===
-
===== Related Topics =====
+
In addition to the commands listed in [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Table:_Command_Reference:_Operating_System_Commands_for_the_Application_Server|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.
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Using Alarms and Logs on Cisco Unified MeetingPlace#Using Alarms and Logs on Cisco Unified MeetingPlace|Using Alarms and Logs on Cisco Unified MeetingPlace]] module
+
-
===  Operating System Commands for the Application Server ===
+
<br> 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 [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#root|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:
-
In addition to the commands listed in [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Table: Command Reference: Operating System Commands for the Application Server|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.
+
:'''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.
-
These are the requirements and restrictions for operating system commands:
+
<br>
-
* 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 [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#root|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  =====
-
===== Table: Command Reference: Operating System Commands for the Application Server =====
+
{| border="1"
-
 
+
-
{| border = 1  
+
|-
|-
-
!Command
+
! Command  
-
!Description
+
! Description
|-
|-
-
|
+
|  
-
 
+
mpx_app  
-
mpx_app
+
-
|
+
 +
|
Starts, stops, or restarts all Cisco Unified MeetingPlace application services.  
Starts, stops, or restarts all Cisco Unified MeetingPlace application services.  
 +
<br> Syntax: '''mpx_app''' {'''start''' &#124; '''stop''' &#124; '''restart''' &#124; '''status'''} ['''-v''']
-
Syntax: '''mpx_app''' {'''start''' | '''stop''' | '''restart''' | '''status'''} ['''-v''']
 
|-
|-
-
|
+
|  
-
 
+
mpx_axlds  
-
mpx_axlds
+
-
|
+
 +
|
Starts, stops, or restarts Directory Service and external AXL authentication through Cisco Unified Communications Manager.  
Starts, stops, or restarts Directory Service and external AXL authentication through Cisco Unified Communications Manager.  
 +
<br> Syntax: '''mpx_axlds''' {'''start''' &#124; '''stop''' &#124; '''restart''' &#124; '''status'''} ['''-v''']
-
Syntax: '''mpx_axlds''' {'''start''' | '''stop''' | '''restart''' | '''status'''} ['''-v''']
 
|-
|-
-
|
+
|  
 +
mpx_db
-
mpx_db
+
|  
-
|
+
Starts, stops, or restarts Cisco Unified MeetingPlace database services.
-
Starts, stops, or restarts Cisco Unified MeetingPlace database services.
+
<br> Syntax: '''mpx_db''' {'''start''' &#124; '''stop''' &#124; '''restart''' &#124; '''status'''} ['''-v''']
-
 
-
Syntax: '''mpx_db''' {'''start''' | '''stop''' | '''restart''' | '''status'''} ['''-v''']
 
|-
|-
-
|
+
|  
 +
mpx_lm
-
mpx_lm
+
|  
-
|
+
Starts, stops, or restarts Cisco Unified MeetingPlace license manager services.
-
Starts, stops, or restarts Cisco Unified MeetingPlace license manager services.
+
<br> Syntax: '''mpx_lm''' {'''start''' &#124; '''stop''' &#124; '''restart''' &#124; '''status'''} ['''-v''']
-
 
-
Syntax: '''mpx_lm''' {'''start''' | '''stop''' | '''restart''' | '''status'''} ['''-v''']
 
|-
|-
-
|
+
|  
-
 
+
mpx_rmi  
-
mpx_rmi
+
-
|
+
 +
|
Starts, stops, or restarts messaging integration services for Cisco Unified MeetingPlace Click-to-Conference for IBM Lotus Sametime Instant Messaging.  
Starts, stops, or restarts messaging integration services for Cisco Unified MeetingPlace Click-to-Conference for IBM Lotus Sametime Instant Messaging.  
 +
<br> Syntax: '''mpx_rmi''' {'''start''' &#124; '''stop''' &#124; '''restart''' &#124; '''status'''} ['''-v''']
-
Syntax: '''mpx_rmi''' {'''start''' | '''stop''' | '''restart''' | '''status'''} ['''-v''']
 
|-
|-
-
|
+
|  
 +
mpx_rssctrl
-
mpx_rssctrl
+
|  
-
|
+
Starts, stops, or restarts the Cisco Unified MeetingPlace recording and streaming service.
-
Starts, stops, or restarts the Cisco Unified MeetingPlace recording and streaming service.
+
<br> Syntax: '''mpx_rssctrl''' {'''start''' &#124; '''stop''' &#124; '''restart''' &#124; '''status'''} ['''-v''']
-
 
-
Syntax: '''mpx_rssctrl''' {'''start''' | '''stop''' | '''restart''' | '''status'''} ['''-v''']
 
|-
|-
-
|
+
|  
-
 
+
mpx_snmp  
-
mpx_snmp
+
-
|
+
-
Starts, stops, or restarts SNMP services.
+
|
 +
Starts, stops, or restarts SNMP services.  
 +
<br> Syntax: '''mpx_snmp''' {'''start''' &#124; '''stop''' &#124; '''restart''' &#124; '''status'''} ['''-v''']
-
Syntax: '''mpx_snmp''' {'''start''' | '''stop''' | '''restart''' | '''status'''} ['''-v''']
 
|-
|-
-
|
+
|  
-
 
+
mpx_sys  
-
mpx_sys
+
-
|
+
 +
|
Starts, stops, or restarts ''all'' Cisco Unified MeetingPlace services.  
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.
+
'''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.
+
'''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.  
 +
<br> Syntax: '''mpx_sys''' {'''stop''' &#124; '''restart''' &#124; '''status'''} ['''-v''']
-
Syntax: '''mpx_sys''' {'''stop''' | '''restart''' | '''status'''} ['''-v''']
 
|-
|-
-
|
+
|  
 +
mpx_tomcat
-
mpx_tomcat
+
|  
-
|
+
Starts, stops, or restarts Apache Tomcat services.
-
Starts, stops, or restarts Apache Tomcat services.
+
<br> Syntax: '''mpx_tomcat''' {'''start''' &#124; '''stop''' &#124; '''restart''' &#124; '''status'''} ['''-v''']
-
 
-
Syntax: '''mpx_tomcat''' {'''start''' | '''stop''' | '''restart''' | '''status'''} ['''-v''']
 
|-
|-
-
|
+
|  
-
 
+
mpx_tomcatmon  
-
mpx_tomcatmon
+
-
|
+
-
Starts, stops, or restarts Apache Tomcat monitoring services.
+
|
 +
Starts, stops, or restarts Apache Tomcat monitoring services.  
 +
<br> Syntax: '''mpx_tomcatmon''' {'''start''' &#124; '''stop''' &#124; '''restart''' &#124; '''status'''} ['''-v''']
-
Syntax: '''mpx_tomcatmon''' {'''start''' | '''stop''' | '''restart''' | '''status'''} ['''-v''']
 
|-
|-
-
|
+
|  
 +
mpx_va
-
mpx_va
+
|  
-
|
+
Starts, stops, or restarts Media Server services on the Application Server.
-
Starts, stops, or restarts Media Server services on the Application Server.
+
<br> If all other Cisco Unified MeetingPlace services continue running, then entering this command does ''not'' interrupt meetings that are active.  
 +
<br> Syntax: '''mpx_va''' {'''start''' &#124; '''stop''' &#124; '''restart''' &#124; '''status'''} ['''-v''']
-
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  
mpx_version  
-
|
 
 +
|
Lists all installed versions of Cisco Unified MeetingPlace.  
Lists all installed versions of Cisco Unified MeetingPlace.  
 +
<br> Syntax: '''mpx_version '''
-
Syntax: '''mpx_version '''
 
|-
|-
-
|
+
|  
 +
mpx_webx
-
mpx_webx
+
|  
-
|
+
Starts, stops, or restarts all Cisco WebEx integration services on the Application Server.
-
Starts, stops, or restarts all Cisco WebEx integration services on the Application Server.
+
<br> Syntax: '''mpx_webx''' {'''start''' &#124; '''stop''' &#124; '''restart''' &#124; '''status'''} ['''-v''']
-
 
-
Syntax: '''mpx_webx''' {'''start''' | '''stop''' | '''restart''' | '''status'''} ['''-v''']
 
|-
|-
-
|
+
|  
 +
resetmsapassword
-
resetmsapassword
+
|  
-
|
+
Resets the Hardware Media Server Administration password to "cisco".
-
Resets the Hardware Media Server Administration password to "cisco".
+
<br> Syntax: '''resetmsapassword'''
-
 
-
Syntax: '''resetmsapassword'''
 
|-
|-
-
|
+
|  
-
 
+
shutdown  
-
shutdown
+
-
|
+
-
 
+
-
Shuts down the Application Server.
+
 +
|
 +
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.
+
<br> 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.  
 +
<br> Syntax: '''shutdown -h now'''
-
Syntax: '''shutdown -h now'''
 
|}
|}
-
===== Related Topics =====
+
===== Related Topics =====
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Configuring Application Server Failover for Cisco Unified MeetingPlace#Configuring Application Server Failover for Cisco Unified MeetingPlace|Configuring Application Server Failover for Cisco Unified MeetingPlace]] module
+
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Changing Values for the Hardware Media Server#Changing the Media Server Administration Password for the Hardware Media Server|Changing the Media Server Administration Password for the Hardware Media Server]] in the [[Cisco Unified MeetingPlace Release 8.0 -- Changing Values for the Hardware Media Server#Changing Values for the Hardware Media Server|Changing Values for the Hardware Media Server]] module
+
-
=== Database Replication Commands for the Application Server ===
+
*[[Cisco Unified MeetingPlace Release 8.0 -- Configuring Application Server Failover for Cisco Unified MeetingPlace#Configuring_Application_Server_Failover_for_Cisco_Unified_MeetingPlace|Configuring Application Server Failover for Cisco Unified MeetingPlace]] module
 +
*[[Cisco Unified MeetingPlace Release 8.0 -- Changing Values for the Hardware Media Server#Changing_the_Media_Server_Administration_Password_for_the_Hardware_Media_Server|Changing the Media Server Administration Password for the Hardware Media Server]] in the [[Cisco Unified MeetingPlace Release 8.0 -- Changing Values for the Hardware Media Server#Changing_Values_for_the_Hardware_Media_Server|Changing Values for the Hardware Media Server]] module
 +
=== Database Replication Commands for the Application Server  ===
-
'''Note: ''' To enter the database replication commands in [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Table: Command Reference: Database Replication Commands for the Application Server|Table: Command Reference: Database Replication Commands for the Application Server]]:
+
'''Note: ''' To enter the database replication commands in [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Table:_Command_Reference:_Database_Replication_Commands_for_the_Application_Server|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 [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#root|root]] user.
+
 +
*The MeetingPlace Database services must be running on the Application Server.
 +
*You must be signed in to the Application Server CLI as the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#root|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>.
+
<br> 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.&lt;YYYY-MM-DD_hh-mm-ss&gt;.  
 +
<br>
-
===== Table: Command Reference: Database Replication Commands for the Application Server =====
+
===== Table: Command Reference: Database Replication Commands for the Application Server =====
-
{| border = 1  
+
{| border="1"
|-
|-
-
!Command
+
! Command  
-
!Description
+
! Description
|-
|-
-
|
+
|  
 +
mp_replication init
-
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.
-
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.
+
<br> Syntax: '''mp_replication init -s''' ''site'' '''-n''' ''node'' ['''-l''' ''local-server''] '''-r''' ''remote-server'' {'''-h''' &#124; '''-m'''} ['''-v''']
 +
<br> Parameters:
-
Syntax: '''mp_replication init -s''' ''site'' '''-n''' ''node'' ['''-l''' ''local-server''] '''-r''' ''remote-server'' {'''-h''' | '''-m'''} ['''-v''']
+
*'''-s''' ''site''-Specifies the site of the node on which you run this command. Valid values for ''site'' are 1 and 2.
 +
*'''-n''' ''node''-Specifies the node (within the specified site) on which you run the command. Valid values for ''node'' are 1 and 2.
 +
*'''-l''' ''local-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 [[Cisco Unified MeetingPlace Release 8.0 -- Configuring Application Server Failover for Cisco Unified MeetingPlace#Application_Server_Failover|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 [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#hostname|hostname]] command is used.
 +
 +
*'''-r''' ''remote-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.
-
Parameters:
 
-
* '''-s''' ''site''-Specifies the site of the node on which you run this command. Valid values for ''site'' are 1 and 2.
 
-
* '''-n''' ''node''-Specifies the node (within the specified site) on which you run the command. Valid values for ''node'' are 1 and 2.
 
-
* '''-l''' ''local-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 [[Cisco Unified MeetingPlace Release 8.0 -- Configuring Application Server Failover for Cisco Unified MeetingPlace#Application Server Failover|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 [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#hostname|hostname]] command is used.
 
-
* '''-r''' ''remote-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  
-
mp_replication switchON
+
-
|
+
 +
|
Starts replication between two Application Servers.  
Starts replication between two Application Servers.  
-
* Run this command on node 1 only.
 
-
* Run this command only after running the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#mp_replication init|mp_replication init]] command on each node involved in replication.
 
 +
*Run this command on node 1 only.
 +
*Run this command only after running the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#mp_replication_init|mp_replication init]] command on each node involved in replication.
-
Syntax: '''mp_replication switchON''' '''-r''' ''remote-server'' ['''-S''' '''-F''' ''data-source-server''] ['''-v''']  
+
<br> Syntax: '''mp_replication switchON''' '''-r''' ''remote-server'' ['''-S''' '''-F''' ''data-source-server''] ['''-v''']  
 +
<br> Parameters:
-
Parameters:
+
*'''-r''' ''remote-server''-Specifies the hostname or IP address of the other Application Server with which to establish replication.
-
* '''-r''' ''remote-server''-Specifies the hostname or IP address of the other Application Server with which to establish replication.
+
-
: For intra-site replication, which is used for Application Server failover, specify the hostname or IP address of the virtual network interface eth0:0.
+
-
* '''-S''' '''-F''' ''data-source-server''-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 [[Cisco Unified MeetingPlace Release 8.0 -- Configuring Application Server Failover for Cisco Unified MeetingPlace#Application Server Failover|Application Server Failover]], specify the hostname or IP address of the virtual network interface eth0:0.
+
-
* '''-v'''-Specifies verbose output.
+
-
|-
+
-
|
+
-
mp_replication status
+
:For intra-site replication, which is used for Application Server failover, specify the hostname or IP address of the virtual network interface eth0:0.
-
|
+
-
Displays the status of replication between the specified servers.
+
*'''-S''' '''-F''' ''data-source-server''-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 [[Cisco Unified MeetingPlace Release 8.0 -- Configuring Application Server Failover for Cisco Unified MeetingPlace#Application_Server_Failover|Application Server Failover]], specify the hostname or IP address of the virtual network interface eth0:0.
-
Syntax: '''mp_replication status''' ['''-v''']
+
*'''-v'''-Specifies verbose output.
 +
 
 +
|-
 +
|
 +
mp_replication status
 +
|
 +
Displays the status of replication between the specified servers.
-
Parameter: '''-v'''-Specifies verbose output.
+
<br> Syntax: '''mp_replication status''' ['''-v''']
 +
<br> 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.  
+
<br> 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.  
 +
<br> The State shows the connection status, for example, dropped, disconnected, and so forth.
-
The State shows the connection status, for example, dropped, disconnected, and so forth.
 
|-
|-
-
|
+
|  
 +
mp_replication switchOFF
-
mp_replication switchOFF
+
|  
-
|
+
Stops replication, but does not restore configuration changes.
-
Stops replication, but does not restore configuration changes.
+
*Run this command on node 1 only.  
-
* Run this command on node 1 only.  
+
*To restart replication, use the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#mp_replication_switchON|mp_replication switchON]] command.  
-
* To restart replication, use the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#mp_replication switchON|mp_replication switchON]] command.
+
*To restore the configuration changes done by the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#mp_replication_init|mp_replication init]] command, use the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#mp_replication_teardown|mp_replication teardown]] command.
-
* To restore the configuration changes done by the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#mp_replication init|mp_replication init]] command, use the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#mp_replication teardown|mp_replication teardown]] command.
+
 +
<br> Syntax: '''mp_replication switchOFF''' ['''-l''' ''local-server''] '''-r''' ''remote-server'' ['''-v'''] ['''-f''']
-
Syntax: '''mp_replication switchOFF''' ['''-l''' ''local-server''] '''-r''' ''remote-server'' ['''-v'''] ['''-f''']
+
<br> Parameters: See the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#mp_replication_init|mp_replication init]] command. Exception:
 +
*'''-f'''-Specifies to remove the local server from replication even in the following cases:
 +
**Specified remote server is not part of replication.
 +
**Local server is not in replication with any other servers.
-
Parameters: See the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#mp_replication init|mp_replication init]] command. Exception:
 
-
* '''-f'''-Specifies to remove the local server from replication even in the following cases:
 
-
** Specified remote server is not part of replication.
 
-
** Local server is not in replication with any other servers.
 
|-
|-
-
|
+
|  
-
 
+
mp_replication teardown  
-
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.  
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.  
 +
<br> Syntax: '''mp_replication teardown''' ['''-l''' ''local-server''] '''-r''' ''remote-server'' ['''-v'''] ['''-f''']
-
Syntax: '''mp_replication teardown''' ['''-l''' ''local-server''] '''-r''' ''remote-server'' ['''-v'''] ['''-f''']
+
<br> Parameters: See the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#mp_replication_init|mp_replication init]] command.
-
 
+
-
Parameters: See the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#mp_replication init|mp_replication init]] command.
 
|}
|}
-
===== Related Topics =====
+
===== Related Topics =====
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Configuring Cisco Unified MeetingPlace Directory Service#Configuring Cisco Unified MeetingPlace Directory Service|Configuring Cisco Unified MeetingPlace Directory Service]] module
+
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Configuring Application Server Failover for Cisco Unified MeetingPlace#Configuring Application Server Failover for Cisco Unified MeetingPlace|Configuring Application Server Failover for Cisco Unified MeetingPlace]] module
+
 +
*[[Cisco Unified MeetingPlace Release 8.0 -- Configuring Cisco Unified MeetingPlace Directory Service#Configuring_Cisco_Unified_MeetingPlace_Directory_Service|Configuring Cisco Unified MeetingPlace Directory Service]] module
 +
*[[Cisco Unified MeetingPlace Release 8.0 -- Configuring Application Server Failover for Cisco Unified MeetingPlace#Configuring_Application_Server_Failover_for_Cisco_Unified_MeetingPlace|Configuring Application Server Failover for Cisco Unified MeetingPlace]] module
 +
 +
<br>
=== Failover Commands for the Application Server  ===
=== Failover Commands for the Application Server  ===
 +
'''Note: ''' You must be signed in to the Application Server CLI as the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#root|root]] user to enter the failover commands in [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Table:_Command_Reference:_Failover_Commands_for_the_Application_Server|Table: Command Reference: Failover Commands for the Application Server]].
-
'''Note: ''' You must be signed in to the Application Server CLI as the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#root|root]] user to enter the failover commands in [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#Table: Command Reference: Failover Commands for the Application Server|Table: Command Reference: Failover Commands for the Application Server]].
+
<br>
 +
===== Table: Command Reference: Failover Commands for the Application Server  =====
-
===== Table: Command Reference: Failover Commands for the Application Server =====
+
{| border="1"
-
 
+
-
{| border = 1  
+
|-
|-
-
!Command
+
! Command  
-
!Description
+
! Description
|-
|-
-
|
+
|  
 +
failoverUtil copyConfigFiles
-
failoverUtil copyConfigFiles
+
|  
-
|
+
Transfers configuration files from one Application Server to the other, specifically:
-
Transfers configuration files from one Application Server to the other, specifically:
+
#Compresses the configuration files and user prompts on the local server.  
-
# Compresses the configuration files and user prompts on the local server.
+
#Transfers the compressed files to the remote server.
-
# Transfers the compressed files to the remote server.
+
 +
<br> After you enter this command on the local server, you need to enter the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#failoverUtil_restoreConfigFiles|failoverUtil restoreConfigFiles]] on the remote server.
-
After you enter this command on the local server, you need to enter the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#failoverUtil restoreConfigFiles|failoverUtil restoreConfigFiles]] on the remote server.
+
<br> 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
-
The following files and directories are transferred by this command:
+
<br> Syntax: '''failoverUtil copyConfigFiles'''
-
* 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
-
failoverUtil restoreConfigFiles
+
|  
-
|
+
Completes the transfer of configuration files from one Application Server to the other, specifically:
-
Completes the transfer of configuration files from one Application Server to the other, specifically:
+
#Decompresses the configuration files and user prompts that were transferred from the remote server.  
-
# Decompresses the configuration files and user prompts that were transferred from the remote server.  
+
#Places the transferred files into the correct directories, overwriting any existing local files with those from the remote server.
-
# 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.
+
'''Note: ''' The failoverUtil copyConfigFiles and failoverUtil restoreConfigFiles commands are entered on separate Application Servers.  
 +
<br> Syntax: '''failoverUtil restoreConfigFiles'''
-
Syntax: '''failoverUtil restoreConfigFiles'''
 
|-
|-
-
|
+
|  
 +
failoverUtil setDeployment failover
-
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.
-
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.
+
<br> Syntax: '''failoverUtil setDeployment failover'''
-
 
-
Syntax: '''failoverUtil setDeployment failover'''
 
|-
|-
-
|
+
|  
-
 
+
failoverUtil setDeployment singleServer  
failoverUtil setDeployment singleServer  
-
|
 
-
Restores a failover-deployed Application Server to a single-server deployment.
+
|
 +
Restores a failover-deployed Application Server to a single-server deployment.  
 +
<br> Syntax: '''failoverUtil setDeployment singleServer'''
-
Syntax: '''failoverUtil setDeployment singleServer'''
 
|-
|-
-
|
+
|  
-
 
+
failoverUtil setServer  
-
failoverUtil setServer
+
-
|
+
 +
|
Sets a failover-deployed Application Server to either active or standby mode.  
Sets a failover-deployed Application Server to either active or standby mode.  
 +
<br> Enter this command only after running the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#failoverUtil_setDeployment_failover|failoverUtil setDeployment failover]] command on the server.
-
Enter this command only after running the [[Cisco Unified MeetingPlace Release 8.0 -- Using the Command-Line Interface (CLI) on the Cisco Unified MeetingPlace Application Server#failoverUtil setDeployment failover|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.  
-
 
+
-
'''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.
+
 +
<br> Syntax: '''failoverUtil setServer''' {'''active''' &#124; '''standby'''}
-
Syntax: '''failoverUtil setServer''' {'''active''' | '''standby'''}
 
|-
|-
-
|
+
|  
-
 
+
failoverUtil status  
failoverUtil status  
-
|
 
-
Displays the current modes of the Application Server, specifically:
+
|
-
* Whether the server is deployed for failover or as a single server.
+
Displays the current modes of the Application Server, specifically:  
-
* If deployed for failover, then whether the server is in active or standby mode.
+
 +
*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.
 +
 +
<br> Syntax: '''failoverUtil status'''
-
Syntax: '''failoverUtil status'''
 
|}
|}
 +
<br>
 +
<br>
 +
===== Related Topics  =====
-
===== Related Topics =====
+
*[[Cisco Unified MeetingPlace Release 8.0 -- Configuring Application Server Failover for Cisco Unified MeetingPlace#Configuring_Application_Server_Failover_for_Cisco_Unified_MeetingPlace|Configuring Application Server Failover for Cisco Unified MeetingPlace]] module
-
* [[Cisco Unified MeetingPlace Release 8.0 -- Configuring Application Server Failover for Cisco Unified MeetingPlace#Configuring Application Server Failover for Cisco Unified MeetingPlace|Configuring Application Server Failover for Cisco Unified MeetingPlace]] module
+
-
 
+
-
[[Category: Reference Information for Cisco Unified MeetingPlace Release 8.0]]
+
[[Category:Reference_Information_for_Cisco_Unified_MeetingPlace_Release_8.0]]

Latest revision as of 23:10, 10 April 2012

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.


Contents

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.



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

CLI User Level Description

mpxadmin

We recommend that you use this user level whenever possible.

root

Highest authority, enabling you to do the following:


To get to the root user level, do one of 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


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

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
  1. Connect the monitor, keyboard, and mouse to the Application Server.
    The Cisco Unified MeetingPlace operating system sign-in page is displayed.
  2. For the username, enter mpxadmin.
  3. Enter the password for the mpxadmin user.
    This was established during installation.
  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 for information about the operating system commands.
  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

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
  1. From your computer, go to Start > Programs > SSH Secure Shell > Secure Shell Client.
  2. Select Quick Connect.
  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>


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

Application Server Command Reference


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.


Syntax: activity

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.


Syntax: alarm

ccamon

Monitors the Call Control Agent. Allows you to view the call statistics and set the log tracing level.


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 in the Using Alarms and Logs on Cisco Unified MeetingPlace module.


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 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 Cisco Unified MeetingPlace Application Server module.


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 in the Configuring Cisco Unified MeetingPlace Directory Service module.

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.

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.


Restrictions:


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

infocapmtg

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


Syntax: infocapmtg [meetingID] [-S | -P | -Bminutes] [-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

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:


Syntax: net

ntpdate

Sets the Application Server date and time to match the time obtained by polling an NTP (2) 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.

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


Syntax: taccli

techui

Displays statistics for the Media Server, ports, and conferences.


This technician user interface helps to diagnose and troubleshoot media and voice quality issues of active calls.


Syntax: techui

userinfo

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

  • User ID
  • 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.
  • userid-User ID.
  • 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



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.


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

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.


Syntax: mp_replication init -s site -n node [-l local-server] -r remote-server {-h | -m} [-v]


Parameters:

  • -s site-Specifies the site of the node on which you run this command. Valid values for site are 1 and 2.
  • -n node-Specifies the node (within the specified site) on which you run the command. Valid values for node are 1 and 2.
  • -l local-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.
  • -r remote-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.


Syntax: mp_replication switchON -r remote-server [-S -F data-source-server] [-v]


Parameters:

  • -r remote-server-Specifies the hostname or IP address of the other Application Server with which to establish replication.
For intra-site replication, which is used for Application Server failover, specify the hostname or IP address of the virtual network interface eth0:0.
  • -S -F data-source-server-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.


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


Parameters: See the mp_replication init command. Exception:

  • -f-Specifies to remove the local server from replication even in the following cases:
    • Specified remote server is not part of replication.
    • Local server is not in replication with any other servers.

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


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:

  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

Rating: 0.0/5 (0 votes cast)

Personal tools