About this guide

Overview

The NSP NFM-P XML API Developer Guide provides information to help OSS developers create applications that perform NFM-P functions. It is part of the Developer documentation, which also includes the XML API Reference and Schema Reference.

This guide covers the following topics:

  • An overview of the XML API, including the following:

    • an NFM-P and XML API high-level overview

    • redundant configurations and supported devices and technologies

    • open interfaces professional support

  • Information about how an OSS via the XML API can communicate with the NFM-P and the underlying network, including the following:

    • communication with the NFM-P server

    • event monitoring

    • XML requests

    • interworking with other systems

  • Information about the XML API object model that includes the following:

    • XML package descriptions, object properties, and value definitions and relationships

    • XML Reference and XML Schema type and method definitions and descriptions

    • XML message structure and request/response operation

  • Information that a developer can use to help with the development of applications for the following OSS domains:

    • Fault management—provides information for developing an event and alarm management system

    • Inventory management—provides information about inventory retrieval

    • Accounting and Performance Management

    • OAM diagnostic tests

  • Information about how an OSS can be used to make changes to network objects, which can involve creating, deleting, and modifying the objects in the following areas:

    • general configuration using generic method that applies to all areas

    • equipment configuration

    • routing protocol configuration

    • customer and residential subscriber configuration

    • policy configuration

    • service configuration

    • XML service template configuration

    • script management configuration

  • Information about other network management products, such as:

    • CPAM

  • Appendices containing information about the following:

    • best practices

    • troubleshooting client OSS application problems

The following guides, documents, or files are also relevant to an OSS developer:

  • When setting up the NFM-P in your lab environment:

    • NSP Planning Guide—platform support information

    • NSP Installation and Upgrade Guide—installation information

  • When starting to use the NFM-P:

    • NSP NFM-P Classic Management User Guide

  • When developing an OSS application:

    • XML API Reference—contains javadoc-style documentation of the object model, essential for writing XML API requests

    • Schema Reference—contains XSD schema definitions for the object model

    • XML API SDK Sample Code Navigator—includes a library of XML scripts that provides configuration and network management request samples, as well as the corresponding responses, to help developers with OSS integration. The samples in this document can be used as a base on which to build OSS requests.

    • JMS Test Example Code—contains example code for writing JMS subscribers

    See the Network Developer Portal for more information.

  • Other files:

    • MIBs—files are on each main server in the /opt/nsp/nfmp/server/nms/web/tomcat/work/Catalina/localhost/help/eclipse/plugins/ALU_SAM_MIB directory