Specifications

1-15
Cisco CRS-1 Series Carrier Routing System XML API Guide
OL-4596-02
Chapter 1 Cisco CRS-1 Series XML API Overview
Cisco CRS-1 Series XML API and Cisco CRS-1 Series Router System Features
• How to use Cisco CRS-1 Series XML to configure the Cisco CRS-1 Series router:
– Using the two–stage “target configuration” mechanism provided by the Cisco CRS-1 Series
configuration manager
– Using features such as locking, loading, browsing, modifying, saving, and committing the
configuration
• Accessing the Cisco CRS-1 Series router’s operational data with XML
• Working with the native management data object class hierarchies:
– To represent the native data objects in XML
– To use various techniques for structuring XML requests to access the management data of
interest, including the use of wildcards and filters
• Encapsulating CLI commands in XML
• How error information is returned to the client application
• Using iterators for large data retrieval
• Handling event notifications with XML
• How authorization of client requests is enforced
• Versioning of the Cisco CRS-1 Series XML schemas
• Generation and packaging of the Cisco CRS-1 Series XML schemas
Cisco CRS-1 Series XML API and Cisco CRS-1 Series Router
System Features
Using the Cisco CRS-1 Series XML API, an external client application can send XML encoded
management requests to an XML agent running on the Cisco CRS-1 Series router. The initial release of
the API supports CORBA as the transport mechanism. Using CORBA, the client application sends XML
encoded requests to the router through remote operation calls. The remote operation interface is
implemented on the router by the CORBA specific XML agent. Later on, the Cisco CRS-1 Series XML
API can support other transport mechanisms, which might include terminal based protocols such as
Telnet and Secure Shell (SSH). The Cisco CRS-1 Series XML API interface described in this document
applies equally to all supported transports.
Before an XML session is established, the XML transport and XML agent must be enabled on the router.
For more information, see Chapter 11, “XML Transport and Event Notifications.”
A client request sent to the Cisco CRS-1 Series router must specify the different types of operations to
be carried out. The following three general types of management operations are supported through XML:
• Native data access (get, set, delete, and so on) using the native management data model.
• Configuration services for more advanced configuration management through the Configuration
Manager.
• Traditional CLI access where the CLI commands and command responses are encapsulated in XML.
When a client request is received by an XML agent on the router, the request is routed to the appropriate
XML operation provider in the internal Cisco CRS-1 Series XML API library for processing. After all
the requested operations are processed, the XML agent receives the result and then sends the XML
encoded response stream on to the client.