Licensing Features for the Cisco PGW 2200 Softswitch Feature Module

Transcription

1 Licensing Features for the Feature Module Document Release History Publication Date February 27, 2009 November 26, 2008 March 12, 2007 Comments Updated for SIP-I interface license. Updated for Release 9.8 TimesTen in-memory database and SBE interface licenses. Initial version of the document. Feature History Release Modification 9.8(1) Added support for SIP-I interface license. 9.8(1) Added support for TimesTen in-memory database and SBE interface licenses. 9.7(3) Support for Licensing Features for the feature was introduced on the software. This document describes the Licensing Features for the feature. This feature is described in the following sections: Feature Overview, page 2 Supported Platforms, page 7 Prerequisites for Using this Feature, page 8 Installing the License File, page 8 Upgrading to Support This Feature, page 10 Command Reference, page 11 Software Changes for This Feature Module, page 15 Obtaining Documentation and Submitting a Service Request, page 27 Glossary, page 28 1

2 Feature Overview Licensing Features for the Feature Module Feature Overview To manage licenses, the provides the license files that are stored in a directory where the obtains the required license information. The uses the license file to enforce the capacity and features available. Each feature line of the license file is encrypted. Licensing also applies to HSI and BAMS components. The requires a unique license file during the execution of the software. This license file allows the software to be loaded and run on a specified set of active/standby servers. The release 9.8(1) introduces licensing control for TimesTen in-memory database and IP-IP Gateway. The TimesTen license keeps track of the Number Portability and Full Number Translations. The IP-IP Gateway interface license is needed when is used as Session Border Element (SBE) in the Cisco Session Border Controller solution. The terms IP-IP gateway interface licenses and SBE licenses are interchangeable within this document. s of Licenses Base Software License Interface License This feature enables or tracks the usage of four types of license objects in the based on license files: Base Software License, page 2 Interface License, page 2 Configuration-Time Ports License, page 3 Run-Time License, page 3 TimesTen License, page 4 The Base Software License allows the to execute on a specified Sun platform. The license is assigned to a given system. In a standalone configuration, the license is node-locked to the hostid of the machine. In active-standby configuration, the license is node-locked to the hostid of each machine. The license file controls the maximum number of call-legs that are allowed. The licensing feature uses different machine identifications for different machine architectures. All Sun Microsystems machines have a unique hostid, which is a 32-bit integer. On Solaris, you can run the command hostid to get the 32-bit hostid in hexadecimal format. The interface license entitles you to use an interface type on a given system. If you configure that interface type without having a license for it, an alarm, Unlicensed interface configured, appears; calls on that interface are rejected at run time.. The following interfaces are managed at configuration time: INAP interface SS7 interface PBX interface (including DPNSS interface and QSIG interface) 2

3 Licensing Features for the Feature Module Feature Overview PRI interface Legal Intercept interface Configuration-Time Ports License Run-Time License SBE interface (controlled by the H.248 protocol) SIPI interface The use of SIP, BRI, MGCP, QBE, and EISUP interfaces is unrestricted. Call-leg RTU licenses are enforced on the for SIP and H.323. H.323 is supported on the HSI, which communicates to the through EISUP. This license specifies how many TDM ports can be configured in a given system. The license file contains a feature ConfigTimeDescrepencyPeriod that allows the discrepancy between the configured TDM ports and the licensed TDM ports for a duration (45 days) from the time the license file is generated. Within this discrepancy period, the configuration-time ports oversubscription is allowed and the H.323 and SIP run time license control is not enforced. After that, the enforces the configuration time limit at run time. For example, if you configure 10,000 ports but only purchase 8,000 ports license, enforces the license by setting the run-time license number to 8,000. An alarm is always raised in the case of configuration-time ports oversubscription. All the TDM ports (RTUs) are managed by licensing using the following two types: Signaling Mode RTU Call Control Mode RTU TDM ports include the following: Trunking gateway ports (IMT/PRI) usually connected to PSTN Access gateway ports (DPNSS, QSIG, PRI, BRI) usually connected to a PBX The run-time license keeps track of the number of concurrent active TDM ports, SIP call legs, H.323 call legs, or the number of entries in the TimesTen database. You can exceed the run-time license number by only 30 percent; after that, only emergency calls and priority calls are allowed. An alarm, Run-time oversubscription, appears if you use more TDM ports, SIP call legs, or H.323 call legs than the number of licenses. For normal call rejections, the alarm Normal call rejected due to oversubscription appears. To minimize the impact on performance, every day is divided into minute intervals and the alarms are set and cleared at 15-minute intervals. If the calls counter exceeds 130 percent of the license number in the nth interval, an alarm is set in the (n+1)th interval, and normal calls are rejected if the calls counter exceeds 130 percent of the license number at this interval. If no call is rejected in the nth interval, the alarm is cleared in the (n+1)th interval. Note Before the expiration of the ConfigTimeDescrepencyPeriod license feature, no call is rejected. Run-time license control is enforced after the expiration of the ConfigTimeDescrepencyPeriod license feature. For a TDM call, SIP call, or H.323 call rejected due to license issues, the license reject measurements are increased. SeeTable 1 for these measurements. 3

4 Feature Overview Licensing Features for the Feature Module Run-time license management is done on the active. If the call is rejected on the originating side, the call is rejected, and corresponding license-rejecting measurement is updated. If the call is rejected on the outgoing side, the performs cause analysis for a possible reroute. For each license check rejection, the license-rejecting measurement is updated. The counters to entitled licenses are compared to the run-time licenses: If the incoming or outgoing SigPath is not licensed, the call is rejected. If both incoming and outgoing SigPaths are licensed, and the counter (or the summation of counters) is within the run-time license limit, the call is permitted. If you are oversubscribed but still within the oversubscription limit, a corresponding alarm appears in the consequent 15-minute interval. The corresponding counters based on incoming and outgoing Sigpath are increased, and the call is permitted. If the allowed oversubscription limit is exceeded, the call is rejected if it is a normal call. A corresponding alarm appears in the consequent 15-minute interval. Emergency calls and priority calls are counted but they are not rejected. TimesTen License The TimesTen RTU license keeps track of the Number Portability and Full Number Translations. The number of entries taken into account for licensing is the sum of the number of provisioned entries in all licensed database tables. This imposes a constraint on the number of entries in the TimesTen tables PORTEDNUMBERS and FULLNUMBERTRANSLATION. If the sum of PORTEDNUMBERS entries and FULLNUMBERTRANSLATION entries exceeds the license, some calls may fail because of TimesTen database query failure. Calls are rejected based on percentage. For example, if you bought 2000 licenses but there are 4000 entries in the database, then 50 percent of the calls are rejected. You can exceed the run-time license number by only 30 percent; after that, only emergency calls and priority calls are allowed. An alarm, Normal call rejected due to database oversubscription and restricted access to database, appears if you use more database entries than the number of licenses. Note Before the expiration of the ConfigTimeDescrepencyPeriod license feature, no call is rejected. Run-time license control is enforced after the expiration of the ConfigTimeDescrepencyPeriod license feature. Obtaining a License Users with an Existing Contract, page 4 New Contracts, page 6 Users with an Existing Contract Step 1 Order the application SW upgrade license, consisting of Licensing SW, from the top level in the configuration tool (PGW2200-UPG-TO-9.8). licensing objects consist of the following: application SW DS0 RTU license (signaling and call control) 4

5 Licensing Features for the Feature Module Feature Overview Step 2 Step 3 Step 4 Step 5 SIP license H323 license SS7 license PRI license PBX license INAP license LI license SBE interface license SIPI interface license TimesTen RTU license Specify the exact number of licenses you purchased or are using for the above license objects. Cisco analyzes the CDR and configuration data and provides the information related to your traffic pattern. The order is placed on New Product Hold (NPH). Release of the NPH requires: product marketing validates the information against the bookings database. Any discrepancy is resolved by discussion with the account team and/or with you. This might require modification of the order to reflect the eligible number of licenses. The NPH is removed. A software upgrade CD is shipped to you with a Product Authorization Key (PAK). A PAK is a string of characters identifying the product and the order. Obtain the license file from the Cisco license fulfillment web site using the PAK and the hostid. In the server hostname field, enter the hostname of the server machine where the software will run. The hostname is the machine name where the license server will run. If the Softswitch software is to run in standalone mode, the license server runs on the same machine as the software. If the software is to run in active-standby mode, the license server can be on either the primary server machine or the secondary server machine. Note If you apply several times to obtain a license file for the same, be sure to use the same hostname for each license file application. This can happen if you are expanding RTU licenses. If the hostname is different for different license files, you can use only some of the licenses. Note In the active-standby mode, to ensure that the hostname is reachable on another, you can either change the DNS server configuration or add this hostname to /etc/hosts. Step 6 In the server hostid field, enter the hostid of the server machine where the software will run. 5

6 Feature Overview Licensing Features for the Feature Module Step 7 Step 8 To read the Sun machine host ID, run the Solaris shell command hostid on the machine, an 8-character hexadecimal number is displayed, for example, 83ca7c39. If the software is to run in standalone mode, enter the hostid of the server machine. For the hostid field, enter the host ID of the server hardware on which you will install your software. If the software is to run in active-standby mode, you need the hostid of both the machines, for example, 83ca7c39 and 83ca7c40. Enter both hostids, with a space between them, for example, 83ca7c39 83ca7c40. After you verify the order information, the license file is sent to you in . We suggest that you keep the attached license file (.lic) in a safe place. You must install the license file in the specified machine before you can start the. See the Installing the License File section on page 8. New Contracts Step 1 Step 2 Step 3 Step 4 Step 5 Order the application SW upgrade license consisting of a Licensing SW from the top level in the configuration tool, (PGW2200-FFX if ordered with hardware or PGW2200-FFX-SWONLY if only software is ordered). licensing objects consist of the following: application SW DS0 RTU license (signaling and call control) SIP license H323 license SS7 license PRI license PBX license INAP license LI license SBE interface license SIPI interface license TimesTen RTU license The order is placed on New Product Hold (NPH). The order is shipped with a Product Authorization Key (PAK). A PAK is a string of characters identifying the product and the order. Go to the Cisco License Fulfillment web site with the PAK and Host ID of the machine where the is to be installed and complete the information form. In the server hostname field, enter the hostname of the server machine where the software will run. The hostname is the name of the machine where the license server will run. If the software will be running in standalone mode, the license server will run on the same machine as the software. If the 6

7 Licensing Features for the Feature Module Supported Platforms software will be running in active-standby mode, the license server can be on either the primary server machine or on the secondary server machine. Note If you apply several times to obtain a license file for the same, be sure to use the same hostname for each license file application. This can happen if you are expanding RTU licenses. If the hostname is different for different license files, you can use only some of the licenses. Note In the active-standby mode, to ensure that the hostname is reachable on another, you can either change the DNS server configuration or add this hostname to /etc/hosts. Step 6 Step 7 A license file is sent to you in . You must install the license file on the specified machine before you can start the. See the Installing the License File section on page 8. Rehost Licenses A license file is node-locked to a pair. This pair might be broken because of a machine crash or other reason. In this case, you must contact Cisco for another license file. This is called license file rehost. Perform the following steps to reinstall the license. Step 1 Step 2 Step 3 Step 4 When you receive the replacement license file, store it in a safe place. Remove the old license files under /opt/ciscomgc/license on both the active and the standby machine. Copy the new license files to the machine under /opt/ciscomgc/license on both the active and the standby machine. You must install the license file on the specified machine before you can start the. See the Installing the License File section on page 8. Related Documents This document contains information that is related to this feature. The documents that contain additional information related to the are at the following url: Supported Platforms The hardware platforms supported for the software are described in the Hardware Installation Guide. 7

8 Prerequisites for Using this Feature Licensing Features for the Feature Module The Release 9.8(1) software and the license server run on a Sun platform using Solaris 10. Prerequisites for Using this Feature The Softswitch must be running software Release 9.8(1). Prerequisites for this release can be found in the Release Notes for the Software Release 9.8(1) Before migrating to the Release 9.8(1) license-based software, check the provisioning on the to ensure that the extnode type of HSI is correctly provisioned. You can use the prov-ed MML command to fix the provisioning problem. prov-ed:extnode:name= hsi-name, description= The HSI node connected to PGW,type= H323 In Release 9.8(1), if the extnode type of HSI is provisioned as MGC instead of H323, the rejects the H.323 calls. HSI Release 4.3 can interoperate with the older version of only for a certain period of time. For detailed information, see Installing and Configuring Cisco HSI Software at the following url: Installing the License File This section contains the steps necessary for installing this feature. If you are installing and configuring the software on your system for the first time, see the Software Release 9.7 Installation and Configuration Guide at the following url: Note You must install the license file on both the active and the standby for it to function properly. Install if the is NOT Running If the is not in a running state, perform the following steps. Step 1 Step 2 Step 3 Step 4 Save the license file (.lic) to a temporary directory on your hard disk Copy the license file to /opt/ciscomgc/license directory of the. Log in as root. Enter the following command to start the : /etc/init.d/ciscomgc start 8

9 Licensing Features for the Feature Module Installing the License File The license file loads automatically. Install if the is Running If the is in a running state, perform the following steps. Step 1 Step 2 Step 3 Step 4 Step 5 Save the license file (.lic) to a temporary directory on your hard disk. Copy the license file to /opt/ciscomgc/license directory of the. Licenses are cumulative, so there can be multiple license files of the same type. Log in as mgcusr. Go to the /opt/ciscomgc/bin directory of the. On the active, run the script reload_lics.sh. The following is a sample out put from the script: Copyright , Cisco Systems, Inc. MGC-01 - Media Gateway Controller :56: CST M COMPLD "LMAgent: PGW Fully Featured License 9.8 permanent Interface Name Entitled Provisioned SS7Interface Y Y PRIInterface Y N PBXInterface Y Y INAPInterface Y N LIInterface Y N/A SBEInterface N N SIPIInterface Y Y Configure TDM Ports Entitled Provisioned Available Call Control Run Time License Entitled SIP H TimesTen " ; Deploying Licenses The deploys counted (Entitled/Provisioned/Available) licenses. These counted licenses must apply to both systems in an active/standby pair. HSI and BAMS deploy license files locally. All licenses for these systems are node locked to a particular machine. 9

10 Upgrading to Support This Feature Licensing Features for the Feature Module Exception Handling Base License Line Missing in License Files License Server Unreachable If the script stops because there is no valid base license, ensure that you have the valid base license and that you put this license file under /opt/ciscomgc/license on that machine. If you have a valid license file but it is in the wrong directory, put the license file in /opt/ciscomgc/license. If you have no base license or the license has expired, please contact the Cisco account team for a formal license. If you see a Base license line missing in license files or License to expire in a week or less alarm, see the New Alarms section on page 16 for recommended actions. If the application software shuts down, see the log file to determine if the shutdown is due to license expiration. If so, please contact the Cisco account team or Cisco TAC. If you see the license server unreachable alarm, you can use the rtrv-lics output to determine how many days the license server has been unreachable. Follow these steps to resolve this problem. Step 1 Step 2 Go to the machine where the license server is running (see the first line of the license file for the server hostname). Enter ps -ef grep lmgrd to see whether the license server daemon is running. a. If the license server is not running, enter /opt/ciscomgc/local/reload_lics.sh to restart the license server. b. If the license server still fails to start, check the /opt/ciscomgc/var/log/flexlm_server.log for detailed information or contact Cisco TAC. c. If the license server is running, but the active is running on a separate machine, ensure that the machine can reach the ip address of the license server machine. Upgrading to Support This Feature This section contains the steps necessary for upgrading the software to support this feature. If you are installing and configuring the software on your system for the first time, see the Release 9 Software Installation and Configuration Guide. Note If you are upgrading from a release previous to Release 9.7(3), you have received a license file. If you are upgrading from Release 9.7(3) or a later release, you will receive an upgrade license file. 10

11 Licensing Features for the Feature Module Command Reference Perform the following steps to upgrade your software: Step 1 Step 2 Step 3 Step 4 Step 5 Step 6 Step 7 Step 8 Upgrade the standby. Install the license file on the standby. Go to the Cisco website, use the hostid of the active and standby and PAK (received with the software CD) to apply the license file. Note that the server line will address the host ID of the standby host. Start the standby. Log in as root and enter: /etc/init.d/ciscomgc start Be aware that the license server will start before the start of software. Verify the license counts by entering: mml> rtrv-lics:all Run soft switchover from the active PGW: mml> sw-over::confirm Upgrade the previously active. Copy the license file to /opt/ciscomgc/license on the previously active. Start the software on the previously active. Note If you cannot start the application, see the Exception Handling section on page 10. Command Reference This section documents new, modified, or deleted Man-Machine Language (MML) commands. All other MML commands are documented in the Release 9 MML Command Reference. New MML Commands There are no new MML commands for this feature. Modified MML Commands This section contains the MML commands that were modified for this feature. 11

12 Command Reference Licensing Features for the Feature Module RTRV-LICS DISPLAY LICENSES (Release 9.8(1)) Purpose: Syntax: This MML command displays the number of licenses to which you are entitled, the number of these licenses that are currently used, and the number of free licenses that are available. This MML command runs on an active and retrieves the license information. If you run it on a standby, you can correctly retrieve only the base license information; other types of license are displayed as unentitled on a standby. rtrv-lics:base rtrv-lics:interface rtrv-lics:configure rtrv-lics:runtime rtrv-lics:all Input : Output : base Base license information interface Interface license information configure Configuration TDM Ports license information runtime Run-time license information all All license information Entitled Indicates if the interface is licensed and the number of licenses. Used Indicates if the interface is used and the number of licenses provisioned. Available Indicates the number of unused licenses. Run-time license Entitled license number Number of licenses Current usage Runtime counter of call legs Peak usage (15 min) Measurement of peak usage (15-minute span) Peak usage (60 min) Measurement of peak usage (60-minute span) Peak usage (24 hours) Measurement of peak usage (24-hour span) 12

13 Licensing Features for the Feature Module Command Reference Example: The MML command shown in the following example displays all license information: mml>rtrv-lics:all MGC-01 - Media Gateway Controller :43: CST M RTRV ''LMAgent: PGW Fully Featured License 9.8 permanent Interface Name Entitled Provisioned SS7Interface Y Y PRIInterface Y N PBXInterface Y N INAPInterface Y N LIInterface Y N/A SBEInterface N N SIPIInterface N N Configure TDM Ports Entitled Provisioned Available Call Control Runtime TimesTen Entitled Provisioned Available License <Press 'SPACE' for next page, 'Enter' for next line or 'q' to quit this output> Run Time License TDMPorts SIP H323 Entitled Number Current Usage Peak Usage(15 min) Peak Usage(1 hour) Peak Usage(24 hour) '' Comments: Performance Impact Category: A RTRV-NE-HEALTH Retrieve Network Element Health (Release 9.7(3)) Purpose: Syntax: This MML command displays the health of the network element. This includes information about physical and virtual memory allocation, as well as CPU percentages showing the available computing resources. rtrv-ne-health rtrv-ne-health::sys rtrv-ne-health::callp rtrv-ne-health::load rtrv-ne-health::all 13

14 Command Reference Licensing Features for the Feature Module Input : sys Retrieves the top-level status of the host and the number of active alarms, arranged by severity. callp Retrieves Machine congestion level (MCL) Current number of calls in progress Current call attempt rate over the previous few seconds Number of successful calls over the last 15-, 60-, and 1440-minute collection intervals Number of failed call setups over the last 15-, 60-, and 1440-minute collection intervals load Retrieves MCL CPU utilization Free memory Percentage of used disk space for each partition all All of the above indicators. 14

15 Licensing Features for the Feature Module Software Changes for This Feature Module Output : Example: CALL: SIPLicRej TOT SIP calls rejected due to run-time license management CALL: H323LicRej TOT H323 calls rejected due to run-time license management CALL: TDMLicRej TOT TDM calls rejected due to run-time license management CALL: TimesTenLicRej TOT TimesTen calls rejected due to database entries license management The following example displays the status of the host and the number of calls rejected by license failure. If a call is rejected by license failure, the corresponding LicRej measurement is increased, and the CALL: SuccCall TOT is increased, instead of CALL: FailCall TOT, because there is no protocol outage for this call flow. mml> RTRV-NE-HEALTH::ALL MGC-01 - Media Gateway Controller :21: EDT M COMPLD Platform State:ACTIVE'' ''0 critical, 19 major, 0 minor active alarms'' ''Machine Congestion Level = MCL 0 (No Congestion), Reason: not applicable'' ''Current in progress calls = 0, half calls = 0, full calls = 0, call attempts = 0 cps'' ''CPU 0 Utilization = 0 % CPU 1 Utilization = 2 %'' ''Memory (KB): Free virtual, Total virtual, Total real'' ''Interval (minutes) '' ''CALL: SuccCall TOT 0 0 0'' ''CALL: FailCall TOT 0 0 0'' ''CALL: SIPLicRej TOT 0 0 0'' ''CALL: H323LicRej TOT 0 0 0'' ''CALL: TDMLicRej TOT 0 0 0'' ''CALL: TimesTenLicRej TOT 0 0 0'' ''Filesystem kbytes used avail capacity Mounted on'' ''/dev/dsk/c0t2d0s % /'' ''/dev/dsk/c0t2d0s % /opt'' ; Software Changes for This Feature Module The following sections contain reference material related to this feature. Information is included on the following areas: Alarms, page 16 Log Messages, page 23 Measurements, page 24 Billing Interface, page 25 Processes, page 26 and Location Codes, page 27 15

16 Software Changes for This Feature Module Licensing Features for the Feature Module Alarms This section lists the alarms that are added and modified to support this feature. For information on the other alarms for the software, see the Release 9 Messages Reference. New Alarms The alarms that are added for this feature are listed below. Unless otherwise noted, these alarms were added in release 9.7(3) Active and standby machines have different license files License files are mismatched between active and standby systems. Local files are used. Major (service affecting) License files are different on both machines. Processing error alarm. Base license line missing in license files Check the license files on the active and standby machines to ensure that they use the same license files, and then run the license reload script to load the new license files. The base license line is missing in license files. Major (service affecting) This alarm could happen if the license file containing the base license has been removed. Processing error alarm. Check whether the license file that contains the base license line is at /opt/ciscomgc/license. If it is not there, copy that license file to /opt/ciscomgc/license. 16

17 Licensing Features for the Feature Module Software Changes for This Feature Module Configuration time port discrepancy period expired The discrepancy period expired. The license will be enforced at run time. Informational (non-service affecting) The allowed configuration time TDM port and SIP and H.323 call legs discrepancy period expired. No error. None. H323 call rejected due to wrong provision An H.323 call was rejected because the HSI EISUP interface is provisioned as an inter-pgw EISUP interface. License server unreachable Major (service affecting) An H.323 call was rejected because it was incorrectly provisioned. Processing error alarm. Correct the HSI EISUP interface provision. This alarm appears if the license server is unavailable. The looks at the local license files to retrieve the configuration time TDM ports/ the run time license information. At the same time, a timer is started. If the license server is still unreachable after 1 week, the license number will be half of the license number in license files. If the license server is still unreachable after 8 weeks, the license number will be the number of demo licenses. Major (service affecting) 17

18 Software Changes for This Feature Module Licensing Features for the Feature Module The LMAgent reports that the TCP connection to the license server is lost. The license server might be down, or there might be something wrong with the network connection to the license server. Communication alarm. License to expire in a week or less Verify that the network connection to the license server is up and ensure that the license server is running. For troubleshooting instructions, see the License Server Unreachable section on page 10. The license will expire in a week or less. Major (service affecting) The given License will expire in a week or less. Processing error alarm. Contact the account team for a formal license. MMDB: Database temporary memory is nearly full (Release 9.8(1) Database temporary memory is nearly full. Major (service affecting) This alarm is reported when database temporary memory is nearly full. Processing error alarm Expand memory or reduce database size. More TDM ports configured than entitled There are more TDM ports configured than are entitled. 18

19 Licensing Features for the Feature Module Software Changes for This Feature Module Major (service affecting) This alarm is reported because there are more TDM ports configured than are entitled. Processing error alarm. First verify that the license files are in the right place. If they are, then either contact the account team to order more TDM port licenses or remove the over-configured TDM ports. If they are not, move the license files to the right place. Normal call rejected due to database oversubscription and restricted access to database (Release 9.8(1) Non-emergency call will be rejected due to database oversubscription and restricted access to database. Major (service affecting) This alarm is reported when a call is rejected on percentage when the number of TimesTen entries exceeds the allowed amount. Processing error alarm Contact the account team to purchase additional TimesTen license. Normal call rejected due to oversubscription A non emergency call was rejected due to oversubscription. Major (service affecting) The number of active call legs exceeded the allowed oversubscription ratio. Processing error alarm. Contact the account team to purchase additional licenses. 19

20 Software Changes for This Feature Module Licensing Features for the Feature Module Number of remaining Database RTU license reach 5% of the purchased RTU Only 5 percent of the purchased Database RTU licenses remain. Informational (non-service affecting) The LMAgent reports that you have used more than 95 percent of the purchased Database RTU licenses. No error. Contact the account team to purchase additional licenses. Number of remaining Database RTU license reach 10% of the purchased RTU Only 10 percent of the purchased Database RTU licenses remain. Informational (non-service affecting) The LMAgent reports that you have used more than 90 percent of the purchased Database RTU licenses. No error. Contact the account team to purchase additional licenses. Number of remaining Database RTU license reach 25% of the purchased RTU Only 25 percent of the purchased Database RTU licenses remain. Informational (non-service affecting) The LMAgent reports that you have used more than 75 percent of the purchased Database RTU licenses. No error. 20

21 Licensing Features for the Feature Module Software Changes for This Feature Module Contact the account team to purchase additional licenses. Number of remaining RTU licenses reach 5% of the purchased RTU Only 5 percent of the purchased RTU licenses remain. Informational (non-service affecting) The LMAgent reports that you have used more than 95 percent of the purchased RTU licenses. No error. Contact the account team to purchase additional licenses. Number of remaining RTU licenses reach 10% of the purchased RTU Only 10 percent of the purchased RTU licenses remain. Informational (non-service affecting) The LMAgent reports that you have used more than 90 percent of the purchased RTU licenses. No Error. Contact the account team to purchase additional licenses. Number of remaining RTU licenses reach 25% of the purchased RTU Only 25 percent of the purchased RTU licenses remain. Informational (non-service affecting) The LMAgent reports that you have used more than 75 percent of the purchased RTU licenses. 21

22 Software Changes for This Feature Module Licensing Features for the Feature Module No error. Contact the account team to purchase additional licenses. Run-time database oversubscription The number of TimesTen entries exceeds the allowed amount. Major (service affecting) This alarm is reported when the number of TimesTen entries exceeds the allowed amount. Processing error alarm. Contact the account team to purchase additional licenses. Run-time oversubscription The call-leg number stays in the oversubscription zone for more than 15 minutes. Major (service affecting) This alarm is reported by the engine to indicate run-time license oversubscription. Processing error alarm. Contact the account team to purchase additional licenses. System type limit license violation The entitled license number is larger than the license limit of the corresponding base license. Major (service affecting) 22

23 Licensing Features for the Feature Module Software Changes for This Feature Module This alarm is reported if the LMAgent finds that the entitled license number is larger than the system type license limit. Processing error alarm. Unlicensed interface configured Contact the account team to upgrade the base license to a fully featured PGW. An unlicensed interface is configured. Major (service affecting) This alarm is reported because the configured interface is not licensed. Processing error alarm. First verify that the license file is in the right place. If it is, either contact the account team to order an interface license or remove the provisioning of that interface. If it is not, move the license file to the right place. Otherwise, no call can be made on this interface. Log Messages New Log Messages This section lists the logs that are added or deleted to support this feature. For information on the other logs, see the Release 9 Messages Reference. This section contains the log messages that were added to support this feature. cmgpackinitializecdr::execute: no interface This message appears when the rejects an LI interface for licensing reasons. handleengreq(), counted license has been changed due to license server unreachable for a long period of time This message indicates that the number of counted licenses is less because the license server has been unreachable for a long period of time. 23

24 Software Changes for This Feature Module Licensing Features for the Feature Module handleperiodtimerevent(), counted license has been changed due to license server unreachable for a long period of time' This message indicates that the number of counted licenses is less because the license server has been unreachable for a long period of time. LMDataMgr::handlePeriodTimerEvent(), No valid base license, inform procm to shutdown PGW This message indicates that there is no base license. LMDataMgr::handleProcMReq(), gethostid() function been crashed, inform procm to shutdown PGW This message indicates that the gethostid() function has crashed. The shuts down. LMDataMgr::handleProcMReq(), No valid base license, inform procm to shutdown PGW This message indicates that there is no base license. LMDataMgr::initialize(), gethostid() function been crashed, inform procm to shutdown PGW This message indicates that the gethostid() function has crashed. The shuts down. LMDataMgr::initialize(), No valid base license, inform procm to shutdown PGW This message indicates that there is no base license. Measurements Table 1 contains the system measurements (four counters) that are added to support this feature. For information on the other system measurements, see the Software Release 9 Operations, Maintenance, and Troubleshooting Guide. 24

25 Licensing Features for the Feature Module Software Changes for This Feature Module Table 1 New Operational Measurements MML Counter Group:Name CALL-GROUP CALL:SIPLicRej TOT CALL:H323LicRej TOT SIP call is rejected due to run-time license management. This counter is incremented each time an originating or terminating SIP call leg is rejected by the due to run-time license management. H.323 call is rejected due to run-time license management. This counter is incremented each time an originating or terminating H.323 call leg is rejected by the due to run-time license management. Logging Interval 15, 60, , 60, 1440 CALL:TDMLicRej TOT TDM call is rejected due to run-time license management. This counter is incremented each time an originating or terminating TDM call leg is rejected by the due to run-time license management. 15, 60, 1440 CALL:TimesTenLicRej TOT TimesTen call is rejected due to a TimesTen license violation. This counter is incremented each time that the rejects a call due to run-time database license management. 15, 60, 1440 Billing Interface This section identifies the call detail record (CDR) data added for this feature. For billing interface information for the rest of the software, see the Release 9 Billing Interface Guide. License Rejecting Reason (Tag: 4244) Table 2 Reject License Protocol Name: License Rejecting Reason Tag: 4244 Source: MDL /Purpose: Name of reason that caused the call rejection due to license management. Format: IA5 (string) Length in Octets: 1-20 Data Value: string Example: SS7 Interface ANSI/ITU Variations: None 25

26 Software Changes for This Feature Module Licensing Features for the Feature Module Table 2 Reject License Protocol (continued) Extended Data Value: No extended value General Information: For calls with License Control, a license check must be made. If the license limit threshold is reached or there is no license for this protocol interface, the call is rejected against that license. This record provides the identity of the license that caused the call to fail. This tag is added to the CDB only if the call admission check results in rejection. Release: Release and later. Answered (1010) Deselected (1020) Aborted (1030) Release (1040) License Rejecting Direction (Tag: 4245) Interrupted (1050) Ongoing (1060) Maintenance (1070) External DB (1080) N N Y N N N N N Y End of Call (1110) Table 3 License Rejecting Direction Name: License Rejecting Direction Tag: 4245 Source: MDL /Purpose: Indication of whether the call was rejected by a license relating to the originating (incoming) or terminating (outgoing) side. Format: IA5 (string) Length in Octets: 1-20 Data Value: 1 = Inbound ( originating side) 2 = Outbound ( terminating side) ANSI/ITU Variations: None Extended Data Value: No extended value General Information: For calls with License Control, a license check must be made. If the license limit threshold is reached or there is no license for this protocol interface, the Call is rejected against that license. This record provides an indication of whether this was rejected by the originating (inbound) or terminating (outbound) side. This tag is added to the CDB only if the call admission check results in rejection. Release: Release and later. Answered (1010) Deselected (1020) Aborted (1030) Release (1040) Interrupted (1050) Ongoing (1060) Maintenance (1070) External DB (1080) N N Y N N N N N Y End of Call (1110) Processes The LMAgent process was added for this feature. For information on other processes for the software, see the Release 9 Operations, Maintenance, and Troubleshooting Guide. Table 4 shows the LMAgent process added for this feature. 26

27 Licensing Features for the Feature Module Obtaining Documentation and Submitting a Service Request Table 4 Process LMAgent New Processes Controlled by the Process Manager License agent. Handles all the business about licensing based on license client library. Communicates with other processes through IPC. and Location Codes Two internal cause codes described in Table 5 were added for this feature: IC_CALL_LICENSE_REJ IC_RUNTIMR_LICS_REJ For information on other cause and location codes for the software, see the Release 9 Dial Plan Guide. Table 5 Internally Generated Codes Internal Code IC_CALL_LICENSE_REJ IC_RUNTIMR_LICS_REJ Code Explanation To allow identifications of call rejections due to license control and also to allow individual cause analysis of such events, a new cause value IC_CALL_LICENSE_REJ is added to the Call context Enum. IC_CALL_LICENSE_REJ Internal value 174. If the cause analysis result is to release the call, set the internal cause code to IC_CALL_REJECTED. This cause code is mapped to the corresponding protocol cause code, for example, 403 Forbidden for SIP protocol. When an initial run-time license checking request is made and the call is rejected, the next action taken by the universal call module (UCM) is to invoke cause analysis on the new internal cause. The run-time license checking is added to the UCM module. In the case of a call rejected due to run-time license management, cause analysis is invoked. The also invokes the update of run-time license management call rejection measurement and collection of the call detail record (CDR). Obtaining Documentation and Submitting a Service Request For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What s New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at 27

28 Glossary Licensing Features for the Feature Module Subscribe to the What s New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS version 2.0. Glossary Table 6 contains expansions of acronyms and technical terms used in this feature module. Table 6 Acronym BRI CDR DPNSS DS0 EISUP IMT ISUP MGC MML PBX PGW PRI QSIG RTU SBE SIP TDM UCM Acronyms and Expansions Expansion Basic Rate Interface Call Detail Record Digital private network signaling system Digital signal level zero Enhanced ISUP Inter-Machine Trunk ISDN User Part Media Gateway Controller Man-Machine Language Private branch exchange PSTN gateway Primary Rate Interface Q Signaling Right To Use Session Border Element Session Initiation Protocol Time-Division Multiplexing Universal Call Module CCDE, CCENT, Cisco Eos, Cisco HealthPresence, the Cisco logo, Cisco Lumin, Cisco Nexus, Cisco StadiumVision, Cisco TelePresence, Cisco WebEx, DCE, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn and Cisco Store are service marks; and Access Registrar, Aironet, AsyncOS, Bringing the Meeting To You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Collaboration Without Limitation, EtherFast, EtherSwitch, Event Center, Fast Step, Follow Me Browsing, FormShare, GigaDrive, HomeLink, Internet Quotient, IOS, iphone, iquick Study, IronPort, the IronPort logo, LightStream, Linksys, MediaTone, MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, Network Registrar, PCNow, PIX, PowerPanels, ProConnect, ScriptShare, SenderBase, SMARTnet, Spectrum Expert, StackWise, The Fastest Way to Increase Your Internet Quotient, TransPath, WebEx, and the WebEx logo are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. All other trademarks mentioned in this document or website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0812R) Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental Cisco Systems, Inc. All rights reserved. 28