Main Hierarchy Structure - Cisco CRS-1 - Carrier Routing System Router Api Manual

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

Main Hierarchy Structure

The main structure of the hierarchy consists of the native data model organized as a tree of nodes, where
related data items appear in the same branch of the tree. At each level of the tree, a node can be a
container of further, more specific sets of related data, or a leaf that will hold an actual value.
For example, the first element in the configuration data model is <Configuration>, which contains all
possible configuration items. The children of this element are more specific groups of configuration,
such as <BGP> for Border Gateway Protocol (BGP) configuration, and <ISIS> for Intermediate
System-to-Intermediate System (ISIS) configuration. Beneath the <BGP> element the data is further
compartmentalized with the <Global> element for global BGP configuration and <BGPEntity> element
for per-entity BGP configuration. This compartmentalization continues down to the elements that hold
the values, the values being the character data of the element.
The following example shows the main hierarchy structure:
<Configuration>
<BGP>
</BGP>
<ISIS>
</ISIS>
</Configuration>
Data can be retrieved at any level in the hierarchy—one particular data item can be examined, or all of
the data items in a branch of the tree can be returned in one request (see
XML and Native Data Access Techniques,"
Similarly, configuration data can be deleted at any granularity—one item can be deleted, or a whole
branch of related configuration can be deleted. So, for example, all BGP configuration can be deleted in
one request, or just the value of the default metric.
Hierarchy Tables
One special type of container element is a table. Tables can hold any number of keyed entries, and are
used when there can be multiple instances of an entity. For example, BGP has a table of multiple
neighbors, each of which has a unique IP address "key" to identify it. In this case, the table element is
OL-4596-01
.
.
.
<Global>
.
.
.
<DefaultMetric>10</DefaultMetric>
.
.
.
</Global>
<BGPEntity>
.
.
.
</BGPEntity>
.
.
.
.
.
.
for details on how to do perform hierarchical data retrieval).
Cisco CRS-1 Series Carrier Routing System XML API Guide
Native Data Operation Content
Chapter 5, "Cisco CRS-1 Series
4-53