Cisco Unified Messaging Gateway 1.0 Command Reference
L

Table Of Contents

L

list-manager

list number

list publish

log console

log console monitor

log server address

log trace boot

log trace buffer save


L


Last Updated: April 16, 2010

list-manager

list number

list publish

log console

log console monitor

log server address

log trace boot

log trace buffer save

list-manager

To enter list manager mode in order to create, edit, or publish a system distribution list (SDL), use the list manager command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.

list-manager

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

Entering list manager mode locks list management on all peer messaging gateways, thereby preventing system desynchronization.

If the system encounters an SDL lock on a peer messaging gateway, it fails to lock and automatically leaves list manager mode. In this situation, you can wait until the lock on the peer messaging gateway is released or exit by using the exit command.


Caution If the system tells you that the current configuring messaging gateway is out of sync when you attempt to enter list manager mode, use the show list command to find out peer messaging gateway has the latest SDL information by looking at the SDL version numbers. Publishing from that messaging gateway brings the other messaging gateways back into sync.

Examples

The following example illustrates the use of the list-manager command to enter list manager mode:

umg-1# list-manager
umg-1(listmgr)# list number 4085550101
umg-1(listmgr-edit)#end
umg-1# 

The following example shows the output when the system fails to lock the list management.
umg-1# list-manager
Locking system distribution lists...Lock manager reports failure [FAILED]

The following example shows the out-of-sync warning.
umg-1# list-manager
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 
-------------------------- ------------------------ ------------------------

Related Commands

Command
Description

list number

Creates an SDL.

list publish

Publishes one or more SDLs to peer messaging gateways.

member

Assigns members to an SDL.

name

Assigns a name to an SDL.

privilege

Configures an authorized sender to an SDL.

show list

Displays a list of the SDLs that are configured and their details.

show list privilege

Displays the authorized sender to a specific SDL.

show list tracking version

Displays an SDL tracking version.


list number

To enter list manager edit mode in order to configure a system distribution list (SDL) in detail, use the list number command in Cisco Unified Messaging Gateway (Cisco UMG) list manager mode. To delete an SDL, use the no form of this command.

list number number

no list number number

Syntax Description

number

The number an authorized subscriber dials to address a message to this SDL (range: 1-16 digits).


Command Default

None

Command Modes

Cisco UMG list manager (listmgr)

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

The list number cannot be the same as any other SDL number or any subscriber's number.

When you have created an SDL, unless you configure both an authorized sender and members for it, no messages can be sent to it and nobody can receive them.

When you leave list manager edit mode, the system automatically publishes your changes to all peer messaging gateways.

Examples

The following example illustrates the use of the list number command, and also subsequent configuration and publication:

umg-1# list-manager
Locking system distribution lists...[OK] 
umg-1(listmgr)# list number 1111 
umg-1(listmgr-edit)# name FirstList
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)# end
auto publishing to all ...
LocationID        Status          Description
-----------------------------------------------------------
57000             Published


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

Unlocking system distribution lists...[OK]
umg-1# show list 1111
Extension:          1111
Name:               FirstList
Number of members:  2
Member(s):          4085550101 (subscriber) 
                    2222 (list)
                    # of members: 2
umg-1#

Related Commands

Command
Description

list-manager

Locks down all peer Cisco UMGs so that SDLs can be published to peer messaging gateways,

list publish

Publishes one or more SDLs to peer messaging gateways.

member

Assigns members to an SDL.

name

Assigns a name to an SDL.

privilege

Configures an authorized sender to an SDL.

show list

Displays a list of the SDLs that are configured and their details.

show list privilege

Displays the authorized sender to a specific SDL.

show list tracking version

Displays an SDL tracking version.


list publish

To publish one or more system distribution lists (SDLs) to one or more peer messaging gateways, use the list publish command in Cisco Unified Messaging Gateway (Cisco UMG) list manager mode.

list publish [ location-id ]

Syntax Description

location-id

The location ID (range: 1-10 digits) of the peer messaging gateway to which you are publishing.


Command Default

None

Command Modes

Cisco UMG list manager (listmgr)

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

Use this command to publish SDLs to peer messaging gateways.


Note Use this command when you create an SDL, and each time you update an SDL, for example, when you add a new member.


Examples

The following examples illustrate the use of the list publish command to publish to all messaging gateways. The system indicates that it could not publish to one messaging gateway because that one was locked.

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#

Related Commands

Command
Description

list-manager

Enters list manager mode and locks down list management on all peer messaging gateways.

list number

Creates an SDL.

member

Assigns members to an SDL.

name

Assigns a name to an SDL.

privilege

Configures an authorized sender to an SDL.

show list

Displays a list of the SDLs that are configured and their details.

show list privilege

Displays the authorized sender to a specific SDL.

show list tracking version

Displays an SDL tracking version.


log console

To configure the types of messages to be displayed on the console, use the log console command in Cisco Unified Messaging Gateway (Cisco UMG) configuration mode. To turn off message display, use the no form of this command.

log console {errors | info | notice | warning }

no log console {errors | info | notice | warning }

Syntax Description

errors

Error messages, severity 3

info

Information messages, severity 6

notice

Notices, severity 5

warning

Warning messages, severity 4


Command Default

Only fatal error messages are displayed.

Command Modes

Cisco UMG configuration (config)

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

This command has the same function as the trace command.

The messages on the console display are also saved in the messages.log file. You can use these messages for debugging.

Examples

The following example shows how to display warning messages on the console:

umg-1# config t
umg-1(config)# log console warning
umg-1(config)# end

Related Commands

Command
Description

log console monitor

Enables log monitor events for debugging.

log server address

Specifies an external server for saving log messages.

log trace boot

Saves the trace configuration on rebooting.

show logging

Displays console logging options.

show logs

Displays the logs.


log console monitor

To enable log monitor events for debugging, use the log console monitor command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode. To turn off log monitor events, use the no form of this command.

log console monitor { backuprestore | umg | all | dbclient | dns | management | ntp | security | snmp | superthread | sysdb | udppacer }

no log console monitor { backuprestore | UMG | all | dbclient | dns | management | ntp | security | snmp | superthread | sysdb | udppacer }

Syntax Description

backuprestore

Module

umg

Module

all

All modules

dbclient

Module

dns

Module

management

Module

ntp

Module

security

Module

snmp

Module

superthread

Module


Command Default

None

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Examples

The following example illustrates the use of one of the log console monitor options:

umg-1# log console monitor umg registration 4
umg-1

log server address

To specify a remote server for saving log messages, use the log server address command in Cisco Unified Messaging Gateway (Cisco UMG) configuration mode. To delete the log server, use the no form of this command.

log server address A.B.C.D

no log server address A.B.C.D

Syntax Description

A.B.C.D

IP address hostname of the remote syslog server.


Defaults

No external log server is configured. The local hard disk is used for saving log messages.

Command Modes

Cisco UMG configuration (config)

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

To achieve flexibility in viewing and printing system messages when troubleshooting, copy to a server the messages.log file that is stored on the hard disk of the Cisco UMG network module.

Examples

The following example illustrates the configuration of a remote syslog server:

umg-1(config)# log server address 192.0.2.24
umg-1(config)# exit
umg-1# show running-config
Generating configuration:
...
log server address 192.0.2.24
...
umg-1#

Related Commands

Command
Description

log console

Configures the types of messages to be displayed on the console.

log console monitor

Displays system messages on the console.

log trace boot

Saves the trace configuration on rebooting.

log trace buffer save

Saves the current trace information.

show log name

Displays a particular log.

show logging

Shows the types of messages that are displayed on the console

show logs

Shows the existing log files on the Cisco UMG.

show running-config

Displays the running configuration, including the IP address or hostname of the remote syslog server.


log trace boot

To save the trace settings, use the log trace boot command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.

log trace boot

Syntax Description

This command has no arguments or keywords.

Command Default

The trace configuration is lost on reboot because tracing is CPU-intensive.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

Before you reboot Cisco UMG, use the log trace boot command to save the trace configuration.

Examples

The following example illustrates the log trace boot command:

umg-1# log trace boot
umg-1# 

Related Commands

Command
Description

show log name

Displays a particular log.

show logging

Shows the types of messages that are displayed on the console.

show logs

Shows the existing log files on the Cisco UMG.

show trace buffer

Displays trace information.

show trace store-prev

Displays a list of events from the atrace.log.prev file.


log trace buffer save

To save the current trace information, use the log trace buffer save command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.

log trace buffer save

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

Current trace information stored in the memory buffer can be saved to a file. The file created with the log trace buffer save command is atrace_save.log.

Examples

The following example illustrates the log trace buffer save command:

umg-1# log trace buffer save
umg-1

Related Commands

Command
Description

log trace boot

Saves the trace configuration on rebooting.

show log name

Displays a particular log.

show logging

Shows the types of messages that are displayed on the console.

show logs

Shows the existing log files on the Cisco UMG.

show trace buffer

Displays trace information.

show trace store-prev

Displays a list of events from the atrace.log.prev file.