Licensing Features for the PGW 2200
Document Release History
Publication Date
Comments
March 12, 2007
Initial version of the document.
Feature History
Release
Modification
9.7(3)
Support for Licensing Features for the PGW 2200 feature was introduced
on the Cisco MGC software.
This document describes the Licensing Features for the PGW 2200 feature.
This feature is described in the following sections:
•
Feature Overview, page 1
•
Supported Platforms, page 6
•
Prerequisites for Using this Feature, page 7
•
Installing the License File, page 7
•
Upgrading to Support This Feature, page 9
•
Command Reference, page 10
•
Software Changes for This Feature Module, page 13
•
Obtaining Documentation, Obtaining Support, and Security Guidelines, page 23
•
Glossary, page 23
Feature Overview
To manage licenses, the PGW 2200 provides the license files that are stored in a directory where the
PGW 2200 obtains the required license information. PGW 2200 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 PGW 2200 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.
Cisco MGC Software Release 9.7(3)
1
Licensing Features for the PGW 2200
Feature Overview
Types of Licenses
This feature enables or tracks the usage of four types of license objects in the PGW based on license files:
•
Base Software License, page 2
•
Interface License, page 2
•
Configuration-Time Ports License, page 2
•
Run-Time License, page 3
Base Software License
The Base Software License allows the PGW application software to execute on a specified Sun platform.
The license is assigned to a given PGW system. In a standalone configuration, the license is node-locked
to the hostID of the PGW machine. In active-standby configuration, the license is node-locked to the
hostID of both PGW machines. 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.
Interface License
The interface license entitles you to use an interface type on a given PGW 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)
•
PRI interface
•
Legal Intercept interface
The use of SIP, BRI, MGCP, QBE, and EISUP interfaces is unrestricted. Call-leg RTU licenses are
enforced on the PGW for SIP and H.323. H.323 is supported on the HSI, which communicates to the
PGW through EISUP.
Configuration-Time Ports License
This license specifies how many TDM ports can be configured in a given PGW 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 PGW 2200 enforces the
configuration time limit at run time. For example, if you configure 10,000 ports but only purchase 8,000
ports license, PGW 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 PGW 2200 licensing using the following two types:
Cisco MGC Software Release 9.7(3)
2
Licensing Features for the PGW 2200
Feature Overview
•
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
Run-Time License
The run-time license keeps track of the number of concurrent active TDM ports, SIP call legs, and H.323
call legs. 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 96 15-minute intervals and the alarms are set and cleared at 15-minute intervals.
Note
•
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.
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.
Run-time license management is done on the active PGW. 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 PGW 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.
Cisco MGC Software Release 9.7(3)
3
Licensing Features for the PGW 2200
Feature Overview
Obtaining a PGW License
Users with an Existing PGW Contract
Step 1
Order the PGW application SW upgrade license, consisting of Licensing SW, from the top level in the
configuration tool (PGW2200-UPG-TO-9.7).
PGW licensing objects consist of the following:
Step 2
•
PGW application SW
•
DS0 RTU license (signaling and call control)
•
SIP license
•
H323 license
•
SS7 license
•
PRI license
•
PBX license
•
INAP license
•
LI 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:
– PGW 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.
Step 3
A PGW 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.
Step 4
Obtain the license file from the Cisco license fulfillment web site using the PAK and the hostID.
Step 5
In the server hostname field, enter the hostname of the server machine where the PGW 2200 software
will run.
The hostname is the machine name where the license server will run. If the PGW 2200 software is to run
in standalone mode, the license server runs on the same machine as the PGW 2200 software. If the
PGW2200 software is to run in active-standby mode, the license server can be on either the primary
PGW server machine or the secondary PGW server machine.
Note
If you apply several times to obtain a license file for the same PGW, 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 PGW, you can
either change the DNS server configuration or add this hostname to /etc/hosts.
Cisco MGC Software Release 9.7(3)
4
Licensing Features for the PGW 2200
Feature Overview
Step 6
In the server hostID field, enter the hostId of the server machine where the PGW 2200 software will run.
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 PGW 2200 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 PGW 2200
software.
•
If PGW 2200 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.
Step 7
After you verify the order information, the license file is sent to you in email. We suggest that you keep
the attached license file (.lic) in a safe place.
Step 8
You must install the license file in the specified machine before you can start the PGW 2200. See the
“Installing the License File” section on page 7.
New PGW Contracts
Step 1
Order the PGW 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.)
PGW licensing objects consist of the following:
•
PGW application SW
•
DS0 RTU license (signaling and call control)
•
SIP license
•
H323 license
•
SS7 license
•
PRI license
•
PBX license
•
INAP license
•
LI license
Step 2
The order is placed on New Product Hold (NPH).
Step 3
The order is shipped with a Product Authorization Key (PAK). A PAK is a string of characters
identifying the product and the order.
Step 4
Go to the Cisco License Fulfillment web site with the PAK and Host ID of the machine where the PGW
2200 is to be installed and complete the information form.
Step 5
In the server hostname field, enter the hostname of the server machine where the PGW 2200 software
will run.
The hostname is the name of the machine where the license server will run. If the PGW 2200 software
will be running in standalone mode, the license server will run on the same machine as the PGW 2200
software. If the PGW 2200 software will be running in active-standby mode, the license server can be
on either the primary PGW server machine or on the secondary PGW server machine.
Cisco MGC Software Release 9.7(3)
5
Licensing Features for the PGW 2200
Supported Platforms
Note
If you apply several times to obtain a license file for the same PGW, 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 PGW, you can
either change the DNS server configuration or add this hostname to /etc/hosts.
Step 6
A license file is sent to you in email.
Step 7
You must install the license file on the specified machine before you can start the PGW 2200. See the
“Installing the License File” section on page 7.
Rehost Licenses
A license file is node-locked to a PGW 2200 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
When you receive the replacement license file, store it in a safe place.
Step 2
Remove the old license files under /opt/CiscoMGC/license on both the active and the standby machine.
Step 3
Copy the new license files to the PGW 2200 machine under /opt/CiscoMGC/license on both the active
and the standby machine.
Step 4
You must install the license file on the specified machine before you can start the PGW 2200. See the
“Installing the License File” section on page 7.
Related Documents
This document contains information that is related to this feature. The documents that contain additional
information related to the Cisco Media Gateway Controller (MGC) are at the following url:
http://www.cisco.com/en/US/products/hw/vcallcon/ps2027/tsd_products_support_series_home.html
Supported Platforms
The hardware platforms supported for the Cisco MGC software are described in the Cisco Media
Gateway Controller Hardware Installation Guide.
The Cisco MGC Release 9.7(3) software and the license server run on a Sun platform using Solaris 10.
Cisco MGC Software Release 9.7(3)
6
Licensing Features for the PGW 2200
Prerequisites for Using this Feature
Prerequisites for Using this Feature
The Cisco PGW 2200 must be running Cisco MGC software Release 9.7(3). Prerequisites for this release
can be found in the Release Notes for the Cisco Media Gateway Controller Software Release 9.7(3)
Before migrating to the Release 9.7(3) license-based software, check the provisioning on the PGW 2200
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 PGW Release 9.7(3), if the extNode type of HSI is provisioned as “MGC” instead of “H323”, the
PGW 2200 rejects the H.323 calls.
HSI Release 4.3 can interoperate with PGW Release 9.7(3) and higher.
For detailed information, see Installing and Configuring Cisco HSI Software at the following url:
http://www.cisco.com/univercd/cc/td/doc/product/access/sc/rel9/hsi_43/43ug/43ch2.htm
Installing the License File
This section contains the steps necessary for installing this feature. If you are installing and configuring
the Cisco MGC software on your system for the first time, see the Cisco Media Gateway Controller
Software Release 9.7 Installation and Configuration Guide at the following url:
http://www.cisco.com/en/US/docs/voice_ip_comm/pgw/9/installation/software/SW1/97.html
Note
You must install the license file on both the active and the standby PGW 2200 for it to function properly.
Install if the PGW 2200 is NOT Running
If the PGW 2200 is not in a running state, perform the following steps.
Step 1
Save the license file (.lic) to a temporary directory on your hard disk
Step 2
Copy the license file to /opt/CiscoMGC/license directory of the PGW.
Step 3
Log in as root.
Step 4
Enter the following command to start the PGW:
/etc/init.d/CiscoMGC start
The license file loads automatically.
Install if the PGW 2200 is Running
If the PGW 2200 is in a running state, perform the following steps.
Step 1
Save the license file (.lic) to a temporary directory on your hard disk.
Cisco MGC Software Release 9.7(3)
7
Licensing Features for the PGW 2200
Installing the License File
Step 2
Copy the license file to /opt/CiscoMGC/license directory of the PGW. Licenses are cumulative, so there
can be multiple license files of the same type..
Step 3
Log in as mgcusr.
Step 4
Go to the /opt/CiscoMGC/bin directory of the PGW.
Step 5
On the active PGW 2200, run the script reload_lics.sh.
The following is a sample out put from the script:
Copyright © 1998-2002, Cisco Systems, Inc.
MGC-01 - Media Gateway Controller 2006-05-18 08:07:37.051 EDT M COMPLD
''LMAgent:
-----------------------------------------------------------------PGW License 9.7 permanent
-----------------------------------------------------------------Interface Name Entitled Provisioned
SS7Interface Y Y
PRIInterface Y N
PBXInterface Y N
INAPInterface Y N
LIInterface Y N/A
-----------------------------------------------------------------Configure TDM Ports Entitled Provisioned Available
Call Control 1500 1384 116
-----------------------------------------------------------------Run Time License Entitled
SIP 1500
H323 1500
------------------------------------------------------------------''
Deploying Licenses
PGW deploys counted licenses. These counted licenses must apply to both PGWs in an active/standby
pair.
HSI and BAMS deploy license files locally. All licenses for these systems are node locked to a particular
machine.
Exception Handling
Base License Line Missing in License Files
If the Cisco MGC 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, contact the 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 14 for recommended actions.
•
If the PGW application software shuts down, see the log file to determine if the shutdown is due to
license expiration. If so, contact the account team.
Cisco MGC Software Release 9.7(3)
8
Licensing Features for the PGW 2200
Upgrading to Support This Feature
License Server Unreachable
If you see the license server unreachable alarm, you can use the rtrv-lics output to determine how many
days license server has been unreachable.
Follow these steps to resolve this problem.
Step 1
Go to the machine where the license server is running (see the first line of the license file for the server
hostname).
Step 2
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 start, check the /opt/CiscoMGC/var/log/flexlm_server.log for detailed
information.
c.
If the license server is running, but the active Cisco PGW 2200 Softswitch is running on a separate
machine, ensure that the Cisco PGW 2200 Softswitch 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 Cisco MGC software to support this feature.
If you are installing and configuring the Cisco MGC software on your system for the first time, see the
Cisco Media Gateway Controller Software Release 9 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 PGW from Release 9.7(3) or a later release, you will receive an upgrade license file.
Perform the following steps to upgrade your Cisco MGC software:
Step 1
Upgrade the standby PGW.
Step 2
Install the license file on the standby PGW.
Go to the Cisco website, use the hostID of the active and standby PGW and PAK (received with the PGW
software CD) to apply the license file. Note that the server line will address the host ID of the standby
PGW host.
Step 3
Start the standby PGW. Log in as root and enter:
/etc/init.d/CiscoMGC start
Be aware that the license server will start before the start of PGW software.
Step 4
Switch over to the active PGW.
Step 5
Upgrade the previously active PGW.
Step 6
Copy the license file to /opt/CiscoMGC/license on the previously active PGW.
Step 7
Start the PGW software on the previously active PGW.
Cisco MGC Software Release 9.7(3)
9
Licensing Features for the PGW 2200
Command Reference
Note
If you cannot start the PGW application, see the “Exception Handling” section on page 8.
Command Reference
This section documents new, modified, or deleted Man-Machine Language (MML) commands. All other
MML commands are documented in the Cisco Media Gateway Controller Software Release 9 MML
Command Reference.
New MML Commands
This section contains the MML commands that are new for this feature.
RTRV-LICS—DISPLAY LICENSES (Release 9.7(3)
Purpose:
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 PGW and retrieves the license
information. If you run it on a standby PGW, you can correctly retrieve only the base
license information; other types of license are displayed as unentitled on a standby
PGW.
Syntax:
rtrv-lics:base
rtrv-lics:interface
rtrv-lics:configure
rtrv-lics:runtime
rtrv-lics:all
Input
Description:
Output
Description:
•
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)
Cisco MGC Software Release 9.7(3)
10
Licensing Features for the PGW 2200
Command Reference
Example:
The MML command shown in the following example displays all license information:
mml>rtrv-lics:all
------------------------------------------------------------------------PGW Fully Featured 9.7 permanent
------------------------------------------------------------------------Interface Name
Entitled
Used
SS7Interface
Y
N
PRIInterface
N
N
PBXInterface
Y
Y
INAPInterface
Y
N
LIInterface
Y
N/A
------------------------------------------------------------------------Configure TDM Ports Entitled
Provisioned
Available
Call Control
1500
1400
100
------------------------------------------------------------------------Run Time License
TDMPorts
SIP
H.323
Entitled License Number 1500
1500
1500
Current usage
0
0
0
Peak Usage (15 min)
0
0
0
Peak Usage (1 hour)
0
0
0
Peak Usage (24 hours)
0
0
0
-------------------------------------------------------------------------
Comments:
Performance Impact Category: A
Modified MML Commands
This section contains the MML commands that were modified for this feature.
RTRV-NE-HEALTH—Retrieve Network Element Health (Release 9.7(3))
Purpose:
This MML command displays the health of the Cisco MGC network element. This
includes information about physical and virtual memory allocation, as well as CPU
percentages showing the available computing resources.
Syntax:
rtrv-ne-health
rtrv-ne-health::sys
rtrv-ne-health::callp
rtrv-ne-health::load
rtrv-ne-health::all
Cisco MGC Software Release 9.7(3)
11
Licensing Features for the PGW 2200
Command Reference
Input
Description:
•
sys—Retrieves the top-level status of the Cisco MGC 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.
Cisco MGC Software Release 9.7(3)
12
Licensing Features for the PGW 2200
Software Changes for This Feature Module
Output
Description:
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
The following example displays the status of the Cisco MGC 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 2006-05-18 08:21:02.581 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): 4921240 Free virtual, 6193264 Total virtual, 2096696 Total
real''
''Interval (minutes) 15 60 1440''
''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''
''Filesystem kbytes used avail capacity Mounted on''
''/dev/dsk/c0t2d0s0 1986446 467404 1459449 25% /''
''/dev/dsk/c0t2d0s5 57416722 11775209 45067346 21% /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 14
•
Log Messages, page 19
•
Measurements, page 20
•
Billing Interface, page 20
•
Processes, page 22
•
Cause and Location Codes, page 22
Cisco MGC Software Release 9.7(3)
13
Licensing Features for the PGW 2200
Software Changes for This 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 Cisco MGC software, see the Cisco Media Gateway Controller Software Release 9
Messages Reference.
New Alarms
The alarms that are added for this feature are listed below.
Active and standby machines have different license files
Description
License files are mismatched between active and standby PGWs. Local files are used.
Severity
Major (service affecting)
Cause
License files are different on both machines.
Type
Processing error alarm.
Action
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.
Base license line missing in license files
Description
The base license line is missing in license files.
Severity
Major (service affecting)
Cause
This alarm could happen if the license file containing the base license has been removed.
Type
Processing error alarm.
Action
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.
Configuration time port discrepancy period expired
Description
Cisco MGC Software Release 9.7(3)
14
Licensing Features for the PGW 2200
Software Changes for This Feature Module
The discrepancy period expired. The license will be enforced at run time.
Severity
Informational (non-service affecting)
Cause
The allowed configuration time TDM port and SIP and H.323 call legs discrepancy period expired.
Type
No error.
Action
None.
H323 call rejected due to wrong provision
Description
An H.323 call was rejected because the HSI EISUP interface is provisioned as an inter-PGW EISUP
interface.
Severity
Major (service affecting)
Cause
An H.323 call was rejected because it was incorrectly provisioned.
Type
Processing error alarm.
Action
Correct the HSI EISUP interface provision.
License server unreachable
Description
This alarm appears if the license server is unavailable. The Cisco PGW 2200 Softswitch 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 demo license number.
Severity
Major (service affecting)
Cause
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.
Cisco MGC Software Release 9.7(3)
15
Licensing Features for the PGW 2200
Software Changes for This Feature Module
Type
Communication alarm.
Action
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 9.
License to expire in a week or less
Description
The license will expire in a week or less.
Severity
Major (service affecting)
Cause
The given License will expire in a week or less.
Type
Processing error alarm.
Action
Contact the account team for a formal license.
More TDM ports configured than entitled
Description
There are more TDM ports configured than are entitled.
Severity
Major (service affecting)
Cause
This alarm is reported because there are more TDM ports configured than are entitled.
Type
Processing error alarm.
Action
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 oversubscription
Description
A non emergency call was rejected due to oversubscription.
Cisco MGC Software Release 9.7(3)
16
Licensing Features for the PGW 2200
Software Changes for This Feature Module
Severity
Major (service affecting)
Cause
The number of active call legs exceeded the allowed oversubscription ratio.
Type
Processing error alarm.
Action
Contact the account team to purchase additional licenses.
Number of remaining RTU licenses reach 5% of the purchased RTU
Description
Only 5 percent of the purchased RTU licenses remain.
Severity
Informational (non-service affecting)
Cause
The LMAgent reports that you have used more than 95 percent of the purchased RTU licenses.
Type
No error.
Action
Contact the account team to purchase additional licenses.
Number of remaining RTU licenses reach 10% of the purchased RTU
Description
Only 10 percent of the purchased RTU licenses remain.
Severity
Informational (non-service affecting)
Cause
The LMAgent reports that you have used more than 90 percent of the purchased RTU licenses.
Type
No Error.
Action
Contact the account team to purchase additional licenses.
Number of remaining RTU licenses reach 25% of the purchased RTU
Description
Cisco MGC Software Release 9.7(3)
17
Licensing Features for the PGW 2200
Software Changes for This Feature Module
Only 25 percent of the purchased RTU licenses remain.
Severity
Informational (non-service affecting)
Cause
The LMAgent reports that you have used more than 75 percent of the purchased RTU licenses.
Type
No error.
Action
Contact the account team to purchase additional licenses.
Run-time oversubscription
Description
The call-leg number stays in the oversubscription zone for more than 15 minutes.
Severity
Major (service affecting)
Cause
This alarm is reported by the engine to indicate run-time license oversubscription.
Type
Processing error alarm.
Action
Contact the account team to purchase additional licenses.
System type limit license violation
Description
The entitled license number is larger than the license limit of the corresponding base license.
Severity
Major (service affecting)
Cause
This alarm is reported if the LMAgent finds that the entitled license number is larger than the system
type license limit.
Type
Processing error alarm.
Action
Contact the account team to upgrade the base license to a fully featured PGW.
Cisco MGC Software Release 9.7(3)
18
Licensing Features for the PGW 2200
Software Changes for This Feature Module
Unlicensed interface configured
Description
An unlicensed interface is configured.
Severity
Major (service affecting)
Cause
This alarm is reported because the configured interface is not licensed.
Type
Processing error alarm.
Action
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
This section lists the logs that are added or deleted to support this feature. For information on the other
logs, see the Cisco Media Gateway Controller Software Release 9 Messages Reference.
New Log Messages
This section contains the log messages that were added to support this feature.
cmgPackInitializeCdr::execute: no interface
This message appears when the PGW 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.
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 PGW 2200 shuts down.
LMDataMgr::handleProcMReq(), No valid base license, inform procM to shutdown PGW
This message indicates that there is no base license.
Cisco MGC Software Release 9.7(3)
19
Licensing Features for the PGW 2200
Software Changes for This Feature Module
LMDataMgr::initialize(), gethostid() function been crashed, inform procM to shutdown PGW
This message indicates that the gethostid() functionhas crashed. The PGW 2200 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 (three counters) that are added to support this feature. For
information on the other system measurements, see the Cisco Media Gateway Controller Software
Release 9 Operations, Maintenance, and Troubleshooting Guide.
n
Table 1
New Operational Measurements
MML Counter Group:Name
Description
Related
Components
Logging
Interval
CALL-GROUP
CALL:SIPLicRej 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 PGW due to run-time license
management.
15, 60, 1440
CALL:H323LicRej TOT
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 PGW due to run-time license
management.
15, 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 PGW due to run-time 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 Cisco MGC software, see the Cisco Media Gateway Controller Software
Release 9 Billing Interface Guide.
Cisco MGC Software Release 9.7(3)
20
Licensing Features for the PGW 2200
Software Changes for This Feature Module
License Rejecting Reason (Tag: 4244)
Table 2
Reject License Protocol
Name: License Rejecting Reason
Tag: 4244
Source: MDL
Description/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
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.
MGC Release: Release 9.7.3 and later.
Answered
(1010)
Deselected
(1020)
Aborted
(1030)
Release
(1040)
Interrupted
(1050)
Ongoing
(1060)
Maintenance
(1070)
External DB End of Call
(1080)
(1110)
N
N
Y
N
N
N
N
N
Y
License Rejecting Direction (Tag: 4245)
Table 3
License Rejecting Direction
Name: License Rejecting Direction
Tag: 4245
Source: MDL
Description/Purpose: Indication of whether the call was rejected by a license relating to the PGW originating (incoming)
or terminating (outgoing) side.
Format: IA5 (string)
Length in Octets: 1-20
Data Value:
1 = Inbound (PGW originating side)
2 = Outbound (PGW 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.
MGC Release: Release 9.7.3 and later.
Answered
(1010)
Deselected
(1020)
Aborted
(1030)
Release
(1040)
Interrupted
(1050)
Ongoing
(1060)
Maintenance
(1070)
External DB End of Call
(1080)
(1110)
N
N
Y
N
N
N
N
N
Y
Cisco MGC Software Release 9.7(3)
21
Licensing Features for the PGW 2200
Software Changes for This Feature Module
Processes
The LMAgent process was added for this feature. For information on other processes for the Cisco MGC
software, see the Cisco Media Gateway Controller Software Release 9 Operations, Maintenance, and
Troubleshooting Guide.
Table 4 shows the LMAgent process added for this feature.
Table 4
New Processes Controlled by the Process Manager
Process
Description
LMAgent
License agent. Handles all the business about licensing based on license client library.
Communicates with other processes through IPC.
Cause 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 Cisco MGC software, see the Cisco Media
Gateway Controller Software Release 9 Dial Plan Guide.
Table 5
Internally Generated Cause Codes
Internal Cause Code
Cause Code Explanation
IC_CALL_LICENSE_REJ
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 CauseEnum.
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.
IC_RUNTIMR_LICS_REJ
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. PGW
also invokes the update of run-time license
management call rejection measurement and
collection of the call detail record (CDR).
Cisco MGC Software Release 9.7(3)
22
Licensing Features for the PGW 2200
Obtaining Documentation, Obtaining Support, and Security Guidelines
Obtaining Documentation, Obtaining Support, and Security
Guidelines
For information on obtaining documentation, obtaining support, providing documentation feedback,
security guidelines, and also recommended aliases and general Cisco documents, see the monthly What's
New in Cisco Product Documentation, which also lists all new and revised Cisco technical
documentation.
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Glossary
Table 6 contains expansions of acronyms and technical terms used in this feature module.
Table 6
Acronyms and Expansions
Acronym
Expansion
BRI
Basic Rate Interface
CDR
Call Detail Record
DPNSS
Digital private network signaling system
DS0
Digital signal level zero
EISUP
Enhanced ISUP
IMT
Inter-Machine Trunk
ISUP
ISDN User Part
MGC
Media Gateway Controller
MML
Man-Machine Language
PBX
Private branch exchange
PGW
PSTN gateway
PRI
Primary Rate Interface
QSIG
Q Signaling
RTU
Right To Use
SIP
Session Initiation Protocol
TDM
Time-Division Multiplexing
UCM
Universal Call Module
Cisco MGC Software Release 9.7(3)
23
Licensing Features for the PGW 2200
Glossary
CCVP, the Cisco logo, and Welcome to the Human Network are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn is
a service mark of Cisco Systems, Inc.; and Access Registrar, Aironet, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, Cisco, the Cisco
Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity,
Enterprise/Solver, EtherChannel, EtherFast, EtherSwitch, Fast Step, Follow Me Browsing, FormShare, GigaDrive, HomeLink, Internet Quotient, IOS,
iPhone, IP/TV, iQ Expertise, the iQ logo, iQ Net Readiness Scorecard, iQuick Study, LightStream, Linksys, MeetingPlace, MGX, Networkers,
Networking Academy, Network Registrar, PIX, ProConnect, ScriptShare, SMARTnet, StackWise, The Fastest Way to Increase Your Internet Quotient,
and TransPath 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. (0711R)
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.
© 2007 Cisco Systems, Inc. All rights reserved.
Cisco MGC Software Release 9.7(3)
24