Table Of Contents
MPSM Licensing
MPSM Licensing Information
MPSM License Overview
MPSM License Concepts and Terms
PXM License Pool
Displaying License Data
Displaying All Node Licenses
Displaying Licenses for a Specific MPSM Card Type
Displaying the License Usage for All Cards
Displaying Licenses for All Cards
Displaying the License Usage for a Specific Card
Displaying a History of License Updates
Displaying License Alarms
Adding Licenses Purchased from Cisco.com
Moving Licenses from an MPSM Card to the Switch
Allocating Feature Licenses to a Card
Recovering Feature Licenses That are Not In Use
Saving and Restoring the License Configuration
Transferring Licenses Between Switches
MPSM License Alarms
Node License Alarm
Slot License Alarms
Rekeying Feature Licenses
MPSM Licensing
MPSM Licensing Information
The multiprotocol service module (MPSM) family of cards includes the MPSM-T3E3-155 and MPSM-8T1E1 service modules. With proper licensing, these cards can provide multiple services or features. The MPSM provides these services and features with the same hardware and same runtime firmware image using License Management. License Management is a software component that grants and enforces the use of licensed services. This appendix explains License Management functions and procedures.
This appendix is organized as follows:
•
MPSM License Overview
•
MPSM License Concepts and Terms
•
PXM License Pool
•
Displaying License Data
•
Adding Licenses Purchased from Cisco.com
•
Moving Licenses from an MPSM Card to the Switch
•
Allocating Feature Licenses to a Card
•
Recovering Feature Licenses That are Not In Use
•
Saving and Restoring the License Configuration
•
MPSM License Alarms
•
Rekeying Feature Licenses
MPSM License Overview
This appendix will help you with the following five MPSM licensing scenarios:
•
You purchase MSPM cards and licenses as part of an initial chassis purchase. The license(s) will ship to you loaded on the PXM card.
•
You purchase spare MPSM cards with licenses loaded.
•
You purchase MPSM license(s) only, with no hardware.
•
You need to transfer MPSM license(s) from one MGX node to another.
•
You need to have MPSM licenses that are in an alarm state rekeyed.
Note
You can purchase MGX systems, spares, and MPSM licenses from www.cisco.com, specifically, http://www.cisco.com/order/apollo/configureHome.html.
Tip
Licensed services are new for MGX switches. Although available licenses are summarized in Table F-1, please read this whole appendix to become familiar with the terms and processes used for MPSM licensing. For example, if your shelf goes into Node License Alarm, you will have a 5-day grace period in which to recover licenses without interrupting service. After you read this whole appendix, you will be comfortable with the licensing and rekeying process. If you need additional assistance, please contact licensing@cisco.com.
Table F-1 lists the MPSM licenses that can be purchased for the MPSM8-T1E1 and MPSM-T3E3-155 cards.
Table F-1 Available Licensed Services for MPSM8-T1E1 and MPSM-T3E3-155 Cards
Name of Licensed Service
|
Product ID of Licensed Service for MPSM-8-T1E1 Card
|
Product ID of Licensed Service for MPSM-T3E3-155 Card
|
Description
|
Multiservice
|
—
|
MPSM-MS-HS-LIC(=)
|
The Multiservice License allows simultaneous provisioning of both ATM and Frame Relay connections on the MPSM-T3E3-155 module.
One license of this type is required by a licensable service module.
|
RateControl
|
MPSM-RC-8-LIC (=)
|
MPSM-RC-HS-LIC(=)
|
MPSM-8-T1E1: The Rate Control license provides either Standard ABR or Foresight features to Frame Relay connections on the MPSM-8-T1E1 card.
MPSM-T3E3-155: The Rate Control License allows the use of Standard ABR feature for Frame Relay connections.
One Rate Control license is required by a licensable service module.
|
Channelization
|
—
|
MPSM-CH-HS-LIC(=)
|
Channelization License allows the physical port to support multiple DS0s for Frame Relay service and/or DS1s for ATM service.
One license of this type is required by a licensable service module.
|
Multilink
|
—
|
MPSM-ML-HS-LIC(=)
|
This license covers multilink features, which includes IMA (Inverse Multiplexing for ATM).
One license of this type is required by a licensable service module.
|
Licenses are installed on the PXM card and form a pool of licenses that is managed by the PXM controller. Licenses are authorized for a specific backplane serial number. (You cannot move licensed PXM cards to different chassis without sending the node into an alarm state.) The licenses can then be allocated to specific slots. When an MPSM card is provisioned, the licenses required for that configuration are allocated to that slot.
Note
Redundant cards require the same licenses as the primary cards they protect. For 1:N redundancy, a redundant card needs one of each type of licence used by the primary cards it protects.
The PXM CLI command, cnflic, can be used to add licenses to the PXM license pool or to transfer licenses from other nodes. The cnflic command gets license information using the encrypted key that was generated by the License Keycutter application on a Cisco server when the license was purchased
The MPSM CLI command, movlic, moves licenses from the MPSM card to the PXM license pool.
Additional commands for managing licenses are dsplicalms, dspliccd, dspliccds, dsplicnodeid, and dsplics. These commands are described in procedures contained in this manual, and explained in greater detail in the Cisco MGX 8850 (PXM45/PXM1E), Cisco MGX 8950, Cisco MGX 8830, and Cisco MGX 8880 Command Reference, Release 5, at http://www.cisco.com/univercd/cc/td/doc/product/wanbu/8850px45/rel5/cmdref/index.htm.
MPSM licenses enable the optional MPSM features listed in Table F-2. These features are enabled whenever a feature license is available in the license pool.
Table F-2 Feature Options for MPSM Services
Licensed Feature
|
MPSM-8T1E1
|
MPSM-T3E3-155
|
ATM
|
Circuit Emulation
|
Frame Relay
|
ATM
|
Frame Relay
|
Rate Control
|
—
|
—
|
X
|
—
|
X
|
Channelization
|
—
|
—
|
—
|
X
|
X
|
Multiservice1
|
—
|
—
|
—
|
X
|
X
|
Multilink2
|
—
|
—
|
—
|
X
|
—
|
These licenses can be installed in the PXM license pool. In a shelf, there may be different MPSM cards that can support the licensed services and features. Licenses for one type of card cannot be used on another type of card. For the MPSM-T3E3-155 card, if no license is allocated to the service module, only the default single service functionality is available on that service module.
MPSM License Concepts and Terms
Table F-3 lists concepts and terms used to explain the MPSM licensing procedure.
Table F-3 MPSM License Concepts and Terms
Concept or Term
|
Description
|
Bulk License Activation file
|
File-based input to a CWM application to automate the process of license activation on multiple MGX nodes
|
Bulk License Registration file
|
File-based input to the license registration web page to facilitate registering multiple licenses on multiple nodes in one transaction
|
CLI
|
Command Line Interface
|
CWM
|
Cisco WAN Manager, Network Management Software for MGX nodes.
|
Digital License Agreement (DLA)
|
Corporate standard format for transporting license keys and associated metadata (PAK and/or RLK, License Agreement, related order information, transactional information)
|
License
|
A license allows the customer to use a certain service supported by the MPSM hardware, e.g., "IMA Service" license.
|
License Certificate
|
A claim certificate containing the PAK number and instructions for how a customer can register the license and obtain the RLK.
|
License Transfer
|
The process of transferring licenses from one MGX node to another. A similar concept is Re-Host.
|
MPSM License Keycutter
|
The Cisco-proprietary algorithm used to generate the MPSM RLK.
|
Node License ID
|
A required input field in the License Registration and License Transfer web pages. It's a combination of the Chassis Serial Number, Node License Sequence Number, and Runtime Firmware Version.
|
Node License Sequence Number
|
A unique number used to identify the license installation sequence on an MGX node. After a license or a set of licenses is installed on a node, this number is incremented.
|
Product Authorization Key (PAK)
|
A serial number that can either activate the software (and associated features) or be a required element to generate an RLK.
|
Registered License Key (RLK)
|
A key that requires specific element(s) in order to be generated, and it is subsequently used to enable the feature(s) supported by the license.
|
Rehost Authorization Key (RAK)
|
An encrypted key generated by the License Keycutter application to allow re-enabling (rekeying) of licenses on a node.
|
Software Licensing Engine (SLICE)
|
The system that will generate PAKs or RLKs based on product requirements.
|
Spare License
|
A license purchased independently from the hardware.
|
Transfer Authorization Key (TAK)
|
An encrypted key generated by the License Keycutter when the customer requests transferring licenses from one node to another. This key is then used on the source MGX node to initiate the transfer.
|
Table F-4 lists the terminology used for managing feature licenses on the MPSM cards.
Table F-4 Feature LIcense Terminology for MPSM Cards
Term
|
Explanation
|
Allocated Licenses
|
To provide a feature or service, a license is acquired by a module from the pool of installed licenses on the node. An acquired license is referred to as allocated to the module.
|
Available Licenses
|
The installed licenses which are not allocated are said to be available in the license pool for use by modules.
|
Encrypted Key
|
A long string of characters generated by the Keycutter application. This string contains all information about purchased licenses as well as the node to which it can be applied.
|
Grace Period
|
Under certain conditions, if a sufficient number of licenses are not available or if licenses are invalid, the system is allowed for certain period of time to run without impacting service. This period is called the Grace Period, and by default it is set to 5 days (120 hours).
Note Within this period, it is responsibility of the system owner to purchase and install the required number of licenses to avoid service degradation after this period has expired.
|
Installed Licenses
|
This refers to the purchased licenses which have been added to the license pool owned by the node. The installed licenses in the license pool can be used by the service modules plugged into the MGX node. Licenses are used by the modules on as-needed basis.
|
License Pool
|
License Pool is a persistent database of all installed licenses owned by an MGX node. Service modules are allocated licenses from this pool to provide services and features. Licenses are added to the pool by installing them on the node using cnflic or movelic CLI commands.
|
Moving Licenses
|
When programmed licenses migrate from a module NVRAM into the license pool and become installed, we refer the process as moving the licenses from a card to the license pool.
|
Needed Licenses
|
These are licenses that are required by an entity (such as a service module) to provide desired services or features. For the entity to operate normally, it must have same number of allocated licenses as needed licenses.
|
Programmed Licenses
|
When the licenses are supplied in the NVRAM of a module, we refer to them as physically programmed licenses. These licenses cannot be allocated to any module, but they can be installed in a node by moving them from NVRAM of the module to the license pool owned by the MGX node.
|
Registering Licenses
|
When licenses are moved from the card's NVRAM to the license pool, the process is also referred to as registering licenses with the node.
|
Rekey License
|
If a licensed shelf database is migrated to another non-native shelf, the licenses become invalid. To revalidate shelf licenses, Rekeying or Rehosting licenses is necessary. The special license that achieves this purpose is the Rekey License. Rekey license is the same as RAK.
|
Transferring Licenses
|
You can migrate installed licenses from one node's license pool to another node's installed pool of licenses. This process is referred to as transferring licenses.
|
PXM License Pool
Figure F-1 illustrates the license pool and the types of items that are stored in it.
Figure F-1 The Switch License Pool
The switch license pool serves as a depository for all licenses installed on a switch. When a card needs to use a license, it checks the license out of the depository and the license becomes unavailable to all other cards while it is checked out. For example, if a standard ABR connection is provisioned on an MPSM-8T1E1 card configured for Frame Relay services, a rate control license in the pool is checked out or allocated to that card. If the ABR connection is removed and no other ports on the card have provisioned standard ABR connections, the rate control feature license is checked back into the license pool and becomes available for other cards.
There are three ways to add licenses to the license pool:
•
If the license is purchased with the MPSM card, use movlic to move the license(s) from the MPSM card to the PXM license pool.
•
If the license is purchased alone—without the MPSM hardware, use cnflic to add the license(s) to the PXM license pool.
•
If you want to move a license from one MGX node to another MGX node, you must transfer the license.
To explain these cases further, if a license is purchased at the same time as the MPSM card, the license can be programmed on the MPSM card. When a license is programmed on an MPSM card, the license is unavailable to that card and all other cards in the switch. To enable use of the license, it must be moved to the switch license pool, which is a database on the PXM card. The MPSM movelic CLI command is used to move programmed licenses from MPSM cards to the PXM license pool.
If you want to add licenses after receiving an MPSM card, you can purchase them using the Cisco.com website. Licenses that are purchased on the web site can arrive in the form of an encrypted key in an E-mail message or a file that contains an encrypted key. The PXM cnflic command is used with the encrypted key or license file to add licenses to the PXM license pool.
When a license is checked out, the switch records the assignment of the feature to a card and enables the feature on the card. The license remains in the license pool until explicitly removed. The only way to safely remove a license from the pool is to explicitly transfer it to another switch.
Displaying License Data
Display commands allow you to view node license data, card license data, or license history data. The following sections describe ways to view the license data.
Displaying All Node Licenses
To display all node licenses, enter the dsplics command as follows:
M8830_CH.1.PXM.a > dsplics
M8830_CH System Rev: 04.09 Mar. 08, 2004 00:15:51 GMT
MGX8830 Node Alarm: CRITICAL
Licensed License Licenses Licenses Licenses
Card Type Type Installed Allocated Available
----------------- ----------- --------- --------- ---------
MPSM-T3E3-155 MultiSrvc 4 1 3
This command displays all the license data on the node for all MPSM card types. It also shows how many licenses are in use and how many are available.
Displaying Licenses for a Specific MPSM Card Type
To display the license usage for a specific MPSM card type, enter the dsplics -cd command as follows:
M8830_CH.1.PXM.a > dsplics -cd 3
M8830_CH System Rev: 04.09 Mar. 08, 2004 00:08:45 GMT
MGX8830 Node Alarm: CRITICAL
Licensed License Licenses Licenses Licenses
Card Type Type Installed Allocated Available
----------------- ----------- --------- --------- ---------
MPSM-T3E3-155 MultiSrvc 4 1 3
The number in the command specifies the MPSM card type which must be one of the following:
•
MPSM-8-T1E1 = 1
•
MPSM-T3E3-155 = 3
The dsplics -cd command displays the same information as the dsplics, command, but it limits the display to a single card type.
Displaying the License Usage for All Cards
To display the license usage for all cards in a switch, enter the dspliccds command as follows:
M8830_CH.1.PXM.a > dspliccds
M8830_CH System Rev: 05.00 Apr. 11, 2004 19:08:26 GMT
MGX8830 Node Alarm: CRITICAL
Card Lic Prov License Allocated
Slot Card Type Alarm Allowed Type Licenses
---- ----------------- -------- ------- ----------- ---------
12 MPSM-T3E3-155 No Yes Channelize 1
Note
Redundant cards require the same licenses as the primary cards they protect. For 1:N redundancy, a redundant card needs one of each type of licence used by the primary cards it protects.
Displaying Licenses for All Cards
The dspliccds command displays the total licenses allocated or programmed on all cards. The dspliccds command is a non-privileged command and is available on the PXM45 and PXM1E cards.
Note
To get detailed information for a specific card, use dspliccd command for a particular slot.
The following example displays licenses of all cards.
MGX8850.7.PXM.a>dspliccds
Mynode19 System Rev: 04.00 Feb. 27, 2003 17:28:26 GMT
Chassis Serial No: SAA02390010 Chassis Rev: E4 GMT Offset: 0
Card Card Lic Prov License Alloc
Slot Type Alarm Status Type lics
---- ------------- -------- ------ ------- ----
3 MPSM-T3E3-155 No Yes MultiSrvc 1
4 MPSM-T3E3-155 Minor Yes MultiSrvc 1
5 MPSM-T3E3-155 Minor No MultiSrvc 1
6 MPSM-T3E3-155 No Yes -- --
10 MPSM-8T1E1 No Yes RateControl 1
11 MPSM-8T1E1 No Yes -- --
12 MPSM-8T1E1 No Yes RateControl 1
12 MPSM-16T1E1 No Yes MultiSrvc 1
The following example displays programmed licenses of all cards.
MGX8850.7.PXM.a> dspliccds -prog
Mynode19 System Rev: 04.00 Feb. 27, 2003 17:28:26 GMT
Chassis Serial No: SAA02390010 Chassis Rev: E4 GMT Offset: 0
Card Licenses License Programmed
Slot Type Moved Type lics
---- ------------- -------- ------- ----------
3 MPSM-T3E3-155 No MultiSrvc 1
4 MPSM-T3E3-155 Yes MultiSrvc 1
5 MPSM-T3E3-155 Yes MultiSrvc 1
6 MPSM-T3E3-155 N/A -- --
10 MPSM-8T1E1 No RateControl 1
12 MPSM-8T1E1 Yes RateControl 1
Displaying the License Usage for a Specific Card
To display the license usage for a single card within a switch, enter the dspliccd command on either the PXM or the MPSM. The following example shows how the display appears when the command is run from a PXM card:
M8830_CH.11.PXM.a > dspliccd 11
M8830_CH System Rev: 04.00 Feb. 27, 2003 17:28:26 GMT
Chassis Serial No: SAA02390010 Chassis Rev: E4 GMT Offset: 0
Card License Alarm: Minor
Service Module Type: MPSM-T3E3-155
Service Module Serial Number: 3SA4567011
Provisioning allowed: Yes
Grace-Period Remaining: 3 Days 4 Hours
=========================================================
Allocated License Type Qty
---------------------- ----
=========================================================
Programmed License Type Qty
----------------------- ----
=========================================================
Programmed Licenses Registered: YES
License Registration Node: MyNodeBuilding3
License Registration Chassis Serial No: 8SA931247821
License Creation Timestamp: Oct 25, 2003 14:20:40
License Registration Timestamp: Dec 02, 2003 19:33:12
=========================================================
In the example above, the following states might occur:
•
If the grace period has already expired, the following output displays:
Provisioning allowed: No
Grace-Period Status: Expired
•
If the slot is running normally without a license alarm, only the following output displays:
Provisioning allowed: Yes
The number after the dspliccd command is the slot number for which you want to display license data.
An allocated license is one that has been assigned to a card. A programmed license is a license that has been shipped on a card from the factory. It must be moved to the license pool before it can be allocated to a card.
In the next example, the dspliccd command is run from an MPSM card, so you do not have to enter the slot number:
M8830_CH.12.MPSM155[FR].a > dspliccd
Service Module Type: MPSM-T3E3-155
Service Module Serial Number: SAD073504CT
Provisioning (addcon) Allowed: YES
=========================================================
Needed License Type Needed Licenses
------------------- ---------------
=========================================================
Allocated License Type Allocated licenses
---------------------- ------------------
=========================================================
Programmed License Type Programmed licenses
------------------------ -------------------
=========================================================
Programmed License Registered: YES
License registration node: M8830_CH
License registration chassis: 8SA931247821
=========================================================
In the example above, a needed license is a license that is required by the MPSM card to provide a desired feature.
Displaying a History of License Updates
To display a history of all license updates on the switch, enter the dsplics -history command as follows:
M8830_CH.1.PXM.a > dsplics -history
M8830_CH System Rev: 04.09 Mar. 08, 2004 00:20:22 GMT
MGX8830 Node Alarm: CRITICAL
Licensed Chassis or Update Update License
CardType Card Serial# Method Sequence# Update Time
---------------- ------------ -------- --------- -----------
MPSM-T3E3-155 SAG06152SZM Addition 1 WED OCT 08 19:58:54 2003
Displaying License Alarms
To display a list of license feature alarms, enter the dsplicalms command as follows:
M8830_CH.1.PXM.a > dsplicalms
M8830_CH System Rev: 04.09 Mar. 08, 2004 00:20:59 GMT
MGX8830 Node Alarm: CRITICAL
Slot Critical Major Minor || Slot Critical Major Minor
---- -------- ------- ------- || ---- -------- ------- -------
Adding Licenses Purchased from Cisco.com
Purchased licenses are delivered in the form of an encrypted key, which appear within an E-mail message or within a text file attached to an E-mail. When ordering additional licenses, you must provide the back plane serial number for the switch that will host the licenses. The output generated by the dsplicnodeid command is part of the encryption key.
The general procedure is as follows:
1.
Purchase additional licenses from Cisco.com and receive a Product Authorization Key (PAK) by mail.
2.
Collect the serial number used for licensing from the destination switch.
3.
Using Cisco.com, the PAK, and the destination switch serial number, generate a license key for the destination switch.
4.
Move the new license key to the destination switch.
5.
Apply the new license on the destination switch.
The following procedure describes how to obtain the back plane serial number so that you can purchase licenses, and it describes how to install licenses when you receive them.
Step 1
Establish a configuration session using a user name with SERVICE_GP privileges or higher.
Step 2
Purchase additional licenses from Cisco.com. After you purchase additional licenses, a Product Authorization Key (PAK) will be mailed to you.
Step 3
To display the switch serial number used for licensing, enter the dsplicnodeid command. If no licenses have been installed, the switch will generate a node license ID as shown in the following example:
M8850_SF.7.PXM.a > dsplicnodeid
The BkPL recorded Lic Seq Num did not exist. Creating with 0.
NodeID=SCA062300GF:000000:004:009:015
If the switch has an existing node license ID, it is displayed as follows:
M8850_SF.7.PXM.a > dsplicnodeid
NodeID=SCA062300GF:000001:004:009:015
Step 4
To generate a license key on Cisco.com, go to the web page specified in the "MPSM License Overview" section.
At this web page, you must specify the PAK and the licenses you want to install, and you must specify the serial number collected in Step 2. After you arrange for additional licenses, you will receive an encrypted key in an E-mail message and in a license file attachment. The key contains the new license information for the destination switch.
•
If you plan to install the new license on the destination switch using the new license file, go to Step 6.
•
If you plan to install the licenses using the encrypted key sent in the E-mail message, go to Step 5.
Step 5
To install a license using a license file, FTP that file to the C:/LICENSE directory on the destination switch. Enter the cnflic command using the following syntax:
M8850_SF.7.PXM.a > cnflic -f filename
Replace filename with the name of the file provided by Cisco.com as shown in the following example:
M8850_SF.7.PXM.a > cnflic -f Lmpsmoc3_20040615113118099.dat
Update method : Addition
Card type : MPSM-T3E3-155
Creation date/time : TUE JUN 15 10:31:18 2004
Grace period (days) : 0
Update sequence number: 6
Licence serial number : L0000003878
Num of features : 4
--------------- -----
License Type Qty
--------------- -----
MultiSrvc 1
Channelize 1
RateControl 1
MultiLink 1
Please confirm the above licence information.
cnflic: Do you want to proceed (Yes/No)? y
M8850_SF.7.PXM.a >
Note
Skip to Step 7.
Step 6
To install a license using an encrypted license key, copy the license key from the E-mail and enter the cnflic command using the following syntax:
M8850_SF.7.PXM.a > cnflic licenseString
Replace licenseString with the encrypted key supplied in the E-mail message as shown in the following example:
M8850_SF.7.PXM.a > cnflic
01050004cbf7420c534f5e21b97754bdb81da8862607040eebc5702aa37cc1e1c5d4e9b00ea6c89c13f1e50df0
2dc8b374f42e84bf96fd1af672fe571a98ae1bf411d3b4dbd
Update method : Addition
Card type : MPSM-T3E3-155
Creation date/time : TUE JUN 15 10:17:39 2004
Grace period (days) : 0
Update sequence number: 5
Licence serial number : L0000008633
Num of features : 4
--------------- -----
License Type Qty
--------------- -----
MultiSrvc 1
Channelize 1
RateControl 1
MultiLink 1
Please confirm the above licence information.
cnflic: Do you want to proceed (Yes/No)? y
M8850_SF.7.PXM.a >
Step 7
To verify that new licenses have been installed, enter the dsplics command.
Caution 
To avoid losing licenses during a configuration restoration, save the switch configuration after installing the new licenses by using the
saveallcnf command.
Step 8
Enter the saveallcnf command.
Moving Licenses from an MPSM Card to the Switch
To move programmed licenses from an MPSM card to the switch license pool, use the cc command to move to the CLI prompt for the MPSM card. Then enter the movelic command as follows:
M8250_SJ.1.22.MPSM8T1.FRM.a > movelic
------------------------------------------------
Programmed License Type #Programmed
----------------------- -----------
Do you want to proceed (Yes/No)? Yes
Card Licenses have been moved to license pool.
M8250_SJ.1.22.MPSM8T1.FRM.a >
Note
The movelic command requires SERVICE_GP privileges.
In the above example, the movelic command moved all licenses programmed into the NVRAM on the MPSM card into the PXM license pool. Licenses can be moved only once from a card to a license pool. Licenses cannot be moved back to an MPSM card. If you want to transfer licenses to another switch, see "Transferring Licenses Between Switches."
Caution 
To avoid losing licenses during a configuration restoration, save the switch configuration after moving the new licenses into the PXM license pool by using the
saveallcnf command.
Allocating Feature Licenses to a Card
To allocate a feature license to an MPSM card, configure the card to use the licensed feature. For example, to allocate the IMA feature to a card, use the addimagrp command to create an IMA group. Licenses are also allocated to redundant cards, so if you use the addred command to configure a secondary card for a primary card, licenses are allocated to the secondary card. When the secondary card serves multiple primary cards, the secondary card receives one of each type of license used by the primary cards it serves.
If the license pool on the switch has an available license for that feature on the MPSM card type, the license is automatically allocated to the card. Once a license is allocated to the card, it is no longer available for use on other cards until it returns to the license pool (See "Recovering Feature Licenses That are Not In Use").
If you configure a card to use a feature for which no licenses are available, the command that requires the feature will fail.
Recovering Feature Licenses That are Not In Use
Feature licenses are automatically returned to the license pool when the card configuration no longer requires them. The following actions can be used to remove the configuration for featured licenses:
•
Use the CLI commands to remove the feature configuration. For example, if you delete all channelized ports (delport) on a card, the channelized feature is no longer required and will be returned to the license pool.
•
Clear the entire configuration on the service module (clrsmcnf).
•
Clear the entire configuration on the switch (clrallcnf).
•
Delete a redundant card configuration. This action releases any licenses reserved for the secondary card, provided that those licenses are no longer required for other primary cards.
When licenses are returned to the license pool, they are immediately available for use on other MPSM cards.
Saving and Restoring the License Configuration
MPSM feature licenses are backed up and restored with the complete switch configuration as described in the "Managing the Configuration Files" section in Chapter 9, "Switch Operating Procedures".
Caution 
To avoid losing feature licenses, always save the switch configuration after you move, transfer, or add licenses, by using the
saveallcnf command.
Transferring Licenses Between Switches
When you transfer licenses between switches, you are removing one or more licenses from one switch for use on another switch. To transfer licenses between switches, you will need to get a transfer license from Cisco.com. The general procedure is as follows:
1.
Collect the switch serial numbers used for licensing from the source and destination nodes.
2.
Using Cisco.com, enter the output generated by the dsplicnodeid command, specify the licenses to transfer, and obtain a transfer license.
3.
Move the transfer license to the source switch.
4.
Apply the transfer license on the source switch to remove the desired licenses and obtain a new license key and file that can be applied on the destination switch.
5.
Transfer the new license to the destination switch.
6.
Apply the new license on the destination switch.
The following procedure provides instructions for transferring licenses between switches.
Step 1
Establish a configuration session with the source and destination switches using a user name with SERVICE_GP privileges or higher.
Step 2
To display the switch serial number used for licensing on the source switch, enter the dsplicnodeid command.
M8850_SF.7.PXM.a > dsplicnodeid
NodeID=SCA062300GF:000001:004:009:015
Step 3
To display the switch serial number used for licensing on the destination switch, enter the dsplicnodeid command.
M8850_SF.7.PXM.a > dsplicnodeid
NodeID=SCA062300GF:000001:004:009:020
Step 4
To request a transfer license from Cisco.com, go to the URL specified in the URL in the "MPSM License Overview" section.
At the license transfer web page, specify the serial numbers you collected in Step 2 and Step 3, and specify the licenses to transfer. After you arrange for a transfer license, you will receive an encrypted key in an E-mail message and in a license file. The encrypted key contains the license transfer information for the specified source and destination switches. Before you can apply the transfer license at the source switch, you must either copy the key from the E-mail message to the switch, or copy the file to the switch.
•
If you plan to install licenses using the encrypted key in the E-mail message, go to Step 5.
•
If you plan to apply the transfer license using the transfer license file, go to Step 6.
Step 5
To apply the transfer license using the key in the E-mail from Cisco.com, copy the key from the E-mail, and enter the cnflic command on the source switch, using the following syntax:
M8850_SF.7.PXM.a > cnflic licenseString
Replace licenseString with the encrypted key supplied in the E-mail message as shown in the following example:
M8850_SF.7.PXM.a > cnflic
01050004fec28e9e8ab1110f48be83e0d2397cb4048d7c368c53c825c15e9245d5886357eac618012a8b515d1c
3fa29a8f35476b28331ca12b1bef166dc7c0bafc01d9e0b36
Update method : Xfer-out
Card type : MPSM-T3E3-155
Creation date/time : TUE JUN 15 10:40:55 2004
Grace period (days) : 0
Update sequence number: 7
Licence serial number : L0000003912
Num of features : 4
--------------- -----
License Type Qty
--------------- -----
MultiSrvc 1
Channelize 1
RateControl 1
MultiLink 1
Please confirm the above licence information.
cnflic: Do you want to proceed (Yes/No)? y
Licence file has been generated as: C:/LICENSE/LX-M8850_NY-7.lic
Licence is:
0105000443e166180e7a310f483833a54079b77eb217332057c3d2fbaa4e9245def5aad5558458d6ab2f6bc64a
6c0441839dbdbb43e02aa7a179facb8e058de821e270a233ce87c3
M8850_SF.7.PXM.a >
This step removes the licenses identified for transfer from the license pool, and these licenses are no longer available for use on the source switch. To verify that transferred licenses have been removed from the source switch, enter the dsplics command.
This step also generates a new license key and a new license file, which can be used to install the removed licenses on the destination switch. The license key appears in the command output. The license file is stored in the C:/LICENSE directory.
Note
Go to Step 7.
Step 6
To apply the transfer license using the key in the license file attached to the E-mail from Cisco.com, FTP that file to the C:/LICENSE directory on the switch, and enter the cnflic command on the source switch, using the following syntax:
M8850_SF.7.PXM.a > cnflic -f filename
Replace filename with the name of the license file provided by Cisco.com as shown in the following example:
M8850_SF.7.PXM.a > cnflic -f Lmpsmoc3_20040615114539410.dat
Update method : Xfer-out
Card type : MPSM-T3E3-155
Creation date/time : TUE JUN 15 10:45:39 2004
Grace period (days) : 0
Update sequence number: 8
Licence serial number : L0000008916
Num of features : 4
--------------- -----
License Type Qty
--------------- -----
MultiSrvc 1
Channelize 1
RateControl 1
MultiLink 1
Please confirm the above licence information.
cnflic: Do you want to proceed (Yes/No)? y
Licence file has been generated as: C:/LICENSE/LX-M8850_NY-8.lic
Licence is:
0105000451ee9dc73e426022d432745064f747169cd393f4a8c5238cfe5ac0166765c9ea6428276a01df3225df
ac9aadf17951b2972bb2acf0950fda2a57892fe6e3ec93e1a26e16
M8850_SF.7.PXM.a >
This step removes the licenses identified for transfer from the license pool, and these licenses are no longer available for use on the source switch. To verify that transferred licenses have been removed from the source switch, enter the dsplics command.
This step also generates a new license key and a new license file, which can be used to install the removed licenses on the destination switch. The license key appears in the command output. The license file is stored in the C:/LICENSE directory.
Note
To install the new license(s) using the encrypted key produced in Step 5 or Step 6, go to Step 7
To install the new license(s) on the destination switch using the new license file produced in Step 5 or Step 6, go to Step 8.
Step 7
To install the new license(s) on the destination switch using the key displayed on the source switch, copy the key and enter the cnflic command with the key generated from the source switch:
M8850_SF.7.PXM.a > cnflic
0105000443e166180e7a310f483833a54079b77eb217332057c3d2fbaa4e9245def5aad5558458d6ab2f6bc64a
6c0441839dbdbb43e02aa7a179facb8e058de8213
Update method : Xfer-in
Card type : MPSM-T3E3-155
Creation date/time : TUE JUN 15 18:40:55 2004
Grace period (days) : 0
Update sequence number: 4
Licence serial number : L0000003912
Num of features : 4
--------------- -----
License Type Qty
--------------- -----
MultiSrvc 1
Channelize 1
RateControl 1
MultiLink 1
Please confirm the above licence information.
cnflic: Do you want to proceed (Yes/No)? y
M8850_SF.7.PXM.a >
Note
Skip to Step 9.
Step 8
To install the new license on the destination switch using the key in the new license file generated from the source switch, FTP that file to the C:/LICENSE directory on the destination switch enter the cnflic command using the following syntax:
M8850_SF.7.PXM.a > cnflic -f filename
Replace filename with the name of the file transferred from the source switch as shown in the following example:
M8850_SF.7.PXM.a > cnflic -f LX-M8850_NY-8.lic
Update method : Xfer-in
Card type : MPSM-T3E3-155
Creation date/time : TUE JUN 15 18:45:39 2004
Grace period (days) : 0
Update sequence number: 5
Licence serial number : L0000008916
Num of features : 4
--------------- -----
License Type Qty
--------------- -----
MultiSrvc 1
Channelize 1
RateControl 1
MultiLink 1
Please confirm the above licence information.
cnflic: Do you want to proceed (Yes/No)? y
M8850_SF.7.PXM.a >
Step 9
To verify that the transferred licenses have been installed on the destination switch, enter the dsplics command.
Step 10
Enter the saveallcnf command.
Caution 
To avoid losing licenses during a configuration restoration, save the switch configuration at the source and destination switches by using the
saveallcnf command.
MPSM License Alarms
MPSM feature license alarms can occur at the node level or the slot level of the switch. The following sections describe these alarms:
•
Node License Alarm
•
Slot License Alarms
Node License Alarm
Node license alarms occur under the following conditions:
•
A switch configuration that was saved before licenses were added or transferred to and from the PXM license pool has been restored. Any mismatch between the actual license count and the restored license count generates a minor license alarm. To prevent this type of alarm, always save the switch configuration (saveallcnf) after you move, transfer, or add licenses.
•
The switch configuration is restored on a different node, or the Cisco MGX chassis is replaced with another chassis. Because licenses are authorized for a specific backplane serial number, such conditions will cause a mismatch between the physical backplane serial number and serial number recorded in the database.
When a node license alarm is raised, all cards that are using feature licenses go into the slot license alarm state. If no licenses are in use by the cards, no slot license alarms will be raised.
On PXM45 and PXM1E platforms, use the PXM dspndalms command to troubleshoot the node license alarm. As shown in the following example on the PXM45 platform, the output of this command will indicate if the switch is in the node license alarm state:
M8850_SF.8.PXM.a > dspndalms
Alarm Type Critical Major Minor
---------- -------- ------- -------
Node license alarms are cleared by validating licenses in the license pool. This is done by applying the special Rekey feature license to the node using the cnflic command. When the pool licenses are validated, any existing slot license alarms are also cleared and normal operation is restored. For the procedure to rekey feature licenses, see "Rekeying Feature Licenses".
Note
If the switch is in node license alarm, you must rekey the PXM license pool before proceeding with any other license management tasks.
Slot License Alarms
Slot license alarms are raised under the following conditions:
•
When a node license alarm is raised, all cards that are using feature licenses go into the slot license alarm state. Slot license alarms raised under this condition can be cleared by rekeying the PXM license pool. For the procedure to rekey feature licenses, see "Rekeying Feature Licenses".
•
The slot in alarm has acquired or oversubscribed one or more licenses while these licenses were not available in the license pool. Slot license alarms raised under this condition are cleared by adding the required number of licenses to the PXM license pool or by releasing corresponding licenses from other slots so that they become available to the slot in alarm. If slots in alarm have redundancy, you must add licenses to cover both the primary and secondary slots to clear the alarms.
On PXM1E and PXM45 platforms, use the PXM dsplicalms command to troubleshoot slot license alarms. The output of this command will indicate which MPSM cards are in the slot license alarm state. The following example shows the output of the PXM dsplicalms command on the PXM45 platform. In this example, the MPSM card in slot 28 is in slot license alarm:
M8850_SF.8.PXM.a > dsplicalms
M8850_SF System Rev: 05.00 Jul. 10, 2004 04:35:12 GMT
MGX8850 Node Alarm: MINOR
Slot Critical Major Minor || Slot Critical Major Minor
---- -------- ------- ------- || ---- -------- ------- -------
On PXM1E and PXM45 platforms, the output of the PXM dspliccd <slot> command also shows if a card is in slot license alarm, and displays how much time is left in the alarm grace period and if provisioning is allowed with the addcon command. The following example shows the output of the PXM dspliccd <slot> command of an MPSM-8T1-FRM card in a PXM45 platform in the slot license alarm state:
M8850_SF.8.PXM.a > dspliccd 28
M8850_SF System Rev: 05.00 Jul. 10, 2004 05:02:24 GMT
MGX8850 Node Alarm: MINOR
Card License Alarm: Minor
Service Module Type: MPSM-8T1-FRM
Service Module Serial Number: SAG07208RRA
Provisioning Allowed: Yes
Grace-Period Remaining: 4 Days, 22 Hrs
=========================================================
Allocated License Type Quantity
-------------------- --------
=========================================================
Programmed License Type Quantity
-------------------- --------
=========================================================
Programmed License Registered: Yes
License Registeration Node: M8850_SF
License Registeration Chassis Serial No: SCA062300GF
On PXM1E and PXM45 platforms, the dspcd command will indicate if a card is in slot license alarm. If the card is in the slot license alarm state, the cardIntegratedAlarm will be minor and the cardMinorAlarmBitMap will indicate License Alarm. The following example shows the output of the dspcd command of an MPSM-8T1-FRM card in a PXM45 platform in the slot license alarm state:
M8850_SF.1.28.MPSM8T1.FRM.a > dspcd
FunctionModuleState: Active
FunctionModuleType: MPSM-8T1-FRM
FunctionModuleSerialNum: SAG07208RRA
FunctionModuleFWRev: 030.000.004.016-P2
FunctionModuleResetReason: Reset by PXM
LineModuleType: LM-RJ48-8T1
configChangeTypeBitMap: No changes
cardIntegratedAlarm: Minor
cardMinorAlarmBitMap: LICENSE ALARM
PCB PART NO-(800 LEVEL): 800-22480-04
PCB PART_NO-(73 LEVEL): 73-8466-04
PCB REVISION (800 LEVEL):
PCB SERIAL NO: SAG07208RRA
PCB PART NO-(800 LEVEL): 000-00000-00
PCB PART NO-(73 LEVEL): 00-00000-00
PCB REVISION (800 LEVEL): AA
FAB PART NO-(28 LEVEL): 28-02011-01
M8850_SF.1.28.MPSM8T1.FRM.a >
On PXM1E and PXM45 platforms, the output of the MPSM dspliccd command also shows if a card is in slot license alarm. The following example shows the output of the dspliccd command of an MPSM-8T1-FRM card in a PXM45 platform in the slot license alarm state:
M8850_SF.1.28.MPSM8T1.FRM.a > dspliccd
Card License Alarm: Minor
Service Module Type: MPSM8T1E1
Service Module Serial Number: SAG07208RRA
Provisioning (addcon) Allowed: YES
=========================================================
Needed License Type Needed Licenses
------------------- ---------------
=========================================================
Allocated License Type Allocated licenses
---------------------- ------------------
=========================================================
Programmed License Type Programmed licenses