-
Cisco Unified Messaging Gateway Command Reference for 8.0 and Later Versions
-
Using Commands
-
Common Commands
-
A Commands (Common)
-
B Commands (Common)
-
C Commands (Common)
-
D Commands (Common)
-
E Commands (Common)
-
H Commands (Common)
-
I Commands (Common)
-
K Commands (Common)
-
L Commands (Common)
-
M Commands (Common)
-
N Commands (Common)
-
O Commands (Common)
-
P Commands (Common)
-
R Commands (Common)
-
S Commands (Common)
-
T Commands (Common)
-
U Commands (Common)
-
W Commands (Common)
-
- VPIM Commands
- SRSV and E-SRST Commands
-
Feedback
Table Of Contents
C
Last Updated: November 17, 2010clear counters interfaces
To clear interface counters, use the clear counters interfaces command in 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
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> enableumg-1# clear counters interfacesumg-1# show interfaces ide 0IDE hd0 is up, line protocol is up0 reads, 0 bytes0 read errors0 write, 0 bytes0 write errorsumg-1#Related Commands
clear crashbuffer
To clear the kernel crash buffer, use the clear crashbuffer command in 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
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 crashbufferumg-1#Related Commands
clear endpoint
To delete an autoregistered endpoint, use the clear endpoint command on the endpoint's primary messaging gateway in Cisco UMG EXEC mode.
clear endpoint location-id
Syntax Description
Command Modes
Cisco UMG EXEC
Command History
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.
•
•
•
Note
Examples
The following example illustrates the use of the clear endpoint command.
umg-1> enableumg-1# show endpoint localA total of 5 local endpoint(s) have been found:Location Location Endpoint Primary SecondaryID Prefix Type Gateway Gateway-----------------------------------------------------------------33 408108 CUE 50000 5900034 408109 CUE 5000035 408110 CUE 5000036 408111 CUE 5000037 408112 CUE 50000umg-1# clear endpoint 35Clear all data associated with endpoint 35 [confirm][OK]umg-1# show endpoint localA total of 4 local endpoint(s) have been found:Location Location Endpoint Primary SecondaryID Prefix Type Gateway Gateway-----------------------------------------------------------------33 408108 CUE 50000 5900034 408109 CUE 5000036 408111 CUE 5000037 408112 CUE 50000umg-1# show endpoint local 35Local endpoint with location id 35 has not been found.Related Commands
commands (kron schedule)
To enter the interactive mode to create the command block for a kron job, use the commands command in Cisco UMG kron-schedule configuration mode. To remove the delimiter for the command block, use the no form of this command.
commands delimiter
no commands
delimiter
Specifies the symbol delimiter to be used to delimit the command names in the command block created for the kron job.
Defaults
No defaults.
Command Modes
Cisco UMG kron-schedule configuration
Command History
Usage Guidelines
You can schedule the execution of a block of CLI commands. Blocks of commands are entered interactively, using a symbol delimiter character to start and stop the execution. The execution of the block of commands begins in EXEC mode, but mode-changing commands are allowed in the command block.
The following limitations apply in Cisco UMG 8.0:
•
•
For example, if the delimiter character entered with the commands command is "#", you cannot use that symbol in the commands in the command block.
•
•
•
Caution
Examples
The following example enters the interactive command mode to enter a command block for a kron job using the percent character "%" as the delimiter:
umg-1(kron-schedule)# commands % Enter CLI commands to be executed. End with the character '%'. Maximum text size is 1024 characters, it may not contain symbols '%' or ',' show ver sh run conf t hostname aaa % umg-1(kron-schedule)#Related Commands
continue
To take 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 Modes
Cisco UMG offline
Command History
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]?: yumg(offline)# backup category allumg(offline)# continueumg#Related Commands
copy ftp
To copy a new configuration from an FTP server to another 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
Command Modes
Cisco UMG EXEC
Command History
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
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-configAddress or name or remote host? admin:messaging@192.0.2.24Source filename? startIn 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]? yAddress or name or remote host? admin:messaging@192.0.2.24configsSource filename? startRelated Commands
copy log
To copy the current logging information stored in the 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
Command Modes
Cisco UMG EXEC
Command History
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/lnstallinfoumg#Related Commands
copy running-config
To copy the running configuration to another destination, use the copy running-config command in Cisco UMG EXEC mode.
copy running-config {ftp: | nvram:startup-config filename | startup-config | tftp:}
Syntax Description
Command Modes
Cisco UMG EXEC
Command History
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
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/configsSource filename? saved_startThe following example shows the running configuration copied to the NVRAM saved configuration as filename startup:
umg# copy running-config nvram:startup-config startupThe following example shows the running configuration copied to the startup configuration as filename start:
umg# copy running-config startup-config startThe 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.24Source filename? temp_startRelated Commands
copy startup-config
To copy the startup configuration to another destination, use the copy startup-config command in Cisco UMG EXEC mode.
copy startup-config {ftp: | tftp: }
Syntax Description
Command Modes
Cisco UMG EXEC
Command History
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
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/configsSource filename? saved_startThe 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.24Source filename? temp_startRelated Commands
copy tftp
To copy the network TFTP server information to another destination, use the copy tftp command in Cisco UMG EXEC mode.
copy tftp: {nvram:startup-config | running-config | startup-config | system:running-config}
Syntax Description
Command Modes
Cisco UMG EXEC
Command History
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
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-configAddress or name of remote host? 192.0.2.24Source filename? startIn 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]? yAddress or name of remote host? 192.0.2.24/configsSource filename? startRelated Commands
crypto key default
To set a certificate and private key pair as the system default, use the crypto key default command in Cisco UMG configuration mode. To remove the system default designation from the certificate-key pair, use the no form of this command.
crypto key label label-name default
no crypto key label label-name default
Syntax Description
Command Modes
Cisco UMG configuration
Command History
Usage Guidelines
Setting the certificate-key pair allows applications such as integrated messaging to use the default certificate for SSL security without knowing the specific label name of the pair.
If several certificate-key pairs exist on the system and none of them are the system default, use this command to designate one of them as the system default.
To change the designation from one pair to another, remove the designation from the original pair using the no form of this command. Then assign the designation to the new pair.
The no form of this command does not delete the certificate or private key. The pair remains on the system but is no longer designated as the system default pair.
The system displays an error message if either of the certificate-key pairs does not exist.
Examples
The following example designates the certificate-private key pair with the label mainkey.ourcompany as the system default.
umg-1# config tumg-1(config)# crypto key label mainkey.ourcompany defaultumg-1(config)#The following example changes the system default designation from certificate-key pair alphakey.myoffice to betakey.myoffice:
umg-1# config tumg-1(config)# no crypto key label alphakey.myoffice defaultumg-1(config)# crypto key label betakey.myoffice defaultumg-1(config)# endRelated Commands
crypto key delete
To delete a certificate and private key pair from the system, use the crypto key delete command in Cisco UMG configuration mode. This command does not have a no or default form.
crypto key delete { all | label label-name }
Syntax Description
all
Deletes all certificate-private key pairs on the system.
label label-name
Deletes the specified certificate-private key pair.
Command Modes
Cisco UMG configuration
Command History
Usage Guidelines
An error message appears if the specified certificate-private key pair does not exist.
Examples
The following example deletes the certificate and private key with the name mainkey.ourcompany.
umg-1# config tumg-1(config)# crypto key delete label mainkey.ourcompanyumg-1(config)#Related Commands
crypto key generate
To generate a self-signed certificate and private key, use the crypto key generate command in Cisco UMG configuration mode. This command does not have a no or default form.
crypto key generate [rsa {label label-name | modulus modulus-size | default]
Syntax Description
Command Default
The default encryption algorithm is ras.
The default label has the form hostname.domainname.
Command Modes
Cisco UMG configuration
Command History
Usage Guidelines
Integrated messaging requires a certificate and private key before SSL connections can be enabled. A certificate-key pair must be set as the system default.
If you do not select any keywords or do not specify a label, the system automatically generates a certificate-key pair with a name in the format hostname.domainname.
Cisco UMG supports only the rsa encryption algorithm.
Use the crypto key generate command or the crypto key label default command to set a certificate-key pair as the system default.
Examples
The following example designates the certificate-private key pair with the label mainkey.ourcompany as the system default.
umg-1# config tumg-1(config)# crypto key generate label mainkey.ourcompany modulus 728 defaultumg-1(config)#Related Commands
crypto key import
To import a certificate and private key from a console or remote server, use the crypto key import command in Cisco UMG configuration mode. This command does not have a no or default form. To delete a certificate and private key, use the crypto key delete command.
crypto key import rsa label label-name {der url {ftp: | http: } | pem { terminal | url {ftp: | http: }} [default]
Syntax Description
Command Modes
Cisco UMG configuration
Command History
Usage Guidelines
The system displays an error message if the certificate-key pair does not exist.
If you import an incorrect certificate-key pair, delete the pair with the crypto key delete command and import the correct one.
Examples
The following example imports a certificate and private key from the console.
umg-1# config tumg-1(config)# crypto key import rsa label newkey.ourcompany der terminalEnter certificate...End with a blank line or "quit" on a line by itselfEnter private key...Private key passphrase?End with a blank line or "quit" on a line by itselfquitImport succeeded.Related Commands
