Table Of Contents

How to Use the Cisco UMG CLI

About the Cisco UMG CLI

Understanding Command Modes

Entering the Command Environment

Prerequisites

Summary Steps

Detailed Steps

Exiting the Command Environment

Getting Help

Using the no and default Forms of Commands

Saving Configuration Changes

Troubleshooting Configuration Changes

How to Use the Cisco UMG CLI

---

Last Updated: August 5, 2011

This chapter provides helpful tips for understanding and configuring the Cisco UMG software using the CLI.

•About the Cisco UMG CLI

•Cisco UMG uses the network module's CLI, which you access through the host-router console. The network module CLI is similar to the router CLI.

•Entering the Command Environment

•Getting Help

•Using the no and default Forms of Commands

•Saving Configuration Changes

•Troubleshooting Configuration Changes

About the Cisco UMG CLI

Cisco UMG uses the network module's CLI, which you access through the host-router console. The network module CLI is similar to the router CLI.

The Cisco UMG CLI commands have a structure very similar to that of Cisco IOS CLI commands. For both interfaces, standard Cisco IOS navigation and command-completion conventions apply. For example, ? lists options, TAB completes a command, and | directs show command output. However, the Cisco UMG CLI commands do not affect Cisco IOS configurations. After you have logged in to the Cisco UMG module, the command environment is no longer the Cisco IOS environment.

The following are differences between the Cisco UMG CLI and the Cisco IOS CLI:

•Standard command names and options do not necessarily apply. A notable example is the command for accessing global configuration mode: the Cisco IOS command is configure terminal; the network module command is config terminal or config t.

•Cisco UMG employs a last-one-wins rule. For example, if George and Frank both try to set the IP address for the same entity at the same time, the system starts and completes one operation before it starts the next. The last IP address set is the final result.

•The Cisco UMG command modes, privileged EXEC, configuration, registration configuration, list configuration, endpoint configuration, and NAT configuration operate similarly to the EXEC and configuration modes in the Cisco IOS CLI.

•After you enter configuration mode, all the CLI commands can be used in the no form, for example, no network messaging gateway location-id { hostname | ip-address }. This command deletes the specified peer messaging gateway.

Understanding Command Modes

The Cisco UMG command environment is divided into two basic modes:

•EXEC—This is the mode that you are in after you log in to the Cisco UMG command environment. Some Cisco UMG EXEC commands only display or clear parameter values, stop or start the entire system, or start troubleshooting procedures. However, unlike Cisco IOS EXEC mode, Cisco UMG EXEC mode has a few commands that change parameter values. These changes are stored in the module's NV memory, rather than in the startup configuration, so that the system has some minimum information available if a catastrophic event, such as a power or disk failure, occurs.

•Configuration—This mode permits you to make system configuration changes, which are stored in the running configuration. If you later save the running configuration to the startup configuration, the changes made with the configuration commands are restored when you reboot the software.

Cisco UMG configuration mode has various subconfiguration levels. The global configuration mode changes the command environment from EXEC to configuration. You can modify many software parameters at this level. However, certain configuration commands change the environment to more specific configuration modes where modifications to the system are entered. For example, the registration command changes the environment from config to config-reg. At this point, you can enter or modify registration parameter values.

The commands available to you at any given time depend on the mode that you are currently in. Entering a question mark (?) at the CLI prompt displays a list of commands available for each command mode. The descriptions in this command reference indicate each command's environment mode.

Table 1 describes how to access and exit various common command modes of the Cisco UMG software. It also shows examples of the prompts displayed for each mode.

Table 1 Accessing and Exiting Command Modes 

Command Mode	Cisco UMG Release	Access Method	Prompt	Exit Method
Cisco UMG EXEC	1.0 and later	When the Cisco UMG software prompt appears, you can enter the enable command, but it is not necessary.	with enable: umg-1# without enable: umg-1>	Press CTRL-SHIFT-6 and then enter x.
Cisco UMG configuration	1.0 and later	From EXEC mode, use the configure terminal command.	umg-1(config)#	To return to EXEC mode from configuration mode, use the end or exit command.
Registration	1.0 and later	From Cisco UMG configuration mode, use the registration command.	umg-1(config-reg)#	To return to Cisco UMG configuration mode, use the end or exit command.
List manager	1.0 and later	From Cisco UMG configuration mode, use the list-manager command.	umg-1(listmgr)#	To return to Cisco UMG configuration mode, use the end or exit command.
List manager edit	1.0 and later	From Cisco UMG configuration mode, use the list number command.	umg-1(listmgr-edit)#	To return to Cisco UMG list manager mode, use the end or exit command.
NAT configuration	1.0 and later	From Cisco UMG configuration mode, use the nat location command.	umg-1(config-nat)#	To return to Cisco UMG configuration mode, use the end or exit command.
Endpoint configuration	1.0 and later	From Cisco UMG configuration mode, use the endpoint command.	umg-1(config-endpoint)#	To return to Cisco UMG configuration mode, use the end or exit command.
AAA accounting	8.0 and later	From Cisco UMG configuration mode, use the aaa accounting server remote command.	umg-1(aaa-accounting)#	To return to Cisco UMG configuration mode, use the end or exit command.
AAA accounting event	8.0 and later	From Cisco UMG configuration mode, use the aaa accounting event command.	umg-1(aaa-accounting-event)#	To return to Cisco UMG configuration mode, use the end or exit command.
AAA accounting policy	8.0 and later	From Cisco UMG configuration mode, use the aaa policy command.	umg-1(aaa-policy)#	To return to Cisco UMG configuration mode, use the end or exit command.
backup schedule	8.0 and later	From Cisco UMG configuration mode, use the backup schedule command.	umg-1(backup-schedule)#	To return to Cisco UMG configuration mode, use the end or exit command.
kron-schedule	8.0 and later	From Cisco UMG configuration mode, use the kron schedule command.	umg-1(kron-schedule)#	To return to Cisco UMG configuration mode, use the end or exit command.

Entering the Command Environment

After you install the Cisco UMG module, establish IP connectivity with it, and activate the software, use this procedure to enter the command environment.

•Prerequisites

•Summary Steps

•Detailed Steps

Prerequisites

The following information is required to enter the command environment:

•IP address of the router that contains the Cisco UMG module

•Username and password to log in to the router

•Slot number of the module

•Port through which the router communicates with Cisco UMG

Summary Steps

1. Open a Telnet session.

2. telnet ip-address

3. Enter the username and password of the router.

4. On the NME-UMG and NME-UMG-EC, enter:

service-module integrated-Service-Engine slot/port session

On the SM-SRE-700-K9 and SM-SRE-900-K9, enter:

service-module sm slot/port session

5. Start configuration by entering enable.

Detailed Steps

	Command or Action	Purpose
Step 1	Open a Telnet session.	Use a Microsoft DOS window, a secure shell, or a software emulation tool such as Reflection.
Step 2	telnet ip-address Example: C:\> telnet 192.0.2.24	Specifies the IP address of the Cisco Unified Communications Manager router.
Step 3	Username: Password:	Enter your username and password for the router.
Step 4	On the NME-UMG and NME-UMG-EC, enter: service-module integrated-service-engine slot/port session On the SM-SRE-700-K9 or SM-SRE-900-K9, enter: service-module sm slot/port session Example: Router# service-module integrated-service-engine 1/0 session	Enters the Cisco Unity Express command environment using the module located in the specified slot and port. The prompt changes to "se" with the IP address of the Cisco UMG module or the hostname you have assigned to it. Note If the message "Trying ip-address slot/port ... Connection refused by remote host" appears, enter the command service-module integrated service-engine slot/port session clear and try Step 4 again.
Step 5	Start configuration. You can enter enable. Example: umg-1# enable	Enters Cisco UMG EXEC mode. You are ready to begin the configuration tasks.

Exiting the Command Environment

To leave the Cisco UMG command environment and return to the router command environment, in Cisco UMG EXEC mode enter the exit command once to exit EXEC mode, and again to exit the application.

The following example illustrates the exit procedure:

se-10-0-0-0# exit

se-10-0-0-0# exit

router-prompt# 

Getting Help

Entering a question mark (?) at the CLI prompt displays a list of commands available for each command mode. You can also get a list of keywords and arguments associated with any command by using the context-sensitive help feature.

To get help specific to a command mode, a command, a keyword, or an argument, use one of the following commands:

Command	Purpose
help	Provides a brief description of the help system in any command mode.
abbreviated-command-entry?	Provides a list of commands that begin with a particular character string. (No space between command and question mark.)
abbreviated-command-entry<Tab>	Completes a partial command name.
?	Lists all commands available for a particular command mode.
command ?	Lists the keywords or arguments that you must enter next on the command line. (Space between command and question mark.)

Using the no and default Forms of Commands

Where available, use the no form of a command to disable a function. Use the command without the no keyword to reenable a disabled function or to enable a function that is disabled by default. The command reference entry for each command provides the complete syntax for the configuration commands and describes what the no form of a command does.

Configuration commands can also have a default form, which returns the command settings to the default values. In those cases where a command is disabled by default, using the default form has the same result as using the no form of the command. However, some commands are enabled by default and have variables set to certain default values. In these cases, the default form of the command enables the command and sets the variables to their default values. Where available, the command reference entry describes the effect of the default form of a command if the command does not function the same way as the no form.

Saving Configuration Changes

Starting in Cisco UMG EXEC mode, use the following command to copy the running configuration in flash memory to another location:

copy running-config {ftp:user-id:password@ftp-server-address[/directory] | 
startup-config | tftp:tftp-server-address} filename

Keyword or Argument	Description
ftp:user-id:password@	Username and password for the FTP server. Include the colon (:) and the at sign (@) in your entry.
ftp-server-address	IP address of the FTP server.
/directory	(Optional) Directory on the FTP server where the copied file will reside. If you use it, precede the name with the forward slash (/).
startup-config	Startup configuration in flash memory.
tftp:tftp-server-address	IP address of the TFTP server.
filename	Name of the destination file that will contain the copied running configuration.

When you copy the running configuration to the startup configuration, enter the command on one line. In the following example, the running configuration is copied to the startup configuration as file start. In this instance, enter the command on a single line.

umg-1# copy running-config startup-config start 

When you copy to the FTP or TFTP server, this command becomes interactive and prompts you for the information. You cannot enter the parameters on one line. The following example illustrates this process. In the following example, the running configuration is copied to the FTP server, which requires a username and password. The IP address of the FTP server is 192.0.2.24. The running configuration is copied to the configs directory as file saved_start.

umg-1# copy running-config ftp:

Address or name of remote host? admin:voice@192.0.2.24/configs

Source filename? saved_start

Troubleshooting Configuration Changes

Problem   You lost some configuration data.

Recommended Action    Copy your changes to the running configuration at frequent intervals. See the "Copying Configurations" section on page 151.

Problem   You lost configuration data when you rebooted the system.

Explanation    You did not save the data before the reboot.

Recommended Action    Issue a copy running-config startup-config command to copy your changes from the running configuration to the startup configuration. When Cisco UMG reboots, it reloads the startup configuration.

---

Note Messages are considered application data and are saved directly to the disk in the startup configuration. (They should be backed up on another server in case of a power outage or a new installation.) All other configuration changes require an explicit "save configuration" operation to preserve them in the startup configuration.

---