Configuration Guide for Cisco Unified MeetingPlace Release 8.5
Using the Command-Line Interface (CLI) on the Cisco WebEx Node
Downloads: This chapterpdf (PDF - 167.0KB) | Feedback

Using the Command-Line Interface (CLI) on the Cisco WebEx Node for MCS

Table Of Contents

Using the Command-Line Interface (CLI) on the Cisco WebEx Node for MCS

Cisco WebEx Node for MCS CLI User Level Options

Restrictions for the Cisco WebEx Node for MCS CLI

How to Sign In to the Cisco WebEx Node for MCS CLI

Signing In to the Cisco WebEx Node for MCS CLI By Using the Console

Signing In to the Cisco WebEx Node for MCS CLI By Using SSH

Creating Additional Administrator User Accounts on Cisco WebEx Node for MCS

Cisco WebEx Node for MCS CLI Command Reference

Command Syntax Conventions

Using the Cisco WebEx Node for MCS CLI

General Commands

Service Commands

Set Commands

Show Commands

Utility Commands


Using the Command-Line Interface (CLI) on the Cisco WebEx Node for MCS


Release 8.5
Revised: October 30, 2012 7:30 pm


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


Cisco WebEx Node for MCS CLI User Level Options

Restrictions for the Cisco WebEx Node for MCS CLI

How to Sign In to the Cisco WebEx Node for MCS CLI

Creating Additional Administrator User Accounts on Cisco WebEx Node for MCS

Cisco WebEx Node for MCS CLI Command Reference

Cisco WebEx Node for MCS CLI User Level Options

CLI User Level
Description

wbxadmin

Used for all tasks in the Cisco WebEx Node for MCS CLI.

We recommend that you use this user level whenever possible.

If you sign in as wbxadmin on either the console or SSH, you go to the Cisco WebEx Node for MCS CLI.

Standard Linux commands do not work in a Cisco WebEx Node for MCS CLI session. Use utils system terminal to launch a standard Linux terminal session. See Cisco WebEx Node for MCS CLI Command Reference: Utility Commands.

root

Highest authority. Only use for maintenance.

If you sign in as root (which you can only do on the console), you go to the standard Linux CLI.

You need to enter the root password for privileged commands.


Related Topics

Signing In to the Cisco WebEx Node for MCS CLI By Using the Console

Signing In to the Cisco WebEx Node for MCS CLI By Using SSH

Restrictions for the Cisco WebEx Node for MCS CLI

The Cisco WebEx Node for MCS CLI and its commands are available only in English.

The Cisco WebEx Node for MCS CLI accepts only the standard 128 ASCII characters.

Many commands prompt you for information. If the Backspace key does not delete characters in this interactive mode, press the Delete key to delete the previous character.

How to Sign In to the Cisco WebEx Node for MCS CLI

Signing In to the Cisco WebEx Node for MCS CLI By Using the Console

Signing In to the Cisco WebEx Node for MCS CLI By Using SSH

Signing In to the Cisco WebEx Node for MCS CLI By Using the Console

You can use the console to do one of the following:

Sign in to the Cisco WebEx Node for MCS CLI as the wbxadmin user.

Sign in to the Linux terminal as the root user.

You cannot sign in directly to the Cisco WebEx Node for MCS CLI as the root user.

Procedure


Step 1 Connect the monitor, keyboard, and mouse to the Cisco WebEx Node for MCS.

The Cisco Unified Communications system sign-in page is displayed.

Step 2 For the username, enter wbxadmin.

Step 3 Enter the password for the wbxadmin user. This was established during installation.

The system displays the CLI. You can now enter commands.

Step 4 When you are finished with the CLI, either enter exit.


Note Always sign out of the Cisco Unified Communications system when you are finished.



Related Topics

Signing In to the Cisco WebEx Node for MCS CLI By Using SSH

Cisco WebEx Node for MCS CLI Command Reference

Changing the Password for root or wbxadmin on the Cisco WebEx Node in the Changing System Administrator Passwords for Cisco Unified MeetingPlace module

Signing In to the Cisco WebEx Node for MCS CLI By Using SSH

You can sign in as the wbxadmin user to the CLI by using SSH. You cannot, however, sign in as the root user to the CLI by using SSH.

This section describes one method of signing in to the CLI by using SSH. Other methods might be available for you.

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 by using SSH.

Procedure


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

Step 2 Click Quick Connect.

Step 3 In the Connect to Remote Host dialog box, enter these values:

Field
Value

Host Name

IP address of your Cisco WebEx Node for MCS

User Name

wbxadmin

Port Number

22

Authentication Method

leave as <Profile Settings>


Step 4 Click Connect.

Step 5 In the Enter Password dialog box, enter the password for the wbxadmin user. This was established during installation.

Step 6 Click OK.

The system displays the CLI, and you can now enter commands.


Related Topics

Signing In to the Cisco WebEx Node for MCS CLI By Using the Console

Cisco WebEx Node for MCS CLI Command Reference

Creating Additional Administrator User Accounts on Cisco WebEx Node for MCS

This procedure shows you how to mitigate security concerns by creating multiple accounts with root access and an audit trail on the Cisco WebEx Node for MCS.

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

In this procedure, we are adding user, user123.


Step 1 Sign in to the Cisco WebEx Node for MCS command-line interface as the root user.

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

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

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

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

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

%mpx ALL=(root) NOPASSWD: /opt/cisco/webex/current/bin/cisco_cli.py
 
   

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

$ ssh <user123>@<a.b.c.d>
<user123>@<a.b.c.d>'s password: 
[<user123>@mp_wbxnode ~]$ sudo /opt/cisco/webex/current/bin/cisco_cli.py
 
   
 
   
mp_wbxnode > show webex version
 
   
Operating System Information
==============================================
 
   
Cisco Unified Communications Linux AS4 (Nahant Update 8)
Build 407  October 24, 2012
 
   
 
   
List Cisco Unified Communications Product
==============================================
 
   
Cisco Webex Node 8.5.5.1 ...
 
   
 
   

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

Oct 29 15:30:15 mp_wbxnode sshd[16879]: Accepted password for user123 from 
::ffff:10.63.53.79 port 50838 ssh2
Oct 29 15:30:33 mp_wbxnode sudo:  user123 : TTY=pts/1 ; PWD=/home/user123 ; USER=root ; 
COMMAND=/opt/cisco/webex/current/bin/cisco_cli.py
 
   


Note On the Cisco WebEx Node for MCS, the wbxadmin user has restricted shell access. If you want to set it for new user, user123, complete the following:


1. As the root user, edit the /etc/passwd file and redirect the new user to:

/opt/cisco/webex/current/bin/cisco_cli.py instead of /bin/bash (the default)

2. Add the new user to the mpx group (complete the steps in the preceding procedure).

3. Edit the sudoers file and give all the same privileges that wbxadmin has to user123:

wbxadmin ALL=(root) NOPASSWD: /opt/cisco/webex/current/bin/cisco_cli.py 

Cisco WebEx Node for MCS CLI Command Reference

Command Syntax Conventions

Using the Cisco WebEx Node for MCS CLI

General Commands

Service Commands

Set Commands

Show Commands

Utility Commands

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.


Using the Cisco WebEx Node for MCS CLI

You can save the output for a command to the download directory by entering the following:

command_name > file_name

where command_name is the name of the command and file_name is the name of the file in the download directory to which you want to write the output.

To display just one page of output at a time, enter the following:

command_name | less

where command_name is the name of the command.

To complete a line or show available commands, either enter ? or press Tab.

To abort a command, press Ctrl-C.

General Commands

Table 1 Cisco WebEx Node for MCS CLI Command Reference: General Commands 

Command
Description

exit

Exits the Cisco WebEx Node for MCS CLI.

Syntax: exit

help

Can be used in three ways:

If entered alone, displays general information about the Cisco WebEx Node for MCS CLI.

If you enter a command and use the wrong syntax, displays help for that command.

If you enter help command_name, displays help for that command.

Syntax: help [command_name]

history

Displays a list of recent commands that were used during the current session.

Syntax: history

interactive

Enables or disables interactive mode.

When interactive mode is enabled, the system prompts you for required input arguments one at a time until you have entered all the required arguments. The system then displays them for confirmation. If you do not confirm the entries, the system repeats this process. By default, interactive mode is disabled.

Syntax: interactive


Service Commands

The commands in the service group are used to control specific services within the system. Common actions are:

start—Starts the service.

stop—Stops the service.

restart—Restarts the service.

status—Provides a status of the service.

enable—Enables the service to start automatically.

disable—Disables the service from starting automatically.

We recommend that you enable and run all of these services at all times.

Table 2 Cisco WebEx Node for MCS CLI Command Reference: Service Commands 

Command
Description

service csa

Provides additional security to the system.

Syntax: service csa {start | stop | restart | status | enable | disable }

service firewall

Provides additional security to the system by restricting network traffic to specific ports.

Syntax: service firewall {start | stop | restart | status | enable | disable }

service network

Provides network connectivity for the system.

Syntax: service network {start | stop | restart | status | enable | disable }

service appserver

Maintains a link to the Application Server.

Syntax: service appserver {start | stop | restart | status | enable | disable }

service ntp

Responds to time requests from other systems, allowing their clocks to remain synchronized.

Syntax: service ntp {start | stop | restart | status | enable | disable }

service ssh

Enables management via a remote connection.

Syntax: service ssh {start | stop | restart | status | enable | disable }

service webex

Controls the meeting services.

Syntax: service webex {start | stop | restart | status | enable | disable }


Set Commands

Use the commands in the set group to configure the system.

Table 3 Cisco WebEx Node for MCS CLI Command Reference: Set Commands 

Command
Description

set network domain

If you did not enter this value during installation, or if you need to change it later, use this command to set the domain name for DNS resolution.

The domain_name input should be in the format company_name.com; for example: cisco.com.

Syntax: set network domain domain_name

set network hostname

If you did not enter this value during installation, or if you need to change it later, use this command to set the hostname for the Cisco WebEx Node for MCS.

The hostname_value must be a Fully Qualified Domain Name (FQDN); for example: mpxSystem.cisco.com.

Syntax: set network hostname hostname_value

set network ip

If you did not enter this value during installation, or if you need to change it later, use this command to set the IP address of the Cisco Unified MeetingPlace system.

The IP_address_value should be in the format ddd.ddd.ddd.ddd.

Syntax: set network ip IP_address_value

set network gateway

If you did not enter this value during installation, or if you need to change it later, use this command to set the IP address of the default gateway address for Cisco Unified MeetingPlace.

The IP_address_value should be in the format ddd.ddd.ddd.ddd.

Syntax: set network gateway IP_address_value

set network nameserver

Sets the primary and secondary DNS addresses for Cisco Unified MeetingPlace.

Enter at least one nameserver. You can enter multiple nameservers, each separated by a comma, with no space after each comma. These values should be in the format ddd.ddd.ddd.ddd.

Syntax: set network nameserver nameserver_1_value[,nameserver_2_value]

set network netmask

If you did not enter this value during installation, or if you need to change it later, use this command to set the subnet mask for Cisco Unified MeetingPlace.

The subnet_mask_value should be in the format ddd.ddd.ddd.ddd.

Syntax: set network netmask subnet_netmask_value

set password

Note This is a privileged command, which means that after you enter the command, you have to enter the root password to continue.

Changes the password for either the root or the wbxadmin user. Enter the user name for which you want to change the password. The system will prompt you for the new password.

Syntax: set password user_name

set webex appserver

Configures the Application Server link information for the Cisco WebEx Node for MCS.

Note This command is interactive; the system prompts you for additional information. Use this command for MeetingPlace-scheduled deployments only. For WebEx-scheduled deployments see set webex mbd.

 Syntax: set webex appserver

set webex config passname

Sets the Cisco WebEx connection passcode name.

Note This information must be provided by a Cisco WebEx representative.

Syntax: set webex config passname passcode_name_value

set webex config passcode

Sets the Cisco WebEx Node for MCS connection passcode.

Note This information must be provided by a Cisco WebEx representative.

Syntax: set webex config passcode passcode_value

set webex config token

Sets the Cisco WebEx Node for MCS connection token.

Note This information must be provided by a Cisco WebEx representative.

Syntax: set webex config token connection_token_value

set webex config url

Sets the Cisco WebEx Node for MCS connection URL.

Note This information must be provided by a Cisco WebEx representative.

Syntax: set webex config url URL_value

set webex config serial

Sets the serial number for the Cisco WebEx Node for MCS.

Note This information must be provided by a Cisco WebEx representative.

Syntax: set webex config serial serial_number_value

set webex mbd

Configures the Cisco WebEx scheduling application server link information.

Syntax: set webex mbd Primary Meeting Director hostname,Secondary Meeting Director hostname


Note When you enter the Primary and Secondary Meeting Director node hostnames, make sure to enter a comma with no space between the two node names.


set webex snmp version

Sets the SNMP version for the Cisco WebEx Node for MCS.

The version_number can be one of the following values:

none—SNMP is disabled

v2—Version 2

v3—Version 3

Syntax: set webex snmp version version_number

set webex snmp manager

Sets the destination (IP address) for SNMP traps for both Version 2 and Version 3.

The IP_address_value should be in the format ddd.ddd.ddd.ddd.

Syntax: set webex snmp manager IP_address_value

set webex snmp community

Sets the SNMP Version 2 community string.

The community_string_name must not contain any spaces.

Syntax: set webex snmp community community_string_name

set webex snmp auth

Sets the SNMP Version 3 authentication key.

Syntax: set webex snmp auth authentication_key

set webex snmp priv

Sets the SNMP Version 3 privacy key.

Syntax: set webex snmp priv privacy_key

set webex snmp user

Sets the name for an SNMP Version 3 user. This user retrieves the SNMP information and does not correspond to any Cisco Unified MeetingPlace end user or administrative user accounts. Give this user a meaningful name.

Syntax: set webex snmp user user_name

set webex slimtty

The SlimTTY feature allows Cisco WebEx to remotely access the system for troubleshooting purposes. This command sets the SlimTTY level to either enabled or disabled.

The status_value can be either "enabled" or "disabled".

Syntax: set webex slimtty status_value


Related Topics

Installing the Cisco WebEx Node for MCS module

Configuring SNMP on the Cisco Unified MeetingPlace Application Server module

Show Commands

Enter the commands in the show group to display information about the system.

Table 4 Cisco WebEx Node for MCS CLI Command Reference: Show Commands 

Command
Description

show cpu info

Shows CPU information as detected by the system.

Syntax: show cpu info

show cpu usage

Shows current CPU usage in a running display, refreshed every second.

Syntax: show cpu usage

show csa debug

Shows detailed Cisco Security Agent (CSA) log information.

Syntax: show csa debug

show csa events

Shows deny events that have been logged by Cisco Security Agent (CSA).

Syntax: show csa events

show csa log

Shows the entire Cisco Security Agent (CSA) log.

Syntax: show csa log

show csa status

Shows the current Cisco Security Agent (CSA) status.

Syntax: show csa status

show disk activity

Shows current disk activity in a running display, refreshed every five seconds.

Syntax: show disk activity

show disk io

Shows current disk I/O metrics in a running display, refreshed every five seconds.

Syntax: show disk io

show disk usage

Shows current local disk usage.

Syntax: show disk usage

show login history

Displays login history for the administrator login.

Syntax: show login history

show memory info

Shows installed memory information as detected by the system.

Syntax: show memory info

show memory usage

Shows current memory usage.

Syntax: show memory usage

show network config

Shows the current network configuration.

Syntax: show network config

show network connections

Shows current network connections.

Syntax: show network connections

show network firewall

Shows current firewall configuration.

Syntax: show network firewall

show network interfaces

Shows current network interfaces.

Syntax: show network interfaces

show network route

Shows the current network routing table.

Syntax: show network route

show network stats

Displays network statistics.

Syntax: show network stats

show ntp

Shows current NTP status information.

Syntax: show ntp

show system cache

Shows the current kernel cache usage.

Syntax: show system cache

show system date

Displays the current date and time.

Syntax: show system date

show system load

Displays the current system load information.

Syntax: show system load

show system memory

Shows the current system memory usage.

Syntax: show system memory

show system processes

Displays a list of currently running processes.

Syntax: show system processes

show system time

Displays the current date and time.

Syntax: show system time

show system uptime

Shows the amount of time that the system has been up since the last reboot.

Syntax: show system uptime

show system vmemory

Shows the current virtual memory usage in a running display, refreshed every second.

Syntax: show system vmemory

show system hardware

Displays the current hardware.

Syntax: show system hardware

show webex appserver

Shows the current Application Server link status and information.

Syntax: show webex appserver

show webex status

Shows the current status of the Cisco WebEx Node for MCS.

Syntax: show webex status

show webex config

Shows the Cisco WebEx Node for MCS configuration.

Syntax: show webex config

show webex services

Shows the current status of the Cisco WebEx Node for MCS services.

Syntax: show webex services

show webex snmp

Shows the current SNMP configuration.

Syntax: show webex snmp

show webex version

Shows the Cisco WebEx Node for MCS version number.

Syntax: show webex version

show webex mibs

Shows available SNMP MIBs.

Syntax: show webex mibs

show webex log

Shows the Cisco WebEx Node for MCS services log.

Syntax: show webex log

show webex meeting error

Shows error level logs for a particular meeting ID.

Syntax: show webex meeting error meeting_ID

show webex meeting info

Shows information level logs for a particular meeting ID.

Syntax: show webex meeting info meeting_ID

show webex meeting log

Shows the entire log for a particular meeting ID.

Syntax: show webex meeting log meeting_ID

show webex meeting warning

Shows the warning level logs for a particular meeting ID.

Syntax: show webex meeting warning meeting_ID

show webex slimtty

The SlimTTY feature allows Cisco WebEx to remotely access the system for troubleshooting purposes. This command shows the status of the SlimTTY configuration.

Syntax: show webex slimtty


Related Topics

Configuring SNMP on the Cisco Unified MeetingPlace Application Server module

Checking the Status of the Cisco WebEx Node in the Troubleshooting Cisco Unified MeetingPlace Integration with Cisco WebEx module

Utility Commands

Use the commands in the utils group to perform utility functions for various aspects of the system.

Table 5 Cisco WebEx Node for MCS CLI Command Reference: Utility Commands 

Command
Description

utils cdrom check

Performs a media check on the disk in the CD/DVD ROM drive. Only valid on install media.

Syntax: utils cdrom check

utils cdrom eject

Ejects the CD/DVD ROM drive.

Syntax: utils cdrom eject

utils csa diagnostics

Captures diagnostic information from the Cisco Security Agent (CSA).

Syntax: utils csa diagnostics

utils file checksum md5

Performs an MD5 checksum against a file.

Enter the name of the file against which you want to perform the checksum.

Syntax: utils file checksum md5 file_name

utils file checksum sha1

Performs an SHA1 checksum against a file.

Enter the name of the file against which you want to perform the checksum.

Syntax: utils file checksum sha1 file_name

utils file copy

Copies the contents of one file to another.

Enter the source location and the destination location.

Syntax: utils file copy source_location destination_location

utils file list

Lists the files available in the download location.

Syntax: utils file list

utils file mkdir

Creates a new directory in the download location.

Syntax: utils file mkdir new_directory_name

utils file open

Opens a file for viewing.

Syntax: utils file open file_name

utils file remove

Removes a file from the download location.

Syntax: utils file remove file_name

utils firewall zero

Sets the counters that are displayed in the "show network firewall" output to zero.

Syntax: utils firewall zero

utils infocap recent

Collects logs from the previous hour of operation.

Syntax: utils infocap recent

utils infocap time

Collects logs from the specified time period.

Enter the start and end times in the format [YY]MMDDHHMM. Entering the year is optional. If no year is entered, the system assumes it is the current year.

Syntax: utils infocap time start_time end_time

utils network arping

Performs an arping against a specified IP address.

The IP_address_value should be in the format ddd.ddd.ddd.ddd.

Syntax: utils network arping IP_address_value

utils network nslookup

Performs an nslookup for a specified hostname.

Syntax: utils network nslookup hostname

utils network ping

Pings a specified hostname.

Syntax: utils network ping hostname

utils network tcpdump

Performs a TCP dump operation to capture network traffic.

Syntax: utils network tcpdump

utils network tracepath

Performs a tracepath to a given host.

Enter a hostname or IP address. If you enter an IP address, it should be in the format ddd.ddd.ddd.ddd.

Syntax: utils network tracepath hostname_or_IP_address_value

utils network traceroute

Performs a traceroute to a given host.

Enter a hostname or IP address. If you enter an IP address, it should be in the format ddd.ddd.ddd.ddd.

Syntax: utils network traceroute hostname_or_IP_address_value

utils snmp v2 get

Performs an SNMP Version 2 "get" for a specified object identifier (OID). You must specify an OID, community string, and hostname.

Syntax: utils snmp v2 get community_string hostname OID

utils snmp v2 walk

Performs an SNMP Version 2 "walk" for a specified object identifier (OID). You must specify an OID, community string, and hostname.

Syntax: utils snmp v2 walk community_string hostname OID

utils snmp v3 get

Performs an SNMP Version 3 "get" for a specified object identifier (OID). You must specify a user name, authority level, privacy level, hostname, and OID.

Syntax: utils snmp v3 get user_name authority_level privacy_key hostname OID

utils snmp v3 walk

Performs an SNMP Version 3 "walk" for a specified object identifier (OID). You must specify a user name, authority level, privacy level, hostname, and OID.

Syntax: utils snmp v3 walk user_name authority_level privacy_key hostname OID

utils ssh

Connects to a remote host via SSH.

Enter a user name and hostname.

Syntax: utils ssh user_name hostname

utils system reboot

Reboots the system.

Syntax: utils system reboot

Note This is a privileged command, which means that after you enter the command, you have to enter the root password to continue.

utils system shutdown

Powers off the system.

Syntax: utils system shutdown

Note This is a privileged command, which means that after you enter the command, you have to enter the root password to continue.

utils system install

Installs new software from the download directory. Enter the name of the software file.

Syntax: utils system install file_name

Note This is a privileged command, which means that after you enter the command, you have to enter the root password to continue.

utils system terminal

Launches a standard Linux terminal session.

Note Cisco WebEx Node for MCS CLI commands will not work in a standard Linux terminal session.

Syntax: utils system terminal

Note This is a privileged command, which means that after you enter the command, you have to enter the root password to continue.


Related Topics

Configuring SNMP on the Cisco Unified MeetingPlace Application Server module