License Management, Capacity Usage Threshold Reached

1	Introduction
1.1	Alarm Description
1.2	Prerequisites
2	Procedure
2.1	Analyzing the Alarm
2.2	Actions to Adjust the LM Configuration
2.3	Actions to Order and Install a New License Key File
2.4	Actions to Obtain New License Keys for Arwa
Reference List

1 Introduction

This document describes the License Management, Capacity Usage Threshold Reached alarm and provides instructions for fault management.

1.1 Alarm Description

License Management, Capacity Usage Threshold Reached is raised when the number of reserved tokens in a capacity license approaches the licensedCapacityLimit.

This primary alarm is issued by the ManagedElement=1,SystemFunctions=1,Lm=1,LicenseId=<licenseId> Managed Object (MO).

Possible alarm causes and fault locations are explained in Table 1.

Table 1 Alarm Causes
Alarm Cause	Description	Fault Reason	Fault Location	Impact
351	License Management, Capacity Usage Threshold Reached	Requested capacity has exceeded the `capacityAlarmThreshold` or the `licensedCapacityLimit`.	LM Server	Requested capacity may be unavailable.

The following consequences are expected if the alarm condition is not resolved:

The application may not be able to use additional instances of the licensed feature.

The alarm attributes are listed and explained in Table 2.

Table 2 Alarm Attributes
Attribute Name	Attribute Value
activeSeverity	WARNING: The reserved capacity of the license identified by the `CapacityKey.capacityKeyId` has passed the warning threshold defined by the `Lm.capacityAlarmThreshold` parameter but is still below the total licensed capacity. MAJOR: The `CapacityKey.licensedCapacityLimit` of the license identified by the `capacityKeyId` has been reached.
additionalInfo	N/A
additionalText	"Capacity usage threshold reached"
eventType	QUALITYOFSERVICEALARM
lastEventTime	A timestamp of the last alarm update, such as an alarm status change or severity change.
majorType	193
minorType	393219
originalAdditionalText	Content of the `additionalText` field when the alarm was raised.
originalEventTime	Timestamp when the alarm was raised.
originalSeverity	Value of the `activeSeverity` level when the alarm was raised.
probableCause	351 (x733 Threshold Crossed)
sequenceNumber	The notification identity for this object instance. It is not the same as the `fmAlarmId` since multiple notifications may be sent for one alarm instance. This value changes for every notification (such as a severity change, alarm clear, and so on).
source	ManagedElement=1,SystemFunctions=1,Lm=1,License=<licenseId>
specificProblem	License Management, Capacity Usage Threshold Reached

1.2 Prerequisites

This section lists the prerequisite documents, tools, and conditions for the alarm handling procedure.

1.2.1 Documents

Review the following documents before starting the procedure:

Personal Health and Safety Information (Reference [1])
System Safety Information (Reference [2])
The user guide for your LM deployment:
- "Installing License Key Files" in the LM User Guide for Sentinel RMS (Reference [3])
- "Installing License Key Files" in the LM User Guide for ELIM (Reference [4])
- "Obtaining License Key Files" in the LM User Guide for Arwa (Reference [5])
"Configuration Management Using CLI" in the COM Management Guide for your version of the product software.

1.2.2 Tools

Ensure that the following tools are available before starting the procedure:

Element Management System (for example: OSS)
COM CLI

For more information on these tools, refer to the documentation for your version of the product software.

1.2.3 Conditions

Ensure that the following conditions are met before starting the procedure:

Know the IP address of the blade where the active COM CLI is running.
Have the proper authority to handle configuration management of the network elements.
Be familiar with basic UNIX commands.

2 Procedure

This section describes the alarm handling procedure.

The License Management, Capacity Usage Threshold Reached alarm will clear automatically when the reserved capacity drops below the Lm.capacityAlarmThreshold minus a hysteresis value defined by the Lm.capacityAlarmHysteresis configuration parameter. For more information about Lm.capacityAlarmThreshold and Lm.capacityAlarmHysteresis, refer to "Configuration Management" in the user guide for your LM deployment.

LM User Guide for Sentinel RMS (Reference [3])
LM User Guide for ELIM (Reference [4])
LM User Guide for Arwa (Reference [5])

If the alarm persists, or if it is triggered frequently, adjusting the LM configuration, ordering a new license with higher capacity, or both may be required.

To better determine the fault location and cause do the following:

From a terminal window, use ssh to connect to the COM CLI Management System server port (default 22) on the blade where the active COM CLI is running:
ssh <username>@<blade_IP_address> -p 22 -t -s cli

The COM CLI opens after supplying your password.
Retrieve the current percentage value of the capacityAlarmHysteresis configuration parameter:
show verbose ManagedElement=1, SystemFunctions=1, Lm=1, capacityAlarmHysteresis
Retrieve the current percentage value of the capacityAlarmThreshold configuration parameter:
show verbose ManagedElement=1, SystemFunctions=1, Lm=1, capacityAlarmThreshold

Retrieve information about the affected capacity license:

ManagedElement=1, SystemFunctions=1, Lm=1

show --moc CapacityKey --condition (keyId=="<licenseId>")

Where <licenseId> is the license identify from the alarm source. For example:

(Lm=1)>show --moc CapacityKey --condition (keyId=="FAT1020383")
CapacityKey=1
   capacityUnit="token"
   expiration="2016-10-1"
   grantedCapacityLevel=900
   keyId="FAT1020383"
   licensedCapacityLimitReached=false
   name="FAT1020383"
   productType=""
   validFrom="2014-3-5"
   version="1.0"
   licensedCapacityLimit
      value=1000

Provide the LM configuration and license information for capacity planning.
- After obtaining a work order to adjust the LM configuration, refer to Section 2.2.
- After obtaining a work order for a new license with higher capacity, refer to Section 2.3 or Section 2.4.

2.2 Actions to Adjust the LM Configuration

After obtaining a work order to adjust the LM configuration:

From a terminal window, use ssh to connect to the COM CLI Management System server port (default 22) on the blade where the active COM CLI is running:
ssh <username>@<blade_IP_address> -p 22 -t -s cli

The COM CLI opens after supplying your password.
Verify that the capacityAlarmHysteresis configuration parameter has the proper value:
show verbose ManagedElement=1, SystemFunctions=1, Lm=1, capacityAlarmHysteresis
If required, set a new percentage value for Lm.capacityAlarmHysteresis with the following commands:
configure

ManagedElement=1, SystemFunctions=1, Lm=1, capacityAlarmHysteresis=<n>

Where <n> is the new parameter value.

commit
Verify that the capacityAlarmThreshold configuration parameter has the proper value:
show verbose ManagedElement=1, SystemFunctions=1, Lm=1, capacityAlarmThreshold
If required, set a new percentage value for capacityAlarmThreshold with the following commands:
configure

ManagedElement=1, SystemFunctions=1, Lm=1, capacityAlarmThreshold=<n>

Where <n> is the new parameter value.

commit
Check the alarm status.
If the alarm is still active, or if it is triggered frequently, a new license with higher capacity may be required.

2.3 Actions to Order and Install a New License Key File

Note:: This procedure only applies to Sentinel RMS, ELIM, and Arwa No Connection deployments.

After obtaining a work order for a new license with higher capacity:

If required, contact your Ericsson supplier and order a new license key file with the required changes.
Install the new license key file.
For more information on installing a license key file, refer to "Installing License Key Files" in the user guide for your LM deployment.
- LM User Guide for Sentinel RMS (Reference [3])
- LM User Guide for ELIM (Reference [4])
Note:
For Arwa No Connection, refer to the ELIM documentation.
After installing the license key file, use ssh to connect to the COM CLI Management System server port (default 22) on the blade where the active COM CLI is running:
ssh <username>@<blade_IP_address> -p 22 -t -s cli

The COM CLI opens after supplying your password.
Check the alarm status.
If the alarm is still active, trigger an additional refresh of the license inventory to ensure that the license changes are applied:
ManagedElement=1, SystemFunctions=1, Lm=1, refreshLicenseInventory

The system returns true if the action was executed successfully.
Verify that the license inventory has been synchronized with the new license key file by checking the lastLicenseInventoryRefresh timestamp:
show ManagedElement=1, SystemFunctions=1, Lm=1, lastLicenseInventoryRefresh

A recent timestamp indicates a successful update.
Check the alarm status.
If the alarm is still active, consult the next level of maintenance support. Further actions are outside the scope of this instruction.

2.4 Actions to Obtain New License Keys for Arwa

Note:: This procedure is not applicable to LM deployments using Arwa No Connection. When deployed in Arwa No Connection mode, LM uses ELIM formatted license key files to store license information locally. For more information on ordering and installing a new license key file, refer to Section 2.3.