NSP Network Services Platform Network Functions Manager - Packet (NFM-P) Release 17.12 XML API Developer Guide 3HE-12018-AAAE-TQZZA Issue 1 December 2017 NFM-P Legal notice Nokia is a registered trademark of Nokia Corporation. Other products and company names mentioned herein may be trademarks or tradenames of their respective owners. The information presented is subject to change without notice. No responsibility is assumed for inaccuracies contained herein. © 2017 Nokia. Release 17.12 December 2017 2 3HE-12018-AAAE-TQZZA Issue 1 NFM-P Contents About this document..........................................................................................................................................11 1 Product and support....................................................................................................................................13 1.1 NFM-P product overview...................................................................................................................13 1.2 XML API ...........................................................................................................................................13 1.3 About this guide ................................................................................................................................15 1.4 To display the XML API SDK Sample Code Navigator......................................................................16 1.5 Redundant network configurations....................................................................................................17 1.6 Supported devices and technologies ................................................................................................18 1.7 Before you begin ...............................................................................................................................18 1.8 Open interfaces professional support ...............................................................................................19 1.9 Recommended upgrade path............................................................................................................19 2 Safety information........................................................................................................................................21 2.1 Structure of safety statements ..........................................................................................................21 3 Schema and FDN changes ..........................................................................................................................23 3.1 XML API schema changes ................................................................................................................23 3.2 NFM-P object FDN changes .............................................................................................................23 4 Communicating with the NFM-P .................................................................................................................25 4.1 Overview ...........................................................................................................................................25 4.2 NFM-P system components..............................................................................................................25 4.3 OSS client interfaces.........................................................................................................................26 4.4 Secure communication......................................................................................................................27 4.5 SSL message encryption ..................................................................................................................28 4.6 To generate an MD5-hashed password for NFM-P main server access...........................................30 4.7 XML API security features controlled through the NFM-P client GUI ................................................31 4.8 Workflow to use the XML API............................................................................................................33 5 Event monitoring using JMS.......................................................................................................................35 5.1 JMS overview....................................................................................................................................35 5.2 JMS and redundancy ........................................................................................................................35 5.3 JMS statistics ....................................................................................................................................35 5.4 JMS connections...............................................................................................................................36 5.5 JMS subscriptions .............................................................................................................................37 5.6 JMS message filtering.......................................................................................................................39 Release 17.12 December 2017 Issue 1 3HE-12018-AAAE-TQZZA 3 NFM-P 5.7 Managing and monitoring client sessions .........................................................................................58 5.8 Connection monitoring and error recovery........................................................................................59 5.9 Workflow to establish an NFM-P JMS connection ............................................................................62 5.10 NFM-P JMS client configuration and testing .....................................................................................63 5.11 To configure the initial JMS context...................................................................................................64 5.12 To compile and connect an NFM-P JMS client..................................................................................64 5.13 To record and replay a JMS message stream...................................................................................66 5.14 To close a JMS client session, or remove a durable subscription.....................................................67 5.15 To determine the Java version ..........................................................................................................67 6 XML requests................................................................................................................................................69 6.1 HTTP communication with the NFM-P..............................................................................................69 6.2 HTTP POST method .........................................................................................................................69 6.3 To post an XML request to the NFM-P..............................................................................................69 6.4 Monitoring connection status using XML API ping ............................................................................70 6.5 XML API ping.....................................................................................................................................71 6.6 Workflow to set up and operate an HTTP XML request-response connection..................................72 6.7 Viewing XML requests ignored by the NFM-P ..................................................................................73 6.8 XML API system commands .............................................................................................................73 6.9 Obtaining the local server time of a request......................................................................................73 6.10 Identifying the NFM-P software release and patch level...................................................................74 7 XML API filtering...........................................................................................................................................77 7.1 XML API filter types...........................................................................................................................77 7.2 Result filtering ...................................................................................................................................79 7.3 JMS simple message filters ..............................................................................................................82 7.4 JMS advanced message filters .........................................................................................................82 7.5 Assigning OSS alarm filters from the NFM-P client GUI ...................................................................85 7.6 OAM test result filtering.....................................................................................................................85 7.7 Inventory filtering...............................................................................................................................85 7.8 Statistics filtering ...............................................................................................................................86 7.9 Configuration management result filtering ........................................................................................86 8 XML API information model overview ........................................................................................................87 8.1 XML API information