XML API objects and configurations overview

Introduction

The following sections describe the objects that can be accessed using the XML API and the configurations that can be performed.

CPAA manual switchover

The XML API can be used to manually switchover from a failed CPAA to the redundant CPAA. A switchover can only be performed once every ten minutes. A warning will be sent to the XML API if another switchover is requested prior to this.

Route analyzer

All CPAA configurations can be performed through the XML API, including the use of the XML API to configure and monitor protocol and device configurations such as OSPF and ISIS. The JMS interface notifies the XML API of any changes to the CPAA.

Topology model

The XML API provides a read-only interface for topology objects, such as areas, routers, links, networks, and baselines. The JMS interface notifies the XML API of any changes to the topology model, including baselines.

Topology operations

The following topology operations can be performed through the XML API:

checkpoint

Includes setting, removing, and resetting the baseline for the OSPF. The JMS interface notifies the NFM-P of the objects affected by the baseline operation.
route calculations

See OSPF topology overview for information about shortest path calculations.

Path and monitored prefix

BGP monitored prefix

The following operations can be performed through XML API:

creation and deletion of monitors
retrieval of BGP monitored prefix data

Use subject to agreed restrictions on disclosure and use.