Contents


XML API Developer Guide

Legal notice

Contents

About this document

1. Product and support

NFM-P product overview

XML API

About this guide

Redundant network configurations

Supported devices and technologies

Before you begin

Open interfaces professional support

Recommended upgrade path

2. Schema and FDN changes

XML API schema changes

NFM-P object FDN changes

3. Communicating with the NFM-P

Overview

NFM-P system components

OSS client interfaces

Secure communication

TLS message encryption

To generate an MD5-hashed password for NFM-P main server access

XML API security features controlled through the NFM-P client GUI

Workflow to use the XML API

4. Event monitoring using JMS

JMS overview

JMS connections

JMS and redundancy

JMS statistics

JMS subscriptions

JMS message filtering

Managing and monitoring client sessions

Connection monitoring and error recovery

Workflow to establish an NFM-P JMS connection

NFM-P JMS client configuration and testing

To configure the initial JMS context

To compile and connect an NFM-P JMS client

To record and replay a JMS message stream

To close a JMS client session, or remove a durable subscription

To determine the Java version

5. XML requests

HTTP communication with the NFM-P

HTTP POST method

To post an XML request to the NFM-P

Monitoring connection status using XML API ping

XML API ping

Workflow to set up and operate an HTTP XML request-response connection

Viewing XML requests ignored by the NFM-P

XML API system commands

Obtaining the local server time of a request

Identifying the NFM-P software release and patch level

6. XML API filtering

XML API filter types

Result filtering

JMS simple message filters

JMS advanced message filters

Assigning OSS alarm filters from the NFM-P client GUI

OAM test result filtering

Inventory filtering

Statistics filtering

Configuration management result filtering

7. XML API information model overview

XML API information model overview

Packages

8. XML API Reference

XML API Reference

Main menu

Package list

Classes, structs, and types list

Class details

Type details

Struct details

XML schema changes

JMS changes

To view release-specific XML schema changes

To view release-specific JMS changes

To view deprecated schema items

To view the general methods and types

To view the supported device types

9. XML message structure

XML message structure

CLI command methods

Mapping XML methods to GUI operations

To view GUI operations in the NFM-P User Activity log

User activity log fields

To enable logging of GUI operations on the NFM-P server

To view the GUI operation in the server log

Log file entries for GUI operations

10. Schema Reference

Schema Reference

General schema files

XML method schema files

XML type schema files

Standard properties of classes

11. Fault management

Fault management

Communicating with the NFM-P

Alarm sources

Alarm definitions

Alarm messages

Retrieving alarms

Alarm management

Alarm policies

Alarm correlation

OSS client alarm testing

Workflow to set up alarm management

12. OAM

OAM

References

Key packages and classes

Tests

Test suites

Generated tests

Workflow to generate tests

Scheduling tests

To schedule a test suite using the NFM-P

NE schedule tests

Retrieving results

Ethernet OAM

PM Session OAM

OAM for OmniSwitch

Performance and scalability

13. Inventory management

Inventory management

Network object model

Inventory retrieval methods

To configure remote findToFile result storage

Inventory request processing

Request filters

14. Accounting, performance, and flow monitoring

Accounting, performance, and flow monitoring

References

Key packages and classes

Statistics objects

Statistics collection methods: Scheduled and on-demand statistics

Statistics retrieval methods

Workflow to retrieve statistics data

Statistics retrieval using registerLogToFile

Statistics retrieval using findToFile

Statistics monitoring using JMS

Collecting NFM-P performance statistics

Collecting Application Assurance (AA) accounting statistics

Collecting flow statistics

Collecting JMS performance statistics

Third-party applications for processing statistics

15. Configuration management overview

Configuration management

Configuration methods

Deployments

Workflow to handle deployment failures

16. Device configuration management

Device configuration

Workflow to configure equipment

GNE profiles

GNE profile parameter configuration

Device software upgrades

17. Network configuration management

Network configuration management

Network interface configuration

Workflow to configure network interfaces

Static route configuration

Routing protocol configuration

Workflow to configure a routing protocol

VRRP virtual router configuration

Workflow to configure a virtual router

MPLS, LSP, and service tunnel configuration

Workflow to configure an MPLS path, LSP, and service tunnel

18. Policy configuration management

Policy configuration

References

Key packages and classes

General policy configuration

Policy configuration workflow

Policy methods

19. Service configuration management

Service configuration

References

Key packages and classes

General service configuration

Service configuration workflow

CLI mapping

Customer configuration

Service configuration

Site configuration

SAP configuration

SDP binding configuration

Creating service with site, access interface, and SDP binding in one request

Modifying service configuration

Mirror service

Mirror service package and classes

CLI mapping

Mirror service configuration

VLAN service

VLAN groups

VLAN service configuration

Optical transport service

Optical transport service configuration

Composite services

Composite service configuration

Residential subscriber configuration

20. Script and template configuration management

Script management

Workflow to execute a script

XML API template configuration management

21. CPAM OSS interface

CPAM OSS interface

References

Key packages and classes

CPAM commissioning configuration

Topology and checkpoint management

Route management

Path and prefix monitoring

Fault management

Appendix A. OSS developer best practices

Recommendations

Recommended durable JMS client operation

HTTP communication

JMS communication

Statistics data retrieval with registerLogToFile and find/findToFile

To configure the registerLogToFile or registerSasLogToFile client inactivity check

Appendix B. JMS events

JMS events

JMS event classes

Appendix C. Troubleshooting

Troubleshooting client OSS application problems

The OSS client cannot communicate with the server

An attempt to log in to the NFM-P server fails

Unable to perform an action using the XML API

Receive insufficient privileges to perform this operation on an object exception when performing an action on an NFM-P object

Receive an authorization failure to access an object exception when performing an action on an NFM-P object

Identifying XML messages from specific users

Receive a java.lang.UnsupportedClassVersionError when sending scripts using an OSS client

Receive a java.net.ConnectException when sending scripts using an OSS Client

The OSS client cannot connect with the HTTP or JMS server

The OSS client cannot perform find or findTofile requests