Cisco Unified Messaging Gateway 1.0 CLI Administrator Guide
Maintaining the Cisco Unified Messaging Gateway System

Table Of Contents

Maintaining the Cisco Unified Messaging Gateway System

Copying Configurations

Copying the Startup Configuration from the Hard Disk to Another Location

Copying the Startup Configuration from the Network FTP Server to Another Location

Examples

Copying the Running Configuration from the Hard Disk to Another Location

Examples

Copying the Running Configuration from the Network TFTP Server to Another Location

Examples

Restoring Factory Default Values

Going Offline, Reloading, Rebooting, Shutting Down, and Going Back Online

Going Offline

Examples

Restarting Cisco UMG

Examples

Shutting Down

Examples

Going Back Online

Examples

Forcing Data Convergence

Prerequisites

Examples

Managing System Distribution Lists

Prerequisites

Examples

Managing System Broadcasts

Prerequisites

Examples

Deleting Peer Messaging Gateways

Examples

Deleting or Clearing Endpoints

Examples

Blocking Endpoint Registration

Prerequisites

Checking Endpoint Mailboxes


Maintaining the Cisco Unified Messaging Gateway System


Last updated: April 13, 2010

This chapter includes instructions for:

Copying Configurations

Copying the Startup Configuration from the Hard Disk to Another Location

Copying the Startup Configuration from the Network FTP Server to Another Location

Copying the Running Configuration from the Hard Disk to Another Location

Copying the Running Configuration from the Network TFTP Server to Another Location

Restoring Factory Default Values

Going Offline, Reloading, Rebooting, Shutting Down, and Going Back Online

Forcing Data Convergence

Managing System Distribution Lists

Managing System Broadcasts

Deleting Peer Messaging Gateways

Deleting or Clearing Endpoints

Blocking Endpoint Registration

Checking Endpoint Mailboxes

To back up Cisco UMG, see "Backing Up Files" on page 46.

To restore backup files - see "Restoring Files" on page 49.

For troubleshooting, see "Troubleshooting" on page 79.

Copying Configurations

The following Cisco UMG EXEC commands are available to copy the startup configuration and running configuration to and from the hard disk on the Cisco UMG module, the network FTP server, and the network TFTP server.


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.


Copying the Startup Configuration from the Hard Disk to Another Location

Starting in Cisco UMG EXEC mode, use the following command to copy the startup configuration on the hard disk to another location:

copy startup-config {ftp: user-id:password@ftp-server-url | tftp:tftp-server-url} 

Syntax Description

ftp: user-id:password@

Username and password for the FTP server. Include the colon (:) and the at sign (@) in your entry.

ftp-server-url

URL of the FTP server including directory and filename (e.g. ftps://server/dir/filename)

tftp:tftp-server-url

URL of the TFTP server including directory and filename (e.g. tftps://server/dir/filename)


This command is interactive and prompts you for the information. You cannot enter the parameters in one line. The following examples illustrate this process.

In this example, the startup configuration is copied to the FTP server, which requires a username and password to transfer files. The startup configuration file is saved on the FTP server with the filename start.

umg-1# copy startup-config ftp
Address or name of remote host? admin:messaging@ftps://server/dir/start
Source filename? temp_start

The following example shows the startup configuration copied to the TFTP server, which does not require a username and password. The startup configuration is saved in the TFTP directory configs as filename temp_start.

umg-1# copy startup-config tftp
Address or name of remote host? tftps://server/dir/temp_start
Source filename? temp_start

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.


Copying the Startup Configuration from the Network FTP Server to Another Location

Starting in Cisco UMG EXEC mode, use the following command to copy the startup configuration on the network FTP server to another location:

copy ftp: {running-config | startup-config} user-id:password@ftps://server/dir/filename

Syntax Description

running-config

Active configuration on hard disk.

startup-config

Startup configuration on hard disk.

user-id:password@

Username and password for the FTP server. Include the colon (:) and the at sign (@) in your entry.

ftp-server-url

URL of the FTP server.


This command is interactive and prompts you for the information. You cannot enter the parameters in one line. The following example illustrates this process.

Examples

In this example, the FTP server requires a username and password. The file start in the FTP server configs directory is copied to the startup configuration.

umg-1# 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@tftps://server/configs 
Source filename? start

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.


Copying the Running Configuration from the Hard Disk to Another Location

Starting in Cisco UMG EXEC mode, use the following command to copy the running configuration on the hard disk to another location:

copy running-config {ftp: user-id:password@ftps://server/dir/filename |
startup-config | tftp:tftps://server/dir/filename }

Syntax Description

ftp: user-id:password@

Username and password for the FTP server. Include the colon (:) and the at sign (@) in your entry.

ftp-server-url

URL of the FTP server including directory and filename..

startup-config

Startup configuration on hard disk.

tftp-server-url

URL of the TFTP server including directory and filename.


When you copy the running configuration to the startup configuration, enter the command on one line.

When you copy to the FTP or TFTP server, this command becomes interactive and prompts you for the information. You cannot enter the parameters in one line. The following example illustrates this process.

Examples

In the following example, the running configuration is copied to the FTP server, which requires a username and password. 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:messaging@ftps://server/configs
Source filename? saved_start

In the following example, the running configuration is copied to the startup configuration. In this instance, enter the command on a single line.

umg-1# copy running-config startup-config 

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.


Copying the Running Configuration from the Network TFTP Server to Another Location

Starting in Cisco UMG EXEC mode, use the following command to copy the running configuration from the network TFTP server to another location:

copy tftp: {running-config | startup-config} tftps://server/dir/filename

Syntax Description

running-config

Active configuration on hard disk.

startup-config

Startup configuration on harddisk.

tftp-server-url

URL of the TFTP server.


This command is interactive and prompts you for the information. You cannot enter the parameters in one line. The following example illustrates this process.

Examples

In this example, the file start in directory configs on the TFTP server is copied to the startup configuration.

umg-1# 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? tftps://server/configs
Source filename? start

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.


Restoring Factory Default Values

Cisco UMG provides a command to restore the factory default values for the entire system. Restoring the system to the factory defaults erases the current configuration. This function is available in offline mode. When the system is clean, you see a message that the system will reload, and the system begins to reload. When the reload is complete, the system prompts you to go through the postinstallation process.


Caution This operation is irreversible. All data and configuration files are erased. Use this feature with caution. We recommend that you do a full system backup before proceeding with this feature.

Perform the following steps to reset the system to Cisco UMG factory default values.


Step 1 umg-1# offline

This command puts the system into offline mode.

Step 2 umg-1(offline)# restore factory default

This operation will cause all the configuration and data on the system to be erased. This 
operation is not reversible. Do you wish to continue? (n)

Step 3 Do one of the following:

Enter n if want to retain the system configuration and data.

The operation is cancelled, but the system remains in offline mode. To return to online mode, enter continue.

Enter y if you want to erase the system configuration and data.

When the system is clean, a message appears indicating that the system will start to reload. When the reload is complete, a prompt appears to start the postinstallation process.


Going Offline, Reloading, Rebooting, Shutting Down, and Going Back Online

You must take the Cisco UMG system offline before you can do any backups, reload, or restore. However, you do not go offline before shutting down the system.

Always shut down Cisco UMG before power-cycling the router to avoid data loss or file corruption.

Going Offline

Using the offline command in Cisco UMG EXEC mode takes the system into offline/administration mode and terminates all directory exchanges and message forwarding. All outstanding messages will be stored for processing when the system goes back online. When you use the offline command, the system asks for confirmation. The default is no, so to confirm, you must enter yes.


Step 1 offline

Step 2 y

Examples

umg-1# 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-1(offline)

Restarting Cisco UMG

To restart the system using the starting configuration, use the reload and boot disk commands in Cisco UMG offline/administration mode. Restarting the system will terminate all end-user sessions and cause any unsaved configuration data to be lost.


Step 1 reload

Step 2 boot disk

Examples

umg-1(offline) reload
umg-1(offline)>
MONITOR SHUTDOWN...
EXITED: probe exit status 0
EXITED: SQL_startup.sh exit status 0
EXITED: LDAP_startup.sh exit status 0
[...]
Booting from Secure secondary boot loader..., please wait.

[BOOT-ASM]


Please enter '***' to change boot configuration:


 ServicesEngine Bootloader Version : eng_bld


ServicesEngine boot-loader boot disk
[...]
STARTED: /bin/products/umg/umg_startup.sh

 waiting 70 ...
SYSTEM ONLINE
umg-1#

Shutting Down

To halt the system, use the shutdown command in Cisco UMG EXEC mode. Shutting down Cisco UMG not only terminates all directory exchange and message forwarding and causes any unsaved configuration data to be lost; it also causes all registered endpoints to go offline.

These instructions apply to shutting down the software. The procedure for the hardware is described in the "Hardware" section.

The procedure for online insertion and removal of the Cisco UMG network module is described in the hardware installation guide, at http://www.cisco.com/en/US/docs/routers/access/3800/hardware/installation/guide/hw.html.


Caution You must shut down the software before you shut down the hardware.

Software


Step 1 shutdown

Examples

umg-1# shutdown

Hardware

Press the reset button on the network module faceplate for less than 2 seconds to perform a graceful shutdown of the hard disk before removing power from the router or before starting an online insertion and removal (OIR) sequence on the router. The application may take up to 2 minutes to fully shut down.


Warning If you press the shutdown button for more than 4 seconds, an immediate, non-graceful shutdown of the hard disk will occur and may cause file corruption on the network module's hard disk. After a non-graceful shutdown, the HD and SYS LEDs remain lit. Press the shutdown button for less than 2 seconds to gracefully reboot the network module.


Going Back Online

The continue command takes the messaging gateway back online again. All endpoints previously marked `offline' will be marked `online' again.


Step 1 continue

Examples

umg-1(offline) continue
umg-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 This operation applies only to Cisco Unity Express 3.1 and later versions.


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. directory exchange endpoint request full [ location-id ]

2. directory exchange messaging-gateway send update

3. directory exchange messaging-gateway request update

4. show messaging-gateway

DETAILED STEPS

 
Command or Action
Purpose

Step 1 

directory exchange endpoint request { full [ location-id ] | update [ location-id ] }

Example:

umg-1# directory exchange endpoint request full 42

Requests an endpoint to send either its full directory or the update information.

Note This operation only applies to Cisco Unity Express 3.1 and later versions.

Step 2 

directory exchange messaging-gateway send { full [ location-id ] | update [ location-id ] }

Example:

umg-1# directory exchange messaging-gateway send update

Sends the current configuring messaging gateway's full directory or the update information

Step 3 

directory exchange messaging-gateway request { full [ location-id ] | update
[ location-id ] }

Example:

umg-1# directory exchange messaging-gateway request update

Requests directory exchange updates from all peer messaging gateways.

Step 4 

show messaging-gateway [location-id]

Example:

umg-1# show messaging-gateway

Displays the location ID and hostname of any peer messaging gateways that have been configured, whether NAT is enabled for any of them, and the location ID of the current configuring messaging gateway. If a location ID other than the current configuring messaging gateway is specified, displays the named details for the specified messaging gateway.

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 42
umg-1# directory exchange messaging-gateway send update
umg-1# show messaging-gateway
LocationID     Hostname                           NAT
------------------------------------------------------------
59000          209.165.200.224                    disabled
777776         peer-1.mycompany.com               enabled

Local Gateway ID: 51000

umg-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 till 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

An unique SDL number. This is the number an authorized sender dials to address a message to the SDL. It is a numeric string of 1-16 digits.

(Optional) The SDL name is an alphanumeric string. If you use this variable, the name will be validated against the names of existing SDLs.

The authorized sender is identified by an E.164 format number; the system will accept any authorized sender, even one whose number is not in the subscriber directory.

SDL members can be subscribers or other lists. Each one is identified by a number. The system will accept any subscriber as a member, even one whose number it does not find in the subscriber directory. However, it will not accept lists that do not exist as members.

SUMMARY STEPS

1. list-manager

2. list { number number | publish [ location-id ]}

3. name string

4. privilege number

5. member number type [ sub | list ]

6. member number type [ sub | list ]

7. end

8. show list [ number | name ] |

9. list { number number | publish [ location-id ]}

10. end

DETAILED STEPS

 
Command or Action
Purpose

Step 1 

list

Example:
umg-1# list

Enters list manager mode.

Step 2 

list { number number | publish [ location-id ]}

Example:
umg-1(listmgr)# list number 1111 

Publishes lists to other messaging gateways or enters list manager mode and specifies an already existing list or creates a list.

Step 3 

name string

Example:
umg-1(listmgr-edit)# name FirstList

Names a list.

Step 4 

privilege number

Example:
umg-1(listmgr-edit)# privilege 4085550100

Grants a list member permission to send messages to the list.

Step 5 

member number type [ sub | list ]

Example:
umg-1(listmgr-edit)# member 4085550101 type sub

Specifies a list member and its type.

Step 6 

member number type [ sub | list ]

Example:
umg-1(listmgr-edit)# member 2222 type list

Specifies a list member and its type.

Step 7 

end

Example:
umg-1(listmgr-edit)# end

Exits list manager mode.

Step 8 

show list [ number | name ] |

Example:
umg-1(listmgr)# show list

Displays all lists.

Step 9 

list { number number | publish [ location-id ]}

Example:
umg-1(listmgr)# list publish

Publishes lists to other messaging gateways or enters list manager mode and specifies an already existing list or creates a list.

Step 10 

end

Example:
umg-1(listmgr)# end

Exits list manager mode.

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# list
Locking system distribution lists...Lock manager reports failure [FAILED]
umg-1#
umg-1# list
Locking 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 1111 
umg-1(listmgr-edit)# name FirstList
umg-1(listmgr-edit)# end
umg-1(listmgr)# list number 2222
umg-1(listmgr-edit)# SecondList
umg-1(listmgr-edit)# end
umg-1(listmgr)# list number 1111
umg-1(listmgr-edit)# privilege 4085550100
This authorized sender [4085550100] will be added.  However this authorized sender does 
not exist yet!
umg-1(listmgr-edit)# member 4085550101 type sub
WARNING! The subscriber has been added to the list, but it doesn't exist in the subscriber 
directory.

umg-1(listmgr-edit)# member 2222 type list
umg-1(listmgr-edit)# end
umg-1(listmgr)# show list
The version of system distribution list is 50000_20070815050633.

A total of 2 System Distribution List(s) have been found:

Extension      Name
-----------------------------------------------
1111           FirstList
2222           SecondList

umg-1(listmgr)# show list 1111
Extension:         1111
Name:              FirstList
Number of members: 2
Member(s):   4085550101 (subscriber)
             2222 (list)
             # of members: 2

umg-1(listmgr)# list publish
LocationID        Status          Description
-----------------------------------------------------------
51000             Published
59000             Locked(Renewed)


# of network gateways published:        1
# of network gateways failed to publish:1

umg-1(listmgr)# end
umg-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 3.1 and later versions, Cisco UMG automatically picks it up when the endpoint autoregisters.

For endpoints running Cisco Unity Express 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 Avaya Interchange does not support SBMs.


You must create at least one authorized sender (i.e., 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

The broadcast VPIM ID for each Cisco Unity Express endpoint (read it off the configured endpoint).

The telephone number of at least one subscriber who is to be granted the system broadcast privilege for that endpoint. The authorized sender can be associated with any endpoint in the Cisco UMG network.

SUMMARY STEPS

1. config t

2. endpoint location-id {unity | interchange | cue }

3. broadcast-id broadcast-id

4. end

5. broadcast location location-id privilege

6. end

7. show endpoint local location-id

8. show broadcast location location-id privilege

DETAILED STEPS

 
Command or Action
Purpose

Step 1 

config t

Example:

umg-1# config t

Enters configuration mode.

Step 2 

endpoint location-id {unity | interchange | cue }

Example:

umg-1(config)# endpoint 11 cue

Enters endpoint configuration mode and specifies the endpoint to be provisioned, including its type.

Step 3 

broadcast-id broadcast-id

Example:

umg-1(config-endpoint)# broadcast-id 0100

Configures the VPIM broadcast ID of the endpoint.

Step 4 

end

Example:

umg-1(config-endpoint)# end

Exits endpoint configuration mode.

Step 5 

broadcast location location-id privilege number

Example:

umg-1(config)# broadcast location 11 privilege 4085550101

Creates an authorized sender for SBMs to the specified endpoint.

Step 6 

end

Example:

umg-1(config)# end

Exits configuration mode.

Step 7 

show endpoint {local [ location-id ] | network [ location-id ]}

Example:
umg-1# show endpoint local 11

Displays details of the specified endpoint, including and in particular, its broadcast-id.

Step 8 

show broadcast location location-id privilege

Example:

umg-1# show broadcast location 11 privilege

Displays the authorized sender for this endpoint.

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 messaging-gateway, use the no form of the messaging-gateway command in Cisco UMG configuration mode.

In the following procedure the viewing activities are optional.

SUMMARY STEPS

1. (Optional) show messaging gateway

2. (Optional) show messaging gateway [ location-id ]

3. config t

4. no network messaging-gateway location-id

5. end

6. show messaging gateway [ location-id ]

DETAILED STEPS

 
Command or Action
Purpose

Step 1 

show messaging gateway

Example:
umg-1# show messaging-gateway

(Optional) Displays the location ID and hostname of any peer messaging gateways that have been configured, whether NAT is enabled for any of them, and the location ID of the current configuring messaging gateway.

Step 2 

show messaging gateway [ location-id ]

Example:
umg-1# show messaging-gateway 5

(Optional) Displays the location ID and hostname of the specified messaging gateway.

Step 3 

config t

Example:

umg-1# config t

Enters configuration mode.

Step 4 

no network messaging-gateway location-id

Example:

umg-1(config)# no network messaging-gateway 5

Clears (deletes) specified messaging gateway.

Step 5 

end

Example:

umg-1(config)# end

Enters EXEC mode.

Step 6 

show messaging gateway

Example:

umg-1# show messaging-gateway

Displays the location ID and hostname of any peer messaging gateways that have been configured, whether NAT is enabled for any of them, and the location ID of the current configuring messaging gateway.

Examples

umg-1# show messaging-gateway
LocationID     Hostname                           NAT
------------------------------------------------------------
5              www.mycompany.com                  disabled
51000          192.0.0.10                         disabled
59000          192.0.0.11                         disabled

Local Gateway ID: 50000

umg-1# show messaging-gateway 5
LocationID:    5
Hostname:      www.mycompany.com
NAT:           disabled

umg-1# config t
Enter configuration commands, one per line.  End with CNTL/Z.
umg-1(config)# no network messaging-gateway 5
umg-1(config)# end
umg-1# show messaging-gateway
LocationID     Hostname                           NAT
------------------------------------------------------------
51000          192.0.0.10 disabled
59000          192.0.0.11 disabled

Local Gateway ID: 50000

umg-1#

Deleting or Clearing Endpoints

To delete a manually provisioned endpoint, use 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 Cisco UMG does not display more than 250 endpoints without prompting. Use a filter to give you a better overview if you have more than a few endpoints.


SUMMARY STEPS

1. show endpoint local [ location-id | filter filter ]

2. clear endpoint location-id

3. show endpoint local [ location-id | filter filter ]

DETAILED STEPS

 
Command or Action
Purpose

Step 1 

show endpoint local [ location-id | filter filter ]

Example:
umg-1# show endpoint local

Displays all remote endpoints or details for the specified remote endpoint.

Step 2 

clear endpoint location-id

Example:
umg-1# clear endpoint 35

Clears the data on the current configuring gateway for the specified endpoint.

Step 3 

show endpoint local [ location-id | filter filter ]

Example:

umg-1(config)# show endpoint local 35

Displays all remote endpoints or details for the specified remote endpoint.

Examples

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.

Blocking Endpoint Registration

Endpoints capable of autoregistering with Cisco UMG (only Cisco Unity Express 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.

Location IDs for endpoints that you want to prevent from autoregistering.

SUMMARY STEPS

1. config t

2. registration

3. block location-id location-id

4. end

5. end

6. show registration block

DETAILED STEPS

 
Command or Action
Purpose

Step 1 

config t

Example:
umg-1# config t

Enters configuration mode..

Step 2 

registration

Example:
umg-1(config)# registration

Enters registration configuration mode.

Step 3 

block location-id location-id

Example:

umg-1(config-reg)# block location-id 29

Prevents the specified endpoint from autoregistering.

Step 4 

end

Example:

umg-1(config-reg)# end

Exits registration configuration mode.

Step 5 

end

Example:

umg-1(config)# end

Exits configuration mode.

Step 6 

show registration block

Example:

umg-1# show registration block

Displays all remote endpoints or details for the specified remote endpoint.

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#

Checking Endpoint Mailboxes

To find out which mailboxes are associated with which endpoints, see "Locating and Viewing Individual Mailbox Details" on page 54.