Feedback
Table Of Contents
Configuring Endpoints for VPIM Networks
Configuring Peer Messaging Gateways
Notice of Delayed Delivery or Non-delivery
Configuring Endpoint Autoregistration Support
Provisioning Endpoints Manually
Managing System Distribution Lists
Deleting Peer Messaging Gateways
Deleting or Clearing Endpoints
Blocking Endpoint Registration
Locating and Viewing Individual Mailbox Details
Configuring Endpoints for VPIM Networks
Last updated: December 2, 2010
This chapter describes how to configure endpoints for a VPIM network. The chapter contains the following sections:
•
Configuring Peer Messaging Gateways
•
•
•
•
•
•
•
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.
You must configure each messaging gateway in your system. If your endpoints are using Cisco Unity Express Release 3.1 and later versions, you only need to set up autoregistration on one messaging gateway.
With Cisco Unity Express Release 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.
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 the "Deleting Peer Messaging Gateways" section on page 73.
Note
Prerequisites
The following information is required to configure a peer Cisco UMG:
•
•
SUMMARY STEPS
1.
2.
3.
4.
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 a 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 the "Configuring Cisco Unity Express Endpoints for Autoregistration to Cisco UMG" section on page 67.
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 the following endpoints to Cisco UMG:
•
•
•
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 the "Deleting or Clearing Endpoints" section 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 the "Configuring Cisco Unity Express Endpoints for Autoregistration to Cisco UMG" section on page 67)
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#Forcing Data Convergence
Data convergence normally takes place automatically, any time an endpoint (including the mailboxes associated with it) or a messaging gateway is added, deleted, or modified. You can also force directory exchange.
Note
Cisco UMG can request that one or all endpoints send their full directories, or just updates. The current configuring messaging gateway can request one or all peer messaging gateways to send their full directories or just updates.
The current configuring messaging gateway can also send either its full directory or just an update to all endpoints and messaging gateways in the system or to specified ones.
The following procedure requests a directory from an endpoint, then sends the current configuring Cisco UMG's updated directory to a peer messaging gateway.
Prerequisites
The location IDs of the endpoints and/or messaging gateways with which directories or updates are to be exchanged.
SUMMARY STEPS
1.
2.
3.
4.
DETAILED STEPS
Examples
The following example illustrates requesting a full directory exchange from an endpoint, then sending out the current configuring Cisco UMG's directory update to all peer messaging gateways, and finally checking to make sure all peers were actually online to receive the update.
umg-1# directory exchange endpoint request full 42umg-1# directory exchange messaging-gateway send updateumg-1# show messaging-gatewayLocationID Hostname NAT------------------------------------------------------------59000 209.165.200.224 disabled777776 peer-1.mycompany.com enabledLocal Gateway ID: 51000umg-1#Managing System Distribution Lists
Cisco UMG enables subscribers to send messages to system distribution lists (SDLs) with recipients (list members) on remote endpoints.
To create an SDL, from EXEC mode, enter the list manager mode to lock list management on all peer Cisco UMGs. The purpose of locking is to prevent messaging gateways getting out of sync. When you have finished configuring SDLs, you must publish them to peer messaging gateways. You can publish to all messaging gateways or you can publish to individual messaging gateways.
If you leave list manager mode without publishing SDLs, the system will automatically publish to all peer messaging gateways.
If the system encounters an SDL lock on a peer messaging gateway, it will fail to lock, and will automatically exit list manager mode. In this situation, you can wait until the lock on the peer messaging gateway is released and/or exit by using the exit command.
It is possible that messaging gateways' SDLs can get out of sync. If this is the case, you will be warned when you attempt to lock SDLs. The system will tell you that the current configuring Cisco UMG is out of sync with other messaging gateways. In this case, determine which messaging gateway has the latest SDL information (by using the show list tracking version command to look at the SDL version numbers), and publish from there. This will bring the other messaging gateway back into sync with the rest.
When you create an SDL, you must ensure the number you assign to it (which is also the number the authorized sender dials to send a message to the list) does not conflict with other SDL numbers nor with any subscriber's number.
SDLs can have members that are other lists, as well as subscribers. Although you can configure an SDL without an authorized sender, messages must have at least one authorized sender.
To delete an SDL, use the no list number command in list-manager mode.
Prerequisites
•
•
•
•
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
DETAILED STEPS
Examples
The first example shows the output when the system fails to lock the SDLs. The second shows the out-of-sync warning, and illustrates list creation and publication.
umg-1# listLocking system distribution lists...Lock manager reports failure [FAILED]umg-1#umg-1# listLocking system distribution lists...[OK]**WARNING** This UMG is out of sync and contains old information, user should probably publish to this UMG from a peer.SDL-Version Last-Updated List-Of-Remote-Gateways-------------------------- ------------------------ ------------------------* 50000_20070807033625 Aug 7, 2007 3:36:25 AM 51000-------------------------- ------------------------ ------------------------umg-1(listmgr)# list number 1111umg-1(listmgr-edit)# name FirstListumg-1(listmgr-edit)# endumg-1(listmgr)# list number 2222umg-1(listmgr-edit)# SecondListumg-1(listmgr-edit)# endumg-1(listmgr)# list number 1111umg-1(listmgr-edit)# privilege 4085550100This authorized sender [4085550100] will be added. However this authorized sender does not exist yet!umg-1(listmgr-edit)# member 4085550101 type subWARNING! The subscriber has been added to the list, but it doesn't exist in the subscriber directory.umg-1(listmgr-edit)# member 2222 type listumg-1(listmgr-edit)# endumg-1(listmgr)# show listThe version of system distribution list is 50000_20070815050633.A total of 2 System Distribution List(s) have been found:Extension Name-----------------------------------------------1111 FirstList2222 SecondListumg-1(listmgr)# show list 1111Extension: 1111Name: FirstListNumber of members: 2Member(s): 4085550101 (subscriber)2222 (list)# of members: 2umg-1(listmgr)# list publishLocationID Status Description-----------------------------------------------------------51000 Published59000 Locked(Renewed)# of network gateways published: 1# of network gateways failed to publish:1umg-1(listmgr)# endumg-1#Managing System Broadcasts
You can enable a subscriber to send a system broadcast message (SBM) to all subscribers on a specified endpoint, whether local or remote. If you grant to one subscriber the broadcast privilege for all endpoints, that person can reach all subscribers in the system by sending the same message. In Cisco UMG 1.0, this means a single SBM sent to each endpoint in succession, not one SBM sent simultaneously to all endpoints.
When you configure a broadcast VPIM ID on Cisco Unity Express, Cisco UMG automatically picks it up when the endpoint autoregisters.
For endpoints running Cisco Unity Express Release 3.0 or earlier versions, not only must you configure the broadcast VPIM ID on the endpoint itself, you must also configure it on Cisco UMG when you manually provision the endpoint.
Note
You must create at least one authorized sender (that is, grant a broadcast privilege) for each endpoint; otherwise, no subscriber can send any messages to it.
Assign broadcast location privileges to local endpoints only because Cisco UMG only validates them locally. In other words, the configuring messaging gateway should be the endpoint's primary or secondary messaging gateway.
Prerequisites
•
•
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
7.
8.
DETAILED STEPS
Examples
umg-1# config t
umg-1(config)# endpoint 11 cue
umg-1(config-endpoint)# broadcast-id 0100
umg-1(config-endpoint)# end
umg-1(config)# broadcast location 11 privilege 4085550101
umg-1(config)# end
umg-1# show endpoint local 11
Location Id: 11
Hostname: Wally
Domain: cuesim1
Prefix: 408555
NAT: Disabled
Type: CUE
Broadcast VPIM ID: 0100
Primary Gateway ID: 50000
Secondary Gateway ID:
Status: Auto-Registered-Offline
umg-1# show broadcast location 11 privilege
A total of 1 Authorized Sender(s) have been found for location 11:
4085550101
umg-1#
Deleting Peer Messaging Gateways
To delete a peer messaging-gateway, use the no form of the network messaging-gateway command in Cisco UMG configuration mode.
In the following procedure, the viewing activities are optional.
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
DETAILED STEPS
Examples
umg-1# show messaging-gatewayLocationID Hostname NAT------------------------------------------------------------5 www.mycompany.com disabled51000 192.0.0.10 disabled59000 192.0.0.11 disabledLocal Gateway ID: 50000umg-1# show messaging-gateway 5LocationID: 5Hostname: www.mycompany.comNAT: disabledumg-1# config tEnter configuration commands, one per line. End with CNTL/Z.umg-1(config)# no network messaging-gateway 5umg-1(config)# endumg-1# show messaging-gatewayLocationID Hostname NAT------------------------------------------------------------51000 192.0.0.10 disabled59000 192.0.0.11 disabledLocal Gateway ID: 50000umg-1#Deleting or Clearing Endpoints
To delete a manually provisioned endpoint, use the no form of the endpoint location-id { cue | unity | interchange} command in Cisco UMG configuration mode on the endpoint's primary messaging gateway.
To delete an autoregistered endpoint, use the following procedure on the endpoint's primary messaging gateway.
Although the endpoint will remain online, any messages it attempts to forward will be rejected by the current configuring Cisco UMG. However, the endpoint will be 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. In this case, remember also to change the primary messaging gateway configuration on the endpoint itself.
The clear endpoint command triggers directory exchange with peer messaging gateways.
Note
SUMMARY STEPS
1.
2.
3.
DETAILED STEPS
Examples
umg-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.Blocking Endpoint Registration
Endpoints capable of autoregistering with Cisco UMG (only Cisco Unity Express Release 3.1 and later versions) can be prevented from registering.
The system logic implicitly allows autoregistration for all endpoints; therefore, preventing autoregistration must be explicit.
Prerequisites
The following information is required to prevent autoregistration-capable endpoints from registering.
•
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
DETAILED STEPS
Example:umg-1# config t
Enter configuration commands, one per line. End with CNTL/Z.
umg-1(config)# registration
umg-1(config-reg)# block location-id 34
umg-1(config-reg)# end
umg-1(config)# end
umg-1# show registration block
UMG registration block list :
location-id 34
umg-1#
Viewing Network Status
Use these commands to verify the status of peer messaging gateways and endpoints.
Locating and Viewing Individual Mailbox Details
To locate an individual mailbox in your system and view its details (the phone number, extension, and first and last names associated with the mailbox), use the following procedure.
This procedure assumes that you know the subscriber number, and that you do not know whether it is associated with a local or remote endpoint. It also assumes that you use the show mailbox command for each of the listed endpoints.
If you have provisioned your endpoints with prefixes, you can more easily identify which of the endpoints is worth searching. However, to find a mailbox, it is not sufficient to know the prefix associated with the mailbox's endpoint (unless each of your prefixes applies only to a single endpoint), you must know which endpoint the mailbox is associated with.
Note
SUMMARY STEPS
1.
2.
3.
4.
5.
DETAILED STEPS
Examples
The following example illustrates the output for the show endpoint local, show endpoint network, and show mailbox commands when used in the sequence described previously:
se-10-1-12-96# show endpoint localA total of 8 local endpoint(s) have been found:Location Location Endpoint Endpoint Primary SecondaryID Prefix Type Status Gateway Gateway---------------------------------------------------------------------------300 408555 CUE Offline 51000365 408555 CUE Offline 51000366 408555 CUE Offline 51000369 408555 CUE Offline 51000370 408555 CUE Offline 51000375 408109 CUE Offline 51000376 408110 CUE Offline 51000379 408111 CUE Offline 51000umg-1# show mailbox prefix 408555 filter 0100No mailbox has been found for prefix 408555(filter='0100').umg-1# show endpoint networkA total of 259 network endpoint(s) have been found:Location Location Endpoint Primary SecondaryID Prefix Type Gateway Gateway-----------------------------------------------------------------1 408101 CUE 500002 408102 CUE 500003 408103 CUE 500004 408104 CUE 500005 408105 CUE 500006 408555 CUE 500007 408555 CUE 500008 408108 CUE 50000[...]umg-1# show mailbox prefix 408555 filter 01001 mailbox(s) has been found for prefix 408555(filter='0100).umg-1# show mailbox 7 4085550100Phone: 4085550100Extension: 0100First Name: JohnLast Name: Doe
