Cisco Unified Messaging Gateway 1.0 Command Reference
C

Table Of Contents

C

clear counters interfaces

clear crashbuffer

clear endpoint

continue

copy ftp

copy log

copy running-config

copy startup-config

copy tftp


C


Last Updated: April 16, 2010

clear counters interfaces

clear crashbuffer

clear endpoint

continue

copy ftp

copy log

copy running-config

copy startup-config

copy tftp

clear counters interfaces

To clear interface counters, use the clear counters interfaces command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.

clear counters interfaces

Syntax Description

This command has no arguments or keywords.

Command Default

None. Interface counters are not cleared.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

Use this command when you have interface counters you want to clear, for example, the general debug counters. This command clears all counters, including statistics counters.

Examples

The following example illustrates the use of the clear counters interfaces command.

umg-1> enable
umg-1# clear counters interfaces
umg-1# show interfaces ide 0
IDE hd0 is up, line protocol is up
     0 reads, 0 bytes
     0 read errors
     0 write, 0 bytes
     0 write errors
umg-1#

Related Commands

Command
Description

clear crashbuffer

Clears the kernel crash buffer.


clear crashbuffer

To clear the kernel crash buffer, use the clear crashbuffer command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.

clear crashbuffer

Syntax Description

This command has no arguments or keywords.

Command Default

None. Crash buffer is not cleared.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

Use this command to clear the kernel crash buffer after the reasons for a crash are fully investigated.

Examples

The following example illustrates the use of the clear crashbuffer command.

umg-1 enable>
umg-1# clear crashbuffer
umg-1#

Related Commands

Command
Description

clear counters interfaces

Clears the interface counters.


clear endpoint

To delete an autoregistered endpoint, use the clear endpoint command on the endpoint's primary messaging gateway in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.

clear endpoint location-id

Syntax Description

location-id

Endpoint's location ID, system-wide unique identifier (max. 10 digits).


Command Default

None

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

After you have cleared an autoregistered endpoint, any messages it attempts to forward is rejected by Cisco UMG, although the endpoint does remain online.

The endpoint is able to reregister after its registration period has expired unless you either block the endpoint or set up autoregistration for it on a different messaging gateway.

If you want the endpoint to autoregister with a different messaging gateway, remember to change the primary messaging gateway configuration on the endpoint itself.

The clear endpoint command triggers directory exchange with peer messaging gateways and other autoregistered endpoints.


Note To delete a manually provisioned endpoint, use the no form of the endpoint command.


Examples

The following example illustrates the use of the clear endpoint command.

umg-1> enable
umg-1# show endpoint local
A total of 5 local endpoint(s) have been found:

Location    Location          Endpoint     Primary     Secondary
ID          Prefix            Type         Gateway     Gateway
-----------------------------------------------------------------
33          408108            CUE          50000       59000
34          408109            CUE          50000
35          408110            CUE          50000
36          408111            CUE          50000
37          408112            CUE          50000
umg-1# clear endpoint 35
Clear all data associated with endpoint 35 [confirm]
 [OK]
umg-1# show endpoint local
A total of 4 local endpoint(s) have been found:

Location    Location          Endpoint     Primary     Secondary
ID          Prefix            Type         Gateway     Gateway
-----------------------------------------------------------------
33          408108            CUE          50000       59000
34          408109            CUE          50000
36          408111            CUE          50000
37          408112            CUE          50000
umg-1# show endpoint local 35
Local endpoint with location id 35 has not been found.

Related Commands

Command
Description

endpoint

Enters endpoint configuration mode to provision endpoints manually.

registration

Enters registration mode to configure autoregistration parameters for endpoints of the type Cisco Unity Express 3.1 and later versions,

show endpoint

Displays a list of endpoints or a specific endpoint.



continue

To take Cisco Unified Messaging Gateway (Cisco UMG) from offline mode to online EXEC mode, use the continue command in Cisco UMG offline mode.

continue

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes

Cisco UMG offline

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

This command returns Cisco UMG to online mode, for example, after a backup or restore procedure.

Examples

The following example illustrates the use of the continue command as a step in the backup procedure:

umg# offline
!!!WARNING!!!: If you are going offline to do a backup, it is recommended that you save 
the current running configuration using the `write' command prior to going to the offline 
state.
Putting the system offline will terminate all end user sessions.
Are you sure you want to go offline[n]?: y
umg(offline)# backup category all
umg(offline)# continue
umg#

Related Commands

Command
Description

backup category

Identifies the data to be backed up and initiates the backup.

offline

Terminates message forwarding and directory exchange.

reload

Restarts the Cisco UMG system.

restore id

Initiates restoration of a backup file or of factory defaults.


copy ftp

To copy a new configuration from an FTP server to another Cisco Unified Messaging Gateway (Cisco UMG) location, use the copy ftp command in Cisco UMG EXEC mode.

copy ftp: {nvram:startup-config | running-config | startup-config | system:running-config }

Syntax Description

nvram:startup-config

Copies the new configuration to the NVRAM saved configuration.

running-config

Copies the new configuration to the current running configuration.

startup-config

Copies the new configuration to the startup configuration on the hard disk.

system:running-config

Copies the new configuration to the system configuration.


Command Default

None

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

When you copy from the FTP server, the copy ftp command becomes interactive and prompts you for the necessary information.

You may add a username and password to the server IP address if your server is not configured to accept anonymous FTP input. The format would be: userid:password@ftp-server-address/directory.

If you do not specify a directory value, the software uses the default FTP directory.


Note Depending on the specific TFTP server you are using, you might need to create a file with the same name on the TFTP server and verify that the file has the correct permissions before transferring the running configuration to the TFTP server.


Examples

The following example shows copying the configuration file named start from the FTP server in the default directory to the startup configuration in NVRAM:

umg# copy ftp: nvram:startup-config
Address or name or remote host? admin:messaging@192.0.2.24
Source filename? start

In the following example, the file named start in the FTP server configs directory is copied to the startup configuration:

umg# copy ftp: startup-config 
!!!WARNING!!! This operation will overwrite your startup configuration.
Do you wish to continue[y]? y
Address or name or remote host? admin:messaging@192.0.2.24configs 
Source filename? start

Related Commands

Command
Description

copy running-config

Copies the running configuration to another location.

copy tftp

Copies the startup configuration to another location.

erase startup-config

Deletes configuration data.

write

Copies the running configuration to the startup configuration.


copy log

To copy the current logging information stored in the Cisco Unified Messaging Gateway (Cisco UMG) database to an FTP server, use the copy log command in Cisco UMG EXEC mode.

copy log {install.log | dmesg | syslog.log | atrace.log | klog.log | debug_server.log | messages.log} url ftp://[user-id:ftp-password@]ftp-server-address[/directory]/filename

Syntax Description

install.log

Contains the latest install information.

dmesg

Contains boot up logs.

syslog.log

Contains system messages.

atrace.log

Contains messages generated by a trace command.

debug_server.log

Contains messages generated by a debug command.

klog.log

The trace facility is a diagnostics facility that writes messages within a kernel buffer in memory.

messages.log

Contains kernel messages and system messages but no trace messages.

user-id:ftp-password@

(Optional) Specifies the FTP username and password to access the FTP server. If no username and password are specified, the default username anonymous is used.

ftp-server-address

IP address of the FTP server.

/directory

(Optional) Directory where the log data file is stored on the FTP server. If no directory is specified, the default directory on the FTP server is used.

/filename

Filename for the log data on the FTP server.


Command Default

None

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced .


Usage Guidelines

If you do not specify a directory value, the software uses the default FTP directory.

Examples

The following example shows copying the install log data to the default directory on the FTP server and saving the data in the file installinfo.

umg# copy log install.log url ftp://admin:umg@192.0.2.24/lnstallinfo
umg#

Related Commands

Command
Description

show log name

Displays the contents of a log file.


copy running-config

To copy the running configuration to another destination, use the copy running-config command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.

copy running-config {ftp: | nvram:startup-config filename | startup-config | tftp:}

Syntax Description

ftp:

Begins the FTP menu where you enter the FTP server IP address and destination filename to copy the running configuration to an FTP server.

nvram:startup-config filename

Copies the running configuration to the NVRAM saved configuration named filename.

startup-config

Copies the running configuration to the startup configuration on the hard disk named filename.

tftp:

Begins the TFTP menu where you enter the TFTP server IP address and destination filename to copy the running configuration to a TFTP server.


Command Default

None

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced .


Usage Guidelines

When you copy to an FTP or TFTP server, the copy running-config command becomes interactive and prompts you for the necessary information. You may add a username and password to the server IP address if your server is not configured to accept anonymous FTP input. The format would be: userid:password@ftp-server-address/directory. If you do not specify a directory value, the software uses the default FTP directory.


Note Depending on the specific TFTP server you are using, you might need to create a file with the same name on the TFTP server and verify that the file has the correct permissions before transferring the running configuration to the TFTP server.


Examples

In the following example, the running configuration is copied to the FTP server, which requires a username and password and has an IP address of 192.0.2.24. The running configuration is copied to the configs directory as file saved_start.


umg# copy running-config ftp:
Address or name of remote host? admin:messaging@192.0.2.24/configs
Source filename? saved_start

The following example shows the running configuration copied to the NVRAM saved configuration as filename startup:

umg# copy running-config nvram:startup-config startup

The following example shows the running configuration copied to the startup configuration as filename start:

umg# copy running-config startup-config start

The following example shows the running configuration copied to the TFTP server as filename temp_start:

umg# copy running-config tftp:
Address or name of remote host? 192.0.2.24
Source filename? temp_start

Related Commands

Command
Description

copy ftp

Copies network FTP data to another destination.

copy startup-config

Copies the startup configuration to another location.

copy tftp

Copies the TFTP data to another location.

erase startup-config

Deletes configuration data.

write

Copies the running configuration to the startup configuration.


copy startup-config

To copy the startup configuration to another destination, use the copy startup-config command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.

copy startup-config {ftp: | tftp: }

Syntax Description

ftp:

Begins the FTP menu where you enter the FTP server IP address and destination filename to copy the startup configuration to an FTP server.

tftp:

Begins the TFTP menu where you enter the TFTP server IP address and destination filename to copy the startup configuration to a TFTP server.


Command Default

None

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

When you copy to an FTP or TFTP server, the copy startup-config command becomes interactive and prompts you for the necessary information. You may add a username and password to the server IP address if your server is not configured to accept anonymous FTP input. The format would be: userid:password@ftp-server-address/directory. If you do not specify a directory value, the software uses the default FTP directory.


Note Depending on the specific TFTP server you are using, you might need to create a file with the same name on the TFTP server and verify that the file has the correct permissions before transferring the running configuration to the TFTP server.


Examples

In the following example, the startup configuration is copied to the FTP server, which requires a username and password and has an IP address of 192.0.2.24. The startup configuration is copied to the configs directory as file saved_start.


umg# copy startup-config ftp:
Address or name of remote host? admin:messaging@192.0.2.24/configs
Source filename? saved_start

The following example shows the startup configuration being copied to the TFTP server as filename temp_start:

umg# copy startup-config tftp:
Address or name of remote host? 192.0.2.24
Source filename? temp_start

Related Commands

Command
Description

copy ftp

Copies network FTP data to another destination.

copy running-config

Copies the running configuration to another location.

copy tftp

Copies the TFTP data to another location.

erase startup-config

Deletes configuration data.

write

Copies the running configuration to the startup configuration.


copy tftp

To copy the network TFTP server information to another destination, use the copy tftp command in Cisco Unified Messaging Gateway EXEC mode.

copy tftp: {nvram:startup-config | running-config | startup-config | system:running-config}

Syntax Description

nvram:startup-config

Destination location for the copy procedure is the NVRAM saved configuration. Begins the interactive menu where you enter the TFTP server IP address and destination filename.

running-config

Destination location for the copy procedure is the active configuration in flash memory. Begins the interactive menu where you enter the TFTP server IP address and destination filename.

startup-config

Destination location for the copy procedure is the startup configuration in flash memory. Begins the interactive menu where you enter the TFTP server IP address and destination filename.

system:running-config

Destination location for the copy procedure is the system configuration. Begins the interactive menu where you enter the TFTP server IP address and destination filename.


Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

The copy tftp command is an interactive command and prompts you for the necessary information. You may add a username and password to the server IP address if your server is not configured to accept anonymous TFTP input. The format would be: userid:password@ftp-server-address/directory. If you do not specify a directory value, the software uses the default TFTP directory.

Copying a startup configuration from the TFTP server to the startup configuration overwrites the startup configuration. Cisco UMG displays a warning that asks you to confirm the overwrite.


Note Depending on the specific TFTP server you are using, you might need to create a file with the same name on the TFTP server and verify that the file has the correct permissions before transferring the running configuration to the TFTP server.


Examples

The following example shows a TFTP server with the IP address 192.0.2.24. The TFTP server data in the source filename start is copied to the running configuration.

umg# copy tftp: running-config
Address or name of remote host? 192.0.2.24
Source filename? start

In the following example, the TFTP server has the IP address 192.0.2.24. The file start in directory configs on the TFTP server is copied to the startup configuration.

umg# copy tftp: startup-config
!!!WARNING!!! This operation will overwrite your startup configuration.
Do you wish to continue[y]? y
Address or name of remote host? 192.0.2.24/configs
Source filename? start

Related Commands

Command
Description

copy ftp

Copies network FTP server information to another location.

copy running-config

Copies the running configuration to another location.

copy startup-config

Copies the startup configuration to another location.

erase startup-config

Deletes configuration data.

write

Copies the running configuration to the startup configuration.