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
IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. 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...
IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. 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...
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 Preface This document describes the extensible markup language (XML) application...
.... 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 Preface This document describes the extensible markup language (XML) application...
XML API Guide
Page 10
... grouped in braces ({ }) and separated by vertical bars (|). For example, the prompt router> indicates the user level, and the prompt router# indicates the privileged level. Alternative but tips do contain useful information. Cisco CRS-1 Carrier Routing System XML API Guide x OL-4596-01 The system prompt indicates the current level of a line indicates a comment line. Tip Means the...
... grouped in braces ({ }) and separated by vertical bars (|). For example, the prompt router> indicates the user level, and the prompt router# indicates the privileged level. Alternative but tips do contain useful information. Cisco CRS-1 Carrier Routing System XML API Guide x OL-4596-01 The system prompt indicates the current level of a line indicates a comment line. Tip Means the...
XML API Guide
Page 11
.... These sections explain how to obtain technical assistance and other technical resources. OL-4596-01 Cisco CRS-1 Carrier Routing System XML API Guide xi Cisco also provides several ways 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...
.... These sections explain how to obtain technical assistance and other technical resources. OL-4596-01 Cisco CRS-1 Carrier Routing System XML API Guide xi Cisco also provides several ways 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...
XML API Guide
Page 12
... for which your network is minimally impaired or for troubleshooting and resolving technical issues with Cisco products and technologies. Cisco CRS-1 Carrier Routing System XML API Guide xii OL-4596-01 The Cisco Technical Support Website on the Cisco Technical Support Website requires a Cisco.com user ID and password. If your issue is located at this URL: http://www...
... for which your network is minimally impaired or for troubleshooting and resolving technical issues with Cisco products and technologies. Cisco CRS-1 Carrier Routing System XML API Guide xii OL-4596-01 The Cisco Technical Support Website on the Cisco Technical Support Website requires a Cisco.com user ID and password. If your issue is located at this URL: http://www...
XML API Guide
Page 13
..., reference guides, and logo merchandise. There is a critical impact to resolve the situation. Access the Cisco Product Catalog at this URL: http://www.cisco.com/packet OL-4596-01 Cisco CRS-1 Carrier Routing System XML API Guide xiii You and Cisco will commit resources during normal business hours to your business operations. Severity 4 (S4)-You require information or...
..., reference guides, and logo merchandise. There is a critical impact to resolve the situation. Access the Cisco Product Catalog at this URL: http://www.cisco.com/packet OL-4596-01 Cisco CRS-1 Carrier Routing System XML API Guide xiii You and Cisco will commit resources during normal business hours to your business operations. Severity 4 (S4)-You require information or...
XML API Guide
Page 14
... 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 access the Internet Protocol Journal at this URL: http://www.cisco.com/en/US/learning/index.html Cisco CRS-1 Carrier Routing System XML API Guide xiv OL-4596-01
... 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 access the Internet Protocol Journal at this URL: http://www.cisco.com/en/US/learning/index.html Cisco CRS-1 Carrier Routing System XML API Guide xiv OL-4596-01
XML API Guide
Page 15
... to manage and monitor the Cisco CRS-1 Series router. OL-4596-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-15 The initial release of Cisco CRS-1 Series router management. 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...
... to manage and monitor the Cisco CRS-1 Series router. OL-4596-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-15 The initial release of Cisco CRS-1 Series router management. 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...
XML API Guide
Page 16
... an operation that sends XML requests to the Cisco CRS-1 Series router and receives XML responses to perform. Cisco CRS-1 Series Management XML Interface This guide provides the following information regarding the Cisco CRS-1 Series management XML interface: • High...router using XML. An XML document sent to the Cisco CRS-1 Series router containing a number of the Cisco CRS-1 Series XML API. Definition of the Cisco CRS-1 Series XML request and response streams • Operation tag types and usage, including their XML format and content 1-16 Cisco CRS-1 Series Carrier Routing System...
... an operation that sends XML requests to the Cisco CRS-1 Series router and receives XML responses to perform. Cisco CRS-1 Series Management XML Interface This guide provides the following information regarding the Cisco CRS-1 Series management XML interface: • High...router using XML. An XML document sent to the Cisco CRS-1 Series router containing a number of the Cisco CRS-1 Series XML API. Definition of the Cisco CRS-1 Series XML request and response streams • Operation tag types and usage, including their XML format and content 1-16 Cisco CRS-1 Series Carrier Routing System...
XML API Guide
Page 17
... requests to access the management data of interest, including the use Cisco CRS-1 Series XML to configure the Cisco CRS-1 Series router: - When a client request is received by an XML agent on the router, the request is implemented on the Cisco CRS-1 Series router. OL-4596-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-17 To represent the native data objects in...
... requests to access the management data of interest, including the use Cisco CRS-1 Series XML to configure the Cisco CRS-1 Series router: - When a client request is received by an XML agent on the router, the request is implemented on the Cisco CRS-1 Series router. OL-4596-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-17 To represent the native data objects in...
XML API Guide
Page 18
Operation1 - The operation type tags contained in the response will correspond to the Cisco CRS-1 Series router must begin with an XML declaration tag followed by a request tag and one or more operation type tags. specific content goes here ... . 1-18 Cisco CRS-1 Series Carrier Routing System XML API Guide OL-4596-01 Top-Level Structure The top level of...
Operation1 - The operation type tags contained in the response will correspond to the Cisco CRS-1 Series router must begin with an XML declaration tag followed by a request tag and one or more operation type tags. specific content goes here ... . 1-18 Cisco CRS-1 Series Carrier Routing System XML API Guide OL-4596-01 Top-Level Structure The top level of...
XML API Guide
Page 19
OL-4596-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-19 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 an XML declaration tag indicating which version of XML and (optionally) which ...character set are being used: The attributes of the XML declaration are defined by the Cisco CRS-1 Series router at this document are formatted with the Cisco CRS-1 Series router do not include new lines and white space characters because theseelements would add significantly to the...
OL-4596-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-19 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 an XML declaration tag indicating which version of XML and (optionally) which ...character set are being used: The attributes of the XML declaration are defined by the Cisco CRS-1 Series router at this document are formatted with the Cisco CRS-1 Series router do not include new lines and white space characters because theseelements would add significantly to the...
XML API Guide
Page 20
...optional attribute specifies the standardized character set to be ignored in every other words, the XML session between a client and the Cisco CRS-1 Series router will consist of a series of alternating requests and response streams. The client application optionally includes a ClientID attribute within a ... XML request or response is supported by the client to client applications. Operation-specific content goes here ... 1-20 Cisco CRS-1 Series Carrier Routing System XML API Guide OL-4596-01 In other way by the restrictions of the ClientID attribute must enclose each XML ...
...optional attribute specifies the standardized character set to be ignored in every other words, the XML session between a client and the Cisco CRS-1 Series router will consist of a series of alternating requests and response streams. The client application optionally includes a ClientID attribute within a ... XML request or response is supported by the client to client applications. Operation-specific content goes here ... 1-20 Cisco CRS-1 Series Carrier Routing System XML API Guide OL-4596-01 In other way by the restrictions of the ClientID attribute must enclose each XML ...
XML API Guide
Page 21
Each of operations supported along with the operation for one or more components. OL-4596-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-21 Table 1-2 Native Data Operation Tags Native Data Tags Description Get the value of one or more... more configuration data items. Get the major and minor version numbers for large responses. 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 . . . Tip The XML schema definitions for the native data operation type tags are provided in...
Each of operations supported along with the operation for one or more components. OL-4596-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-21 Table 1-2 Native Data Operation Tags Native Data Tags Description Get the value of one or more... more configuration data items. Get the major and minor version numbers for large responses. 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 . . . Tip The XML schema definitions for the native data operation type tags are provided in...
XML API Guide
Page 22
... Operations." 1-22 Cisco CRS-1 Series Carrier Routing System XML API Guide OL-4596-01 The CLI operation tag is provided. Get a list of commits made to a binary file. Unlock the running configuration. CLI Operation Tag CLI access provides support for the configuration services operation type tags are contained in Chapter 2, "Cisco CRS-1 Series XML Router Configuration and Management...
... Operations." 1-22 Cisco CRS-1 Series Carrier Routing System XML API Guide OL-4596-01 The CLI operation tag is provided. Get a list of commits made to a binary file. Unlock the running configuration. CLI Operation Tag CLI access provides support for the configuration services operation type tags are contained in Chapter 2, "Cisco CRS-1 Series XML Router Configuration and Management...
XML API Guide
Page 23
...any subsequent operations into a single request. Batched requests are operations 1 through 3 in the schema file common_types.xsd (see Chapter 13, "Cisco CRS-1 Series XML Schemas"). If a operation could return a large amount of data (potentially more than the size of one of several requests ... to retrieve the next portion of a response. Set operation content goes here . It can be attempted. OL-4596-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-23 Table 1-5 GetNext Operation Tag Tags Description Get the next portion of a large response. Note The ...
...any subsequent operations into a single request. Batched requests are operations 1 through 3 in the schema file common_types.xsd (see Chapter 13, "Cisco CRS-1 Series XML Schemas"). If a operation could return a large amount of data (potentially more than the size of one of several requests ... to retrieve the next portion of a response. Set operation content goes here . It can be attempted. OL-4596-01 Cisco CRS-1 Series Carrier Routing System XML API Guide 1-23 Table 1-5 GetNext Operation Tag Tags Description Get the next portion of a large response. Note The ...