XML API Guide
Page 1
Cisco CRS-1 Series Carrier Routing System XML API Guide Cisco IOS XR Software Release 2.0 Corporate Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 526-4100 Text Part Number: OL-4596-01
Cisco CRS-1 Series Carrier Routing System XML API Guide Cisco IOS XR Software Release 2.0 Corporate Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 526-4100 Text Part Number: OL-4596-01
XML API Guide
Page 2
... BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. All other trademarks mentioned in the United States and certain other company. (0406R) Cisco CRS-1 Series Carrier Routing System XML API Guide Copyright © 2004 Cisco Systems, Inc. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE...
... BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. All other trademarks mentioned in the United States and certain other company. (0406R) Cisco CRS-1 Series Carrier Routing System XML API Guide Copyright © 2004 Cisco Systems, Inc. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE...
XML API Guide
Page 3
... xii Definitions of Service Request Severity xiii Obtaining Additional Publications and Information xiii Cisco CRS-1 Series XML API Overview 15 Introduction 15 Definition of Terms 16 Cisco CRS-1 Series Management XML Interface 16 Cisco CRS-1 Series XML API and Cisco CRS-1 Series Router System Features 17 Cisco CRS-1 Series XML API Tags 18 Basic XML Request Content 18 Top-Level Structure...Tags 21 Native Data Operation Tags 21 Configuration Services Operation Tags 22 CLI Operation Tag 22 Get Next Operation Tag 23 XML Request Batching 23 Cisco CRS-1 Series Carrier Routing System XML API Guide iii
... xii Definitions of Service Request Severity xiii Obtaining Additional Publications and Information xiii Cisco CRS-1 Series XML API Overview 15 Introduction 15 Definition of Terms 16 Cisco CRS-1 Series Management XML Interface 16 Cisco CRS-1 Series XML API and Cisco CRS-1 Series Router System Features 17 Cisco CRS-1 Series XML API Tags 18 Basic XML Request Content 18 Top-Level Structure...Tags 21 Native Data Operation Tags 21 Configuration Services Operation Tags 22 CLI Operation Tag 22 Get Next Operation Tag 23 XML Request Batching 23 Cisco CRS-1 Series Carrier Routing System XML API Guide iii
XML API Guide
Page 5
... Example 57 Get Request: Example 58 Get Request of Nonexistent Data: Example 59 Delete Request: Example 61 Cisco CRS-1 Series XML and Native Data Access Techniques 63 Available Set of Native Data Access Techniques 63 XML Request ...Cisco CRS-1 Series XML and Large Data Retrieval (Iterators) 81 Terminating an Iterator 84 Cisco CRS-1 Series XML Security 87 Authentication 87 Authorization 87 Retrieving Task Permissions 88 Task Privileges 88 Task Names 89 Authorization Failure 89 Cisco CRS-1 Series XML Schema Versioning 91 Major and Minor Version Numbers 91 Cisco CRS-1 Series Carrier Routing System...
... Example 57 Get Request: Example 58 Get Request of Nonexistent Data: Example 59 Delete Request: Example 61 Cisco CRS-1 Series XML and Native Data Access Techniques 63 Available Set of Native Data Access Techniques 63 XML Request ...Cisco CRS-1 Series XML and Large Data Retrieval (Iterators) 81 Terminating an Iterator 84 Cisco CRS-1 Series XML Security 87 Authentication 87 Authorization 87 Retrieving Task Permissions 88 Task Privileges 88 Task Names 89 Authorization Failure 89 Cisco CRS-1 Series XML Schema Versioning 91 Major and Minor Version Numbers 91 Cisco CRS-1 Series Carrier Routing System...
XML API Guide
Page 6
... Information 92 Placement of Version Information 92 Version Lag 93 Version Creep 94 Retrieving Version Information 95 Error Reporting in Cisco CRS-1 Series XML Responses 97 Types of Reported Errors 97 Error Attributes 98 Transport Errors 98 XML Parse Errors 98 XML...Cisco CRS-1 Series Infrastructure Notifications 109 Registration 109 Notification Response 111 Summary of Cisco CRS-1 Series XML API Configuration Tags 113 Cisco CRS-1 Series XML Schemas 115 XML Schema Retrieval 115 Common XML Schemas 115 Component XML Schemas 116 Schema File Organization 116 Cisco CRS-1 Series Carrier Routing System...
... Information 92 Placement of Version Information 92 Version Lag 93 Version Creep 94 Retrieving Version Information 95 Error Reporting in Cisco CRS-1 Series XML Responses 97 Types of Reported Errors 97 Error Attributes 98 Transport Errors 98 XML Parse Errors 98 XML...Cisco CRS-1 Series Infrastructure Notifications 109 Registration 109 Notification Response 111 Summary of Cisco CRS-1 Series XML API Configuration Tags 113 Cisco CRS-1 Series XML Schemas 115 XML Schema Retrieval 115 Common XML Schemas 115 Component XML Schemas 116 Schema File Organization 116 Cisco CRS-1 Series Carrier Routing System...
XML API Guide
Page 9
.... Document Objectives This document provides a comprehensive description 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" OL-4596-01 Cisco CRS-1 Carrier Routing System XML API Guide ix Audience This document's audience is available for configuration and information...
.... Document Objectives This document provides a comprehensive description 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" OL-4596-01 Cisco CRS-1 Carrier Routing System XML API Guide ix Audience This document's audience is available for configuration and information...
XML API Guide
Page 10
...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" • Chapter 12, "Summary of a line indicates a comment line. For example, the prompt router... Conventions This publication uses the following information will help you press the Z key." Cisco CRS-1 Carrier Routing System XML API Guide x OL-4596-01 The system prompt indicates the current level of the EXEC command interpreter. Note Means reader take ...
...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" • Chapter 12, "Summary of a line indicates a comment line. For example, the prompt router... Conventions This publication uses the following information will help you press the Z key." Cisco CRS-1 Carrier Routing System XML API Guide x OL-4596-01 The system prompt indicates the current level of the EXEC command interpreter. Note Means reader take ...
XML API Guide
Page 11
... obtain technical information from the Ordering tool: http://www.cisco.com/en/US/partner/ordering/index.shtml • Nonregistered Cisco.com users can find instructions for ordering documentation at 408 526-7208 or, elsewhere in equipment damage or loss of related documents may be careful. OL-4596-01 Cisco CRS-1 Carrier Routing System XML API Guide xi
... obtain technical information from the Ordering tool: http://www.cisco.com/en/US/partner/ordering/index.shtml • Nonregistered Cisco.com users can find instructions for ordering documentation at 408 526-7208 or, elsewhere in equipment damage or loss of related documents may be careful. OL-4596-01 Cisco CRS-1 Carrier Routing System XML API Guide xi
XML API Guide
Page 12
... to help keep your production network is minimally impaired or for troubleshooting and resolving technical issues with Cisco products and technologies. Obtaining Technical Assistance For all tools on Cisco.com features extensive online support resources. Cisco CRS-1 Carrier Routing System XML API Guide xii OL-4596-01 You can submit comments by using the recommended resources, your...
... to help keep your production network is minimally impaired or for troubleshooting and resolving technical issues with Cisco products and technologies. Obtaining Technical Assistance For all tools on Cisco.com features extensive online support resources. Cisco CRS-1 Carrier Routing System XML API Guide xii OL-4596-01 You can submit comments by using the recommended resources, your...
XML API Guide
Page 13
... to restore service to satisfactory levels. Obtaining Additional Publications and Information Information about Cisco products, technologies, and network solutions is the Cisco Systems technical user magazine for maximizing Internet and networking investments. Both new and experienced ... a complete list of Cisco TAC contacts, go to this URL: http://www.cisco.com/packet OL-4596-01 Cisco CRS-1 Carrier Routing System XML API Guide xiii You and Cisco will benefit from various online and printed sources. • Cisco Marketplace provides a variety of Cisco books, reference guides, ...
... to restore service to satisfactory levels. Obtaining Additional Publications and Information Information about Cisco products, technologies, and network solutions is the Cisco Systems technical user magazine for maximizing Internet and networking investments. Both new and experienced ... a complete list of Cisco TAC contacts, go to this URL: http://www.cisco.com/packet OL-4596-01 Cisco CRS-1 Carrier Routing System XML API Guide xiii You and Cisco will benefit from various online and printed sources. • Cisco Marketplace provides a variety of Cisco books, reference guides, ...
XML API Guide
Page 14
...: http://www.cisco.com/en/US/learning/index.html Cisco CRS-1 Carrier Routing System XML API Guide xiv OL-4596-01 You can access iQ Magazine at this URL: http://www.cisco.com/go/iqmagazine • Internet Protocol Journal is the quarterly publication from Cisco. The publication ... business, and expand services. Obtaining Additional Publications and Information Preface • iQ Magazine 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 use technology to...
...: http://www.cisco.com/en/US/learning/index.html Cisco CRS-1 Carrier Routing System XML API Guide xiv OL-4596-01 You can access iQ Magazine at this URL: http://www.cisco.com/go/iqmagazine • Internet Protocol Journal is the quarterly publication from Cisco. The publication ... business, and expand services. Obtaining Additional Publications and Information Preface • iQ Magazine 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 use technology to...
XML API Guide
Page 15
...-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-15 CH A P T E R 1 Cisco CRS-1 Series XML API Overview This chapter contains the following sections: • "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" Introduction The extensible markup language (XML) application programming interface (API) provided by the Cisco CRS-1 Series Carrier Routing System (Cisco CRS...
...-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-15 CH A P T E R 1 Cisco CRS-1 Series XML API Overview This chapter contains the following sections: • "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" Introduction The extensible markup language (XML) application programming interface (API) provided by the Cisco CRS-1 Series Carrier Routing System (Cisco CRS...
XML API Guide
Page 16
...Cisco CRS-1 Series Carrier Routing System XML API Guide OL-4596-01 The Cisco CRS-1 Series code that runs Cisco IOS XR software. The response to those requests. The XML TTY Client will be available in an XML document. An external application that sends XML requests to the Cisco CRS-1 Series router...to perform. An XML document sent to the Cisco CRS-1 Series router containing a number of requested operations to the client. Cisco CRS-1 Series Management XML Interface This guide provides the following information regarding the Cisco CRS-1 Series management XML interface: • High-...
...Cisco CRS-1 Series Carrier Routing System XML API Guide OL-4596-01 The Cisco CRS-1 Series code that runs Cisco IOS XR software. The response to those requests. The XML TTY Client will be available in an XML document. An external application that sends XML requests to the Cisco CRS-1 Series router...to perform. An XML document sent to the Cisco CRS-1 Series router containing a number of requested operations to the client. Cisco CRS-1 Series Management XML Interface This guide provides the following information regarding the Cisco CRS-1 Series management XML interface: • High-...
XML API Guide
Page 17
... all supported transports. To represent the native data objects in XML - OL-4596-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-17 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 request and response flows between the...
... all supported transports. To represent the native data objects in XML - OL-4596-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-17 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 request and response flows between the...
XML API Guide
Page 18
... XML client req/resp (CORBA) CORBA XML agent Cisco CRS-1 Series router XML API library Native Operations Config services CLI access Operation provider Operation provider Operation provider Cisco CRS-1 Series Operating System 101398 Cisco CRS-1 Series XML API Tags An external client application can... Cisco CRS-1 Series router must begin with an XML declaration tag followed by a response tag and one or more operation type tags. Top-Level Structure The top level of router configuration and monitoring. specific content goes here ... . 1-18 Cisco CRS-1 Series Carrier Routing System ...
... XML client req/resp (CORBA) CORBA XML agent Cisco CRS-1 Series router XML API library Native Operations Config services CLI access Operation provider Operation provider Operation provider Cisco CRS-1 Series Operating System 101398 Cisco CRS-1 Series XML API Tags An external client application can... Cisco CRS-1 Series router must begin with an XML declaration tag followed by a response tag and one or more operation type tags. Top-Level Structure The top level of router configuration and monitoring. specific content goes here ... . 1-18 Cisco CRS-1 Series Carrier Routing System ...
XML API Guide
Page 19
... OL-4596-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-19 Operation2 - Chapter 1 Cisco CRS-1 Series XML API Overview Cisco CRS-1 Series XML API Tags . . and so on . . . XML Declaration Tag Each request and response exchanged between a client application and the Cisco CRS-1 Series router must begin with new... XML data and impact the overall performance of XML to be used : The attributes of the XML declaration are defined by the Cisco CRS-1 Series router at this time. and so on . . . specific content goes here ... . . . Only Version"1.0" is supported by ...
... OL-4596-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-19 Operation2 - Chapter 1 Cisco CRS-1 Series XML API Overview Cisco CRS-1 Series XML API Tags . . and so on . . . XML Declaration Tag Each request and response exchanged between a client application and the Cisco CRS-1 Series router must begin with new... XML data and impact the overall performance of XML to be used : The attributes of the XML declaration are defined by the Cisco CRS-1 Series router at this time. and so on . . . specific content goes here ... . . . Only Version"1.0" is supported by ...
XML API Guide
Page 20
...-specific content goes here ... 1-20 Cisco CRS-1 Series Carrier Routing System XML API Guide OL-4596-01 The Cisco CRS-1 Series XML API presents a synchronous interface to return for example, , , ) with no result data is shown in the corresponding request. In other way by the Cisco CRS-1 Series router. Cisco CRS-1 Series XML API Tags Chapter 1 Cisco CRS-1 Series XML API Overview • Encoding...
...-specific content goes here ... 1-20 Cisco CRS-1 Series Carrier Routing System XML API Guide OL-4596-01 The Cisco CRS-1 Series XML API presents a synchronous interface to return for example, , , ) with no result data is shown in the corresponding request. In other way by the Cisco CRS-1 Series router. Cisco CRS-1 Series XML API Tags Chapter 1 Cisco CRS-1 Series XML API Overview • Encoding...
XML API Guide
Page 21
... sections. Tip The XML schema definitions for one or more components. Chapter 1 Cisco CRS-1 Series XML API Overview Cisco CRS-1 Series XML API Tags Sample XML Minimum Response from Cisco CRS-1 Series Router . . . The native data tags are three general types of these operation ...with the operation for large responses. OL-4596-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-21 Native Data Operation Tags Native data operations provide basic access to be carried out by the Cisco CRS-1 Series router. Operation Type Tags Following the tag, the client ...
... sections. Tip The XML schema definitions for one or more components. Chapter 1 Cisco CRS-1 Series XML API Overview Cisco CRS-1 Series XML API Tags Sample XML Minimum Response from Cisco CRS-1 Series Router . . . The native data tags are three general types of these operation ...with the operation for large responses. OL-4596-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-21 Native Data Operation Tags Native data operations provide basic access to be carried out by the Cisco CRS-1 Series router. Operation Type Tags Following the tag, the client ...
XML API Guide
Page 22
...in the schema file common_types.xsd (see Chapter 13, "Cisco CRS-1 Series XML Schemas"). CLI Operation Tag CLI access provides support for the CLI tag are contained in Chapter 2, "Cisco CRS-1 Series XML Router Configuration and Management." Table 1-4 CLI Operation Tag Tags ... current target configuration session. For CLI access a single tag is provided in Chapter 6, "Cisco CRS-1 Series XML and Encapsulated CLI Operations." 1-22 Cisco CRS-1 Series Carrier Routing System XML API Guide OL-4596-01 Load the target configuration from a binary file previously saved by...
...in the schema file common_types.xsd (see Chapter 13, "Cisco CRS-1 Series XML Schemas"). CLI Operation Tag CLI access provides support for the CLI tag are contained in Chapter 2, "Cisco CRS-1 Series XML Router Configuration and Management." Table 1-4 CLI Operation Tag Tags ... current target configuration session. For CLI access a single tag is provided in Chapter 6, "Cisco CRS-1 Series XML and Encapsulated CLI Operations." 1-22 Cisco CRS-1 Series Carrier Routing System XML API Guide OL-4596-01 Load the target configuration from a binary file previously saved by...
XML API Guide
Page 23
... place any subsequent operations in the request. Note The XML schema definition for large requests. XML Request Batching The Cisco CRS-1 Series XML interface supports the combining of a large response. OL-4596-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-23 It can be attempted. If a operation could return a large amount of data (potentially more...
... place any subsequent operations in the request. Note The XML schema definition for large requests. XML Request Batching The Cisco CRS-1 Series XML interface supports the combining of a large response. OL-4596-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-23 It can be attempted. If a operation could return a large amount of data (potentially more...