Xml Request With Combined Object Class Hierarchies - Cisco CRS-1 - Carrier Routing System Router Api Manual

Available Set of Native Data Access Techniques

XML Request with Combined Object Class Hierarchies

Multiple object class hierarchies can be specified in a request. For example, a portion of the hierarchy
can be repeated, and multiple instances of a child object class can be included under a parent.
The object class hierarchy may also be compressed into the most "efficient" XML. In other words, it is
not necessary to repeat hierarchies within a request.
If a Get operation could return a large amount of data (potentially more than the size of one iterator
Note
chunk), then it is advisable to place any subsequent operations into a new request (rather than combining
them inside one <Get> tag). As soon as an iterator boundary is reached, any subsequent operations in
the request will automatically be failed.
The following two examples illustrate two different object class hierarchies that retrieve the same data:
the value of the leaf object <RemoteAS> and <EBGPMultihopMaxHopCount> for the BGP neighbor
with the address 10.0.101.6 and all of the configuration data for the BGP neighbor with the address
10.0.101.7:
Example 1: Verbose Form of a Request Using Duplicated Object Class Hierarchies
Sample XML Client Request for Specific Configuration Data Values
<?xml version="1.0" encoding="UTF-8"?>
<Request MajorVersion="1" MinorVersion="0">
<Get>
</Get>
<Get>
Cisco CRS-1 Series Carrier Routing System XML API Guide
5-68
<Configuration>
<BGP MajorVersion="1" MinorVersion="0">
<AS>
<Naming>
<AS>3</AS>
</Naming>
<BGPEntity>
<NeighborTable>
<Neighbor>
<Naming>
<IPAddress>
<IPV4Address>10.0.101.6</IPV4Address>
</IPAddress>
</Naming>
<!-- Gets the following two leaf objects for this neighbor -->
<RemoteAS/>
<EBGPMultihopMaxHopCount/>
</Neighbor>
</NeighborTable>
</BGPEntity>
</AS>
</BGP>
</Configuration>
<Configuration>
<BGP MajorVersion="1" MinorVersion="0">
<AS>
<Naming>
<AS>3</AS>
</Naming>
<BGPEntity>
<NeighborTable>
<Neighbor>
Chapter 5 Cisco CRS-1 Series XML and Native Data Access Techniques
OL-4596-01