Specifications
7-86
Cisco CRS-1 Series Carrier Routing System XML API Guide
OL-4596-02
Chapter 7 Cisco CRS-1 Series XML and Large Data Retrieval (Iterators)
To reduce memory overhead and avoid memory starvation of the router, the following limitations are
placed on the number of allowed iterators:
• 10—Maximum number of iterators allowed at any one time on a given client session.
• 100—Maximum number of iterators allowed at any one time for all client sessions.
Note If a <Get> request is issued that results in an iterated response, it is counted as 1 iterator, regardless of
the number of <GetNext> operations required to retrieve all of the response data. For example, a <Get>
request may require 10, 100, or more <GetNext> operations to retrieve all of the associated data, but
during this process only 1 iterator is being used. Also, an iterator is considered to be in use until all of
the response data associated with that iterator (that is, all of the response data associated with the original
<Get> request) is retrieved or the iterator is terminated with the Abort attribute.
The following example shows a client request that utilizes an iterator to retrieve all global Border
Gateway Protocol (BGP) configuration data for a specified autonomous system:
Sample XML Client Request to Retrieve All BGP Configuration Data
<?xml version="1.0" encoding="UTF-8"?>
<Request MajorVersion="1" MinorVersion="0">
<Get>
<Configuration>
<BGP MajorVersion=”1” MinorVersion=”0”>
<AS>
<Naming>
<AS>3</AS>
</Naming>
<Global/>
</AS>
</BGP>
</Configuration>
</Get>
</Request>
Sample XML Response from the Cisco CRS-1 Series Router Containing the First Block of Retrieved Data
<?xml version="1.0" encoding="UTF-8"?>
<Response MajorVersion="1" MinorVersion="0" IteratorID=”1”>
<Get>
<Configuration>
<BGP MajorVersion=”1” MinorVersion=”0”>
<AS>
<Naming>
<AS>3</AS>
</Naming>
<Global>
.
.
.
1st block of data returned here
.
.
.
</Global>
<AS>
</BGP>
</Configuration>
<Get>
</Response>