Alu 9900 wng_nbi_v03

539 views

Published on

Published in: Technology
0 Comments
2 Likes
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total views
539
On SlideShare
0
From Embeds
0
Number of Embeds
2
Actions
Shares
0
Downloads
21
Comments
0
Likes
2
Embeds 0
No embeds

No notes for slide

Alu 9900 wng_nbi_v03

  1. 1. 9900 WNG North Bound Interface for Data Export 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.
  2. 2. Alcatel-Lucent 9900 WNG North Bound Interface Last Revised: 2011.11.11 Page 2 of 16 Version 0.3 This document contains Confidential Information of Alcatel-Lucent TABLE OF CONTENTS 1. SCOPE...................................................................................................................................................3 2. 9900 WNG NORTH BOUND INTERFACE ........................................................................................4 3. NBI FOR BULK TRANSFER OF ANALYTICS DATA.....................................................................5 3.1 Client Registration Procedure ...........................................................................................................5 3.2 Operational Characteristics of the Interface......................................................................................5 3.3 Bulk Analytics Data Files Description..............................................................................................5 3.3.1 Traffic Summary Table............................................................................................................5 3.3.2 Subscriber Summary Table......................................................................................................7 3.3.3 Node Summary Table..............................................................................................................9 3.4 Performance Characteristics............................................................................................................12 4. NBI FOR REAL-TIME OF ANALYTICS DATA RECORDS...........................................................13 4.1 Client Registration Procedure .........................................................................................................13 4.2 Operational Characteristics of the Interface....................................................................................13 4.3 Session Record Description ............................................................................................................13 4.4 Performance Characteristics............................................................................................................14 APPENDIX A: MAPPING TABLES FOR ENUMERATED DATA ..........................................................15
  3. 3. Alcatel-Lucent 9900 WNG North Bound Interface Last Revised: 2011.11.11 Page 3 of 16 Version 0.3 This document contains Confidential Information of Alcatel-Lucent 1. SCOPE This document describes the interface from the 9900 WNG to export of data from 9900 WNG Flow Processor to external systems. The interface is intended to enable external analytics engine to leverage 9900 WNG data to create the necessary analytic reports that may require correlation with other non-9900 WNG data.
  4. 4. Alcatel-Lucent 9900 WNG North Bound Interface Last Revised: 2011.11.11 Page 4 of 16 Version 0.3 This document contains Confidential Information of Alcatel-Lucent 2. 9900 WNG NORTH BOUND INTERFACE The 9900 WNG North Bound Interface (NBI) is designed to allow efficient transport of both bulk and real-time data to external systems. As such, this NBI Application Programming Interface (API) will employ two (2) distinct mechanisms to support the transfer function – • For bulk data export, Secure Copy (SCP) Protocol will be used • For real-time data, User Datagram Protocol (UDP) will be used SCP uses secure shell (SSH) for data transfer and utilizes the same mechanisms for authentication, thereby ensuring the authenticity of the data in transit. By default, TCP port 22 will be used. Through this interface, the 9900 WNG Flow Processor will periodically export the processed analytic data to the client system who had been registered to receive the data. For real-time data, UDP is chosen as a light-weight protocol to support efficient streaming of information between systems.
  5. 5. Alcatel-Lucent 9900 WNG North Bound Interface Last Revised: 2011.11.11 Page 5 of 16 Version 0.3 This document contains Confidential Information of Alcatel-Lucent 3. NBI FOR BULK TRANSFER OF ANALYTICS DATA SCP will be used as the transfer protocol for analytics data that the 9900 WNG Flow Processor will generate and push to client systems on a periodic basis. The following sections describe the operational details of this interface. 3.1 Client Registration Procedure The 9900 WNG Flow Processor must be provisioned with the IP address of the client system(s) where data will be exported to. This configuration should be completed as part of 9900 WNG Flow Processor provisioning. On the client system, it must be set up such that it will accept SSH connection request from the 9900 WNG Flow Processor so that the transfer process can commence. 3.2 Operational Characteristics of the Interface As described in section 2, the 9900 WNG Flow Processor will use the SCP protocol to transfer the summary table files to the client system(s). The 9900 WNG Flow Processor will first request to open a SSH connection to the registered client prior to actual file (data) transfer. Once the connection is established, the client should have initiated its SCP process to operate in Sink mode so that it is ready to accept the data file that will be sent then stored on local storage. 3.3 Bulk Analytics Data Files Description The 9900 WNG Flow Processor will export the following analytics data tables to the client on a periodic basis: Table Name Frequency Traffic Summary Table Hourly Subscriber Summary Table Daily Node Summary Table Hourly & Daily The table is transferred as a series of fields, each separated by the “|” character as the delimiter. The client needs to use the table definition to decode the value or meaning of the fields received. The table is sent in the following sequence: row1-column1|row1-column2|…|row2-column1|row2-column2|… |rowM-columnN|EOL 3.3.1 Traffic Summary Table The traffic summary table provides a broad set of parameters that describes the traffic flow monitored by the 9900 WNG in the past hour.
  6. 6. Alcatel-Lucent 9900 WNG North Bound Interface Last Revised: 2011.11.11 Page 6 of 16 Version 0.3 This document contains Confidential Information of Alcatel-Lucent The filename of the table is of the format: trafficSummary_<YYYY><MM><DD><HH> where: <YYYY> = Year (all four digits of the year) <MM> = Month [01..12] <DD> = Day [01..31] <HH> = Hour of day [00..23] For example, the hourly summary for the 18th hour on November 10th 2011 will have the file name of trafficSummary_2011111018 Each row of the table consists of the following fields: realm|network|rnc|devicetype|application|flowCount|upBytes|upPkts |upAirtime|upConnSetup|downBytes|downPkts|downAirtime|downConnSet up|loss|downTcpPkts|busyTime|downTcpBytes|veryBusyTime|veryBusyBy tes|ranHandshakeRTT|ranHandshakeRTTSamples|ranRTT|ranRTTSamples| EOL The data type definition for each of the fields is summarized in the table below: Field Type Description realm Integer Realm/apn id network Integer network type: 1xrtt, DO, or LTE rnc Integer rnc id devicetype String Device model application Integer application id flowCount Integer number of flows upBytes Integer Uplink bytes upPkts Integer uplink packets upAirtime Integer Airtime due to uplink packets upConnSetup Integer connection setups due to uplink packets downBytes Integer Downlink bytes downPkts Integer Downlink packets downAirtime Integer Airtime due to downlink packets downConnSetup Integer number of download connection setups loss Integer number of packet loss downTcpPkts Integer number of download TCP packets busyTime Integer Number of milliseconds with TCP downloading downTcpBytes Integer Total downlink TCP bytes veryBusyTime Integer Number of milliseconds with TCP downloading – excluding slow start veryBusyBytes Integer Total downlink TCP bytes – excluding slow start ranHandshakeRTT Integer Sum of RTT of ran handshake in milliseconds
  7. 7. Alcatel-Lucent 9900 WNG North Bound Interface Last Revised: 2011.11.11 Page 7 of 16 Version 0.3 This document contains Confidential Information of Alcatel-Lucent ranHandshakeRTTSamples Integer number of samples for ran handshake RTT ranRTT Integer Total ran RTT in milliseconds ranRTTSamples Integer number of samples for ran RTT Note that the following fields are enumerated types where a mapping table from numeric value to actual decription will be provided to facilitate decoding of the actual meaning of the field: • network • devicetype • application 3.3.2 Subscriber Summary Table The subscriber summary table provides a summary of signaling and bearer activities consumed by the specified subscriber within the 24 hour period of the day. The filename of the table is of the format: subscriber_Summary_<YYYY><MM><DD><HH> where: <YYYY> = Year (all four digits of the year) <MM> = Month [01..12] <DD> = Day [01..31] For example, the (daily) summary for November 15th 2011 will have the file name of subscriber_Summary_20111115 Each row of the table consists of the following fields: mobileid_str|mobileid|realm|deviceid|device_prefix|reverse_msid|netw orktype|session_flags|handoff_2G3G|handoff_2G4G|handoff_3G4G|handoff _4G3G|handoff_4G2G|handoff_3G2G|firstSeen|lastSeen|duration|numSessi ons|numIPaddr|numHAAddr|orig_pkts|orig_flows|orig_bytes|orig_conns|o rig_air|recv_pkts|recv_flows|recv_bytes|recv_conns|recv_air|minRTT|m axRTT|avgRTT|totalRTTSamples|pktLoss|downTcpPkts|minRanHandshakeRTT| maxRanHandshakeRTT|avgRanHandshakeRTT|totalRanHandshakeRTTSamples|mi nInetHandshakeRTT|maxInetHandshakeRTT|avgInetHandshakeRTT|totalInetH andshakeRTTSamples|minSaturatedThru|maxSaturatedThru|down_busy_bytes |busyTime|very_busy_bytes|veryBusyTime|uni_orig_pkts|uni_orig_flows| uni_orig_bytes|uni_recv_pkts|uni_recv_flows|uni_recv_bytes|os_detect ed|os_flags|gn_success_count|iups_success_count|s1_success_count|s11 _success_count|s5_success_count|gn_failure_count|iups_failure_count| s1_failure_count|s11_failure_count|s5_failure_count The data type definition for each of the fields is summarized in the table below: Field Type Description mobileid_str String NAI/IMSI
  8. 8. Alcatel-Lucent 9900 WNG North Bound Interface Last Revised: 2011.11.11 Page 8 of 16 Version 0.3 This document contains Confidential Information of Alcatel-Lucent mobileid Integer mobile id realm Integer APN /realm id deviceid String ESN/MEID/IMEI device_prefix String prefix of device id reverse_msid String reverse of msid networktype Integer type of network session_flags Integer session flag handoff_2G3G Integer number of handoff on 2G3G handoff_2G4G Integer number of handoff on 2G4G handoff_3G4G Integer number of handoff on 3G4G handoff_4G3G Integer number of handoff on 4G3G handoff_4G2G Integer number of handoff on 4G2G handoff_3G2G Integer number of handoff on 3G2G firstSeen Double first seen time of this subscriber lastSeen Double last seen time of this subscriber duration Integer duration of sessions in minutes numSessions Integer number of sessions numIPaddr Integer number of IP addresses numHAAddr Integer number of HA addresses orig_pkts Integer number of originated packets orig_flows Integer number of originated flows orig_bytes Integer originated traffic volume in bytes orig_conns Integer number of connection setups by the sub orig_air Integer airtime due to originating packets in minutes recv_pkts Integer number of received packets recv_flows Integer number of received flows recv_bytes Integer received bytes recv_conns Integer Number of connection setups by the network recv_air Integer airtime in ms due to receiving packets minRTT Integer minimum RTT in milliseconds maxRTT Integer maximum RTT in milliseconds avgRTT Integer average RTT in milliseconds totalRTTSamples Integer total number of RTT samples pktLoss Integer number of packet loss downTcpPkts Integer number of download TCP packets minRanHandshakeRTT Integer minimum of RAN handshake RTT in milliseconds maxRanHandshakeRTT Integer maximum of RAN handshake RTT in minutes avgRanHandshakeRTT Integer average of RAN handshake RTT in minutes totalRanHandshakeRTTSamples Integer total number of RAN handshake RTT samples
  9. 9. Alcatel-Lucent 9900 WNG North Bound Interface Last Revised: 2011.11.11 Page 9 of 16 Version 0.3 This document contains Confidential Information of Alcatel-Lucent minInetHandshakeRTT Integer minimum of Inet handshake RTT maxInetHandshakeRTT Integer maximum of Inet handshake RTT avgInetHandshakeRTT Integer average of Inet handshake RTT totalInetHandshakeRTTSamples Integer total number of Inet handshake RTT samples minSaturatedThru Double minimum saturated throughput in kbps maxSaturatedThru Double maximum saturated throughput in kbps down_busy_bytes Integer busy download volume in bytes busyTime Integer busy time in milliseconds very_busy_bytes Integer very busy download volume in bytes veryBusyTime Integer very busy time in milliseconds uni_orig_pkts Integer number of originated packets for uni-directional traffic uni_orig_flows Integer number of originated flows for uni-directional traffic uni_orig_bytes Integer originated volume for uni-directional traffic in bytes uni_recv_pkts Integer number of received packets for uni-directional traffic uni_recv_flows Integer number of received flows for uni-directional traffic uni_recv_bytes Integer received volume for uni-directional traffic in bytes os_detected String detected operating system os_flags Integer operating system flags gn_success_count Integer success count of gn iups_success_count Integer success count of iups s1_success_count Integer success count of s1 s11_success_count Integer success count of s11 s5_success_count Integer success count of s5 gn_failure_count Integer failure count of gn iups_failure_count Integer failure count of iups s1_failure_count Integer failure count of s1 s11_failure_count Integer failure count of s11 s5_failure_count Integer failure count of s5 3.3.3 Node Summary Table The node summary table summarizes the performance and resource usage on a hourly and daily basis for each type of network elements; which include RNC, PDSN, HA, eNodeB?, SGSN, GGSN, SGW and PGW. The filename of the daily table is of the format: daily_<XX>_Summary_<YYYY><MM><DD> where: <XX> = Network element type (bs = base station/eNB)
  10. 10. Alcatel-Lucent 9900 WNG North Bound Interface Last Revised: 2011.11.11 Page 10 of 16 Version 0.3 This document contains Confidential Information of Alcatel-Lucent <YYYY> = Year (all four digits of the year) <MM> = Month [01..12] <DD> = Day [01..31] The hourly table name uses similar format: hourly_<XX>_Summary_<YYYY><MM><DD><HH> where <XX>, <YYYY>, <MM>, <DD> is defined as per the daily table file naming convention, and <HH> = Hour of day [0..23] For example, the daily base stations node summary for September 30th 2011 will have the file name of daily_bs_Summary_20110930 Each row of the table consists of the following fields: createtime|endtime|node|num_hoin|num_hoou|num_conn_setup_up|num_c onn_setup_down|loss_rate|num_samples|down_rtt_min|down_rtt_max|do wn_rtt_mean|down_rtt_samples|down_tcp_pkts|down_tcp_loss|down_bus y_bytes|busy_time|very_busy_bytes|very_busy_time|num_active_mn|mi n_num_active_mn|max_num_active_mn|m2i_pkts|m2i_flows|m2i_bytes|i2 m_pkts|i2m_flows|i2m_bytes|m2m_pkts_up|m2m_flows_up|m2m_bytes_up| m2m_pkts_down|m2m_flows_down|m2m_bytes_down|num_uni_m2i_pkts|num_ uni_m2i_flows|num_uni_m2i_bytes|num_uni_i2m_pkts|num_uni_i2m_flow s|num_uni_i2m_bytes|num_uni_m2m_pkts_up|num_uni_m2m_flows_up|num_ uni_m2m_bytes_up|num_uni_m2m_pkts_down|num_uni_m2m_flows_down|num _uni_m2m_bytes_down|tcpreset_i2m_pkts|tcpreset_m2i_pkts|tcpreset_ m2m_pkts_up|tcpreset_m2m_pkts_down|icmpunreach_i2m_pkts|icmpunrea ch_m2i_pkts|icmpunreach_m2m_pkts_up|icmpunreach_m2m_pkts_down|air time_up|airtime_down|peak_hour_volume|peak_volume|peak_hour_conn_ setups|peak_conn_setups Field Type Range createtime Double create time endtime Double end time node Integer node ID num_hoin Integer Number of incoming hanoff num_hoou Integer Number of outgoing handoff num_conn_setup_up Integer number of mobile initiated connection setup num_conn_setup_down Integer number of network initiated connection setup loss_rate Double ratio of # loss packets over total # of packets num_samples Integer number of samples for loss rate estimate down_rtt_min Integer minimum of downlink RTT in milliseconds down_rtt_max Integer maximum of downlink RTT in milliseconds down_rtt_mean Integer mean of downlink RTT in milliseconds down_rtt_samples Integer number of download RTT samples down_tcp_pkts Integer number of download TCP packets
  11. 11. Alcatel-Lucent 9900 WNG North Bound Interface Last Revised: 2011.11.11 Page 11 of 16 Version 0.3 This document contains Confidential Information of Alcatel-Lucent down_tcp_loss Integer number of TCP packets loss down_busy_bytes Integer busy download volume in bytes busy_time Integer busy time in milliseconds very_busy_bytes Integer very busy download volume in bytes very_busy_time Integer very busy time in milliseconds num_active_mn Integer Average number of active subscribers min_num_active_mn Integer Min. number of active subscribers max_num_active_mn Integer Max. number of active subscribers m2i_pkts Integer number of mobile to Internet packets m2i_flows Integer number of mobile to Internet flows m2i_bytes Integer volume of mobile to Internet in bytes i2m_pkts Integer number of Internet to mobile packets i2m_flows Integer number of Internet to mobile flows i2m_bytes Integer volume of Internet to mobile in bytes m2m_pkts_up Integer number of mobile to mobile upload packets m2m_flows_up Integer number of mobile to mobile upload flows m2m_bytes_up Integer upload volume of mobile to mobile in bytes m2m_pkts_down Integer number of mobile to mobile download packets m2m_flows_down Integer number of mobile to mobile download flows m2m_bytes_down Integer download volume of mobile to mobile in bytes num_uni_m2i_pkts Integer number of uni-directional m2i packets num_uni_m2i_flows Integer number of uni-directional m2i flows num_uni_m2i_bytes Integer volume of uni-directional m2i in bytes num_uni_i2m_pkts Integer number of uni-directional i2m packets num_uni_i2m_flows Integer number of uni-directional i2m flows num_uni_i2m_bytes Integer volume of uni-directional i2m in bytes num_uni_m2m_pkts_up Integer number of uni-directional upload m2m packets num_uni_m2m_flows_up Integer number of uni-directional upload m2m flows num_uni_m2m_bytes_up Integer volume of uni-directional upload m2m in bytes num_uni_m2m_pkts_down Integer number of uni-directional download m2m packets num_uni_m2m_flows_down Integer number of uni-directional download m2m flows num_uni_m2m_bytes_down Integer volume of uni-directional download m2m in bytes tcpreset_i2m_pkts Integer number of i2m tcp reset packets tcpreset_m2i_pkts Integer number of m2i tcp reset packets tcpreset_m2m_pkts_up Integer number of m2m upload tcp reset packets tcpreset_m2m_pkts_down Integer number of m2m download tcp reset packets icmpunreach_i2m_pkts Integer number of i2m icmp unreachable packets icmpunreach_m2i_pkts Integer number of m2i icmp unreachable packets icmpunreach_m2m_pkts_up Integer number of m2m upload icmp unreachable packets
  12. 12. Alcatel-Lucent 9900 WNG North Bound Interface Last Revised: 2011.11.11 Page 12 of 16 Version 0.3 This document contains Confidential Information of Alcatel-Lucent icmpunreach_m2m_pkts_down Integer number of m2m download icmp unreachable packets airtime_up Integer upload airtime airtime_down Integer download airtime peak_hour_volume Double peak hour by volume peak_volume Integer peak volume peak_hour_conn_setups Double peak hour by connection setups peak_conn_setups Integer peak number of connection setups 3.4 Performance Characteristics In Release 4, each 9900 WNG Flow Processor can support up to one (1) external client application to which data will be exported to.
  13. 13. Alcatel-Lucent 9900 WNG North Bound Interface Last Revised: 2011.11.11 Page 13 of 16 Version 0.3 This document contains Confidential Information of Alcatel-Lucent 4. NBI FOR REAL-TIME OF ANALYTICS DATA RECORDS The 9900 WNG Flow Processor will support export of real-time session records. These records are generated during session establishment and termination. In order to deliver these records in a timely manner to external client applications, these records will be streamed via a simple message format over UDP. 4.1 Client Registration Procedure The 9900 WNG Flow Processor must be provisioned with the IP address of the client system(s) where the session records will be sent to. This configuration should be completed as part of 9900 WNG Flow Processor provisioning. 4.2 Operational Characteristics of the Interface Due to real-time sensitivity of the information, the 9900 WNG Flow Processor will utilize UDP as the primary protocol to support transmission of session records to client application. UDP is chosen over Transmission Control Protocol (TCP) for its performance and deterministic behaviour. TCP’s inherit reliability mechanism, including re-transmission and congestion management features, will result in un-predictable delivery time for these real-time sensitive information. The session records will be sent within the UDP payload, and will be formatted as a message that consists of three sections: • Header that contains a timestamp of when the message (session record) is sent, • Record type which can be one of START_SESSION, END_SESSION or INTERIM_SESSION, • Contents of the session record which consists of a list of values, without including the definition of what the values are. The comma (“,”) character will be used as field delimiter to separate fields. The following provide a sample format of the UDP payload that represents the message: time=1322079757.891,START_SESSION,123456789012345@xx.yyy.com,62,1,APN,1 23123789789,2043 4.3 Session Record Description Three types of session records will be sent from the 9900 WNG to the client application: • Session Start record – sent upon session establishment • Session Termination record – sent upon session termination • Interim Session record – sent every 4 hours for long duration sessions The Session Start record contains the following fields:
  14. 14. Alcatel-Lucent 9900 WNG North Bound Interface Last Revised: 2011.11.11 Page 14 of 16 Version 0.3 This document contains Confidential Information of Alcatel-Lucent • Subscriber IMSI / NAI • Device ID – similar to Traffic Summary table, this field is a numeric value where the actual device type needs to be looked up via the external mapping table • Network type – 2G / 3G/ LTE • Realm / APN • Subscriber IPv4 address – 5-tuple IP address • BSID / eCGI The Session Termination and Interim Session records contain the following fields: • Subscriber IMSI / NAI • Device ID – similar to Traffic Summary table, this field is a numeric value where the actual device type needs to be looked up via the external mapping table • Network type – 2G / 3G/ LTE • Realm / APN • MSISDN / MSID • First-seen time – • Last-seen time – • Total session duration – in seconds • upLink byte count • downLink byte count • upLink packet count • downLink packet count • IP flow count • # of upLink signaling events • # of downLink signaling events • Average throughput – in kbps • Average TCP data packet RTT – in seconds • Average TCP 3-way handshake in seconds – include both client & server side • Average TCP RAN loss 4.4 Performance Characteristics In Release 4, each 9900 WNG Flow Processor can support up to 65 million session records update per hour. Each WNG Flow Processor will support real-time streaming of records to one (1) client application.
  15. 15. Alcatel-Lucent 9900 WNG North Bound Interface Last Revised: 2011.11.11 Page 15 of 16 Version 0.3 This document contains Confidential Information of Alcatel-Lucent APPENDIX A: MAPPING TABLES FOR ENUMERATED DATA TBD
  16. 16. Alcatel-Lucent 9900 WNG North Bound Interface Last Revised: 2011.11.11 Page 16 of 16 Version 0.3 This document contains Confidential Information of Alcatel-Lucent - END OF DOCUMENT -

×