-
Cisco Unified Messaging Gateway 1.0 CLI Administrator Guide
-
Cisco Unified Messaging Gateway 1.0 Feature Roadmap
-
Overview of Cisco Unified Messaging Gateway 1.0
-
Configuring Cisco Unified Messaging Gateway
-
Entering and Exiting the Command Environment
-
Initial Configuration Tasks
-
Backing Up and Restoring Data
-
Monitoring the Cisco Unified Messaging Gateway System
-
Maintaining the Cisco Unified Messaging Gateway System
-
Troubleshooting
-
Appendix A: Registering Cisco Unity Express Endpoints to UMG 1.0
-
Index
-
Feedback
Table Of Contents
Revisiting the Installation Configuration
Configuring Peer Messaging Gateways
Notice of Delayed Delivery or Non-delivery
Configuring Endpoint Autoregistration Support
Provisioning Endpoints Manually
Displaying NTP Server Information
Configuring Logging Operations
Initial Configuration Tasks
Last updated: April 13, 2010
This chapter describes how to set up your Cisco Unified Messaging Gateway system after you have installed it.
You must configure each messaging gateway in your system. If your endpoints are Cisco Unity Express 3.1 and later versions, you only need to set up autoregistration on one messaging gateway.
With Cisco Unity Express 3.0 or earlier versions, Cisco Unity, and Avaya Interchange endpoints, you must manually provision each one on the messaging gateway associated with it. The messaging gateway on which you manually provision an endpoint becomes that endpoint's primary messaging gateway. You can change the configuration of these types of endpoints only from their primary messaging gateway.
The chapter contains the following sections:
•
Revisiting the Installation Configuration, which describes how to change the configurations that were made during installation;
•
•
•
•
For a brief overview of how the system works, see the "Functional Outline" on page 6.
The "Monitoring the Cisco Unified Messaging Gateway System" chapter covers monitoring tasks, while the "Maintaining the Cisco Unified Messaging Gateway System" chapter covers System Distribution Lists (SDLs) and System Broadcast Messages (SBMs) and also deleting various entities.
Cisco UMG is configured entirely using the command-line interface (CLI). You enter some commands in EXEC mode and others in configuration mode, and still others in submodes. The instructions for each of the tasks cover entering the mode to be used.
For instructions on entering and exiting command modes, see the "Entering and Exiting the Command Environment" chapter.
Revisiting the Installation Configuration
If you used the interactive post-installation wizard, you will have completed these configurations. If you did not choose this method of installation or if you want to change any of the configurations, use these instructions to:
•
•
•
•
•
Note
•
Prerequisites
The following information is required to configure Cisco UMG:
•
•
•
•
Note
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
DETAILED STEPS
Examples
The following output illustrates the use of these commands.
se-10-0-0# config t
se-10-0-0(config)# network local messaging-gateway 50000
se-10-0-0(config)# hostname umg-1
umg-1(config)# ip domain-name mycompany.com
umg-1(config)# ip name-server 192.0.2.24
umg-1(config)# spoken-name enable
umg-1(config)# end
umg-1# show hosts
Hostname: umg-1
Domain: mycompany.com
umg-1# show messaging-gateway
LocationID Hostname NAT
------------------------------------------------------------
5 sj.mycompany.com disabled
55 sf.mycompany.com disabled
555 ny.mycompany.com disabled
Local Gateway ID: 50000
umg-1# show spoken-name
Spoken name is enabled.
umg-1#
Setting Backup Parameters
Cisco UMG backup and restore functions use an FTP server to store and retrieve data. The backup function copies the files from Cisco UMG to the FTP server and the restore function copies the files from the FTP server to Cisco UMG. The FTP server can reside anywhere in the network as long as the backup and restore functions can access it with an IP address or hostname.
All Cisco UMG backup files are stored on the specified server. You can copy the backup files to other locations or servers, if necessary.
The backup parameters specify the FTP server to use for storing Cisco UMG backup files and the number of backups that are stored before the system overwrites the oldest one.
Note
To backup or restore files, see the "Backing Up and Restoring Data" chapter.
Prerequisites
•
•
•
•
•
SUMMARY STEPS
1.
2.
3.
4.
5.
DETAILED STEPS
Examples
The following example configures a backup server and displays the show backup output:
umg-1# config tumg-1(config)# backup revisions 5
umg-1(config)# backup server url ftp://main/umg-1backups username "admin" password "wxyz"
umg-1#(config)# endumg-1# show backup
Server URL: ftp://branch/umg-1backups
User Account on Server: backupadmin
Security Protected: no
Security Enforced: no
Number of Backups to Retain: 5
umg-1#Configuring Peer Messaging Gateways
You can configure multiple peer Cisco UMGs. Location IDs for peer messaging gateways must be unique throughout the solution network.
Not only must you configure peers on each messaging gateway, you must also configure each peer as a messaging gateway. For this, use all the procedures in this chapter.
To delete a peer messaging gateway, see "Deleting Peer Messaging Gateways" on page 73.
Note
Prerequisites
The following information is required to configure a peer Cisco UMG:
•
•
SUMMARY STEPS
1.
2.
3.
4.
5.
DETAILED STEPS
Examples
The following output illustrates the use of these commands.
umg-1# config t
Enter configuration commands, one per line. End with CNTL/Z.
umg-1(config)# network messaging-gateway 5 sj.mycompany.com
umg-1(config)# end
umg-1# show messaging-gateway
LocationID Hostname NAT
------------------------------------------------------------
5 sj.mycompany.com disabled
55 sf.mycompany.com disabled
555 ny.mycompany.com disabled
Local Gateway ID: 51000
umg-1# show messaging-gateway 5
LocationID: 5
Hostname: sj.mycompany.com
NAT: disabled
umg-1#
Message Handling
Default Destination
You can set a default destination (`network default-route') for undeliverable messages; the destination can be either a messaging gateway or an endpoint.
Notice of Delayed Delivery or Non-delivery
If a message is not delivered within one hour of being sent, by default Cisco UMG sends a delayed-delivery receipt (DDR) to the message-sender and a non-delivery receipt (NDR) after six hours. These settings are system-wide, they cannot be applied to individual endpoints.
Changing the defaults is optional. If you do not make the settings described in the following procedure, the system uses the defaults.
Prerequisites
The following information is required to configure the default destination for unroutable messages:
•
The following information is required to change the DDR and NDR settings:
•
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
7.
8.
DETAILED STEPS
Examples
The following example illustrates default destination for undeliverable messages being set to the device with the location ID 51000, and the DDR and NDR timeouts being set for the system.
umg-1# config tEnter configuration commands, one per line. End with CNTL/Z.umg-1(config)# network default-route 51000umg-1(config)# ddr timeout 2umg-1(config)# ndr timeout 12umg-1(config)# endumg-1# show network default-routeDefault route is location 51000.umg-1# show ddr timeoutTimeout window for DDR messages is 2 hours.umg-1# show ndr timeoutTimeout window for NDR messages is 12 hours.umg-1#Configuring Endpoint Autoregistration Support
For endpoints that are to autoregister with Cisco UMG, you must configure registration, connection, and authentication parameters.
You can configure multiple username/password sets on the same messaging gateway.
Note
The endpoints themselves must be configured to present the corresponding information in a registration request.
The default registration period expires after 1440 minutes. After that time, any new configurations such as username and password take effect.
For an overview of the relevant Cisco Unity Express configuration, see "Appendix A: Cisco Unity Express Endpoint Autoregistration to Cisco Unified Messaging Gateway 1.0" on page 91.
In the system logic, autoregistration is implicitly allowed for all endpoints, therefore to prevent autoregistration you must use the block command described in this section or in "Blocking Endpoint Registration" on page 76.
To clear the data associated with an autoregistered endpoint, see "Deleting or Clearing Endpoints" on page 75.
Prerequisites
The following information is required to configure endpoint autoregistration parameters on Cisco UMG.
•
•
•
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
DETAILED STEPS
Examples
The following example shows an expiration being set for all autoregistered endpoints. A block is set, then a username and password. Finally, the results of these operations are displayed. Note that the expiration is not displayed, because the no expiration command caused the default to be set.
umg-1# config tEnter configuration commands, one per line. End with CNTL/Z.umg-1(config)# registrationumg-1(config-reg)# expiration 20000Currently registered endpoint expiration will be unaffected.umg-1(config-reg)# block location-id 33umg-1(config-reg)# username bob password text cue31umg-1(config-reg)# endumg-1(config)# endumg-1 show run | inc usernameusername bob password text cue31umg-1# write memoryumg-1 show start | inc usernameusername bob password text cue31umg-1# show registration blockUMG registration block list :location-id 33se-10-1-12-95# show registration statusEndpoint registration stats :Auto-registered : 1Offline : 10Total number : 11Auto-registered endpoint :Loc. 40000 : cue, registered at 19-Aug-07 17:02:31:212Offline auto-registered endpoint :Loc. 40 : cue, deregistered/unreachable since 17-Aug-07 16:56:45:177Loc. 41 : cue, deregistered/unreachable since 17-Aug-07 16:56:45:177Loc. 42 : cue, deregistered/unreachable since 17-Aug-07 16:56:32:169Loc. 43 : cue, deregistered/unreachable since 17-Aug-07 16:56:45:177Loc. 44 : cue, deregistered/unreachable since 17-Aug-07 16:56:45:177Loc. 45 : cue, deregistered/unreachable since 17-Aug-07 16:56:45:177Loc. 46 : cue, deregistered/unreachable since 17-Aug-07 16:56:45:177Loc. 47 : cue, deregistered/unreachable since 17-Aug-07 16:56:45:177Loc. 48 : cue, deregistered/unreachable since 17-Aug-07 16:56:45:177umg-1#Provisioning Endpoints Manually
You must manually provision Cisco Unity and Avaya Interchange endpoints to Cisco UMG. Endpoints of the type Cisco Unity Express 3.0 or earlier versions must also be manually provisioned.
The configuring Cisco UMG automatically becomes the primary messaging gateway for the endpoint being provisioned.
It is most efficient if you group your endpoints by type (Cisco Unity, Cisco Unity Express, Avaya Interchange) before provisioning them, because each type has one or two parameters that are different from those required for other types.
Note
When you configure a domain for an endpoint, Cisco UMG does an MX lookup on the domain provided and uses those host addresses.
If you have multiple endpoints with the same prefix, you must use the number-only addendum to the prefix command to specify the range of extensions handled by the endpoint you are provisioning. All endpoints sharing a prefix must use this addendum - in other words, you cannot have endpoint 1 with just prefix 1, and endpoint 2 with prefix 1 plus a range of extensions.
After provisioning each endpoint and before leaving the endpoint configuration mode you must enable the endpoint.
If you try to provision an endpoint with a location ID that is already in use, and if both location ID and endpoint type actually match the existing one, you will re-configure the first one. If the location ID and the type do not match the existing one, the system will warn you, for example, "Invalid endpoint type. The specified type does not match the existing endpoint." If you use a location ID similar to one already in your network, the system will warn you, for example, "Possible conflict with existing location ID(s): 3, 333."
To delete an endpoint, see "Deleting or Clearing Endpoints" on page 75.
Note
Prerequisites
In the following, note that what Cisco UMG refers to as endpoint location-id is the same as the Cisco Unity Express network location-id number.
For each endpoint type, you have different parameters to set:
Note
Note
Note
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
a.
orb.
extension extension
end7.
8.
9.
10.
11.
12.
13.
DETAILED STEPS
Examples
The following example is an example of how to manually provision a Cisco Unity endpoint. An endpoint of this type requires a prefix, and because the number-only attribute has been used, it can be safely assumed that at least two of the user's Cisco Unity endpoints are using the same prefix.
umg-1# config t
umg-1(config)# endpoint 77777 unity
umg-1(config-endpoint)# messaging-gateway secondary 51000
umg-1(config-endpoint)# domain sj.mycompany.com
umg-1(config-endpoint)# hostname unity-7
umg-1(config-endpoint)# prefix 231 number-only
umg-1(config-endpoint-extension)# extension 777
umg-1(config-endpoint-extension)# end
umg-1(config-endpoint)# serial-number 13
umg-1(config-endpoint)# broadcast-id 222222
umg-1(config-endpoint)# enable
umg-1(config-endpoint)# end
umg-1(config)# end
se-10-1-12-95# show endpoint local 77777
Location Id: 77777
Hostname: unity-7
Domain: sj.mycompany.com
Prefix: 231
NAT: Enabled
Type: Unity
Serial-number: 13
Addressing Mode: Number-only
Primary Gateway ID: 50000
Secondary Gateway ID: 51000
Status: Disabled
umg-1#
Setting Up NAT Entries
If you have NAT devices in your network, and they are between messaging gateways and/or endpoints, you must configure NAT entries on Cisco UMG for both messaging gateways and endpoints. For a message to reach its destination, Cisco UMG must know the external HTTP IP address and port number and the external VPIM IP address and port number of the NAT device in front of the destination.
Note
(When Cisco Unity Express registers with Cisco UMG, it has the option to specify the HTTP and SMTP ports to match the external PORT used in your setup. For reference, see "Appendix A: Cisco Unity Express Endpoint Autoregistration to Cisco Unified Messaging Gateway 1.0" on page 91)
Prerequisites
For each endpoint and peer messaging gateway in your system, the following information is required to set up NAT entries:
•
•
•
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
7.
DETAILED STEPS
Examples
The following example illustrates the the method for configuring NAT.
umg-1# config t
umg-1(config)# nat location 77777
umg-1(config-nat)# vpim external 192.0.2.13 26
umg-1(config-nat)# http external 192.0.2.13 8080
umg-1(config-nat)# end
umg-1(config)# end
umg-1# show nat location 77777Protocol Ext-IP Ext-Port----------------------------------------HTTP 192.0.2.13 8080SMTP 192.0.2.13 26umg-1#Configuring NTP Servers
During the software postinstallation process, the Network Time Protocol (NTP) server may have been configured. If it was not configured, or if you want to change the configuration, use this procedure to add or delete NTP servers. Cisco UMG supports up to three NTP servers.
Adding NTP Servers
You can specify an NTP server using its IP address or its hostname.
Cisco UMG uses the DNS server to resolve the hostname to an IP address and stores the IP address as an NTP server. If DNS resolves the hostname to more than one IP address, Cisco UMG randomly chooses one of the IP addresses that is not already designated as an NTP server. If you do not want to go with random choice, set the prefer attribute for one server.
To configure an NTP server with multiple IP addresses for a hostname, repeat the configuration steps using the same hostname. Each iteration assigns the NTP server to its remaining IP addresses.
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
DETAILED STEPS
Examples
The following commands configure the NTP server:
umg-1# config tumg-1(config)# ntp server 192.0.2.14umg-1(config)# exitumg-1#The output from the show ntp status command looks similar to the following:
umg-1# show ntp statusNTP reference server 1: 10.100.6.9Status: sys.peerTime difference (secs): 3.268110099434328E8Time jitter (secs): 0.1719226837158203umg-1#The following example configures an NTP server with a hostname that points to two IP addresses, 192.0.2.14 and 192.0.2.13:
umg-1# config tumg-1(config)# ntp server NTP.mine.comumg-1(config)# exitumg-1#umg-1# config tumg-1(config)# ntp server NTP.mine.comumg-1(config)# exitumg-1#The output from the show ntp status command might look similar to the following:
umg-1# show ntp statusNTP reference server 1: 192.0.2.14Status: sys.peerTime difference (secs): 3.268110099434328E8Time jitter (secs): 0.1719226837158203NTP reference server 1: 192.0.2.13Status: sys.peerTime difference (secs): 3.268110099434328E8Time jitter (secs): 0.1719226837158203umg-1#Removing an NTP Server
Remove an NTP server using its IP address or hostname.
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
DETAILED STEPS
Displaying NTP Server Information
The following commands are available to display NTP server configuration information and status:
•
•
•
•
The following is sample output for the show ntp associations command:
umg-1# show ntp associationsind assID status conf reach auth condition last_event cnt===========================================================1 61253 8000 yes yes none rejectThe following is sample output for the show ntp servers command:
umg-1# show ntp serversremote refid st t when poll reach delay offset jitter==============================================================================1.100.6.9 0.0.0.0 16 u - 1024 0 0.000 0.000 4000.00space reject, x falsetick, . excess, - outlyer+ candidate, # selected, * sys.peer, o pps.peerThe following is sample output for the show ntp source command:
umg-1# show ntp source127.0.0.1: stratum 16, offset 0.000013, synch distance 8.672010.0.0.0: *Not Synchronized*The following is sample output for the show ntp status command:
umg-1# show ntp statusNTP reference server : 10.100.6.9Status: rejectTime difference (secs): 0.0Time jitter (secs): 4.0Setting the Time Zone
Typically, you set the time zone during installation. If you did not, or you want to change it, to set the time zone, use the clock timezone command in Cisco UMG configuration mode. The system will offer you a range of options to choose from.
To display the time zone, use the show clock command in Cisco UMG EXEC mode.
Examples
umg-1# config tEnter configuration commands, one per line. End with CNTL/Z.umg-1(config)# clock timezonePlease identify a location so that time zone rules can be set correctly.Please select a continent or ocean.1) Africa 4) Arctic Ocean 7) Australia 10) Pacific Ocean2) Americas 5) Asia 8) Europe3) Antarctica 6) Atlantic Ocean 9) Indian Ocean#? 2Please select a country.1) Anguilla 18) Ecuador 35) Paraguay2) Antigua & Barbuda 19) El Salvador 36) Peru3) Argentina 20) French Guiana 37) Puerto Rico4) Aruba 21) Greenland 38) St Kitts & Nevis5) Bahamas 22) Grenada 39) St Lucia6) Barbados 23) Guadeloupe 40) St Pierre & Miquelon7) Belize 24) Guatemala 41) St Vincent8) Bolivia 25) Guyana 42) Suriname9) Brazil 26) Haiti 43) Trinidad & Tobago10) Canada 27) Honduras 44) Turks & Caicos Is11) Cayman Islands 28) Jamaica 45) United States12) Chile 29) Martinique 46) Uruguay13) Colombia 30) Mexico 47) Venezuela14) Costa Rica 31) Montserrat 48) Virgin Islands (UK)15) Cuba 32) Netherlands Antilles 49) Virgin Islands (US)16) Dominica 33) Nicaragua17) Dominican Republic 34) Panama#? 45Please select one of the following time zone regions.1) Eastern Time2) Eastern Time - Michigan - most locations3) Eastern Time - Kentucky - Louisville area4) Eastern Time - Kentucky - Wayne County5) Eastern Standard Time - Indiana - most locations6) Eastern Standard Time - Indiana - Crawford County7) Eastern Standard Time - Indiana - Starke County8) Eastern Standard Time - Indiana - Switzerland County9) Central Time10) Central Time - Michigan - Wisconsin border11) Central Time - North Dakota - Oliver County12) Mountain Time13) Mountain Time - south Idaho & east Oregon14) Mountain Time - Navajo15) Mountain Standard Time - Arizona16) Pacific Time17) Alaska Time18) Alaska Time - Alaska panhandle19) Alaska Time - Alaska panhandle neck20) Alaska Time - west Alaska21) Aleutian Islands22) Hawaii#? 16The following information has been given:United StatesPacific TimeTherefore TZ='America/Los_Angeles' will be used.Is the above information OK?1) Yes2) No#? 1Local time is now: Mon Aug 27 17:23:54 PDT 2007.Universal Time is now: Tue Aug 28 00:23:54 UTC 2007.Save the change to startup configuration and reload the module for the new timezone to take effect.umg-1(config)#Configuring Logging Operations
Cisco UMG captures messages that describe activities in the system. These messages are collected and directed to a messages.log file on the Cisco UMG module hard disk, the console, or an external system log (syslog) server. The messages.log file is the default destination.
This section describes the procedure for configuring an external server to collect the messages. To view the messages, see "Viewing System Activity Messages" on page 57.
Note
Prerequisites
You need the hostname or IP address of the designated log server.
SUMMARY STEPS
1.
2.
3.
4.
DETAILED STEPS
Examples
The output from the show running-config command looks similar to the following:
umg-1# show running-configclock timezone America/Los_Angeleshostname umg-1ip domain-name localdomainntp server 192.0.2.13log server address 192.0.2.14
