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

Table Of Contents

L

license clear

license comment

license install

license modify priority

license revoke

license save

log console

log console monitor

log server address

log trace boot

log trace buffer save


L


Last Updated: November 17, 2010

license clear

license comment

license install

license modify priority

license revoke

license save

log console

log console monitor

log server address

log trace boot

log trace buffer save

license clear

To remove one or more licenses information from your device, use the license clear feature command in Cisco UMG EXECmode.

license clear feature name

Syntax Description

feature name

Specifies the feature name.


Command Default

None.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command enables you to remove the license entry from your device.

Examples

The following example shows how to clear the license for a feature:

umg-1# license clear SRSV

Feature: SRSV

1 License Type: Evaluation

License State: Active, Not in Use, EULA accepted

Evaluation total period: 4 weeks 2 days

Evaluation period left: 4 weeks 2 days

License Addition: Additive

License Count: 2

Comment:

Store Index: 4

Store Name: Primary License Storage


Are you sure you want to clear? (yes/[no]): yes



Note The application will evaluate the changes in the next reboot.



Related Commands

Command
Description

license comment

Adds or deletes a comment for a specific license.

license modify priority

Modifies the license priority information.


license comment

To add or delete a comment for a specific license, use the license comment command in Cisco UMG EXECmode.

license comment {add | delete} feature-name comment-string

Syntax Description

add

Adds the comment to the feature.

delete

Deletes the comment from the feature.

feature-name

Specifies the feature name.

comment-string

Specifies a text description of the comment string.


Command Default

None.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command enables you to add or delete comments for a specific license line. This can be done only for the installed licenses.

Examples

The following example adds a comment to the license:

umg-1# license comment add SRSV test

Feature: SRSV

1 License Type: Evaluation

License State: Active, Not in Use, EULA accept

Evaluation total period: 4 weeks 2 days

Evaluation period left: 4 weeks 2 days

License Addition: Additive

License Count: 2

Comment:

Store Index: 4

Store Name: Primary License Storage


% Success: Adding comment "test" succeeded


Related Commands

Command
Description

license clear

Clears the license information from your system.

license modify priority

Modifies the license priority information.


license install

To install the licenses, use the license install command in Cisco UMG EXEC mode.

license install URL

Syntax Description

URL

Specifies the URL of the license file. FTP /TFTP are the supported protocol.


Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

This command enables you to install the license stored in a license file.

Examples

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

umg-1# license install ftp://192.1.1.53/lic/nme-159/nme-159.lic 
Installing...Feature:VMIVR-IVR-SESS...Successful:Supported 

License Note: 

Application will evaluate this change upon next reload 

Installing...Feature:VMIVR-VM-MBX...Successful:Supported 

License Note: 

Application will evaluate this change upon next reload 

Installing...Feature:TCV-USER...Successful:Supported 

License Note: 

Application will evaluate this change upon next reload 

Installing...Feature:VMIVR-PORT...Successful:Supported 

License Note: 

Application will evaluate this change upon next reload 

4/4 licenses were successfully installed 

0/4 licenses were existing licenses 

0/4 licenses were failed to install 

The installation process does not install duplicate licenses. The following message is displayed when duplicate licenses are detected:

Installing...Feature:xxx-xxx-xxx...Skipped:Duplicate 

Related Commands

Command
Description

license clear

Clears the license information from your system.

license modify priority

Modifies the license priority information.

show license all

Displays the summary of all of the licenses installed.

show license detail

Displays the details of the installed license.



license modify priority

To modify the license priority information, use the license modify priority command in Cisco UMG EXECmode.

license modify priority feature name {high | low}

Syntax Description

feature name

Indicates the Cisco UMG license name. Valid values are srst, srsv or vpim.

high

Sets the license priority level to high.

low

Sets the license priority level to low.


Command Default

None.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command enables you to modify the license priority level. This command lists all the expiring licenses that are available for the specified feature and you can change the priority level to be the highest for the selected license.

Examples

The following example shows how to change the license priority level:

umg-1# license modify priority srsv high

Feature: TCV-USER

Index: 1 License type : Evaluation

Lock type : Locked

License Count : 2

License Priority: Low


Are you sure you want to modify priority? (yes/[no]): yes



Note The application will evaluate the changes in the next reboot.


Related Commands

Command
Description

license revoke

Revokes the license.

license save

Saves the license and device credential information.

show license all

Displays the summary of all of the licenses installed.

show license detail

Displays the details of the installed license.


license revoke

To revoke the license, use the license revoke command in Cisco UMG EXECmode.

license revoke URL URL

Syntax Description

URL

Specifies the URL path for the permission ticket file.

URL

Specifies the URL path for the destination to rehost ticket file


Command Default

None.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

This command enables you to revoke the license. Rehost operation has multiple steps, which helps in moving a license from Source device (X) to a Target device (Y).

To revoke the license, perform the following steps:

1. To enable the revoke, obtain a permission ticket from the SWIFT portal and save it on the FTP (TFTP) server which is accessible to the module.

2. Enter the license revoke command, a grace period license is issued and accept the EULA for this grace license.

3. After the EULA is accepted, a Revocation ticket is generated as a result of the revoke operation.

4. To complete the Rehost operation, submit the Revocation ticket to the SWIFT portal to obtain a new license file that can be installed on a target device Y.

For example, permanent licenses of 225 count exist for MBX feature. Now permission ticket of 100 count is obtained from SWIFT to revoke 100 count out of 225 counts.

After installing the 225 count Grace (Extension) license, the remaining count of 125 count permanent license is installed as part of revoke operation.

Examples

The following example shows how to revoke the licenses:


umg-1# show license detail CUMG-SRST-NODE

Feature: CUMG-SRST-NODE         Period left: Life time
Index:  1       Feature: CUMG-SRST-NODE                    Version: 1.0
        License Type: Permanent
        License State: Active, In Use
        License Count: 650 /600
        License Priority: Medium
        Store Index: 1
        Store Name: Primary License Storage
Index:  2       Feature: CUMG-SRST-NODE                    Version: 1.0
        License Type: Evaluation
        License State: Inactive
            Evaluation total period:  8 weeks  4 days
            Evaluation period left:  6 weeks  0 day
        License Count: 1000 / 0
        License Priority: Low
        Store Index: 1
        Store Name: Evaluation License Storage



umg-1# license revoke ?
  URL               URL of the permission ticket

umg-1# license revoke ftp://10.xx.xx.195/LIC-FILES/VEGA/FHH12460003_1000-SRST-NODE.lic-PT?
  URL               URL destination for rehost ticket

umg-1# license revoke ftp://10.xx.xx.195/LIC-FILES/VEGA/FHH12460003_1000-SRST-NODE.lic-PT 
ftp://10.1.1.1/permissionticketfile-100MBX 
Following Permanent license(s) will be installed on this device
        Feature Name: 1000-SRST-NODE :Count = 125

PLEASE  READ THE  FOLLOWING TERMS  CAREFULLY. INSTALLING THE LICENSE OR
LICENSE  KEY  PROVIDED FOR  ANY CISCO  PRODUCT  FEATURE  OR  USING SUCH
PRODUCT  FEATURE  CONSTITUTES  YOUR  FULL ACCEPTANCE  OF  THE FOLLOWING
TERMS. YOU MUST NOT PROCEED FURTHER IF YOU ARE NOT WILLING TO  BE BOUND
BOUND BY ALL THE TERMS SET FORTH HEREIN.
You hereby  acknowledge  and  agree that  the  product feature  license
is terminable and that the product  feature  enabled  by  such  license
may  be  shut  down or  terminated by  Cisco  after  expiration of  the
applicable  term  of  the license  (e.g., 30-day  trial  period). Cisco
reserves the  right to terminate or shut down  any such product feature
electronically  or by  any other  means available. While alerts or such
messages  may  be provided, it is  your sole  responsibility to monitor
your terminable  usage of any  product  feature enabled by  the license
and to ensure that your systems and  networks are prepared for the shut
down of the product feature. You acknowledge  and agree that Cisco will
not have any liability  whatsoever for  any damages, including, but not
limited to, direct, indirect, special, or consequential damages related
to any product  feature  being shutdown or terminated. By clicking  the
"accept" button  or typing "yes" you are  indicating  you have read and
agree to be bound by all the terms provided herein.
ACCEPT? [yes/no]: yes
License Note:
Application will evaluate this change upon next reload
Application will evaluate this change upon next reload
Rehost ticket saved ..... to ftp://10.1.1.1/permissionticketfile-1000-SRST-NODE

Related Commands

Command
Description

license save

Saves the license and device credential information.

license install

Installs the license on your system.

show license all

Displays the summary of all the licenses installed.

show license detail

Displays the details of the installed license.


license save

To save a copy of the all the licenses installed, use the license save command in Cisco UMG EXEC mode.

license save {credential | URL} URL

Syntax Description

credential

Saves the device credential information.

URL

Defines the URL destination path for the license file.

URL

Defines the URL destination path for saving the device credential information.


Command Default

None.

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

8.0

This command was introduced.


Usage Guidelines

The command enables you to saves a copy of the all the licenses installed in the license storage to a specified file. These licenses include all node locked licenses which are installed on a device and it does not include the evaluation licenses

Examples

The following example shows how to save the license installed on your device:

umg-1# license save credential ftp://anonymous:guest@10.86.26.195/NME-Credential 
Device credential saved ..... to ftp://anonymous:guest@10.86.26.195/NME-Credential

umg-1# license save ftp://anonymous:guest@10.86.26.195/License-Copy  
license lines saved ..... to ftp://anonymous:guest@10.86.26.195/License-Copy

Related Commands

Command
Description

license revoke

Revokes the license.

license clear

Clears the license information from your system.

show license all

Displays a summary of all of the licenses installed.

show license detail

Displays the details of the installed license.



log console

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

log console {errors | info | notice | warning }

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

Syntax Description

errors

Error messages, severity 3

info

Information messages, severity 6

notice

Notices, severity 5

warning

Warning messages, severity 4


Command Default

Only fatal error messages are displayed.

Command Modes

Cisco UMG configuration (config)

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

This command has the same function as the trace command.

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

Examples

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

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

Related Commands

Command
Description

log console monitor

Enables log monitor events for debugging.

log server address

Specifies an external server for saving log messages.

log trace boot

Saves the trace configuration on rebooting.

show logging

Displays console logging options.

show logs

Displays the logs.


log console monitor

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

log console monitor {module {entity {activity}}}

no log console monitor

Syntax Description

module

Trace module values. Can be any combination of the values listed in Table 28 on page 238. Entering all gives information for all the modules.

entity

Entity values. Each module has one or more entity values associated with it. Can be any combination of the values for that particular module. See Table 28 on page 238. Entering all gives information for all the entities.

activity

Activity values. Each entity has one or more activity values associated with it. Can be any combination of the values for that particular entity. See Table 28 on page 238. Entering all gives information for all the activities.


Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Examples

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

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

Related Commands

Command
Description

trace

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


log server address

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

log server address a.b.c.d

no log server address a.b.c.d

Syntax Description

a.b.c.d

IP address hostname of the remote syslog server.


Defaults

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

Command Modes

Cisco UMG configuration (config)

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

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

Examples

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

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

Related Commands

Command
Description

log console

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

log console monitor

Displays system messages on the console.

log trace boot

Saves the trace configuration on rebooting.

log trace buffer save

Saves the current trace information.

show log name

Displays a particular log.

show logging

Shows the types of messages that are displayed on the console

show logs

Shows the existing log files on the Cisco UMG.

show running-config

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


log trace boot

To save the trace settings, use the log trace boot command in Cisco UMG EXEC mode.

log trace boot

Syntax Description

This command has no arguments or keywords.

Command Default

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

Command Modes

Cisco UMG EXEC

Command History

Cisco UMG Version
Modification

1.0

This command was introduced.


Usage Guidelines

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

Examples

The following example illustrates the log trace boot command:

umg-1# log trace boot
umg-1# 

Related Commands

Command
Description

show log name

Displays a particular log.

show logging

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

show logs

Shows the existing log files on the Cisco UMG.

show trace buffer

Displays trace information.

show trace store-prev

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


log trace buffer save

To save the current trace information, use the log trace buffer save command in Cisco UMG EXEC mode.

log trace buffer save

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

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

Examples

The following example illustrates the log trace buffer save command:

umg-1# log trace buffer save
umg-1

Related Commands

Command
Description

log trace boot

Saves the trace configuration on rebooting.

show log name

Displays a particular log.

show logging

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

show logs

Shows the existing log files on the Cisco UMG.

show trace buffer

Displays trace information.

show trace store-prev

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