Alu 9900 wng_congestion_notification_interface_v1 3_external

Network Load Notification Interface –

9900 WNG Interface

Version 1.3

Product Name:

9900 Wireless Network Guardian (WNG)

www.alcatel-lucent.com

Alcatel-Lucent, TiMetra, and the Alcatel-Lucent logo are registered trademarks of

Alcatel-Lucent. All other trademarks are the property of their respective owners.

Alcatel-Lucent assumes no responsibility for the accuracy of the information

presented, which is subject to change without notice. © 2011 Alcatel-Lucent. All

rights reserved.

Alcatel-Lucent 9900 WNG Congestion Alert Interface Last Revised: 2011.05.20 of 10 Version 1.3

This document contains Confidential Information of Alcatel-Lucent

TABLE OF CONTENTS

1. SCOPE ................................................................................................................................................... 3

2. 9900 WNG INTERFACE ...................................................................................................................... 4

The 9900 WNG notifies the external entity over the interface of the following types of events: .............. 4

2.1 Network Performance Event Interface .............................................................................................. 4

2.2 Event Query Interface ....................................................................................................................... 5

3. RESTFUL INTERFACE DESCIRPTION ............................................................................................ 6

3.1 Network Performance Events ............................................................................................................ 6

3.1.1 Network Load Alerts creation................................................................................................. 6

3.1.2 NW Load Alerts Updates ......................................................................................................... 8

3.1.3 Clearing NW Load Alerts ........................................................................................................ 8

3.2 Event Query Interface ....................................................................................................................... 9



1. SCOPE

This document describes the interface from the 9900 WNG to provide notification of congested cells and the IP addresses contributing that network load. The interface is intended to be used to identify loaded cells for the purpose of optimization.



2. 9900 WNG INTERFACE

The 9900 WNG network load notification interface is a RESTful, web services API. This API uses request-response type messages to allow notification of anomaly events to external entities. The communication between the 9900 WNG and the client may occur over HTTPS and using port 8443. Alternatively the communication may be over SSH using port 22.

By default, the interface will communicate over secure connections (HTTPS or SSH), however, the operator may optionally disable the security to just use HTTP.

The 9900 WNG notifies the external entity over the interface of the following types of events:

• Network Performance Events – alerts associated with identifying a network element /

segment that is exhibiting a performance threshold crossing including the subscribers that are contributing to that performance crossing threshold

In addition to notifications, an external entity can issue a query to obtain the status of particular network element or correlation / event id as described below.

2.1 Network Performance Event Interface

The Network Performance Event notification interface provides notification of a performance event on a per Network Element basis:

• Performance Event Type (eg. NWLoad Alert, Trend Alert) • Event ID • Timestamp in UTC format • Refresh Update Type (time, transition, query)

• Network Element Type (CELL, RNC, SGSN…)

• Cell Type (CDMA, GPRS, W-CDMA, LTE, WIMAX…) • Network Element name/ID • Performance Event Status (Active or Cleared)

• Performance Event Intensity (0 to 5)

• Subscriber List - IP Addresses (v4/v6) of Subscribers traversing/terminating on the Network Element

• Correlation ID • Detector ID (Unique Identifier for each 9900 WNG detector)

As the Network Element enters into, exits from, or transitions from one level of intensity to another, the 9900 WNG will notify the client.

The 9900 WNG can filter notifications and only send if a performance/trend event is of a specified intensity threshold.

The 9900 WNG expects an HTTP status code response (eg. 200 OK), otherwise it will retry the POST.



2.2 Event Query Interface

The Query Interface is used to allow an external entity to query the status of a particular network element or correlation id/event id for outstanding or past events. This interface is useful in the case where the external entity may have experienced a communication or system failure in which event notifications may have been lost. As such the interface provides a mechanism to synchronize the status between the 9900 WNG and external entity.

The content of the query will be identical to the event notification with the Refresh Update Type = QUERY.



3. RESTFUL INTERFACE DESCIRPTION

3.1 Network Performance Events

The Network related events (NWloadalert alerts) are sent to the external entity using HTTP or HTTPS to URI

<client-ip-addr>/wng/perfalert .

9900 WNG load alerts are created or cleared using method POST.

3.1.1 Network Load Alerts creation

The HTTP/HTTPS post for the creation of a performance alert (load alert) to the external entity uses the following XML format.

<perfalert>

<NWloadalert> <alertId></alertId> <timestamp></timestamp> <refupdate></refupdate> <ne_type></ne_type> <cell_type></cell_type>

<name></name> <status></status> <intensity></intensity> <sub_list> <subid> <IMSI></IMSI> <ipv4></ipv4> <ipv6></ipv6) </subid> … <subid> <IMSI></IMSI> <ipv4></ipv4> <ipv6></ipv6) </subid>

</sub_list> <correlationId></correlationId> <detectorId></detectorId> </NWloadalert>

</perfalert>

Where the possible values for the different XML tags are:

<alert_id> Unique integer id corresponding to the notification

<timestamp> YYYY-MM-DD:HH:MM:SS:MS in UTC (including time -offset)

<ref-update> TIME

TRANSITION



QUERY NOTE: If a network element transitions from any in tensity to a different intensity, then the ref_update value will be set to TRANSITION. If a network element remains in the cu rrent intensity level for a configurable time period, the 9900 WNG will re-issue and refresh the notification with an updat ed set of IP addresses and set the ref_update value to TIME. Th e exception is intensity 0. Notifications will only be generated on transitions from and to intensity 0. If a network element rema ins in intensity 0, no further notifications will be sent. By default, the update interval between TIME notifications is 2 minutes, however, this is system configurable via the 9900 W NG CLI. If the update is the result of an external entity issu ing a query for the status, then the ref-update value will be s et to QUERY.

<ne_type> CELL BS RNC SGSN GGSN

Note: Currently the only supported value is CELL.

<cell_type> CDMA

GPRS W-CDMA LTE WIMAX

<name> Network element name (eg. 20401602cc4dd9 is a cell id in hex format)

<status> ACTIVE ACKNOWLEDGED AUTO_CLEARED MANUAL_CLEARED RESET_CLEARED

<intensity> values (0-5)

NOTE: The thresholds that correspond to the intensity values are user configured on the 9900 WNG.

<sub_list> list of subscribers in the network element at the time of the notification.

<sub_id> Subscriber id is used to provide an identification of subscriber breakdown per sub. The subid tag will be repeated for each subscriber in the list and is used to identify the grouping of attributes for that given subscriber (note the “id” portion will not be updated for each sub – instead it is strictly used to separate entries.



<IMSI> The Subscriber IMSI or NAI.

<ipv4> The IP V4 address in text representation. If the subscriber does not have an IPv4 address, this tag entry will be missing.

<ipv6> The IP V6 address in text representation. If the subscriber does not have an IPv6 address, this tag entry will be missing.

The addresses will be in text representation for both v4 and v6 addresses. NOTE: If a UE has both a v4 and v6 address, both addresses will be in the list.

<correlationId> unique integer. Used to correlate to an update of an existing alert.

<detectorId> unique integer. This is used to identify the 9900 WNG detector from which the alert was generated. Useful if the recipient is receiving alerts from multiple 9900 WNG detectors.

3.1.2 NW Load Alerts Updates

In order to update a NW Load Alert, the 9900 WNG sends the same XML message but using the <ref_update> tag can be used to distinguish whether the update is due to a transition from one intensity level to another or based on a time interval update.

If a network element transitions from any intensity to a different intensity, then the ref_update value will be set to TRANSITION. If a network element remains in the current intensity level for a configurable time period, the 9900 WNG will re-issue and refresh the notification with an updated set of IP addresses and set the ref_update value to TIME. The exception is intensity 0. Notifications will only be generated on transitions from and to intensity 0. If a network element remains in intensity 0, no further notifications will be sent.

The <correlationId> in the message has to match the one in the original event creation, the network element name has to match also.

The list of sub_list subscriber and address will be a complete list of all subs/addresses in that congested network element at the time of the notification.

3.1.3 Clearing NW Load Alerts

In order to clear a NW Load Alert, the 9900 WNG sends the same XML message but using <status> with one of the following:

AUTO_CLEARED MANUAL_CLEARED RESET_CLEARED

The intensity will also be set to 0.

The <correlationId> in the Clear message has to match the one in the original event creation, the network element name has to match also.



3.2 Event Query Interface

The HTTP request for the creation of a status query and response to & from the 9900 WNG uses the following XML format:

<statusquery>

<eventtype> <queryId></queryid> <alertId></alertId> <name></name>

<correlationId></correlationId> <detectorId></detectorId> </eventtype>

</statusquery>

<queryId> Mandatory - Unique integer id corresponding to the query

<eventtype> Mandatory - Corrresponds to the type of event for which the query shall be executed – NWLoadalert, trendalert, etc.

<alertId> Optional – corresponds to the alertID that wa s reported during the notification

<name> Optional – corresponds to the network element name for which the query shall be executed upon.

<correlationid> Optional – corresponds to the correlationid f or a given set of alerts

One of alertid, name, or correlationid must be spec ified in the query. If name or correrlationid are specified, the latest status is provided. Response

<statusresponse> <queryid> <querytimestamp></querytimestamp> SAME CONTENT AS NOTIFICATION ABOVE </queryid>

</statusres[pmse>



- END OF DOCUMENT -

Alu 9900 wng_congestion_notification_interface_v1 3_external

Technology

Transcript of Alu 9900 wng_congestion_notification_interface_v1 3_external