Chapter 1 Cisco Crs-1 Series Xml Api Overview; Introduction - Cisco CRS-1 - Carrier Routing System Router Api Manual

Cisco CRS-1 Series XML API Overview
This chapter contains the following sections:
•
•
•
•

Introduction

The extensible markup language (XML) application programming interface (API) provided by the
Cisco CRS-1 Series Carrier Routing System (Cisco CRS-1 Series) is an interface used for rapid
development of client applications and perl scripts to manage and monitor the Cisco CRS-1 Series router.
The XML interface is specified by the Cisco CRS-1 Series XML schemas. The XML API provides a
mechanism for router configuration and monitoring utilizing an exchange of XML formatted request and
response streams.
Client applications can be used to configure the router, or to request status information from the router,
by encoding a request in Cisco CRS-1 Series XML API tags and sending it to the router. The Cisco
CRS-1 Series router processes the request and sends the response to the client by again encoding the
response in Cisco CRS-1 Series XML API tags. This guide describes the XML requests that can be sent
by external client applications to access router management data, and also details the responses to the
client by the Cisco CRS-1 Series router.
The Cisco CRS-1 Series XML API readily supports available transport layers. The initial release of the
API supports the Common Object Request Broker Architecture (CORBA). Future releases of the API
will support additional transport options.
Customers use a variety of vendor-specific command-line interface (CLI)–based scripts to manage their
routers because no alternative programmatic mechanism is available. In addition, there has not been
available a common framework for developing CLI-based scripts. In response to this need, Cisco CRS-1
Series XML API provides the necessary common framework for rapid development, deployment, and
maintenance of Cisco CRS-1 Series router management.
The Cisco CRS-1 Series Carrier Routing System XML API Guide explains how to use the
Cisco CRS-1 Series XML API to configure Cisco CRS-1 Series routers or request information about
configuration, management, or operation of Cisco CRS-1 Series routers. The goal of this guide is to help
Cisco CRS-1 Series router customers write client applications to interact with the Cisco CRS-1 Series
XML infrastructure on the router, and to also use the Cisco CRS-1 Series Management XML API to
build custom end-user interfaces for configuration and information retrieval and display.
OL-4596-01
"Introduction"
"Cisco CRS-1 Series Management XML Interface"
"Cisco CRS-1 Series XML API and Cisco CRS-1 Series Router System Features"
"Cisco CRS-1 Series XML API Tags"
C H A P T E R
Cisco CRS-1 Series Carrier Routing System XML API Guide
1
1-15