Preface

Table Of Contents

Preface

About This Document

Intended Audience

Organization of the Document

Related Documentation

Document Conventions

Obtaining Documentation

Cisco.com

Ordering Documentation

Documentation Feedback

Obtaining Technical Assistance

Cisco Technical Support Website

Submitting a Service Request

Definitions of Service Request Severity

Obtaining Additional Publications and Information

Preface

This document describes the extensible markup language (XML) application programming interface (API) provided by the Cisco CRS-1 Series Carrier Routing System (Cisco CRS-1 Series) to developers of external management applications. The Cisco CRS-1 Series XML interface provides a mechanism for Cisco CRS-1 Series router configuration and monitoring using XML formatted request and response streams.

The XML schemas referenced in this guide are used by the management application developer to integrate client applications with the Cisco CRS-1 Series programmable interface. The Cisco CRS-1 Series XML API is also available for use on any Cisco platform running Cisco IOS XR software.

Note The XML API code is available for use on any Cisco platform that runs Cisco IOS XR software.

The preface contains the following sections:

• About This Document

• Related Documentation

• Document Conventions

• Obtaining Documentation

• Documentation Feedback

• Obtaining Technical Assistance

• Obtaining Additional Publications and Information

About This Document

This document provides a comprehensive description of the XML interface to the Cisco CRS-1 Series router. The goal of this guide is to help Cisco CRS-1 Series 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 XML API to build custom end-user interfaces for configuration and information retrieval and display.

Intended Audience

This document's audience is expected to have background knowledge and information about XML, Common Object Request Broker Architecture (CORBA), and network management.

This document will be of particular use to those who want to build management client applications.

Organization of the Document

This document consists of the following chapters:

• Chapter 1, "Cisco CRS-1 Series XML API Overview"

• Chapter 2, "Cisco CRS-1 Series XML Router Configuration and Management"

• Chapter 3, "Cisco CRS-1 Series XML Operational Requests and Fault Management"

• Chapter 4, "Cisco CRS-1 Series XML and Native Data Operations"

• Chapter 5, "Cisco CRS-1 Series XML and Native Data Access Techniques"

• Chapter 6, "Cisco CRS-1 Series XML and Encapsulated CLI Operations"

• Chapter 7, "Cisco CRS-1 Series XML and Large Data Retrieval (Iterators)"

• Chapter 8, "Cisco CRS-1 Series XML Security"

• Chapter 9, "Cisco CRS-1 Series XML Schema Versioning"

• Chapter 10, "Error Reporting in Cisco CRS-1 Series XML Responses"

• Chapter 11, "XML Transport and Event Notifications"

• "Summary of Cisco CRS-1 Series XML API Configuration Tags"

• Chapter 13, "Cisco CRS-1 Series XML Schemas"

• "Sample BGP Configuration"

Related Documentation

The following list of related documents are useful:

•Cisco CRS-1 Series Carrier Routing System Getting Started Guide

•Cisco Craft Works Interface Configuration Guide

•Cisco CRS-1 Series Carrier Routing System Release Notes

•Cisco IOS XR software configuration guides and command references

Document Conventions

This publication uses the following conventions:

•The symbol ^ represents the key labeled Ctrl. For example, the key combination ^z means "hold down the Ctrl key while you press the Z key."

Command descriptions use these conventions:

•Examples that contain system prompts denote interactive sessions, indicating the commands that you should enter at the prompt. The system prompt indicates the current level of the EXEC command interpreter. For example, the prompt router> indicates the user level, and the prompt router# indicates the privileged level. Access to the privileged level usually requires a password.

•Commands and keywords are in boldface font.

•Arguments for which you supply values are in italic font.

•Elements in square brackets ([ ]) are optional.

–Alternative but required keywords are grouped in braces ({ }) and separated by vertical bars (|).

Examples use these conventions:

•Terminal sessions and sample console screen displays are in screen font.

•Information you enter is in boldface screen font.

•Nonprinting characters, such as passwords, are in angle brackets (< >).

•Default responses to system prompts are in square brackets ([ ]).

•An exclamation point (!) at the beginning of a line indicates a comment line.

Note Means reader take note. Notes contain helpful suggestions or references to material not covered in the publication.

Tip Means the following information will help you solve a problem. The information in tips might not contain troubleshooting or task-specific actions, but tips do contain useful information.

Caution Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data.

Obtaining Documentation

Cisco documentation and additional literature are available on Cisco.com. Cisco also provides several ways to obtain technical assistance and other technical resources. These sections explain how to obtain technical information from Cisco Systems.

Cisco.com

You can access the most current Cisco documentation at this URL:

http://www.cisco.com/univercd/home/home.htm

You can access the Cisco website at this URL:

http://www.cisco.com

You can access international Cisco websites at this URL:

http://www.cisco.com/public/countries_languages.shtml

Ordering Documentation

You can find instructions for ordering documentation at this URL:

http://www.cisco.com/univercd/cc/td/doc/es_inpck/pdi.htm

You can order Cisco documentation in these ways:

•Registered Cisco.com users (Cisco direct customers) can order Cisco product documentation from the Ordering tool:

http://www.cisco.com/en/US/partner/ordering/index.shtml

•Nonregistered Cisco.com users can order documentation through a local account representative by calling Cisco Systems Corporate Headquarters (California, USA) at 408 526-7208 or, elsewhere in North America, by calling 800 553-NETS (6387).

Documentation Feedback

You can send comments about technical documentation to bug-doc@cisco.com.

You can submit comments by using the response card (if present) behind the front cover of your document or by writing to the following address:

Cisco Systems
Attn: Customer Document Ordering
170 West Tasman Drive
San Jose, CA 95134-9883

We appreciate your comments.

Obtaining Technical Assistance

For all customers, partners, resellers, and distributors who hold valid Cisco service contracts, Cisco Technical Support provides 24-hour-a-day, award-winning technical assistance. The Cisco Technical Support Website on Cisco.com features extensive online support resources. In addition, Cisco Technical Assistance Center (TAC) engineers provide telephone support. If you do not hold a valid Cisco service contract, contact your reseller.

Cisco Technical Support Website

The Cisco Technical Support Website provides online documents and tools for troubleshooting and resolving technical issues with Cisco products and technologies. The website is available 24 hours a day, 365 days a year at this URL:

http://www.cisco.com/techsupport

Access to all tools on the Cisco Technical Support Website requires a Cisco.com user ID and password. If you have a valid service contract but do not have a user ID or password, you can register at this URL:

http://tools.cisco.com/RPF/register/register.do

Submitting a Service Request

Using the online TAC Service Request Tool is the fastest way to open S3 and S4 service requests. (S3 and S4 service requests are those in which your network is minimally impaired or for which you require product information.) After you describe your situation, the TAC Service Request Tool automatically provides recommended solutions. If your issue is not resolved using the recommended resources, your service request will be assigned to a Cisco TAC engineer. The TAC Service Request Tool is located at this URL:

http://www.cisco.com/techsupport/servicerequest

For S1 or S2 service requests or if you do not have Internet access, contact the Cisco TAC by telephone. (S1 or S2 service requests are those in which your production network is down or severely degraded.) Cisco TAC engineers are assigned immediately to S1 and S2 service requests to help keep your business operations running smoothly.

To open a service request by telephone, use one of the following numbers:

Asia-Pacific: +61 2 8446 7411 (Australia: 1 800 805 227)
EMEA: +32 2 704 55 55
USA: 1 800 553 2447

For a complete list of Cisco TAC contacts, go to this URL:

http://www.cisco.com/techsupport/contacts

Definitions of Service Request Severity

To ensure that all service requests are reported in a standard format, Cisco has established severity definitions.

Severity 1 (S1)—Your network is "down," or there is a critical impact to your business operations. You and Cisco will commit all necessary resources around the clock to resolve the situation.

Severity 2 (S2)—Operation of an existing network is severely degraded, or significant aspects of your business operation are negatively affected by inadequate performance of Cisco products. You and Cisco will commit full-time resources during normal business hours to resolve the situation.

Severity 3 (S3)—Operational performance of your network is impaired, but most business operations remain functional. You and Cisco will commit resources during normal business hours to restore service to satisfactory levels.

Severity 4 (S4)—You require information or assistance with Cisco product capabilities, installation, or configuration. There is little or no effect on your business operations.

Obtaining Additional Publications and Information

Information about Cisco products, technologies, and network solutions is available from various online and printed sources.

•Cisco Marketplace provides a variety of Cisco books, reference guides, and logo merchandise. Visit Cisco Marketplace, the company store, at this URL:

http://www.cisco.com/go/marketplace/

•The Cisco Product Catalog describes the networking products offered by Cisco Systems, as well as ordering and customer support services. Access the Cisco Product Catalog at this URL:

http://cisco.com/univercd/cc/td/doc/pcat/

•Cisco Press publishes a wide range of general networking, training and certification titles. Both new and experienced users will benefit from these publications. For current Cisco Press titles and other information, go to Cisco Press at this URL:

http://www.ciscopress.com

•Packet magazine is the Cisco Systems technical user magazine for maximizing Internet and networking investments. Each quarter, Packet delivers coverage of the latest industry trends, technology breakthroughs, and Cisco products and solutions, as well as network deployment and troubleshooting tips, configuration examples, customer case studies, certification and training information, and links to scores of in-depth online resources. You can access Packet magazine at this URL:

http://www.cisco.com/packet

•iQ Magazine is the quarterly publication from Cisco Systems designed to help growing companies learn how they can use technology to increase revenue, streamline their business, and expand services. The publication identifies the challenges facing these companies and the technologies to help solve them, using real-world case studies and business strategies to help readers make sound technology investment decisions. You can access iQ Magazine at this URL:

http://www.cisco.com/go/iqmagazine

•Internet Protocol Journal is a quarterly journal published by Cisco Systems for engineering professionals involved in designing, developing, and operating public and private internets and intranets. You can access the Internet Protocol Journal at this URL:

http://www.cisco.com/ipj

•World-class networking training is available from Cisco. You can view current offerings at this URL:

http://www.cisco.com/en/US/learning/index.html