Table Of Contents
S
serial-number
show backup
show backup history
show backup server
show broadcast location
show clock
show configuration
show ddr timeout
show endpoint
show hosts
show ip
show list
show list privilege
show list tracking version
show log name
show logging
show logs
show memory
show messaging-gateway
show nat location
show ndr timeout
show network default-route
show ntp
show processes
show registration
show running-config
show software
show software directory
show spoken-name
show startup-config
show statistics
show trace buffer
show trace store
show trace store-prev
show translation-rule
shutdown
software download abort
software download clean
software download server
software download status
software download uninstall
software download upgrade
software install clean
software install downgrade
software install upgrade
software remove
spoken-name
S
Last Updated: April 16, 2010
serial-number
show backup
show backup history
show backup server
show broadcast location
show clock
show configuration
show ddr timeout
show endpoint
show hosts
show ip
show list
show list privilege
show list tracking version
show log name
show logging
show logs
show memory
show messaging-gateway
show nat location
show ndr timeout
show network default-route
show ntp
show processes
show registration
show running-config
show software
show software directory
show spoken-name
show startup-config
show statistics
show trace buffer
show trace store
show trace store-prev
show translation-rule
shutdown
software download abort
software download clean
software download server
software download status
software download uninstall
software download upgrade
software install clean
software install downgrade
software install upgrade
software remove
spoken-name
serial-number
To configure a serial number for a Cisco Unity endpoint, use the serial-number command in Cisco Unified Messaging Gateway (Cisco UMG) endpoint configuration mode. To clear this configuration, use the no form of this command.
serial-number numeric_string
no serial-number numeric_string
Syntax Description
numeric_string
|
Serial number of the Cisco Unity endpoint
|
Command Default
None
Command Modes
Cisco UMG endpoint configuration (config-endpoint)
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
Use this command to configure a serial-number for a Cisco Unity endpoint.
Note
This command is not applicable to Avaya Interchange or to <Abbreviation>Cisco Unity Express endpoints.
Examples
The following example shows how the serial number is set as part of the process of provisioning a Cisco Unity endpoint:
umg-1(config)# endpoint 12345 type unity
umg-1(config-unity)# serial-number 12345
umg-1(config-unity)# secondary gateway 10.100.50.2
Related Commands
Command
|
Description
|
endpoint
|
Enters endpoint configuration mode in order to provision endpoints manually.
|
domain
|
Sets the domain name for an endpoint.
|
messaging-gateway secondary
|
Specifies a secondary messaging gateway.
|
prefix
|
Sets the phone number prefix for an endpoint.
|
show backup
To display backup utility configurations, use the show backup command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show backup
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
This command displays the FTP server URL, the subscriber account on the FTP server, and the number of backup file revisions that are stored on the server.
Examples
The following is sample output from the show backup command:
Server URL: ftp://192.0.2.24/ftp
Number of Backups to Retain: 5
Table 1 describes the significant fields shown in the display.
Table 1 show backup Field Descriptions
Field
|
Description
|
Server URL
|
IP address of the backup server.
|
User Account on Server
|
(Optional) Username on the backup server.
|
Number of Backups to Retain
|
Number of backup files to store before the oldest one is overwritten.
|
Related Commands
Command
|
Description
|
backup category
|
Specifies the type of data to be backed up and initiates the backup process.
|
backup revisions
|
Sets the number of backup files to store and/or the FTP server to which they are to be saved.
|
restore id
|
Restores a backup file.
|
show backup history
|
Displays the success or failure of backup and restore procedures.
|
show backup server
|
Displays the details of the most recent backup files.
|
show backup history
To display the success or failure of backup and restore procedures, use the show backup history command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show backup history
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
This command displays each backup file, its backup ID, the type of data stored in the file, and the success or failure of the backup procedure.
Examples
The following is sample output from the show backup history command:
umg-1# show backup history
Backup Server: ftp://192.0.2.24/UMG_backup
Description: test backup 1
Date: Sun Jun 13 12:23:38 PDT 1993
Reason: Script execution failed: /bin/BR_VMConfg_backup.sh: returnvalue:1
; Server Url:ftp://192.0.2.24/UMG_backup: returnvalue:9 Unable to authenticate
Backup Server: ftp://192.0.2.24/UMG_backup
Description: test backup 1
Date: Sun Jun 13 12:23:44 PDT 1993
Reason: Script execution failed: /bin/BR_VMData_backup.sh: returnvalue:1
Backup failed; Server Url:ftp://192.0.2.24/UMG_backup: returnvalue:9
Backup Server: ftp://192.0.2.24/UMG_backup
Description: UMG test backup
Date: Sun Jun 13 12:32:48 PDT 1993
Backup Server: ftp://192.0.2.24/UMG_backup
Description: UMG test backup
Date: Sun Jun 13 12:32:57 PDT 1993
Backup Server: ftp://192.0.2.24/UMG_backup
Date: Sun Jun 13 12:37:52 PDT 1993
Backup Server: ftp://192.0.2.24/UMG_backup
Date: Sun Jun 13 12:38:00 PDT 1993
Table 2 describes the significant fields shown in the display.
Table 2 show backup history Field Descriptions
Field
|
Description
|
Category
|
Specifies the type of file (data, configuration, or all) backed up.
|
Backup Server
|
Backup server location.
|
Operation
|
Type of operation performed.
|
Backupid
|
ID of the backup file.
|
Restoreid
|
ID to use to restore this file.
|
Description
|
Optional description of the backup procedure.
|
Date
|
Date and time (in hh:mm:ss) when the operation occurred.
|
Result
|
Indication of success or failure of the operation.
|
Reason
|
If the operation failed, this field gives the reason for the failure.
|
Related Commands
Command
|
Description
|
backup category
|
Specifies the type of data to back up and initiates the backup process.
|
backup revisions
|
Sets the number of backup files to store and/or the FTP server to which they are to be saved.
|
restore id
|
Restores a backup file.
|
show backup server
|
Displays the details of the most recent backup files.
|
show backup server
To display the details of the most recent backup files, use the show backup server command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show backup server
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
This command displays a list of the backup files available on the backup server. The files are grouped by category, with the date of each backup and the backup file ID. For information on the success or failure of a backup procedure, see the show backup history command.
Examples
The following is sample output for the show backup server command:
umg-1# show backup server
Details of last 5 backups
Date: Tue Jul 22 10:55:52 PDT 2007
Date: Tue Jul 29 18:06:33 PDT 2007
Date: Tue Jul 29 19:10:32 PDT 2007
Details of last 5 backups
Date: Tue Jul 22 10:55:48 PDT 2007
Date: Tue Jul 29 18:06:27 PDT 2007
Date: Tue Jul 29 19:10:29 PDT 2007
Table 3 describes the significant fields shown in the display.
Table 3 show backup server Field Descriptions
Field
|
Description
|
Category
|
Type of backup file.
|
Backupid
|
ID of the backup file.
|
Date
|
Date and time (in hh:mm:ss) when the file was backed up.
|
Description
|
Optional description of the backup file.
|
Related Commands
Command
|
Description
|
backup category
|
Specifies the type of data to be backed up and initiates the backup process.
|
backup revisions
|
Sets the number of backup files to store and/or the ftp server to which they are to be saved.
|
restore id
|
Restores a backup file.
|
show backup history
|
Displays the success or failure of backup and restore procedures.
|
show broadcast location
To display any subscribers who are authorized to send System Broadcast Messages (SBMs) to a specified endpoint, use the show broadcast location command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show broadcast location location-id privilege
Syntax Description
location-id
|
Numeric string that functions as a system-wide unique identifier (range: 1-10 digits).
|
Command Default
None
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
•
The authorized sender has the privilege of being able to send System Broadcast Messages (SBMs) to all subscribers on any Cisco Unity or <Abbreviation>Cisco Unity Express endpoint, local or remote.
•
The number the authorized sender dials to send an SBM is the endpoint's location ID.
•
There is no limit on the number of subscribers to whom you can grant this privilege.
•
Avaya Interchange does not support the SBM function.
Examples
The following example illustrates the use of the show broadcast location command:
umg-1# show broadcast location 1234 privilege
A total of 1 Authorized Sender(s) have been found for location 1234:
Related Commands
Command
|
Description
|
broadcast-id
|
Provisions a broadcast VPIM ID to a local <Abbreviation>Cisco Unity Express or a local Cisco Unity endpoint so that authorized senders can send System Broadcast Messages (SBMs) to all subscribers on that endpoint.
|
endpoint
|
Enters endpoint configuration mode to provision endpoints manually.
|
broadcast location
|
Enables a subscriber to send a System Broadcast Message (SBM) to all subscribers on a specified endpoint, whether local or remote.
|
show clock
To display clock statistics, use the show clock command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show clock
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
Cisco UMG uses the Network Time Protocol (NTP) server for clocking functions. Use the show clock command to display the Cisco UMG clock status.
Examples
The following is sample output for the show clock command:
19:20:33.724 PST Wed Mar 17 1993
time zone: America/Los_Angeles
delta from reference (microsec): 0
estimated error (microsec): 175431
time resolution (microsec): 1
clock interrupt period (microsec): 10000
time of day (sec): 732424833
time of day (microsec): 760817
Table 4 describes the significant fields shown in the display.
Table 4 show clock Field Descriptions
Field
|
Description
|
time zone
|
Current time zone setting.
|
clock state
|
Synchronization state of the clock.
|
delta from reference (ms)
|
Difference between the module clock and the NTP reference clock.
|
time of day (sec)
|
Current time of day in seconds.
|
time of day (ms)
|
Current time of day in microseconds.
|
Related Commands
Command
|
Description
|
ntp server
|
Specifies the NTP server for Cisco UMG.
|
show ntp
|
Displays the time source for a Network Time Protocol (NTP) server.
|
show configuration
To display the contents of the non-volatile memory, use the show configuration command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show configuration
Syntax Description
This command has nor 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
Use this command for troubleshooting.
Examples
The following is sample output for the show configuration command:
umg-1# show configuration
clock timezone America/Los_Angeles
system language preferred "en_US"
ntp server 192.0.2.24 prefer
software download server url "ftp://192.0.2.23/ftp" credentials hidden "6u/dKTN/h
sEuSAEfw40XlF2eFHnZfyUTSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfG
WTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmP"
groupname Administrators create
groupname Broadcasters create
groupname Administrators privilege superuser
groupname Administrators privilege ManagePrompts
groupname Administrators privilege broadcast
groupname Administrators privilege local-broadcast
groupname Administrators privilege ManagePublicList
groupname Administrators privilege ViewPrivateList
groupname Administrators privilege vm-imap
groupname Administrators privilege ViewHistoricalReports
groupname Administrators privilege ViewRealTimeReports
groupname Broadcasters privilege broadcast
backup server url "ftp://192.0.2.23/sd_backup_10" credentials hidden "+EdqgXXrw
vTq9Gr22KTpoknfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfG
WTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmP"
security password lockout policy temp-lock
security pin lockout policy temp-lock
network local messaging-gateway 50000
network messaging-gateway 57000 192.0.2.22
username cue_02 password encrypted "Cnjf81Z1zXpbrA7+7/IBX0nfGWTYHfmPSd8ZZNgd+Y9
J3xlk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWT
username umg password encrypted "R30jwZyreaDX3TqGSvsp5EnfGWTYHfmPSd8ZZNgd+Y9J3x
lk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHf
translation-rule message unity from-host to-host
Related Commands
Command
|
Description
|
backup category
|
Specifies the type of data to be backed up and initiates the backup process.
|
hostname
|
Specifies the hostname of the current messaging gateway.
|
ip domain-name
|
Specifies the local messaging gateway's domain name and/or domain name server.
|
nat location
|
Enters the NAT configuration mode to set up NAT entries on Cisco UMG for an endpoint or for a messaging-gateway.
|
registration
|
Enters registration configuration mode in order to configure autoregistration parameters for endpoints of the type Cisco Unity Express 3.1 and later versions.
|
restore factory default
|
Restores factory default settings.
|
show ddr timeout
To display the timeout window whose elapse will result in a delayed delivery receipt (DDR), use the show ddr timeout command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show ddr timeout
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
Use this command to display the DDR timeout.
Examples
The following example sets a DDR timeout, then displays it:
umg-1# config t
umg-1(config)# DDR timeout 2
umg-1# show DDR timeout
Timeout window for DDR is 2 hours
Related Commands
Command
|
Description
|
ddr timeout
|
Configures the amount of time that elapses before a DDR is sent.
|
ndr timeout
|
Configures the amount of time that elapses before a non-delivery receipt (NDR) is sent.
|
show ndr timeout
|
Displays the amount of time that elapses before an NDR is sent.
|
show endpoint
To display a list of the endpoints in the system and their details or a specific endpoint's details, use the show endpoint command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show endpoint { local [ location-id | filter ] } | { network [ location-id | filter string ] }
Syntax Description
local
|
Endpoints for which the current configuring Cisco UMG is the primary or secondary messaging gateway.
|
network
|
Endpoints whose primary messaging gateways are peer Cisco UMGs.
|
location-id
|
This is a numeric string that functions as a system-wide unique identifier (range: 1-10 digits).
|
filter string
|
The filter string. Any location ID containing the filter string is returned. Regular expression is not supported.
|
Command Default
None
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
Use this command to display a list of endpoints on the Cisco UMG network, local or remote, or the details for a single specified endpoint, either local or remote.
If there are more than 50 endpoints on the network, you are prompted to provide a filter string.
Examples
The following is sample output for the show endpoint local command.
umg-1# show endpoint local
A total of 7 local endpoint(s) have been found:
Location Location Endpoint Endpoint Primary Secondary
ID Prefix Type Status Gateway Gateway
---------------------------------------------------------------------------
400001 CUE Disabled 50000
400002 Interchange Disabled 50000
999 Interchange Disabled 50000
400000 Unity Disabled 50000
5555 6505551010 Unity Disabled 50000
The following is sample output for the show endpoint local location-id command.
umg-1# show endpoint local 999
Primary Gateway ID: 50000
umg-1# show endpoint local 40000
Broadcast VPIM ID: vpim-broadcast
Primary Gateway ID: 50000
Status: Auto-Registered-Online
The following is sample output for the show endpoint network command.
umg-1# show endpoint network
A total of 20 network endpoint(s) have been found:
Location Location Endpoint Primary Secondary
ID Prefix Type Gateway Gateway
-----------------------------------------------------------------
The following is sample output for the show endpoint network location-id command.
umg-1# show endpoint network 115
Broadcast VPIM ID: vpim-broadcast
Primary Gateway ID: 51000
umg-1# show endpoints network filter 1111
3 endpoints have been found.
Table 5 describes the categories of information shown in the display.
Table 5 show endpoint Field Descriptions
Field
|
Description
|
Location ID
|
Endpoint's location ID.
|
Hostname
|
Endpoint's hostname or IP address.
|
Domain
|
Endpoint's domain name or IP address.
|
(Location) Prefix
|
Dialing prefix for endpoint.
|
(Endpoint) Type
|
Type of endpoint: CUE (<Abbreviation>Cisco Unity Express), Unity (Cisco Unity) or Interchange (Avaya Interchange).
|
Broadcast VPIM ID
|
Number that authorized sender dials to send broadcast messages.
|
Primary Gateway ID
|
Location ID of the primary Cisco UMG.
|
Secondary Gateway ID
|
Location ID of the secondary Cisco UMG (not supported by Avaya Interchange endpoints).
|
(Endpoint) Status
|
Indicates whether registered or blocked (not relevant for Cisco Unity or Avaya Interchange).
|
Serial-number
|
Serial number of the endpoint (not relevant for <Abbreviation>Cisco Unity Express).
|
Related Commands
Command
|
Description
|
block location-id
|
Prevents an endpoint of the type Cisco Unity Express 3.1 and later versions from autoregistering.
|
broadcast-id
|
Provisions a broadcast VPIM ID to local endpoints of the type Cisco Unity Express 3.0 and earlier versions.
|
broadcast location
|
Enables a subscriber to send a System Broadcast Message (SBM) to all subscribers on a specified endpoint, whether local or remote.
|
domain
|
Provisions the domain name of an endpoint to Cisco UMG.
|
endpoint
|
Enters endpoint configuration mode to provision endpoints manually.
|
hostname (endpoint)
|
Specifies the hostname of an endpoint you are provisioning manually.
|
messaging-gateway secondary
|
Specifies a secondary messaging gateway.
|
prefix
|
Specifies the telephone number prefix for an endpoint you are provisioning manually.
|
registration
|
Enters registration configuration mode to configure autoregistration parameters for Cisco Unity Express 3.1 and later versions.
|
show hosts
To display the hostname and the domain of the local messaging gateway, use the show hosts command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show hosts
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
Use this command to display the hostname and domain name for the current messaging gateway.
Examples
The following is sample output from the show hosts command:
Related Commands
show ip
To display the IP routing table or the DNS cache, use the show ip command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show ip { route | dns cache }
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.
|
Examples
The following is sample output for the show ip command:
10.0.6.0 0.0.0.0 255.255.255.0 eth1
172.16.0.0 0.0.0.0 255.0.0.0 lo
0.0.0.0 10.0.6.9 0.0.0.0 eth1
The following is sample output for the show ip dns cache command:
umg-1.unspecified. 2147483647 IN A 192.0.2.24
localhost.\(none\). 2147483647 IN A 192.0.2.23
192.0.2.22.in-addr.arpa. 2147483647 IN PTR localhost.
stress-umg1-192.0.2.24.example.com. 2147483647 IN A 192.0.2.24
192.0.2.24.in-addr.arpa. 2147483647 IN PTR 192.0.2.24.te
se-192.0.2.24.localdomain. 2147483647 IN A 192.0.2.24
sundial1-umg-se-192.0.2.24.localdomain. 2147483647 IN A 10.1.12.95
localhost.temp.com. 2147483647 IN A 192.0.2.18
192.0.2.24.temp.com. 2147483647 IN A 192.0.2.24
192.0.2.24.\(none\). 2147483647 IN A 192.0.2.24
stress-umg1-192.0.2.24.example.com. 2147483647 IN A 192.0.2.24
localhost. 2147483647 IN A 192.0.2.20
stress-umg1-192.0.2.22.\(none\). 2147483647 IN A 192.0.2.24
se-192.0.2.24.example.com. 2147483647 IN A 192.0.2.24
localhost.cisco.com. 2147483647 IN A 192.0.2.23
Table 6 describes the significant fields shown in the display.
Table 6 show ip route Field Descriptions
Field
|
Description
|
DEST
|
IP address of the destination network.
|
GATE
|
IP address of the gateway to access the destination network.
|
MASK
|
Mask for the gateway IP address.
|
IFACE
|
Interface to reach the destination network.
|
Related Commands
Command
|
Description
|
hostname
|
Specifies the hostname for the current configuring Cisco UMG.
|
ip name-server
|
Specifies the domain name server.
|
ntp server
|
Specifies the NTP clocking server.
|
show hosts
|
Displays all configured hosts.
|
show list
To display a list of the system distribution lists (SDLs) that are configured, use the show list command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode or list manager mode.
show list { number | filter | name string }
Syntax Description
number
|
This is the SDL number, which the subscriber dials to send a message to the list.
|
filter
|
This is the SDL number filter: for example, use "22" to find all SDLs whose numbers contain that string.
|
name string
|
This is the (optional) SDL name
|
Command Default
None
Command Modes
Cisco UMG list manager (listmgr)
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modifications
|
1.0
|
This command was introduced.
|
Usage Guidelines
If an SDL has been configured with a name, that name is displayed.
SDL synchronization across the Cisco UMG system implements version numbers. Each SDL has a tracking version number. Changes to SDL lists will increment the number and this version number can be used to indicate whether multiple messaging gateways' SDL configurations are synchronized .
If no SDLs are configured, the system indicates that.
Examples
The following is sample output from the show list command in both list manager and EXEC modes:
Locking system distribution lists...[OK]
**WARNING** This UMG may have outdated SDL, please check the listed SDL version
and publish from which ever seems most correct.
local sdl version last updated: Oct 16, 2007 5:17:30 AM
remote sdl version last updated: Oct 19, 2007 7:04:44 AM
SDL-Version Last-Updated List-Of-Remote-Gateways
-------------------------- ------------------------ ------------------------
* 57000_20071019070444 Oct 19, 2007 7:04:44 AM 57000
-------------------------- ------------------------ ------------------------
umg-1(listmgr)> show list
The version of system distribution list is 101_20071016051730.
A total of 1 System Distribution List(s) have been found:
-----------------------------------------------
Unlocking system distribution lists...[OK]
The version of system distribution list is 101_20071016051730.
A total of 1 System Distribution List(s) have been found:
-----------------------------------------------
The following is sample output for the show list name command:
umg-1(listmgr)# show list name sample-list
Related Commands
show list privilege
To display the mailbox number of the authorized sender to a specific system distribution list (SDL), use the show list privilege command in Cisco Unified Messaging Gateway (Cisco UMG) list manager mode.
show list privilege number
Syntax Description
number
|
SDL number, which is the number an authorized subscriber dials to address a message to this SDL.
|
Command Default
None
Command Modes
Cisco UMG list manager (listmgr)
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modifications
|
1.0
|
This command was introduced.
|
Usage Guidelines
The command displays the list name if applicable, list number, and members, and additionally, type of member, whether subscriber or another list.
An error message appears if the specified list does not exist.
Examples
The following is sample output from the show list privilege command:
umg-1(listmgr)# show list privilege 1234
1 authorized sender(s) has been found for system distribution list 1234
Related Commands
show list tracking version
To display a system distribution list (SDL) tracking version, use the show list tracking version command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show list tracking version
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
Use this command to find out whether two messaging gateways are in synch as regards an SDL.
Examples
The following examples illustrate the use of the show list tracking version command:
umg-1# show list tracking version
Related Commands
Command
|
Description
|
list-manager
|
Enters list configuration mode in order to configure an SDL in detail.
|
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 configured SDLs.
|
show list privilege
|
Displays the authorized sender to a specific SDL.
|
show log name
To display logging data, use the show log name command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show log name word [containing expression | paged | tail]
Syntax Description
word
|
The name of the log file to display. Use the show logs command to display a list of available log files.
|
containing expression
|
(Optional) Only display events that match a search expression.
|
paged
|
(Optional) Display in paged mode.
|
tail
|
(Optional) Display the latest events as they occur.
|
Command Default
None
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
Filtering options:
show begin: Begins the output of any show command from a specified string.
show exclude: Filters show command output so that it excludes lines that contain a particular regular expression.
show include: Filters show command output so that it displays only lines that contain a particular regular expression.
Examples
The following partial output for the show log name command displays the dmesg log:
umg-1# show log name dmesg
Press <CTRL-C> to exit...
Linux version 2.4.24 (bld_adm@bld-system) (gcc version 2.95.3 20010315 (version4
setup.c: handling flash window at [15MB..16MB]
setup.c: handling kernel log buf at [245.5MB]
setup.c: handling trace buf at [246MB]
BIOS-provided physical RAM map:
BIOS-e820: 0000000000000000 - 000000000009f400 (usable)
BIOS-e820: 000000000009f400 - 00000000000a0000 (reserved)
BIOS-e820: 00000000000e0800 - 0000000000100000 (reserved)
BIOS-e820: 0000000000100000 - 0000000000f00000 (usable)
BIOS-e820: 0000000000f00000 - 0000000001000000 (reserved)
BIOS-e820: 0000000001000000 - 000000000f580000 (usable)
BIOS-e820: 000000000f580000 - 000000000f600000 (reserved)
BIOS-e820: 000000000f600000 - 0000000010000000 (reserved)
BIOS-e820: 00000000fff00000 - 0000000100000000 (reserved)
On node 0 totalpages: 62848
Kernel command line: root=/dev/hda1 ro plat=nm
Detected 498.674 MHz processor.
Calibrating delay loop... 996.14 BogoMIPS
Memory: 245128k/251392k available (1164k kernel code, 4852k reserved, 667k data)
kdb version 4.3 by Keith Owens, Scott Lurndal. Copyright SGI, All Rights Reservd
log_head: h: 0, t: 8429274, l: 0, w: 0, s: 10484672
log_head: h: 0, t: 8429274, l: 0, w: 0, s: 10484672
Dentry cache hash table entries: 32768 (order: 6, 262144 bytes)
Inode cache hash table entries: 16384 (order: 5, 131072 bytes)
Mount cache hash table entries: 512 (order: 0, 4096 bytes)
Buffer cache hash table entries: 16384 (order: 4, 65536 bytes)
Page-cache hash table entries: 65536 (order: 6, 262144 bytes)
CPU: L1 I cache: 16K, L1 D cache: 16K
CPU serial number disabled.
The following sample output for the show log command displays the dmesg log using a search string:
umg-1# show log name dmesg containing setup
Press <CTRL-C> to exit...
setup.c: handling flash window at [15MB..16MB]
setup.c: handling kernel log buf at [245.5MB]
setup.c: handling trace buf at [246MB]
The following partial output for the show log command displays the dmesg log in paged mode:
umg-1# show log name dmesg paged
Linux version 2.4.24 (bld_adm@bld-system) (gcc version 2.95.3 20010315 (version
)) #1 Tue Nov 30 23:07:21 PST 2007
setup.c: handling flash window at [15MB..16MB]
setup.c: handling kernel log buf at [245.5MB]
setup.c: handling trace buf at [246MB]
BIOS-provided physical RAM map:
BIOS-e820: 0000000000000000 - 000000000009f400 (usable)
BIOS-e820: 000000000009f400 - 00000000000a0000 (reserved)
BIOS-e820: 00000000000e0800 - 0000000000100000 (reserved)
BIOS-e820: 0000000000100000 - 0000000000f00000 (usable)
BIOS-e820: 0000000000f00000 - 0000000001000000 (reserved)
BIOS-e820: 0000000001000000 - 000000000f580000 (usable)
BIOS-e820: 000000000f580000 - 000000000f600000 (reserved)
BIOS-e820: 000000000f600000 - 0000000010000000 (reserved)
BIOS-e820: 00000000fff00000 - 0000000100000000 (reserved)
On node 0 totalpages: 62848
Kernel command line: root=/dev/hda1 ro plat=nm
The following output for the show log name command displays the current dmesg log as events are being entered:
umg-1# show log name dmesg tail
Press <CTRL-C> to exit...
Freeing unused kernel memory: 88k freed
The following partial output for the show log name command displays the dmesg log beginning with the first line starting with ide0:
umg-1# show log name dmesg | begin ide0
ide0: BM-DMA at 0xfc00-0xfc07, BIOS settings: hda:pio, hdb:pio
ide1: BM-DMA at 0xfc08-0xfc0f, BIOS settings: hdc:pio, hdd:pio
hda: C/H/S=50127/232/176 from BIOS ignored
hdb: C/H/S=0/0/0 from BIOS ignored
hda: IC25N020ATMR04-0, ATA DISK drive
blk: queue c030c160, I/O limit 4095Mb (mask 0xffffffff)
ide0 at 0x1f0-0x1f7,0x3f6 on irq 14
hda: attached ide-disk driver.
hda: host protected area => 1
hda: 39070080 sectors (20004 MB) w/1740KiB Cache, CHS=2432/255/63, UDMA(33)
Related Commands.
show logging
To display the types of messages that are displayed on the console, use the show logging command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show logging
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
Filtering options:
show begin: Begins the output of any show command from a specified string.
show exclude: Filters show command output so that it excludes lines that contain a particular regular expression.
show include: Filters show command output so that it displays only lines that contain a particular regular expression.
Examples
The following displays the output for the show logging command when errors and fatal messages are displayed on the console.
MODULE ENTITY ACTIVITY FILTER
The following displays the output for the show logging command when errors, fatal messages, and ccn engine messages are displayed on the console.
MODULE ENTITY ACTIVITY FILTER
The following example displays show logging output when an external syslog server is configured:
MODULE ENTITY ACTIVITY FILTER
No monitored events active
Log server address: 192.0.2.24
Related Commands
show logs
To display the existing log files on the current Cisco Unified Messaging Gateway (Cisco UMG) module, use the show logs command in Cisco UMG EXEC mode.
show logs
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
Filtering options:
show begin: Begins the output of any show command from a specified string.
show exclude: Filters show command output so that it excludes lines that contain a particular regular expression.
show include: Filters show command output so that it displays only lines that contain a particular regular expression.
Examples
The following example is a sample list of log files available on the system:
root_heapdump2749.1023408628.txt
Related Commands
show memory
To display memory information for the Cisco Unified Messaging Gateway (Cisco UMG) module, use the show memory command in Cisco UMG EXEC mode.
show memory
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.
|
Examples
The following example shows detailed information about the memory on the Cisco UMG network module:
Total Memory (kB): 245216
Active Memory (kB): 23728
Inactive Memory (kB): 196620
TOTAL INUSE MAXUSED ERR TYPE
Table 7 describes the significant fields shown in the display.
Table 7 show memory Field Descriptions
Field
|
Description
|
Total Memory (KB)
|
Total amount of memory available to the kernel.
Note Some of the physical memory may be reserved and therefore not included in this number.
|
Active Memory (KB)
|
Portion of process memory accessed recently by code somewhere in the system.
|
Inactive Memory (KB)
|
Portion of process memory that has not been accessed recently.
|
Other Memory (KB)
|
Memory allocated for nonprocess use.
|
MemoryPool (kB)
|
Memory not allocated for any use.
|
Kernel Memory
|
TOTAL
|
Amount of memory reserved for this type.
|
INUSE
|
Portion of the reserved memory that is currently being used.
|
MAXUSED
|
Peak INUSE value since the last reboot.
|
ERR
|
Number of times allocations for this use have failed.
|
TYPE
|
There are three types possible:
• fs—File system
• net—Network protocols
• other—All other types
|
Related Commands
Command
|
Description
|
show processes
|
Displays subsystem status and statistics for the Cisco UMG module.
|
show messaging-gateway
To display details for any or all messaging gateways - including the network peer messaging gateways and the current configuring messaging gateway - use the show messaging-gateway command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show messaging-gateway [ location-id ]
Syntax Description
location-id
|
This is a numeric string that functions as a system-wide unique identifier (range: 1-10 digits).
|
Command Default
None
Command Modes
Cisco UMG EXEC.
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
Use this command to display details for all the messaging gateways in the network or for a specified messaging gateway: its location ID, its hostname, and whether NAT is enabled or disabled.
Examples
The following is sample output for the show messaging-gateway command:
umg-1# show messaging-gateway 101
Related Commands
show nat location
To list out configured NAT entries, use the show nat location command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show nat location location-id
Syntax Description
location-id
|
A numeric string that functions as a system-wide unique identifier (range: 1-10 digits).
|
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 the show nat location command:
Enter configuration commands, one per line. End with CNTL/Z.
umg-1(config)# nat location 777777
umg-1(config-nat)# http external 192.0.2.24
umg-1# show nat location 777777
----------------------------------------
Related Commands
Command
|
Description
|
http external
|
Configures NAT entries for HTTP for endpoints and messaging gateways.
|
nat location
|
Enters NAT configuration mode to set up NAT entries for endpoints and messaging gateways.
|
show messaging-gateway
|
Displays details for any or all messaging gateways in the system.
|
vpim external
|
Configures NAT entries for VPIM for endpoints and messaging gateways.
|
show ndr timeout
To display the timeout window whose elapse will result in a non-delivery receipt (NDR), use the show ndr timeout command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show ndr timeout
Syntax Description
This command has no arguments or keywords.
Command Default
None
Command Modes
Cisco UMG configuration EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
Use this command to display the NDR timeout. If the NDR is not set, the timeout shown is 6 hours.
Examples
The following example sets an NDR timeout, then displays it:
umg-1# config t
umg-1(config)# NDR timeout 12
umg-1# show NDR timeout
Timeout window for NDR is 12 hours
Related Commands
Command
|
Description
|
ddr timeout
|
Configures the amount of time that elapses before a delayed delivery receipt (DDR) is sent.
|
ndr timeout
|
Configures the amount of time that elapses before an NDR is sent.
|
show ddr timeout
|
Displays the amount of time that elapses before a delayed delivery receipt (DDR) is sent.
|
show network default-route
To display the default destination for messages that Cisco Unified Messaging Gateway (Cisco UMG) cannot deliver, use the show network default-route command in Cisco UMG EXEC mode.
show network default-route
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
Use this command to display the default destination (either an endpoint or a peer messaging gateway) where a message is sent if the system cannot deliver it.
Examples
The following example illustrates the use of the show network default-route command:
umg-1(config)# network default-route 777
umg-1# show network default-route
Default route is location 777.
Related Commands
Command
|
Description
|
network default-route
|
Configures the default destination for messages that the system cannot deliver.
|
show ntp
To display the time source for a Network Time Protocol (NTP) server, use the show ntp command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show ntp [ detail ]
Syntax Description
detail
|
(Optional) Displays detailed information about the NTP servers.
|
Command Default
None
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
This command displays the chain of NTP servers back to their primary time source, starting from the local host.
Examples
The following is sample output for the show ntp command:
192.0.2.24: stratum 9, offset 0.000015, synch distance 0.03047
192.0.2.23: stratum 8, offset -0.001124, synch distance 0.00003
Table 8 describes the significant fields shown in the display.
Table 8 show ntp Field Descriptions
Field
|
Description
|
(first field)
|
IP address of the host.
|
stratum
|
Server hop count to the primary clock source. Valid values are:
• 0—Unspecified
• 1—Primary clock reference
• 2-255—Secondary reference via NTP
|
offset
|
Time offset between the host and the local host, in seconds.
|
synch distance
|
Host synchronization distance, which is the estimated error relative to the primary source.
|
The following is sample output for the show ntp detail command:
server 192.0.2.24, port 123
stratum 9, precision -17, leap 00
refid [192.0.2.22] delay 0.00012, dispersion 0.00000 offset 0.000011
rootdelay 0.00058, rootdispersion 0.03111, synch dist 0.03140
reference time: af4a3ff7.926698bb Thu, Mar 11 1993 14:47:19.571
originate timestamp: af4a4041.bf991bc5 Thu, Mar 11 1993 14:48:33.748
transmit timestamp: af4a4041.bf90a782 Thu, Mar 11 1993 14:48:33.748
server 192.0.2.23, port 123
stratum 8, precision -18, leap 00
refid [192.0.2.21] delay 0.00024, dispersion 0.00000 offset -0.001130
rootdelay 0.00000, rootdispersion 0.00003, synch dist 0.00003
reference time: af4a402e.f46eaea6 Thu, Mar 11 1993 14:48:14.954
originate timestamp: af4a4041.bf6fb4d4 Thu, Mar 11 1993 14:48:33.747
transmit timestamp: af4a4041.bfb0d51f Thu, Mar 11 1993 14:48:33.748
Table 9 describes the significant fields shown in the display.
Table 9 show ntp detail Field Descriptions
Field
|
Description
|
server
|
IP address of the host server.
|
port
|
Port number of the host server.
|
stratum
|
Server hop count to the primary clock source. Valid values are:
• 0—Unspecified
• 1—Primary clock reference
• 2-255—Secondary reference via NTP
|
precision
|
Precision of the clock, in seconds to the power of two.
|
leap
|
Two-bit code warning of an impending leap second to be inserted in the NTP time scale. Valid values are:
• 00—No warning
• 01—Last minute was 61 seconds
• 10—Last minute was 59 seconds
• 11—Alarm condition (clock not synchronized)
|
refid
|
IP address of the peer selected for synchronization.
|
delay
|
Round-trip delay of the packet, in milliseconds.
|
dispersion
|
Measure, in milliseconds, of how scattered the time offsets have been from a given time server.
|
offset
|
Time offset between the host and the local host, in seconds.
|
rootdelay
|
Total round-trip delay, in seconds, to the primary reference source at the root of the synchronization subnet.
|
rootdispersion
|
Maximum error, in seconds, relative to the primary reference source at the root of the synchronization subnet.
|
synch dist
|
Host synchronization distance, which is the estimated error relative to the primary source.
|
reference time
|
Local time, in time-stamp format, when the local clock was last updated. If the local clock has never been synchronized, the value is zero.
|
originate timestamp
|
Local time, in time-stamp format, at the peer when its latest NTP message was sent. If the peer becomes unreachable, the value is zero.
|
transmit timestamp
|
Local time, in time-stamp format, when the latest NTP message from the peer arrived. If the peer becomes unreachable, the value is zero.
|
Related Commands
Command
|
Description
|
ntp server
|
Configures the Network Time Protocol (NTP) server to keep the system time synchronized with the NTP server.
|
show clock
|
Displays clock statistics.
|
show processes
To display subsystem status and statistics for the Cisco Unified Messaging Gateway (Cisco UMG) module, use the show process command in Cisco UMG EXEC mode.
show processes [cpu | memory]
Syntax Description
cpu
|
(Optional) Displays CPU time.
|
memory
|
(Optional) Displays process memory usage.
|
Command Default
None
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
The output of this command is most useful to technical support personnel diagnosing problems.
Examples
The following is sample output from the show processes command:
online alive platform_config
online alive backuprestore
The following is sample output for the show processes cpu command:
umg-1# show processes cpu
Kernel time (secs): 38.14
Idle time (secs): 950911.8
The following is sample output for the show processes memory command:
umg-1# show processes memory
VSZ RSS SHR PVT RD RW EXE DAT STK %PVT CMD
12176 1256 988 268 0 220 780 244 12 0.1 syslog-ng
20028 1148 928 220 0 296 772 36 44 0.1 platform_config
11840 964 756 208 0 220 684 36 24 0.1 rbcp
14076 956 748 208 0 208 688 44 16 0.1 trace
2080 1084 980 104 0 56 896 116 16 0.0 monitor
20320 1264 1000 264 0 304 852 76 32 0.1 ntp
11808 1008 824 184 0 284 676 36 12 0.1 probe
21256 2096 888 1208 0 352 684 1032 28 0.5 downloader
19292 3676 2476 1200 0 932 1772 912 60 0.5 ldap
17040 0 0 0 0 0 0 0 0 0.0 sql
58992 39248 2056 37192 0 664 2988 34864 732 15.2 superthread
58560 38616 2900 35716 0 580 4020 33524 492 14.6 http
81824 45188 2820 42368 0 516 4016 39336 1320 17.3 ccn
58992 39248 2056 37192 0 664 2988 34864 732 15.2 smtp
35912 22128 1896 20232 0 556 2920 18444 208 8.3 cli
Table 10 describes the fields shown in the show processes command output.
Table 10 show process Field Descriptions
Field
|
Description
|
State
|
There are two possible states:
• online—The subsystem is ready to handle requests.
• ready-to-go-online—The subsystem is ready, but the main processing system has not brought the subsystem online.
|
Health
|
There are two possible health conditions:
• alive—The primary thread of the process exists.
• dead—The primary thread of the process does not exist. Usually, a dead primary thread will cause the subsystem to restart.
|
CMD
|
The name of the subsystem.
|
Table 11 describes the fields shown in the show processes cpu command output.
Table 11 show process cpu Field Descriptions
Field
|
Description
|
Uptime (secs)
|
The number of seconds since the last reboot.
|
User time (secs)
|
The number of seconds since the last reboot that the system has spent executing nonprivileged code.
|
Kernel time (secs)
|
The number of seconds since the last reboot that the system has spent executing privileged code.
|
Idle time (secs)
|
The number of seconds since the last reboot that the system spent idle.
|
Table 12 describes the fields shown in the show process memory command output.
Table 12 show process memory Field Descriptions
Field
|
Description
|
VSZ
|
The size of the process address space, in kilobytes.
|
RSS
|
The amount of physical memory, in kilobytes, in use by the process.
|
SHR
|
The portion of RSS, in kilobytes, that is shared with other processes.
|
PVT
|
The portion of RSS, in kilobytes, that is private to this process.
|
RD
|
Size of file-mapped, read-only data memory, in kilobytes.
|
RW
|
Size of file-mapped, read-write data memory, in kilobytes.
|
EXE
|
Size of file-mapped, read-only executable memory, in kilobytes.
|
DAT
|
Size of non-stack, non-file mapped, read-write memory, in kilobytes.
|
STK
|
Size of native thread stacks. Non-file-mapped, read-write memory.
|
%PVT
|
The percentage of RSS that is private to this process.
|
CMD
|
The name of the subsystem.
|
Related Commands
Command
|
Description
|
show memory
|
Displays memory information.
|
show registration
To display the registration configurations and endpoint registration status on the current configuring messaging gateway, use the show registration command in Cisco Unified Messaging Gateway (Cisco UMG EXEC mode.
show registration { block | status | users}
Syntax Description
block
|
Endpoints that are blocked; that is, prevented from registering.
|
status
|
Status of registered endpoints: autoregistered, offline, unreachable, deregistered.
|
users
|
Endpoint's registration credentials: username and password.
|
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 the show registration command:
umg-1# show registration users
umg-1# show registration block
umg registration block list :
umg-1# show registration status
Endpoint registration stats :
Auto-registered endpoint :
Loc. 23 : cue, registered at
Tue Aug 21 17:09:08 PDT 2007
Offline auto-registered endpoint :
Loc. 34 : cue, unreachable
Loc. 35 : cue, deregistered
Table 13 show registration Field Descriptions
Field
|
Description
|
username
|
Endpoint registration credential.
|
location-id
|
Location ID for endpoints that are blocked.
|
autoregistered
|
Description of autoregistered endpoints. Subfields: Location ID, type (Cisco Unity Express 3.1 and later versions), time and date of registration.
|
Offline
|
Description of endpoints that are offline. Subfields: Location ID, type, comment (for example, "unreachable").
|
Related Commands
Command
|
Description
|
block location-id
|
Specifies a Cisco Unity Express 3.1 and later versions endpoint that will be prevented from registering with Cisco UMG.
|
expiration
|
Specifies the registration lifetime of autoregistered <Abbreviation>Cisco Unity Express endpoints.
|
registration
|
Enters registration configuration mode in order to configure autoregistration parameters for Cisco Unity Express 3.1 and later versions.
|
show endpoint
|
Displays a list of endpoints and their details or a specific endpoint's details.
|
username
|
Specifies the registration credentials for autoregistering Cisco Unity Express 3.1 and later versions.
|
show running-config
To display the current running configuration for Cisco Unified Messaging Gateway (Cisco UMG), use the show running-config command in Cisco UMG EXEC mode.
show running-config [ paged ]
Syntax Description
paged
|
(Optional) Displays enough output to fill the current viewing screen.
|
Command Default
None
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
This command displays the running configuration for Cisco UMG stored in flash memory.
Use the paged keyword to display the output in screen-length pages.
Examples
The following is sample output for the show running-config command:
umg-1# show running-config
Generating configuration:
clock timezone America/Los_Angeles
ip domain-name mycompany.com
system language preferred "en_US"
ntp server 192.0.2.24 prefer
software download server url "ftp://192.0.2.23/ftp" credentials hidden "6u/dKTN/h
sEuSAEfw40XlF2eFHnZfyUTSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfG
WTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmP"
groupname Administrators create
groupname Broadcasters create
groupname Administrators privilege superuser
groupname Administrators privilege ManagePrompts
groupname Administrators privilege broadcast
groupname Administrators privilege local-broadcast
groupname Administrators privilege ManagePublicList
groupname Administrators privilege ViewPrivateList
groupname Administrators privilege vm-imap
groupname Administrators privilege ViewHistoricalReports
groupname Administrators privilege ViewRealTimeReports
groupname Broadcasters privilege broadcast
backup server url "ftp://192.0.2.22/umg_backup" credentials hidden "+EdqgXXrwvT
q9Gr22KTpoknfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWT
YHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmP"
log server address 192.0.2.21
security password lockout policy temp-lock
security pin lockout policy temp-lock
network local messaging-gateway 51000
username umg password encrypted "R30jwZyreaDX3TqGSvsp5EnfGWTYHfmPSd8ZZNgd+Y9J3x
lk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHf
Related Commands
show software
To display the characteristics of the installed software, use the show software command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show software {directory | download server | packages | versions}
Syntax Description
directory
|
Displays the software directory.
|
download server
|
Displays the IP address of the FTP server.
|
packages
|
Displays the configured Cisco UMG application packages.
|
versions
|
Displays the current versions of the configured software and applications.
|
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Examples
The following is sample output for the show software command:
umg-1# show software download server
Download server URL is: ftp://192.0.2.24/ftp
umg-1# show software packages
- Installer (Installer application)
- UMG (Unified Messaging Gateway)
- Bootloader (Primary) (Service Engine Bootloader)
- Infrastructure (Service Engine Infrastructure)
- Global (Global manifest)
- Bootloader (Secondary) (Service Engine Bootloader)
- Core (Service Engine OS Core)
- GPL Infrastructure (Service Engine GPL Infrastructure)
umg-1# show software versions
Software Version dthf_apr6
- Bootloader (Primary) 2.1.8.0
- Bootloader (Secondary) 2.1.10.0
- GPL Infrastructure 2.2.1.0
Related Commands
Command
|
Description
|
backup category
|
Specifies the type of data to be backed up and initiates the backup process.
|
copy ftp
|
Copies a new configuration from an FTP server to another Cisco UMG location.
|
copy running-config
|
Copies the running configuration to another destination.
|
copy startup-config
|
Copies the startup configuration to another destination.
|
copy tftp
|
Copies the network TFTP server information to another destination.
|
restore factory default
|
Restores the system to the factory defaults.
|
show startup-config
|
Displays the current startup configuration.
|
shutdown
|
Displays the software version.
|
show software directory
To display directory information for software download and downgrade files, use the show software directory command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show software directory {download | downgrade}
Syntax Description
download
|
Displays download directory information.
|
downgrade
|
Displays downgrade directory information.
|
Command Default
None
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
Cisco UMG 1.0.1 does not support downgrade files.
Examples
The following is sample output for the show software directory download command:
umg-1# show software directory download
Directory: /dwnld/pkgdata
drwxrwxr-x 2 root daemon 48 Apr 6 16:40 .
drwxrwxr-x 4 root daemon 200 Apr 6 16:40 ..
Related Commands
show spoken-name
To display spoken-name support on the local Cisco Unified Messaging Gateway (Cisco UMG), use the show spoken-name command in Cisco UMG EXEC mode.
show spoken-name
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
If spoken name support is disabled on Cisco UMG, the spoken names received from <Abbreviation>Cisco Unity Express and/or Cisco Unity will not be stored in the database.
If the network link is slow, we recommend that you disable spoken name support.
We strongly recommend that you set all messaging gateways consistently for spoken-name support, either all enabled or all disabled.
Examples
The following is an example of the show spoken-name command:
Related Commands
Command
|
Description
|
spoken-name
|
Enables spoken-name support on Cisco UMG
|
show startup-config
To display the current startup configuration, use the show startup-config command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show startup-config [paged]
Syntax Description
paged
|
(Optional) Displays enough output to fill the current viewing screen.
|
Command Default
None
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
Use this command to display the startup configuration stored on the hard disk.
Examples
The following is sample output for the show startup-config command:
umg-1# show startup-config
clock timezone America/Los_Angeles
software download server url "ftp://192.0.2.24/ftp" credentials hidden "6u/dKTN/h
sEuSAEfw40XlF2eFHnZfyUTSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfG
WTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmP"
groupname Administrators create
groupname Broadcasters create
groupname Administrators member root
groupname Administrators privilege superuser
groupname Broadcasters privilege broadcast
groupname Administrators privilege ManagePrompts
groupname Administrators privilege broadcast
groupname Administrators privilege local-broadcast
groupname Administrators privilege ManagePublicList
groupname Administrators privilege ViewPrivateList
groupname Administrators privilege vm-imap
groupname Administrators privilege ViewHistoricalReports
groupname Administrators privilege ViewRealTimeReports
backup server url "ftp://192.0.2.23/ftp" credentials hidden "EWlTygcMhYmjazXhE/VN
XHCkplVV4KjescbDaLa4fl4WLSPFvv1rWUnfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmPSd8Z
ZNgd+Y9J3xlk2B35j0nfGWTYHfmP"
translation-rules message cue src_host src_host
translation-rules smtp cue src_host src_host
network local gateway id 50000
endpoint id 33 type unity
security password lockout policy temp-lock
security pin lockout policy temp-lock
Related Commands
show statistics
To display a statistics report, use the show statistics command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show statistics
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.
|
Examples
The following example shows a partial output from the show statistics command:
SMTP Receive Failure: 0
SMTP Sent Failure: 0
SMTP Rejected: 0
NDR Message Generated: 0
DDR Message Generated: 0
Number of Lookup Request: 0
SDL Message Received: 0
SDL Message Sent: 0
SBM Message Received: 11
DirEx Message Received: 6
DirEx Message Send: 25
VPIM Message Received: 12
VPIM Message Sent: 12
Total SMTP Message Received: 18
Total SMTP Message Sent: 37
Related Commands
Command
|
Description
|
ddr timeout
|
Configures a timeout window whose elapse will result in a delayed delivery receipt (DDR).
|
directory exchange endpoint request
|
Manually forces data convergence between autoregistered endpoints and messaging gateways.
|
directory exchange messaging-gateway request
|
Manually forces data convergence between the current messaging gateway and its peers by requesting either full directory exchange or directory updates.
|
directory exchange messaging-gateway send
|
Manually forces data convergence between the current messaging gateway and its peers, by sending either full directory exchange or directory updates.
|
ndr timeout
|
Configures a timeout window whose elapse will result in a non- delivery receipt (NDR).
|
show ddr timeout
|
Displays the timeout window whose elapse will result in a delayed delivery receipt (DDR).
|
show list
|
Displays a list of the system distribution lists (SDLs) that are configured.
|
show list privilege
|
Displays the authorized senders for SDLs.
|
show ndr timeout
|
Displays the timeout window whose elapse will result in a non-delivery receipt (NDR).
|
show translation-rule
|
Displays translation rules for the SMTP header for each supported endpoint.
|
translation-rule
|
Configures translation rules for both message header and SMTP header for each supported endpoint.
|
vpim external
|
Configures NAT entries for peer messaging gateways or endpoints.
|
show trace buffer
To display a list of events in memory, use the show trace buffer command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show trace buffer [containing string [long | short] | long [paged] | short [paged] | tail [number
[long | short]]]
Syntax Description
containing string
|
(Optional) Displays only events that match a search expression.
|
long
|
(Optional) Displays expanded text for many error and return codes.
|
short
|
(Optional) Displays hexadecimal codes.
|
paged
|
(Optional) Displays the output a page at a time.
|
tail
|
(Optional) Display the latest events as they occur.
|
number
|
(Optional) Displays the most recent number of events.
|
Command Default
None
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
This command displays a list of the trace events being captured in the memory buffer. Use this command to monitor trace events set for debugging. You can stop the output by pressing CTRL-C.
Filtering options:
show begin: Begins the output of any show command from a specified string.
show exclude: Filters a show command output so that it excludes lines that contain a particular regular expression.
show include: Filters a show command output so that it displays only lines that contain a particular regular expression.
Examples
The following example shows partial output from the show trace buffer command:
Press <CTRL-C> to exit...
238 09/19 23:23:11.041 TRAC TIMZ 0 UTC UTC 0
238 09/19 23:23:11.043 TRAC TIMZ 0 UTC UTC 0
800 09/19 23:28:04.152 WFSP MISC 0 WFSysdbLimits::WFSysdbLimits hwModuleType=NM
800 09/19 23:28:04.171 WFSP MISC 0 WFSysdbProp::getProp
800 09/19 23:28:04.171 WFSP MISC 0 keyName = limitsDir
str = /sw/apps/wf/ccnapps/limits
800 09/19 23:28:04.197 WFSP MISC 0 WFSysdbProp::getNodeXml
800 09/19 23:28:04.197 WFSP MISC 0 WFSysdbProp::getProp
800 09/19 23:28:04.198 WFSP MISC 0 keyName = limits
str = <?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?> <attrList> <a
ttrDecl purpose="CONFIG" type="INT32" maxsize="4"> <node>limits</node> <attr>max
_scripts</attr> <desc>maximum number of scripts</desc> <value>0</value> </attrDe
cl> <attrDecl purpose="CONFIG" type="INT32" maxsize="4"> <node>limits</node> <at
tr>max_prompts</attr> <desc>maximum number of prompts</desc> <value>0</value> </
800 09/19 23:28:04.199 WFSP MISC 0 WFSysdbProp::getNodeXml(str, str)
800 09/19 23:28:04.200 WFSP MISC 0 WFSysdbProp::getProp
800 09/19 23:28:04.200 WFSP MISC 0 keyName = app
Related Commands
show trace store
To display a list of events from the atrace.log file, use the show trace store command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show trace store [containing string [long | short] | long [paged] | short [paged] | tail [number
[long | short]]]
Syntax Description
containing string
|
(Optional) Displays only events that match a search expression.
|
long
|
(Optional) Displays expanded text for many error and return codes.
|
short
|
(Optional) Displays hexadecimal codes.
|
paged
|
(Optional) Displays the output a page at a time.
|
tail
|
(Optional) Display the latest events as they occur.
|
number
|
(Optional) Displays the most recent number of events.
|
Command Default
None
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
This command displays a list of the trace events saved in the atrace.log file. Use this command to monitor trace events set for debugging. The atrace.log file capacity is 10 MB on the AIM and 100 MB on the NM. When the atrace.log file reaches its limit, it is copied to the atrace.log.prev file and restarted. You can stop the output by pressing CTRL-C.
Filtering options:
show begin: Begins the output of any show command from a specified string.
show exclude: Filters a show command output so that it excludes lines that contain a particular regular expression.
show include: Filters a show command output so that it displays only lines that contain a particular regular expression.
Examples
The following example shows a partial output from the show trace store command:
Press <CTRL-C> to exit...
238 09/19 23:23:11.041 TRAC TIMZ 0 UTC UTC 0
238 09/19 23:23:11.043 TRAC TIMZ 0 UTC UTC 0
800 09/19 23:28:04.152 WFSP MISC 0 WFSysdbLimits::WFSysdbLimits hwModuleType=NM
800 09/19 23:28:04.171 WFSP MISC 0 WFSysdbProp::getProp
800 09/19 23:28:04.171 WFSP MISC 0 keyName = limitsDir
str = /sw/apps/wf/ccnapps/limits
800 09/19 23:28:04.197 WFSP MISC 0 WFSysdbProp::getNodeXml
800 09/19 23:28:04.197 WFSP MISC 0 WFSysdbProp::getProp
800 09/19 23:28:04.198 WFSP MISC 0 keyName = limits
str = <?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?> <attrList> <a
ttrDecl purpose="CONFIG" type="INT32" maxsize="4"> <node>limits</node> <attr>max
_scripts</attr> <desc>maximum number of scripts</desc> <value>0</value> </attrDe
cl> <attrDecl purpose="CONFIG" type="INT32" maxsize="4"> <node>limits</node> <at
tr>max_prompts</attr> <desc>maximum number of prompts</desc> <value>0</value> </
800 09/19 23:28:04.199 WFSP MISC 0 WFSysdbProp::getNodeXml(str, str)
800 09/19 23:28:04.200 WFSP MISC 0 WFSysdbProp::getProp
800 09/19 23:28:04.200 WFSP MISC 0 keyName = app
Related Commands
show trace store-prev
To display a list of events from the atrace.log.prev file, use the show trace store-prev command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show trace store-prev [containing string [long | short] | long [paged] | short [paged] | tail
[number [long | short]]]
Syntax Description
containing string
|
(Optional) Display only events that match a search expression.
|
long
|
(Optional) Displays expanded text for many error and return codes.
|
short
|
(Optional) Displays hexadecimal codes.
|
paged
|
(Optional) Displays the output a page at a time.
|
tail
|
(Optional) Display the latest events as they occur.
|
number
|
(Optional) Displays the most recent number of events.
|
Command Default
None
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
This command displays a list of the trace events being captured in the atrace.log.prev file. Use this command to monitor trace events set for debugging. The atrace.log file capacity is 10 MB on the AIM and 100 MB on the NM. When the atrace.log file reaches its limit, it is copied to the atrace.log.prev file and restarted. You may stop the output by pressing CTRL-C.
Filtering options:
show begin: Begins the output of any show command from a specified string.
show exclude: Filters a show command output so that it excludes lines that contain a particular regular expression.
show include: Filters a show command output so that it displays only lines that contain a particular regular expression.
Examples
The following example shows a partial output from the show trace store-prev command:
umg-1# show trace store-prev
Press <CTRL-C> to exit...
238 09/19 23:23:11.041 TRAC TIMZ 0 UTC UTC 0
238 09/19 23:23:11.043 TRAC TIMZ 0 UTC UTC 0
800 09/19 23:28:04.152 WFSP MISC 0 WFSysdbLimits::WFSysdbLimits hwModuleType=NM
800 09/19 23:28:04.171 WFSP MISC 0 WFSysdbProp::getProp
800 09/19 23:28:04.171 WFSP MISC 0 keyName = limitsDir
str = /sw/apps/wf/ccnapps/limits
800 09/19 23:28:04.197 WFSP MISC 0 WFSysdbProp::getNodeXml
800 09/19 23:28:04.197 WFSP MISC 0 WFSysdbProp::getProp
800 09/19 23:28:04.198 WFSP MISC 0 keyName = limits
str = <?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?> <attrList> <a
ttrDecl purpose="CONFIG" type="INT32" maxsize="4"> <node>limits</node> <attr>max
_scripts</attr> <desc>maximum number of scripts</desc> <value>0</value> </attrDe
cl> <attrDecl purpose="CONFIG" type="INT32" maxsize="4"> <node>limits</node> <at
tr>max_prompts</attr> <desc>maximum number of prompts</desc> <value>0</value> </
800 09/19 23:28:04.199 WFSP MISC 0 WFSysdbProp::getNodeXml(str, str)
800 09/19 23:28:04.200 WFSP MISC 0 WFSysdbProp::getProp
800 09/19 23:28:04.200 WFSP MISC 0 keyName = app
Related Commands
Command
|
Description
|
show log name
|
Displays the content of the specified log.
|
show logging
|
Displays the types of messages that are shown on the console.
|
show logs
|
Displays a list of the log files.
|
show trace store
|
Displays a list of events from the atrace.log.prev file.
|
show translation-rule
To display the translation rule for the message or SMTP header for each supported endpoint type, use the show translation-rule command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
show translation-rule { smtp | message }
Syntax Description
message
|
Display message header translation rules.
|
smtp
|
Display SMTP header translation rules.
|
Command Default
None
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
<Abbreviation>Cisco Unity Express utilizes the `SMTP Envelope To': data to route voice messages for delivery. Cisco Unity uses the `Message Header To:' line, and Avaya Interchange uses the `SMTP Envelop From:' and the `Message Envelope From:'.
Do not manipulate the translation rules unless Cisco Tech Support instructs you to do so.
Examples
The following example illustrates the use of the show translation-rule command.
umg-1# show translation-rule message
Message Translation Rules -
umg-1# show translation-rule smtp
Table 14 lists the significant fields shown in the display.
Table 14 show translation-rule Field Descriptions
Field
|
Description
|
message
|
Message header translation rules.
|
smtp
|
SMTP header translation rules.
|
cue
|
Message or SMTP header translation rules for <Abbreviation>Cisco Unity Express.
|
interchange
|
Message or SMTP header translation rules for Avaya Interchange.
|
umg
|
Message or SMTP header translation rules for Cisco UMG.
|
unity
|
Message or SMTP header translation rules for Cisco Unity.
|
from-host
|
Src-host translation rules for an endpoint.
|
from-host text
|
Set source e-mail domain value.
|
from-host umg-host
|
Variable name used for src-host translation.
|
from-user
|
Src-user translation rules for an endpoint.
|
from-user umg-user
|
Variable name used for src-user translation.
|
to-host
|
Dest-host translation rules for an endpoint.
|
to-host text
|
Set destination e-mail domain value.
|
to-host umg-host
|
Variable name used for dest-host translation.
|
to-user
|
Dest-user translation rules for an endpoint.
|
to-user umg-user
|
Variable name used for dest-user translation.
|
Related Commands
Command
|
Description
|
translation-rule
|
Configures the translation rule for the message or SMTP header for each supported endpoint.
|
shutdown
To shut down the current configuring messaging gateway, use the shutdown command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
shutdown
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
All registered endpoints will be marked "off-line".
Caution 
Always shut down the module before power-cycling the router to prevent file corruption and data loss.
Caution 
The shutdown is immediate. The software does not ask for confirmation.
Examples
The following example illustrates the use of the shutdown command in Cisco UMG:
Related Commands
Command
|
Description
|
offline
|
Takes Cisco UMG offline.
|
reload
|
Starts Cisco UMG.
|
software download abort
To abort a download that is in progress, use the software download abort command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
software download abort
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.
|
Examples
The following is an example of aborting an existing download:
umg-1# software download abort
Download request aborted.
Related Commands
software download clean
To download software packages for installing later, use the software download clean command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
software download clean {package-file-name | url ftp://ftp-server-ip-address/package-file-name}
Syntax Description
package-file-name
|
Name of the package file for the new software.
|
url ftp://ftp-server-ip-address
|
URL of the FTP server.
|
Command Default
None
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Examples
The following is an example of downloading a software package to install later where the FTP server information has been set in the Cisco UMG configuration.
umg-1# software download clean umg.nme.1.0.1.pkg
The following is an example of downloading a software package to install later where the FTP server information is included on the command line.
umg-1# software download clean url ftp://192.0.2.24/umg.nme.1.0.1.pkg
WARNING:: This command will download the necessary software to
WARNING:: complete a clean install. It is recommended that a backup be done
WARNING:: before installing software.
Would you like to continue? [n] y
Downloading umg.nme.1.0.1.pkg
Validating package signature ... done
Validating package signature ... done
The following is an example of using the software download status command to check on the download progress.
umg-1# software download status
Download request in progress.
downloading file : umg.nme.1.0.1.pkg
bytes downloaded : 5536224
Related Commands
software download server
To configure the FTP server address on the Cisco Unified Messaging Gateway (Cisco UMG) module, use the software download server command in Cisco UMG configuration mode.
software download server url ftp://server-ip-address[/dir] [username username
password password | credentials hidden credentials]
Syntax Description
url ftp://server-ip-address
|
IP address of the FTP server.
|
/dir
|
(Optional) The FTP directory on the server.
|
username username
|
(Optional) Specifies the FTP username. If this option is not used, the default is "anonymous".
|
password password
|
(Optional) Specifies the FTP password.
|
credentials hidden credentials
|
(Optional) Specifies the encrypted username and password value.
|
Command Modes
Cisco UMG configuration (config)
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Examples
The following is an example of setting the server information with just a root directory.
umg-1(config)# software download server url ftp://192.0.2.24/
The following is an example of setting the server information with a directory different than the root directory.
umg-1(config)# software download server url ftp://192.0.2.24/ftp_dir
The following is an example of setting the server information with a username and password.
umg-1(config)# software download server url ftp://192.0.2.24/ftp_dir username ftpuser
password ftppassword
The following is an example of setting the server information with an encrypted credentials string.
umg-1(config)# software download server url ftp://192.0.2.24/ftp_dir credentials hidden
+EdgXXrwvTekoNCDGbGiEnfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nGWTYHfmPSd8ZZNgd+Y9J3xlk2B35jwAAAAA=
Related Commands
Command
|
Description
|
show software
|
Displays the FTP server information.
|
software download status
To display the progress of a software download, use the software download status command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
software download status
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.
|
Examples
The following is an example of displaying the status of a download in progress:
umg-1# software download status
Download request in progress.
downloading file : cue-vm.2.0.1.prt1
bytes downloaded : 5536224
umg-1# software download status
Download request completed successfully.
Related Commands
software download uninstall
To upgrade to a newer version of Cisco Unified Messaging Gateway (Cisco UMG) software, use the software install upgrade command in Cisco UMG EXEC mode.
software install upgrade {pkg umg-package.pkg |
url ftp://ftp-server-ip-address/umg-package.pkg}
Syntax Description
pkg umg-package.pkg
|
Specifies a package name.
|
url ftp://ftp-server-ip-address/umg-package.pkg
|
Specifies the FTP server information.
|
Command Default
None
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
Use this command to upgrade to a newer version of Cisco UMG software.
Cisco UMG 1.0.1 does not support upgrades or downgrades.
Examples
The following is an example of the command to upgrade to a newer version of Cisco UMG software.
umg-1# software install upgrade url ftp://192.0.2.24/umg.nme.1.0.1.pkg
The following is an example of the command to upgrade to a newer version of Cisco UMG software if the FTP server has been configured or the software files have been downloaded previously with the software download upgrade command:
umg-1# software install upgrade pkg umg.nme.1.0.1.pkg
Related Commands
software download upgrade
To download software for a later upgrade, use the software download upgrade command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
software download upgrade {package-filename |
url ftp://ftp-server-ip-address[/dir]/package-filename} [username username password
password]
Syntax Description
package-filename
|
Name of the package file for the new software.
|
url ftp://ftp-server-ip-address
|
URL of the FTP server.
|
/dir
|
(Optional) Directory other than the default.
|
username username
|
(Optional) Username for the FTP server.
|
password password
|
(Optional) Password for the FTP server.
|
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
Use this command to download files for a future upgrade.
Cisco UMG 1.0.1 does not support upgrades or downgrades.
Examples
The following is an example of downloading a software package to upgrade later where the FTP server information has been set in the Cisco UMG configuration.
umg-1# software download upgrade umg.nme.1.0.1.pkg
The following is an example of downloading a software package to upgrade later where the FTP server information is included on the command line. The username and password could also be included in this command.
umg-1# software download upgrade url ftp://192.0.2.24/umg.nme.1.0.1.pkg
WARNING:: This command will download the necessary software to
WARNING:: complete an upgrade. It is recommended that a backup be done
WARNING:: before installing software.
Would you like to continue? [n] y
url_fname :umg.nme.1.0.1.pkg
url_url :ftp://192.0.2.24/
Downloading umg.nme.1.0.1.pkg
Validating package signature ... done
Validating installed manifests ..........complete.
Note
When you download the software, there are no other prompts for user input. The software package is downloaded to the Cisco UMG network module.
The following is an example of using the software download status command to check on the download progress.
umg-1# software download status
Download request in progress.
downloading file : umg-full.nme.1.0.1.prt1
bytes downloaded : 5536224
umg-1# software download status
Download request completed successfully.
The following example shows how to verify the download success using the show software directory download command.
umg-1# show software directory download
Directory: /dwnld/pkgdata
drwxrwxr-x 2 root daemon 48 Sep 15 2007 .
drwxrwxr-x 4 root daemon 200 Sep 15 2007 ..
Related Commands
software install clean
To install a new version of Cisco Unified Messaging Gateway (Cisco UMG) software, use the software install clean command in Cisco UMG EXEC mode.
software install clean {package-filename | url ftp://ftp-server-ip-address/package-filename}
Syntax Description
package-filename
|
Name of the package file for the new software.
|
url ftp://ftp-server-ip-address/
|
URL of the FTP server.
|
Command Default
None
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
Use this command to download files for a new install.
Note
This command cleans the disk. All configuration and data are lost after this step. For future upgrades and installations, verify that a backup has been done. If not, abort and do a backup first.
Examples
The following is an example of the command to install a new version of Cisco UMG software where the FTP server information has been set in the Cisco UMG configuration.
umg-1# software install clean umg.nme.1.0.1.pkg
The following is an example of installing a new version of Cisco UMG software where the FTP server information is included on the command line.
umg-1# software install clean url ftp://192.0.2.24/umg.nme.1.0.1.pkg
WARNING:: This command will install the necessary software to
WARNING:: complete a clean install. It is recommended that a backup be done
WARNING:: before installing software.
Would you like to continue? [n] y
At this point the new software loads from the FTP server and the system will restart.
IMPORTANT:: Welcome to Cisco Systems Service Engine
IMPORTANT:: post installation configuration tool.
IMPORTANT:: This is a one time process which will guide
IMPORTANT:: you through initial setup of your Service Engine.
IMPORTANT:: Once run, this process will have configured
IMPORTANT:: the system for your location.
IMPORTANT:: If you do not wish to continue, the system will be halted
IMPORTANT:: so it can be safely removed from the router.
Do you wish to start configuration now (y,n)? y
IMPORTANT:: A Cisco Unified Messaging Gateway configuration has been found
IMPORTANT:: You can choose to restore this configuration into
IMPORTANT:: current image.
IMPORTANT:: A stored configuration contains some of the data
IMPORTANT:: previous installation, but not as much as a backup.
IMPORTANT:: If you are recovering from a disaster and do not have a
IMPORTANT:: backup, you can restore the saved configuration.
IMPORTANT:: If you are going to restore a backup from a previous
IMPORTANT:: installation, you should not restore the saved configuration
IMPORTANT:: If you choose not to restore the saved configuration,
IMPORTANT:: will be erased from flash.
Would you like to restore the saved configuration? (y,n)y
Related Commands
software install downgrade
To downgrade to a previously installed version of Cisco Unified Messaging Gateway (Cisco UMG) software, use the software install downgrade command in Cisco UMG EXEC mode.
software install downgrade
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
Use this command to downgrade to the previous version of Cisco UMG software. The package information was already saved on the Cisco UMG module from the previous upgrade. No FTP information is necessary.
Cisco UMG 1.0.1 does not support upgrades or downgrades.
Examples
The following is an example of the command to downgrade to the previous version of Cisco UMG software.
umg-1# software install downgrade
The following example shows how to verify the downgrade success using the show software directory downgrade command.
umg-1# show software directory downgrade
Directory: /dwnld/dwngrade
drwxrwxrwx 2 root daemon 48 Sep 15 2007 .
drwxrwxr-x 4 root daemon 200 Sep 15 2007 ..
Related Commands
software install upgrade
To upgrade to a newer version of Cisco Unified Messaging Gateway (Cisco UMG) software, use the software install upgrade command in Cisco UMG EXEC mode.
software install upgrade {pkg umg-package.pkg |
url ftp://ftp-server-ip-address/umg-package.pkg}
Syntax Description
pkg umg-package.pkg
|
Specifies a package name.
|
url ftp://ftp-server-ip-address/umg-package.pkg
|
Specifies the FTP server information.
|
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
Use this command to upgrade to a newer version of <Abbreviation>Cisco Unity Express software.
Cisco UMG 1.0.1 does not support upgrades or downgrades.
Examples
The following is an example of the command to upgrade to a newer version of Cisco UMG software.
umg-1# software install upgrade url ftp://192.0.2.24/umg.nme.1.0.1.pkg
The following is an example of the command to upgrade to a newer version of Cisco UMG software if the FTP server was configured or the software files were downloaded previously with the software download upgrade command:
umg-1# software install upgrade pkg umg.nme.1.0.1.pkg
Related Commands
software remove
To remove software installed during a download or upgrade, use the software remove command in Cisco Unified Messaging Gateway (Cisco UMG) EXEC mode.
software remove {all | downgradefiles | downloadfiles}
Syntax Description
all
|
Removes both the downgrade and the download files.
|
downgradefiles
|
Removes the downgrade files.
|
downloadfiles
|
Removes the download files.
|
Command Modes
Cisco UMG EXEC
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Examples
The following is an example the software remove command:
umg-1# software remove all
umg-1# software remove downgradefiles
umg-1# software remove downloadfiles
Related Commands
spoken-name
To enable spoken-name support on the gateway, use the spoken-name command in Cisco Unified Messaging Gateway (Cisco UMG) configuration mode.
spoken-name { enable | disable}
Syntax Description
enable
|
Enable spoken-name support.
|
disable
|
Disable spoken-name support.
|
Command Modes
Cisco UMG configuration
Command History
Cisco UMG Version
|
Modification
|
1.0
|
This command was introduced.
|
Usage Guidelines
If spoken name support is disabled on Cisco UMG, the spoken names received from <Abbreviation>Cisco Unity Express and Cisco Unity will not be stored in the database.
If the network link is slow, we recommend you disable spoken name in directory exchange.
We strongly recommend that you set all peer messaging gateways consistently for spoken-name support - either all enabled or all disabled.
Examples
The following illustrates the use of the spoken-name command:
umg-1(config)# spoken-name enable
Related Commands
Command
|
Description
|
show spoken-name
|
Displays whether spoken-name support is enabled or disabled on the local messaging gateway.
|