Cisco Unified Messaging Gateway Command Reference for 8.0 and Later Versions
S Commands (Common)

Table Of Contents

S

security ssh

security ssh knownhost

serial-number

show aaa accounting event

show aaa accounting service

show aaa policy

show backup

show backup history

show backup schedule detail job

show backup schedules

show backup server

show clock

show configuration

show crypto key

show hosts

show ip dns cache

show ip route

show kron schedules

show kron schedule detail job

show license agent

show license all

show license detail

show license evaluation

show license expiring

show license feature

show license file

show license in-use

show license permanent

show license statistics

show license status

show license status application

show license udi

show log name

show logging

show logs

show memory

show ntp

show processes

show restore history

show running-config

show security ssh known-hosts

show software

show software directory

show startup-config

show statistics

show trace buffer

show trace store

show trace store-prev

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

start-date (backup-schedule)

start-date (kron-schedule)

stop-date (backup-schedule)

stop-date (kron-schedule)


S


Last Updated: November 17, 2010

security ssh

security ssh knownhost

serial-number

show aaa accounting event

show aaa accounting service

show aaa policy

show backup

show backup history

show backup schedule detail job

show backup schedules

show backup server

show clock

show configuration

show crypto key

show hosts

show ip dns cache

show ip route

show kron schedules

show kron schedule detail job

show license agent

show license all

show license detail

show license evaluation

show license expiring

show license feature

show license file

show license in-use

show license permanent

show license statistics

show license status

show license status application

show license udi

show log name

show logging

show logs

show memory

show ntp

show processes

show restore history

show running-config

show security ssh known-hosts

show software

show software directory

show startup-config

show statistics

show trace buffer

show trace store

show trace store-prev

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

start-date (backup-schedule)

start-date (kron-schedule)

stop-date (backup-schedule)

stop-date (kron-schedule)

security ssh

To configure system-wide SSH length and expiry time, use the security ssh command in Cisco UMG configuration mode. To reset the PIN length and expiry time to system defaults, use the no or default form of this command.

security ssh {length min ssh-length | expiry days ssh-days}

no security ssh {length min | expiry}

default security ssh length min

Syntax Description

length min ssh-length

Minimum length of all subscribers' SSHs. Valid values range from 3 to 16.

expiry days ssh-days

Maximum number of days for which subscribers' PINs are valid. Valid values range from 3 to 365. If this value is not configured, SSHs will not expire.


Defaults

SSH length = 3
SSHs do not expire.

Command Modes

Cisco UMG configuration

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

To control security on your system, the SSH length and expiry times can be configured on a system-wide basis.

The administrator can configure the length to a value greater than or equal to 3 alphanumeric characters. This is a system-wide value, so all subscribers must have SSHs of at least that many characters.

The SSH length does not have to equal the password length.

The expiry time is the time, in days, for which the SSH is valid. When this time is reached, the subscriber must enter a new SSH.

If the expiry time is not configured, SSHs do not expire.

The SSH expiry time does not have to equal the password expiry time.

Additionally, the GUI Defaults > User menu option configures these settings.

Examples

The following example sets the SSH length to 5 characters and the SSH expiry time to 45 days.

umg-1# config t
umg-1(config)# security ssh length min 5
umg-1(config)# security ssh expiry days 45
umg-1(config)# end

The following example resets the SSH length to the system default:

umg-1# config t
umg-1(config)# default security ssh length min
umg-1(config)# end

The following example resets the SSH expiry time to the system default:

umg-1# config t
umg-1(config)# no security ssh expiry days
umg-1(config)# end

Related Commands

Command
Description

security password

Configures password length and expiry time for the local system.

show security detail

Displays the password and SSH settings.


security ssh knownhost

To configure the MD5 (Message-Digest algorithm 5) fingerprint and type of host key for the SSH (Secure Shell) server's host key, use the security ssh command in Cisco UMG configuration mode. Use the no form of this command to remove the MD5 fingerprint.

security ssh knownhost host {ssh-rsa | ssh-dsa} fingerprint-string

no security ssh knownhost host {ssh-rsa | ssh-dsa} fingerprint-string

Syntax Description

host

Hostname or IP address of the SSH server.

ssh-rsa

The RSA encryption algorithm was used to create this fingerprint for an SSH server's host key.

ssh-dsa

The DSA (Digital Signature Algorithm) was used to create this fingerprint for an SSH server's host key.

fingerprint-string

MD5 fingerprint string.


Command Default

No server authentication performed for the specified host.

Command Modes

Cisco UMG configuration

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

Use the security ssh command in Cisco UMG configuration mode to configure the MD5 fingerprint of the SSH server's host key. When the fingerprint is configured, the local SSH/SFTP client performs server authentication by comparing the configured fingerprint with the one returned from the SSH server.

The host argument can be either a hostname or a IP address.

If the fingerprint is not configured, no server authentication is performed. The fingerprint will not be saved in the startup configuration when you use the write command.

Examples

The following example specifies the MD5 fingerprint of a SSH-RSA server's host key:

umg-1# config t

umg-1(config)# security ssh knownhost server.cisco.com ssh-rsa a5:3a:12:6d:e9:48:a3:34:be:8f:ee:50:30:e5:e6:c3


Related Commands

Command
Description

backup server authenticate

Retrieves the fingerprint of the backup server's host key.

show security ssh known-hosts

Displays a list of configured SSH (Secure Shell) servers and their fingerprints.


serial-number

To configure a serial number for a Cisco Unity endpoint, use the serial-number command in 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

The default serial-number is no serial number or the empty string " ".

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 t
umg-1(config)# endpoint 12345 type unity
umg-1(config-unity)# serial-number 12345
umg-1(config-unity)# secondary gateway 10.100.50.2
umg-1(config-unity)# end
umg-1(config)#

Related Commands

Command
Description

endpoint

Enters endpoint configuration mode in order to provision endpoints manually.

domain

Sets the domain name for an endpoint.

prefix

Sets the phone number prefix for an endpoint.


show aaa accounting event

To show the AAA accounting events that are designated to be logged, use the show aaa accounting event command in Cisco UMG EXEC mode.

show aaa accounting event

Syntax Description

This command has no arguments or keywords.

Defaults

None.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

Table 3 describes the information displayed by this command:

Table 2 show aaa accounting event Field Descriptions 

Field
Description

Event

Type of AAA accounting event.

State

Whether logging is enabled for this type of accounting event.

Description

Description of this type of accounting event.


Examples

The following example shows the output for the show aaa accounting event command:

umg-1# show aaa accounting event
Event              State      Description
login              Enabled    Log accounting events for successful login
logout             Enabled    Log accounting events for user logout
login-fail         Enabled    Log accounting events for failed login attempts
config-commands    Enabled    Log accounting events for any changes to configuration
exec-commands      Enabled    Log accounting events for execution of commands
system-startup     Enabled    Log accounting events for system startup
system-shutdown    Enabled    Log accounting events for system shutdown
imap               Disabled   Log accounting events for all imap events

Related Commands

Command
Description

aaa accounting event

Enters AAA accounting submode and configures event filtering for accounting packets.


show aaa accounting service

To show the login information configured for the AAA accounting server, use the show aaa accounting service command in Cisco UMG EXEC mode.

show aaa accounting service

Syntax Description

This command has no arguments or keywords.

Defaults

None.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

Examples

The following example shows the output for the show aaa accounting service command:

umg-1# show aaa accounting service
Accounting: Enabled
Address: 192.168.12.22 Port: 1813 Credentials: 
woYLtSq19jEOBNL8wg+WB0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGW
TYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmP
Address: 192.168.12.57 Port: 1813 Credentials: 
woYLtSq19jEOBNL8wg+WB0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGW
TYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmP
Timeout: 5 (sec)
Retries: 3

Table 3 describes the information displayed by this command:

Table 3 show aaa accounting service Field Descriptions 

Field
Description

Accounting

Whether AAA accounting logging is enabled.

Address

IP address or DNS hostname of the AAA accounting server.

Port

Port number of the AAA accounting server.

Credentials

Credentials required to access the AAA accounting server.

Timeout

Amount of time before an AAA authentication request is considered to be unanswered.

Retries

Maximum number of times an AAA authentication request is retried before the authentication fails.


Related Commands

Command
Description

aaa accounting server remote

Enters aaa-accounting submode and configures the AAA accounting server.


show aaa policy

To show the AAA policy settings, use the show aaa policy command in Cisco UMG EXEC mode.

show aaa policy

Syntax Description

This command has no arguments or keywords.

Defaults

None.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

Examples

The following example shows the output for the show aaa policy command:

umg-1# show aaa policy
AAA policy:system
 authentication-order local
 merge-attributes enable
 preferred-server remote
AAA server: remote
 retries 3
 timeout 5

Table 4 describes the information displayed by this command:

Table 4 show aaa accounting policy Field Descriptions 

Field
Description

authentication-order

The order in which to query the remote RADIUS authentication server and the local authentication database.

merge-attributes

Whether the user attributes that are retrieved from an AAA server will be merged with attributes for the same username found in the local user database.

preferred-server

Whether the preferred authentication server is local or remote.

AAA server

Whether the AAA authentication server is local or remote.

retries

Maximum number of times an AAA authentication request is retried before the authentication fails.

timeout

Amount of time before an AAA authentication request is considered to be unanswered.


Related Commands

Command
Description

show aaa accounting event

Enters aaa-policy submode and configures the system AAA policy.


show backup

To display backup utility configurations, use the show backup command in Cisco UMG EXEC mode.

show backup

Syntax Description

This command has no arguments or keywords.

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:

umg-1# show backup

Server URL:                             ftp://192.0.2.24/ftp
User Account on Server:
Number of Backups to Retain:            5

Table 5 describes the significant fields shown in the display.

Table 5 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

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 UMG EXEC mode.

show backup history

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.

8.0

This command was modified to show information about past backups only. Beginning with this release, past restores are shown using the show restore history command. In addition, new fields for showing the Schedule type and backup Version were added.


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.


Note If the backup/restore fails because the FTP server is not reachable, the failure is not logged in the backup/restore history.


Examples

The following is sample output from the show backup history command:

umg# show backup history

aaa# show backup history
#Start Operation 
Category: Configuration 
Backup Server: ftp://192.1.1.31/backups 
Operation: Backup 
Backupid: 7 
Date: Wed Feb 17 23:19:48 EST 2010 
Result: Success 
Reason: 
Version: 8.0.0.1
#End Operation 

#Start Operation 
Category: Data 
Backup Server: ftp://192.1.1.31/backups 
Operation: Backup 
Backupid: 7 
Date: Wed Feb 17 23:19:48 EST 2010 
Result: Success 
Reason: 
Version: 8.0.0.1 
#End Operation 

#Start Operation 
Category: HistoricalData 
Backup Server: ftp://192.1.1.31/backups 
Operation: Backup 
Backupid: 7 
Date: Wed Feb 17 23:19:49 EST 2010 
Result: Success 
Reason: 
Version: 8.0.0.1 
#End Operation 

#Start Operation
Category: Configuration 
Backup Server: ftp://192.1.1.31/backups 
Operation: Backup 
Backupid: 8 
Date: Fri Feb 19 14:36:33 EST 2010 
Result: Success 
Reason: 
Version: 8.0.0.1 
#End Operation 

Table 6 describes the significant fields shown in the display.

Table 6 show backup history Field Descriptions 

Field
Description

Category

Specifies the type of file (data, configuration, or all) that was backed up.

Backup Server

Backup server location.

Operation

Type of operation performed.

Backupid

ID number of the backup 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.

Version

Specifies the scheduled backup version.


Related Commands

Command
Description

backup category

Specifies the type of data to back up and initiates the backup process.

backup

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 restore history

Displays the success or failure of restore procedures.


show backup schedule detail job

To display the details of the specified recurring scheduled backup job, use the show backup schedule detail job command in Cisco UMG EXEC mode.

show backup schedule detail job job-name

Syntax Description

job-name

Specifies the name of the scheduled backup job to display.


Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Examples

The following example displays information for the specified recurring scheduled backup job:

umg-1# show backup schedule detail job job-8

Name          job-8
Description   main backup
Categories    Data 
Schedule      Daily at 06:00
Last Run      Jan 1, 2009 at 6:00
Last Result   Success
Next Run      Jan 2, 2009 at 6:00
Active        from Jan 01, 2000 until Dec 31, 2009

Table 7 describes the significant fields shown in the display.

Table 7 show backup schedule detail job Field Descriptions 

Field
Description

Name

Name of the scheduled backup job.

Description

Description of the scheduled backup job.

Categories

Categories of information that will be backed up.

Schedule

When the backup job is scheduled to occur.

Last Run

Date and time the last backup occurred

Last Result

Result of the last scheduled backup job.

Next Run

Date and time the next backup will occur

Active

Time period when the scheduled backup job is active.


Related Commands

Command
Description

backup schedule

Enters commands enters backup-schedule submode.

show backup schedule detail job

Shows details for all recurring scheduled backup jobs.


show backup schedules

To display the details of all recurring scheduled backup jobs configured on the local system, use the show backup schedules command in Cisco UMG EXEC mode.

show backup schedules

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Examples

The following example displays the details of all recurring scheduled backup jobs:

umg-1# show backup schedules

Name         Schedule                Next Run       Description   Categories
A22          NOT SET                 NEVER
backup1000   Every 1 days at 12:34   Jun 25, 2002 12:34           Data 
Total: 2


Table 8 describes the significant fields shown in the display.

Table 8 show backup schedules Field Descriptions 

Field
Description

Name

Name of the scheduled backup job.

Schedule

When the backup job is scheduled to occur.

Next Run

Date and time the next backup will occur

Description

Description of the scheduled backup job.

Categories

Categories of information that will be backed up.


Related Commands

Command
Description

backup schedule

Enters commands enters backup-schedule submode.

show backup schedule detail job

Shows details for the specified recurring scheduled backup job.


show backup server

To display the details of the most recent backup files, use the show backup server command in Cisco UMG EXEC mode.

show backup server

Syntax Description

This command has no arguments or keywords.

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

Category:       Data
Details of last 5 backups
Backupid:     1
Date:         Tue Jul 22 10:55:52 PDT 2007
Description:  
Backupid:     2
Date:         Tue Jul 29 18:06:33 PDT 2007
Description:  
Backupid:     3
Date:         Tue Jul 29 19:10:32 PDT 2007
Description:  

Category:       Configuration
Details of last 5 backups
Backupid:     1
Date:         Tue Jul 22 10:55:48 PDT 2007
Description:  

Backupid:     2
Date:         Tue Jul 29 18:06:27 PDT 2007
Description: 

Backupid:     3
Date:         Tue Jul 29 19:10:29 PDT 2007
Description: 

Table 9 describes the significant fields shown in the display.

Table 9 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

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 clock

To display clock statistics, use the show clock command in Cisco UMG EXEC mode.

show clock

Syntax Description

This command has no arguments or keywords.

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:

umg-1# show clock

19:20:33.724 PST Wed Mar 17 1993
time zone:                              America/Los_Angeles
clock state:                            unsync
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 10 describes the significant fields shown in the display.

Table 10 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 an NTP server.


show configuration

To display the contents of the non-volatile memory, use the show configuration command in Cisco UMG EXEC mode.

show configuration

Syntax Description

This command has no arguments or keywords.

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

hostname umg-1

ip domain-name temp.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"

log trace local enable

groupname Administrators create
groupname Broadcasters create

username chambers 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

registration
 username cue_02 password encrypted "Cnjf81Z1zXpbrA7+7/IBX0nfGWTYHfmPSd8ZZNgd+Y9
J3xlk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWT
YHfmP"
 username umg password encrypted "R30jwZyreaDX3TqGSvsp5EnfGWTYHfmPSd8ZZNgd+Y9J3x
lk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHf
mP"
 end registration

spoken-name enable

translation-rule message unity from-host to-host

end
umg-1

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 crypto key

To display configured certificate-private key pairs, use the show crypto key command in Cisco UMG EXEC mode.

show crypto key { all | label label-name }

Syntax Description

all

Displays all configured certificate-private key pairs.

label label-name

Displays characteristics of the specified certificate-private key pair. An error message appears if label-name does not exist.


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 crypto key command:

umg-1# show crypto key label mainkey.ourcompany
Label name: mainkey.ourcompany [default]
Entry type:Key Entry
Creation date: Mon Jun 10 14:23:09 PDT 2002
Owner: CN=se-1-100-6-10.localdomain, OU='', O='', L='', ST='', C=''
Issuer: CN=se-1-100-6-10.localdomain, OU='', O='', L='', ST='', C=''
Valid from: Mon Jun 10 14:23:06 PDT 2002 until: Sun Sep 08 14:23:06 PDT 2002

Table 11 describes the significant fields shown in the display.

Table 11 show crypto key Field Descriptions

Field
Description

Label name

Name of the certificate-key pair.

Entry type

Method of providing the certificate-key pair.

Creation date

Date the certificate-key pair was created.

Owner

Owner of the certificate-key pair.

Issuer

Issuer of the certificate-key pair.

Valid from

Dates for which the certificate-key pair is valid.


Related Commands

Command
Description

crypto key default

Designates a certificate-private key pair as the system default.

crypto key delete

Deletes a certificate-private key pair.

crypto key generate

Generates a certificate-private key pair.

crypto key import

Imports a certificate-private key pair from a console or server.


show hosts

To display the hostname and the domain of the local messaging gateway, use the show hosts command in Cisco UMG EXEC mode.

show hosts

Syntax Description

This command has no arguments or keywords.

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:

umg-1# show hosts
Hostname:      umg-1
Domain:        example.com
umg-1#

Related Commands

Command
Description

hostname

Specifies the local Cisco UMG's hostname.

ip domain-name

Specifies the Cisco UMG domain name and/or DNS server(s).

network local messaging-gateway

Specifies the location ID of the local messaging gateway.

network messaging-gateway

Specifies the location ID and hostname for peer messaging gateways.


show ip dns cache

To display the DNS cache, use the show ip dns cache command in Cisco UMG EXEC mode.

show ip dns cache

Syntax Description

This command has no arguments or keywords.

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 dns cache command:

umg-1> show ip dns cache


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
mp.com.
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


se-10-1-12-95>

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 ip route

To display the IP routing table, use the show ip route command in Cisco UMG EXEC mode.

show ip route

Syntax Description

This command has no arguments or keywords.

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 route command:

umg-1# show ip route 

            DEST            GATE            MASK   IFACE
        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

Table 12 describes the significant fields shown in the display.

Table 12 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 kron schedules

To display a list of kron jobs, use the show kron schedules command in Cisco Messaging Gateway EXEC mode.

show kron schedules

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Release
Modification

8.0

This command was introduced.


Examples

The following example displays a list of scheduled kron jobs:

umg-1# show kron schedules
Name          Schedule                            Commands
krj1          Every 1 days at 12:34               show ver,sh run,conf t,host...
Total: 1

Table 13 describes the significant fields shown in the display.

Table 13 show kron schedule Field Descriptions

Field
Description

Name

The kron job name.

Schedule

When the kron job is configured to take place.

Commands

Lists the commands in the kron job.


Related Commands

Command
Description

commands (kron schedule)

Enters the interactive mode to create the command block for a kron job.

description (kron schedule)

Configures a description for the kron job.

kron schedule

Creates a new kron schedule and enters kron-schedule configuration mode.

show kron schedule detail job

Displays details of a specific kron job.


show kron schedule detail job

To display details of a kron job, use the show kron schedule detail job command in Cisco UMG EXEC mode.

show kron schedule detail job name

Syntax Description

name

Specifies the name of the kron job.


Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Release
Modification

8.0

This command was introduced.


Examples

The following example displays the detailed information about a specific kron job:

umg-1# show kron schedule detail job krj1
Job Name        krj1
Description
Schedule        Every 1 days at 12:34
Last Run        NEVER
Last Result
Next Run        Feb 18, 2010 12:34
Active          from Feb 17, 2010 until INDEFINITE
Disabled
CLI Commands
                show ver
                sh run
                conf t
                hostname aaa

Table 14 describes the significant fields shown in the display.

Table 14 show kron schedule detail job Field Descriptions 

Field
Description

Job Name

The kron job name.

Description

The description of the kron job.

Schedule

When the kron job is configured to take place.

Last Run

When the kron job was last run.

Last Result

The result for the last time the kron job was run.

Next Run

The next time the kron job is scheduled to run.

Active

If the kron job is active, the date for when the kron job will no longer be active.

Disabled

If the kron job is disabled, the date for when the kron job will no longer be disabled.

CLI Commands

Lists the commands in the kron job.


Related Commands

Command
Description

commands (kron schedule)

Enters the interactive mode to create the command block for a kron job.

description (kron schedule)

Configures a description for the kron job.

kron schedule

Creates a new kron schedule and enters kron-schedule configuration mode.

show kron schedules

Displays a list of kron jobs.


show license agent

To display the license agent counters and session information, use the show license agent command in Cisco UMG EXEC mode.

show license agent {counters | session}

Syntax Description

counters

Displays the license agent counters.

session

Displays the license agent session.


Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command displays counter and session information.

Examples

The following is a sample output for the show license agent counters command:

UMG-1# show license agent counters
License Agent Counters
Request Messages Received:0: Messages with Errors:0
Request Operations Received:0: Operations with Errors:0
Notification Messages Sent:0: Transmission Errors:0

The following is a sample output for the show license agent session command:

SRST-UMG# show license agent session

License Agent Sessions: 0 open, maximum is 9

Related Commands

Command
Description

show license detail

Displays the details of the license installed on your system.

show license evaluation

Displays the evaluation licenses that are installed on your system.

show license expiring

Displays the expiring licenses.

show license feature

Displays the license feature information.

show license file

Displays the license file information

show license in-use

Displays information about the licenses that are in use.

show license permanent

Displays the status of the licenses installed.

show license status

Displays the status of the license applications installed.


show license all

To display the summary of all the licenses installed in your system, use the show license all command in Cisco UMG EXEC mode.

show license all

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command displays all of the licenses installed on the module.

Examples

The following is a sample output for the show license all command:

UMG-1# show license all                          
License Store: Primary License Storage                                      
StoreIndex:  0  Feature: CUMG-SRSV-NODE                    Version: 1.0
        License Type: Permanent
        License State: Active, In Use
        License Count: 25 /25
        License Priority: Medium
License Store: Evaluation License Storage
StoreIndex:  0  Feature: CUMG-SRSV-NODE                    Version: 1.0
        License Type: Evaluation
        License State: Inactive
            Evaluation total period:  8 weeks  4 days
            Evaluation period left:  8 weeks  4 days
        License Count: 6000 / 0
        License Priority: None
License Store: Evaluation License Storage
StoreIndex:  1  Feature: CUMG-SRST-NODE                    Version: 1.0
        License Type: Evaluation
        License State: Active, Not in Use, EULA not accepted
            Evaluation total period:  8 weeks  4 days
            Evaluation period left:  8 weeks  4 days
        License Count: 1000 / 0
        License Priority: None
License Store: Evaluation License Storage
StoreIndex:  2  Feature: CUMG-VPIM-NODE                    Version: 1.0
        License Type: Evaluation
        License State: Active, Not in Use, EULA not accepted
            Evaluation total period:  8 weeks  4 days
            Evaluation period left:  8 weeks  4 days
        License Count: 6000 / 0
        License Priority: None

Table 15 describes the significant fields shown in the display.

Table 15 show license all Field Descriptions 

Field
Description

Feature Name

Displays the feature name.

License Type

Types of licenses installed on your system

License State

Licenses that are in different status such as in-use, active, expired and so on.

License Count

Number of the license.

License Priority

Priority level of the license.

Evaluation total period

Total evaluation period for the license.

Evaluation period left

Remaining evaluation period.



Related Commands

Command
Description

show license detail

Displays the details of the license installed on your system.

show license evaluation

Displays the evaluation licenses that are installed on your system.

show license expiring

Displays the expiring licenses.

show license feature

Displays the license feature information.

show license file

Displays the license file information

show license in-use

Displays information about the licenses that are in use.

show license status

Displays the status of the licenses installed.

show license status application

Displays the status of the license applications installed.


show license detail

To display the details of the license installed on your system, use the show license detail command in Cisco UMG EXEC mode.

show license detail

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command displays the detailed information of the license that is installed on your system.

Examples

The following is a sample output for the show license detail command:

umg-1# show license detail
Index:  1       Feature: CUMG-SRST-NODE                    Version: 1.0         
        License Type: Evaluation
        License State: Active, Not in Use, EULA not accepted
            Evaluation total period:  8 weeks  4 days
            Evaluation period left:  8 weeks  4 days
        License Count: 1000 / 0
        License Priority: None
        Store Index: 1
        Store Name: Evaluation License Storage
Index:  2       Feature: CUMG-SRSV-NODE                    Version: 1.0
        License Type: Permanent
        License State: Active, In Use
        License Count: 25 /25
        License Priority: Medium
        Store Index: 0
        Store Name: Primary License Storage
Index:  3       Feature: CUMG-SRSV-NODE                    Version: 1.0
        License Type: Evaluation
        License State: Inactive
            Evaluation total period:  8 weeks  4 days
            Evaluation period left:  8 weeks  4 days
        License Count: 6000 / 0
        License Priority: None
        Store Index: 0
 --More—
Store Index: 0
        Store Name: Evaluation License Storage

Table 16 describes the significant fields shown in the display.

Table 16 show license details Field Descriptions 

Field
Description

Feature Name

Displays the feature name.

License Type

Types of licenses installed on your system

License State

Licenses that are in different status such as in-use, active, expired and so on.

License Count

Number of the license.

License Priority

Priority level of the license.

Evaluation total period

Total evaluation period for the license.

Evaluation period left

Remaining evaluation period.


Command
Description

show license all

Displays the summary of all the licenses installed.

show license evaluation

Displays the evaluation licenses that are installed on your system.

show license expiring

Displays expiring licenses.

show license feature

Displays the license feature information.

show license file

Displays the license file information.

show license in-use

Displays information about the licenses that are in use.

show license permanent

Displays the status of the licenses installed.

show license status application

Displays the status of the license applications installed.


show license evaluation

To display the evaluation licenses that are in your system, use the show license evaluation command in Cisco UMG EXEC mode.

show license evaluation

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command displays the list of evaluation licenses.

Examples

The following is a sample output for the show license evaluation command:

UMG-1# show license evaluation
StoreIndex:  0  Feature: CUMG-SRSV-NODE                    Version: 1.0
        License Type: Evaluation
        License State: Inactive
            Evaluation total period:  8 weeks  4 days
            Evaluation period left:  8 weeks  4 days
        License Count: 6000 / 0
        License Priority: None
StoreIndex:  1  Feature: CUMG-SRST-NODE                    Version: 1.0
        License Type: Evaluation
        License State: Active, Not in Use, EULA not accepted
            Evaluation total period:  8 weeks  4 days
            Evaluation period left:  8 weeks  4 days
        License Count: 1000 / 0
        License Priority: None
StoreIndex:  2  Feature: CUMG-VPIM-NODE                    Version: 1.0
        License Type: Evaluation
        License State: Active, Not in Use, EULA not accepted
            Evaluation total period:  8 weeks  4 days
            Evaluation period left:  8 weeks  4 days
        License Count: 6000 / 0
        License Priority: None

Table 17 describes the significant fields shown in the display.

Table 17 show license evaluation Field Descriptions 

Field
Description

Feature Name

Displays the feature name.

License Type

Types of licenses installed on your system

License State

Licenses that are in different status such as in-use, active, expired and so on.

License Count

Number of the license.

License Priority

Priority level of the license.

Evaluation total period

Total evaluation period for the license.

Evaluation period left

Remaining evaluation period.


Related Commands

Command
Description

show license all

Displays the summary of all the licenses installed.

show license detail

Displays the details of the license installed.

show license expiring

Displays expiring licenses.

show license feature

Displays the license feature information.

show license file

Displays the license file information.

show license in-use

Displays information about the licenses that are in use.

show license status

Displays the status of the licenses installed.

show license status application

Displays the status of the license applications installed.


show license expiring

To display the list of expiring licenses, use the show license expiring command in Cisco UMG EXEC mode.

show license expiring

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command displays the licenses installed in the system.

Examples

The following is sample output for the show license expiring command:

UMG-1# show license expiring
StoreIndex:  0  Feature: CUMG-SRSV-NODE                    Version: 1.0
        License Type: Evaluation
        License State: Inactive
            Evaluation total period:  8 weeks  4 days
            Evaluation period left:  8 weeks  4 days
        License Count: 6000 / 0
        License Priority: None
StoreIndex:  1  Feature: CUMG-SRST-NODE                    Version: 1.0
        License Type: Evaluation
        License State: Active, Not in Use, EULA not accepted
            Evaluation total period:  8 weeks  4 days
            Evaluation period left:  8 weeks  4 days
        License Count: 1000 / 0
        License Priority: None
StoreIndex:  2  Feature: CUMG-VPIM-NODE                    Version: 1.0
        License Type: Evaluation
        License State: Active, Not in Use, EULA not accepted
            Evaluation total period:  8 weeks  4 days
            Evaluation period left:  8 weeks  4 days
        License Count: 6000 / 0
        License Priority: None

Table 18 describes the significant fields shown in the display.

Table 18 show license expiring Field Descriptions 

Field
Description

Feature Name

Displays the feature name.

License Type

Types of licenses installed on your system

License State

Licenses that are in different status such as in-use, active, expired and so on.

License Count

Number of the license.

License Priority

Priority level of the license.

Evaluation total period

Total evaluation period for the license.

Evaluation period left

Remaining evaluation period.


Related Commands

Command
Description

show license all

Displays the summary of all of the licenses installed.

show license detail

Displays the details of the license installed.

show license evaluation

Displays the evaluation licenses that are installed on your system.

show license expiring

Displays the license feature information.

show license file

Displays the license file information.

show license in-use

Displays information about the licenses that are in use.

show license status

Displays the status of the licenses installed.

show license status application

Displays the status of the license applications installed.


show license feature

To display the license feature information, use the show license feature command in Cisco UMG EXEC mode.

show license feature

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

7.1

This command was introduced.


Usage Guidelines

This command displays the license feature information.

Examples

The following is a sample output for the show license feature command:

UMG-1# show license feature
Feature name        Enforcement   Evaluation  Clear Allowed  Enabled
CUMG-SRSV-NODE      yes           yes         yes            yes
CUMG-SRST-NODE      yes           yes         yes            no
CUMG-VPIM-NODE      yes           yes         yes            no

Table 19 describes the significant fields shown in the display.

Table 19 show license feature Field Descriptions 

Field
Description

Feature Name

Displays the feature name.

Enforcement

Displays the feature enforced.

Evaluation

Displays the feature evaluation.

Clear Allowed

Displays the feature cleared.

Enabled

Displays the feature enabled.


Related Commands

Command
Description

show license all

Displays the summary of all of the licenses installed.

show license detail

Displays the details of the license installed.

show license evaluation

Displays the evaluation licenses that are installed on your system.

show license expiring

Displays the expiring licenses.

show license file

Displays the license file information.

show license in-use

Displays information about the licenses that are in use.

show license status

Displays the status of the licenses installed.

show license status application

Displays the status of the license applications installed.


show license file

To display the license file information, use the show license file command in Cisco UMG EXEC mode.

show license file

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command displays the license file information.

Examples

The following is a sample output for the show license file command:

UMG-1# show license file                           
License Store: Primary License Storage                                      
  Store Index: 0
    License: 11 CUMG-SRSV-NODE 1.0 LONG NORMAL STANDALONE EXCL 25_KEYS INFINIT

             E_KEYS NEVER NEVER NiL SLM_CODE CL_ND_LCK NiL *1VWRGKKFHYT48RU400

              NiL NiL NiL 5_MINS <UDI><PID>NME-UMG-EC</PID><SN>FOC12173GKY</SN

             ></UDI> AdlddTwQB7qVoypWOWWSLcNxERLNY:h23I2b8W2zO9VZWbXvPiat,g:Jw

             cW6IMJWVpWx3sCYIoyQvUYrHjeLVrLyXGl17WwW0669al1G2G0Pff$<WLC>AQEBIf

             8B//+WLJLP02ZqFFWJGj41T/rpXCwkhfZHpL5sorgNyNLnmUs+lo4KKZxAO4il7s3

             tfVJHebPkGlARtYd1UQO7GJ3KnufZ9oZ6JdFniDf5HrQ8DrXdpCz5RgZE+y8fbN20

             0xiXA5cB3fwcJqoPIFZm2HmD1qFfsyTAzuio66t6Xk5y8xo1lbVhvoh/FZfy5iRY3

             oE=</WLC>
    Comment:
       Hash: icj3MkSQxB+4Im/RyHNoeWas4pQ=


end

Related Commands

Command
Description

show license all

Displays the summary of all of the licenses installed.

show license detail

Displays the details of the license installed.

show license evaluation

Displays the evaluation licenses that are installed on your system.

show license expiring

Displays the expiring licenses.

show license in-use

Displays information about the licenses that are in use.

show license status

Displays the status of the licenses installed.

show license status application

Displays the status of the license applications installed.


show license in-use

To display information about the licenses that are in use on your module, use the show license in-use command in Cisco UMG EXEC mode.

show license in-use

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco UMG

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command displays the list of licenses currently marked as in-use.

Examples

The following is a sample output for the show license in-use command:

UMG-1#  show license in-use
StoreIndex:  0  Feature: CUMG-SRSV-NODE                    Version: 1.0
        License Type: Permanent
        License State: Active, In Use
        License Count: 25 /25
        License Priority: Medium

Table 20 describes the significant fields shown in the display.

Table 20 show license in-use Field Descriptions 

Field
Description

License Type

Types of licenses installed on your system

License State

Licenses that are in different status such as in-use, active, expired and so on.

License Count

Number of the license.

License Priority

Priority level of the license.

Evaluation total period

Total evaluation period for the license.

Evaluation period left

Remaining evaluation period.


Related Commands

Command
Description

show license all

Displays a summary of all of the licenses installed.

show license detail

Displays the details of the license installed.

show license evaluation

Displays the evaluation licenses that are installed on your system.

show license expiring

Displays the expiring licenses.

show license file

Displays the license file information.

show license status

Displays the status of the licenses installed.

show license status application

Displays the status of the license applications installed.


show license permanent

To display the list of permanent licenses that are installed on your system, use the show license permanent command in Cisco UMG EXEC mode.

show license permanent

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command displays the list of permanent licenses.

Examples

The following is a sample output for the show license permanent command:

UMG-1# show license permanent
StoreIndex:  0  Feature: CUMG-SRSV-NODE                    Version: 1.0
        License Type: Permanent
        License State: Active, In Use
        License Count: 25 /25
        License Priority: Medium

Related Commands

Command
Description

show license all

Displays a summary of all of the licenses installed.

show license detail

Displays the details of the license installed.

show license evaluation

Displays the evaluation licenses that are installed on your system.

show license expiring

Displays the expiring licenses.

show license file

Displays the license file information

show license in-use

Displays information about the licenses that are in use.

show license status

Displays the status of the licenses installed.


show license statistics

To display the statistics of license agent actions, use the show license statistics command in Cisco UMG EXEC mode.

show license statistics

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco Unified Messsaging Gateway EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command displays the statistics of license agent actions.

Examples

The following is a sample output for the show license statistics command:

UMG-1# show license statistics
                Administrative statistics
        Install success count:       0
        Install failure count:       0
        Install duplicate count:     0
        Comment add count:           0
        Comment delete count:        0
        Clear count:                 0
        Save count:                  0
        Save cred count:             0

                Client statistics
        Request success count:     3
        Request failure count:     0
        Release count:             0
        Global Notify count:       0

Related Commands

Command
Description

show license all

Displays a summary of all of the licenses installed.

show license detail

Displays the details of the license installed.

show license evaluation

Displays the evaluation licenses that are installed on your system.

show license expiring

Displays the expiring licenses.

show license file

Displays the license file information.

show license in-use

Displays information about the licenses that are in use.

show license status

Displays the status of the licenses installed.

show license status application

Displays the status of the license applications installed.


show license status

To display the license status information, use the show license status command in Cisco UMG EXEC mode.

show license status

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command displays the license status information..

Examples

The following is a sample output for the show license status command:

UMG-1# show license status
                License Type Supported
        permanent  Non-expiring node locked license
        extension  Expiring node locked license
        evaluation Expiring non node locked license

                License Operation Supported
        install    Install license
        clear      Clear license
        annotate   Comment license
        save       Save license
        modify     Modify license priority
        revoke     Revoke license

                Device status
        Device Credential type: IMAGE
        Device Credential Verification: PASS
        Rehost Type: DC_OR_IC

Related Commands

Command
Description

show license all

Displays the summary of all of the licenses installed.

show license detail

Displays the details of the license installed.

show license evaluation

Displays the evaluation licenses that are installed on your system.

show license expiring

Displays the list of expiring licenses.

show license file

Displays the license file information.

show license in-use

Displays information about the licenses that are in use.

show license status application

Displays the status of the license applications installed.


show license status application

To display the status of the license applications installed, use the show license status application command in Cisco UMG EXEC mode.

show license status application [srst | srsv | vpim ]

Syntax Description

srst

Displays the SRST license status.

srsv

Displays the SRSV license status.

vpim

Displays the VPIM license status.


Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.

8.5

The srst license keyword was added.


Usage Guidelines

This command displays the status of license applications installed in the system. If no keyword is specified, then the status of all installed license applications is displayed.

Examples

The following example displays license status information for all applications.

UMG-1# show license status application
srsv enabled: 25 srsv nodes
srst disabled, no activated srst node license available
vpim disabled, no activated vpim node license available

The following is sample output for the show license status application srsv command:

UMG-1# show license status application srsv
srsv enabled: 25 srsv nodes

Related Commands

Command
Description

show license all

Displays the summary of all of the licenses installed.

show license detail

Displays the details of the license installed.

show license evaluation

Displays the evaluation licenses that are installed on your system.

show license feature

Displays the license feature information.

show license file

Displays the license file information.

show license in-use

Displays information about the licenses that are in use.

show license status

Displays the status of the licenses installed.


show license udi

To display the licensable UDI values on the service module of the system, use the show license udi command in Cisco UMG EXEC mode.

show license udi

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco Unified Messsaging Gateway EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command displays the UDI license information. The UDI is printed on a label located on the back of most Cisco hardware devices or on a label tray visible on the front panel of field-replaceable motherboards.

Examples

The following is sample output for the show license udi command:

UMG-1# show license udi
Device# PID                     SN                      UDI
--------------------------------------------------------------------------------

*0      NME-UMG-EC              FOC12173GKY             NME-UMG-EC:FOC12173GKY

Related Commands

Command
Description

show license all

Displays a summary of all of the licenses installed on your module.

show license detail

Displays the details of the license installed on your system.

show license evaluation

Displays the evaluation licenses that are installed on your system.

show license expiring

Displays the list of expiring licenses.

show license feature

Displays the license file information.

show license in-use

Displays information about the licenses that are in use.

show license status application

Displays the status of the licenses installed.


show log name

To display logging data, use the show log name command in 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

Only displays events that match a search expression.

paged

Displays in paged mode.

tail

Displays the latest events as they occur.


Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

This command has the following 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
Platform: nm
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)
245MB LOWMEM available.
On node 0 totalpages: 62848
zone(0): 4096 pages.
zone(1): 58752 pages.
zone(2): 0 pages.
DMI not present.
Kernel command line: root=/dev/hda1 ro plat=nm
Initializing CPU#0
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
in atrace_init
log_head: h: 0, t: 8429274, l: 0, w: 0, s: 10484672
Using existing trace log
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: L2 cache: 256K
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]
umg-1# 

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
Platform: nm
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)
245MB LOWMEM available.
On node 0 totalpages: 62848
zone(0): 4096 pages.
zone(1): 58752 pages.
zone(2): 0 pages.
DMI not present.
Kernel command line: root=/dev/hda1 ro plat=nm
Initializing CPU#0
 -- More -- 

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)
init unit number == 0

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 server address

Specifies an external server for saving log messages.

log trace boot

Saves the trace configuration on rebooting.

log trace buffer save

Saves the current trace information.

show logging

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

show logs

Displays the list of available logs.


show logging

To display the types of messages that are displayed on the console, use the show logging command in Cisco UMG EXEC mode.

show logging

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

This command has the following 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.

umg-1# show logging

info:     off
warning:  off
errors:   on
fatal:    on

Console Filter Info:

MODULE           ENTITY           ACTIVITY        FILTER

No filter active

The following displays the output for the show logging command when errors, fatal messages, and ccn engine messages are displayed on the console.

umg-1# show logging

info:     off
warning:  off
errors:   on
fatal:    on

Console Filter Info:

MODULE           ENTITY           ACTIVITY        FILTER

ccn              Engine           XDBG            
ccn              Engine           DBUG 

The following example displays show logging output when an external syslog server is configured:

umg-1# show logging

info:     off
warning:  off
errors:   off
fatal:    on

Monitored event  Info:

MODULE           ENTITY           ACTIVITY        FILTER

No monitored events active

Server Info:

Log server address: 192.0.2.24

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 server address

Specifies an external server for saving log messages.

log trace boot

Saves the trace configuration on rebooting.

log trace buffer save

Saves the current trace information.

show log name

Displays a specified log.

show logs

Displays the list of available logs.


show logs

To display the existing log files on the current 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 Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

This command has the following 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:

umg-1# show logs

install.log
dmesg
syslog.log
atrace_save.log
atrace.log
klog.log
messages.log
root_heapdump2749.1023408628.txt

Related Commands

Command
Description

log trace boot

Configures trace logging options.


show memory

To display memory information for the 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 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:

umg-1# show memory

Total Memory (kB):            245216
Active Memory (kB):           23728
Inactive Memory (kB):         196620
Other Memory (kB):            19760
MemoryPool (kB):              5108

Kernel Memory
  TOTAL   INUSE  MAXUSED     ERR TYPE            
   5768    5368     6795       0 fs              
   7040    6828     7499       0 other           
    156     100      186       0 net 

Table 21 describes the significant fields shown in the display.

Table 21 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 ntp

To display the time source for a Network Time Protocol (NTP) server, use the show ntp command in Cisco UMG EXEC mode.

show ntp [ detail ]

Syntax Description

detail

Displays detailed information about the NTP servers.


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:

umg-1# show ntp

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 22 describes the significant fields shown in the display.

Table 22 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:

umg-1# show ntp detail

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 23 describes the significant fields shown in the display.

Table 23 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 UMG module, use the show process command in Cisco UMG EXEC mode.

show processes [cpu | memory]

Syntax Description

cpu

Displays CPU time.

memory

Displays process memory usage.


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:

umg-1# show processes

STATE                    HEALTH   CMD             
online                   alive    syslog-ng       
online                   alive    platform_config 
online                   alive    rbcp            
online                   alive    trace           
online                   alive    cli             
online                   alive    ntp             
online                   alive    ldap            
online                   alive    superthread     
online                   alive    sql             
online                   alive    http            
online                   alive    ccn             
online                   alive    probe           
online                   alive    downloader      
online                   alive    dns             
online                   alive    usermanager     
online                   alive    ccn_config      
online                   alive    backuprestore   
online                   alive    smtp            

The following is sample output for the show processes cpu command:

umg-1# show processes cpu

Uptime (secs):                953302.54
User time (secs):             2352.6
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 24 describes the fields shown in the show processes command output.

Table 24 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 25 describes the fields shown in the show processes cpu command output.

Table 25 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 26 describes the fields shown in the show process memory command output.

Table 26 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 restore history

To display the success or failure of restore procedures, use the show restore history command in Cisco UMG EXEC mode.

show restore history

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Release
Modification

8.0

This command was introduced.


Usage Guidelines

If running a Cisco UMG version prior to 8.0, use the show backup history command to display the restore history.


Note If the restore fails because the FTP server is not reachable, the failure is not logged in the restore history.


Examples

The following is sample output from the show restore history command:

umg-1# show restore history
#Start Operation
Category:      Configuration
Backup Server: ftp://10.100.10.215/CUE_backup
Operation:     Restore
Backupid:      129
Restoreid:     15
Date:          Sun Jun 13 12:32:48 PDT 1993
Result:        Success
Reason:
Version: 8.0.0.1 
#End Operation

Table 27 describes the significant fields shown in the display.

Table 27 show restore history Field Descriptions 

Field
Description

Category

Specifies the type of file (data, configuration, or all) that was backed up.

Backup Server

Backup server location.

Operation

Type of operation performed.

Backupid

ID number of the backup file.

Restoreid

ID to use to restore this file.

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.

Version

Specifies the scheduled restore version.


Related Commands

Command
Description

show backup history

Displays the success or failure of backup and restore procedures.


show running-config

To display the current running configuration for Cisco UMG, use the show running-config command in Cisco UMG EXEC mode.

show running-config [ paged ]

Syntax Description

paged

Displays enough output to fill the current viewing screen.


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.

Examples

The following is sample output for the show running-config command:

umg-1# show running-config
Generating configuration:


clock timezone America/Los_Angeles

hostname umg-1

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"

log trace local enable

groupname Administrators create
groupname Broadcasters create

username chambers 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

registration
 username umg password encrypted "R30jwZyreaDX3TqGSvsp5EnfGWTYHfmPSd8ZZNgd+Y9J3x
lk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHfmPSd8ZZNgd+Y9J3xlk2B35j0nfGWTYHf
mP"
 end registration

end
umg-1#

Related Commands

Command
Description

copy ftp

Copies network FTP server data to another location.

copy running-config

Copies the running configuration to another location.

copy startup-config

Copies the startup configuration to another location.

copy tftp

Copies network TFTP server data to another location.

erase startup-config

Deletes the startup configuration.

log server address

Configures external log server.

show startup-config

Displays the startup configuration.

write

Copies the running configuration to the startup configuration.


show security ssh known-hosts

To display a list of configured SSH (Secure Shell) servers and their fingerprints, use the show security ssh known-hosts command in Cisco UMG EXEC mode.

show security ssh known-hosts

Syntax Description

This command has no arguments or keywords.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

Use the show security ssh known-hosts command in Cisco UMG EXEC mode to display a list of configured SSH servers and their fingerprints. These fingerprints are used to perform SSH server authentication.

Examples

The following is sample output for the show security ssh known-hosts command:

se-10-0-0-0# show security ssh known-hosts

192.168.138.208 ssh-rsa  a5:3a:12:6d:e9:48:a3:34:be:8f:ee:50:30:e5:e6:c3
172.16.103.231 ssh-rsa  5c:31:00:89:04:ed:2e:fc:bd:eb:26:23:cd:24:c0:b6

This output shows the following information:

Hostname or IP address of the SSH server.

Whether the MD5 (Message-Digest algorithm 5) fingerprint is for a SSH server's host key that was created using the DSA (Digital Signature Algorithm) or RSA encryption algorithm.

MD5 fingerprint string

Related Commands

Command
Description

backup server authenticate

Retrieves the fingerprint of the backup server's host key.

security ssh

Configures the MD5 (Message-Digest algorithm 5) fingerprint of the SSH (Secure Shell) server's host key.


show software

To display the characteristics of the installed software, use the show software command in 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

Installed 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
Build Number dthf_apr6

Installed Packages:
 - Installer  dthf_apr6
 - UMG  0.0.1
 - Bootloader (Primary)  2.1.8.0
 - Infrastructure  2.3.2.0
 - Global  dthf_apr6
 - Bootloader (Secondary)  2.1.10.0
 - Core  2.3.0.2
 - GPL Infrastructure  2.2.1.0

umg-1#

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 UMG EXEC mode.

show software directory {download | downgrade}

Syntax Description

download

Displays download directory information.

downgrade

Displays downgrade directory information.


Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

Cisco UMG Release 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

KBytes  Directory
0       /dwnld/pkgdata

Directory listings


Directory: /dwnld/pkgdata

total 0
drwxrwxr-x  2 root daemon  48 Apr  6 16:40 .
drwxrwxr-x  4 root daemon 200 Apr  6 16:40 ..
umg-1#

Related Commands

Command
Description

software download clean

Downloads software packages for installing later.


show startup-config

To display the current startup configuration, use the show startup-config command in Cisco UMG EXEC mode.

show startup-config [ paged ]

Syntax Description

paged

Displays enough output to fill the current viewing screen.


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

hostname umg-1

ip domain-name (none)

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

username root create
username lab 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

registration
 username-hidden umg
 end registration

translation-rules smtp cue src_host src_host

network local gateway id 50000

endpoint id 33 type unity
 hostname unity
 prefix 408
 end endpoint

security password lockout policy temp-lock
security pin lockout policy temp-lock

end
umg-1#

Related Commands

Command
Description

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.

erase startup-config

Deletes startup configuration data.

restore factory default

Restores the system to the factory defaults.

show running-config

Displays the running configuration.

show startup-config

Displays the current startup configuration.

shutdown

Displays the software version.

write

Copies the running configuration to the startup configuration.


show statistics

To display a statistics report, use the show statistics command in Cisco UMG EXEC mode.

show statistics

Syntax Description

This command has no keywords or arguments.

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:

umg-1# show statistics 
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 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 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 UMG EXEC mode.

show trace buffer [containing string [long | short] | long [paged] | short [paged] | tail [number [long | short]]]

Syntax Description

containing string

Displays only events that match a search expression.

long

Displays expanded text for many error and return codes.

short

Displays hexadecimal codes.

paged

Displays the output a page at a time.

tail

Display the latest events as they occur.

number

Displays the most recent number of events.


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.

This command has the following 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 shows partial output from the show trace buffer command:

umg-1# show trace buffer

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> </
attrDecl> </attrList>
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

log console

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

log console monitor

Displays system messages on the console.

log server address

Specifies an external server for saving log messages.

log trace boot

Saves the trace configuration on rebooting.

log trace buffer save

Saves the current trace information.

show log name

Begins the output of any show command from a specified string.

show logging

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

show logs

Displays the list of available logs.


show trace store

To display a list of events from the atrace.log file, use the show trace store command in Cisco UMG EXEC mode.

show trace store [containing string [long | short] | long [paged] | short [paged] | tail [number [long | short]]]

Syntax Description

containing string

Displays only events that match a search expression.

long

Displays expanded text for many error and return codes.

short

Displays hexadecimal codes.

paged

Displays the output a page at a time.

tail

Displays the latest events as they occur.

number

Displays the most recent number of events.


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.

This command has the following 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 shows a partial output from the show trace store command:

umg-1# show trace store

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> </
attrDecl> </attrList>
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 logs

Displays a list of the log files.

show trace store-prev

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


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 UMG EXEC mode.

show trace store-prev [containing string [long | short] | long [paged] | short [paged] | tail [number [long | short]]]

Syntax Description

containing string

Displays only events that match a search expression.

long

Displays expanded text for many error and return codes.

short

Displays hexadecimal codes.

paged

Displays the output a page at a time.

tail

Displays the latest events as they occur.

number

Displays the most recent number of events.


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.

This command has the following 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 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> </
attrDecl> </attrList>
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.


shutdown

To shut down the current configuring messaging gateway, use the shutdown command in Cisco UMG EXEC mode.

shutdown

Syntax Description

This command has no arguments or keywords.

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 offline.


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:

umg-1# shutdown 

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 UMG EXEC mode.

software download abort

Syntax Description

This command has no arguments or keywords.

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

Command
Description

software download clean

Downloads a complete package to install later.

software download status

Reports the status of a download in progress.

software download upgrade

Downloads an upgrade package to install later.


software download clean

To download software packages for installing later, use the software download clean command in 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 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
Bytes downloaded :  63648 

Validating package signature ... done

Validating package signature ... done
[17488 refs]
umg-1#

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

Command
Description

software download abort

Aborts a download that is in progress.

software download status

Reports the status of a download in progress.

software download upgrade

Downloads an upgrade package to install later.


software download server

To configure the FTP server address on the 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

The FTP directory on the server.

username username

Specifies the FTP username. If this option is not used, the default is "anonymous".

password password

Specifies the FTP password.

credentials hidden credentials

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 UMG EXEC mode.

software download status

Syntax Description

This command has no arguments or keywords.

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

Command
Description

software download abort

Aborts a download that is in progress.

software download clean

Downloads a complete package to install later.

software download upgrade

Downloads an upgrade package to install later.


software download uninstall

To upgrade to a newer version of 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 Cisco UMG software.

Neither Cisco UMG Release 1.0.1 nor Cisco UMG Release 8.0.1 supports upgrades.

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

Command
Description

software download upgrade

Configures the FTP server information.

software download upgrade

Downloads the files for a future upgrade.

software install clean

Installs a new version of the Cisco UMG software and cleans the disk.

software install downgrade

Downgrades the current Cisco UMG software to an older version.


software download upgrade

To download software for a later upgrade, use the software download upgrade command in 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

Directory other than the default.

username username

Username for the FTP server.

password password

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.

Neither Cisco UMG Release 1.0.1 nor Cisco UMG Release 8.0.1 supports upgrades.

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_host :192.0.2.24
url_user :null
url_uname :anonymous
url_psword :anonymous
url_proto :ftp
url_path :/
url_fname :umg.nme.1.0.1.pkg
url_url :ftp://192.0.2.24/

Downloading  umg.nme.1.0.1.pkg
Bytes downloaded :  63648 

Validating package signature ... done
Validating installed manifests ..........complete.
[17497 refs]


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

KBytes  Directory
0       /dwnld/pkgdata

Directory listings


Directory: /dwnld/pkgdata

total 0
drwxrwxr-x    2 root     daemon         48 Sep 15  2007 .
drwxrwxr-x    4 root     daemon        200 Sep 15  2007 ..

Related Commands

Command
Description

software download abort

Aborts a download that is in progress.

software download status

Reports the status of a download in progress.

show software directory

Displays directory information for software downloads and downgrades.


software install clean

To install a new version of 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 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::
IMPORTANT:: Welcome to Cisco Systems Service Engine
IMPORTANT:: post installation configuration tool.
IMPORTANT::
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::
IMPORTANT:: If you do not wish to continue, the system will be halted
IMPORTANT:: so it can be safely removed from the router.
IMPORTANT::
Do you wish to start configuration now (y,n)? y

IMPORTANT::
IMPORTANT:: A Cisco Unified Messaging Gateway configuration has been found
IMPORTANT:: You can choose to restore this configuration into
IMPORTANT:: current image.
IMPORTANT::
IMPORTANT:: A stored configuration contains some of the data
IMPORTANT:: previous installation, but not as much as a backup.
IMPORTANT::
IMPORTANT:: If you are recovering from a disaster and do not have a
IMPORTANT:: backup, you can restore the saved configuration.
IMPORTANT::
IMPORTANT:: If you are going to restore a backup from a previous
IMPORTANT:: installation, you should not restore the saved configuration
IMPORTANT::
IMPORTANT:: If you choose not to restore the saved configuration,
IMPORTANT:: will be erased from flash.
IMPORTANT::
Would you like to restore the saved configuration? (y,n)y

SYSTEM ONLINE

Related Commands

Command
Description

software download abort

Aborts a download that is in progress.

software download status

Reports the status of a download in progress.

software download upgrade

Downloads an upgrade package to install later.

software install downgrade

Downgrades the current Cisco UMG software to a previous version.

software install upgrade

Upgrades the current Cisco UMG software to a newer version.


software install downgrade

To downgrade to a previously installed version of 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 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 Release 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
KBytes  Directory
0       /dwnld/dwngrade

Directory listings


Directory: /dwnld/dwngrade

total 0
drwxrwxrwx    2 root     daemon         48 Sep 15  2007 .
drwxrwxr-x    4 root     daemon        200 Sep 15  2007 ..

Related Commands

Command
Description

show software directory

Displays directory information for software downloads and downgrades.

software install clean

Installs a new version of the <Abbreviation>Cisco Unity Express software.

software install upgrade

Upgrades the current <Abbreviation>Cisco Unity Express software to a newer version.


software install upgrade

To upgrade to a newer version of 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 the 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.

Neither Cisco UMG Release 1.0.1 nor Cisco UMG Release 8.0.1 supports upgrades.

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

Command
Description

software download upgrade

Configures the FTP server information.

software download upgrade

Downloads the files for a future upgrade.

software install clean

Installs a new version of the <Abbreviation>Cisco Unity Express software.

software install downgrade

Downgrades the current <Abbreviation>Cisco Unity Express software to an older version.


software remove

To remove software installed during a download or upgrade, use the software remove command in 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

Download files removed
Downgrade files removed

umg-1# software remove downgradefiles

Downgrade files removed

umg-1# software remove downloadfiles

Download files removed

Related Commands

Command
Description

show software directory

Displays the disk usage for the download and downgrade directories.


start-date (backup-schedule)

To specify the start date for recurring scheduled backup to occur, use the start-date command in Cisco UMG scheduled backup configuration mode. Use the no or default form of this command to remove the configuration of the start date.

start-date date

no start-date date

Syntax Description

date

Specifies the start date for the sequence of recurring scheduled backup jobs. The format is MM/DD/YYYY.


Command Default

Set to the day that a new schedule is created.

Command Modes

Cisco UMG scheduled backup configuration (backup-schedule)

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

The format for the date is month, day, and then year (for example: 05/302010).

Examples

The following example sets the start date to May 30, 2009:

umg-1# backup schedule job 22

umg-1(backup-schedule)# start-date 05/30/2009

Related Commands

Command
Description

backup schedule

Enters commands enters backup-schedule submode.



start-date (kron-schedule)

To specify the start date for the recurring scheduled kron job to occur, use the start-date command in Cisco UMG kron-schedule configuration mode. There is no no form of this command.

start-date date

Syntax Description

date

Specifies the start date for the sequence of recurring scheduled kron jobs. The format is MM/DD/YYYY.


Command Default

Set to the day that a new schedule is created.

Command Modes

Cisco UMG kron-schedule configuration

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

The format for the date is month, day, and then year (for example: 05/302010).

Examples

The following example sets the start date to May 27, 2009:

umg-1# kron-schedule krj1

umg-1(kron-schedule)# start-date 05/27/2009

Related Commands

Command
Description

description (kron schedule)

Configures a description for the kron job.

kron schedule

Creates a new kron schedule and enters kron-schedule configuration mode.

show kron schedules

Displays a list of kron jobs.

show kron schedule detail job

Displays details of a specific kron job.



stop-date (backup-schedule)

To specify the stop date for recurring scheduled backup to occur, use the stop-date command in Cisco UMG scheduled backup configuration mode. Use the no or default form of this command to remove the configuration of the stop date.

stop-date date

no stop-date date

Syntax Description

date

Specifies the end date for the sequence of recurring scheduled backup jobs. The format is MM/DD/YYYY.


Command Default

None.

Command Modes

Cisco UMG scheduled backup configuration (backup-schedule)

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

The format for the date is month, day, and then year (for example: 05/302010).

Examples

The following example sets the end date to May 30, 2009:

umg-1# schedule job 22

umg-1(backup-schedule)# stop-date 05/30/2009

Related Commands

Command
Description

backup schedule

Enters backup-schedule submode.


stop-date (kron-schedule)

To specify the stop date for recurring scheduled kron jobs to occur, use the stop-date command in Cisco UMG kron-schedule configuration mode. There is no no form of this command.

stop-date date

Syntax Description

date

Specifies the stop date for the sequence of recurring scheduled kron jobs. The format is MM/DD/YYYY.


Command Default

None.

Command Modes

Cisco UMG kron-schedule configuration

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

The format for the date is month, day, and then year (for example: 05/302010).

Examples

The following example sets the stop date to May 30, 2009:

umg-1# kron schedule krj1

umg-1(kron-schedule)# stop-date 05/30/2009

Related Commands

Command
Description

kron schedule

Enters kron-schedule configuration mode.

show backup schedule detail job

Shows details for the specified recurring scheduled kron job.