Run-Time Use Of Version Information; Placement Of Version Information - Cisco CRS-1 - Carrier Routing System Router Api Manual

Run-Time Use of Version Information

</xsd:annotation>
<xsd:attributeGroup ref="VersionAttributeGroup"/>
</xsd:complexType>
The attribute group VersionAttributeGroup is defined as:
<xsd:attributeGroup name="VersionAttributeGroup">
<xsd:annotation>
</xsd:annotation>
<xsd:attribute name="MajorVersion" type="xsd:unsignedInt" use="required"/>
<xsd:attribute name="MinorVersion" type="xsd:unsignedInt" use="required"/>
</xsd:attributeGroup>
Run-Time Use of Version Information
Each XML request must contain the client's major and minor version numbers at the appropriate
locations in the XML. These version numbers are compared to the version numbers running on the
router. The request is then accepted or rejected based on the following rules:
•
•
•
•
Each XML response will also contain the version numbers at the appropriate locations in the XML.
Note If the client minor version is behind that of the router, then the response may contain elements that are
not recognized by the client application. The client application must be able to handle these additional
elements.

Placement of Version Information

The following example shows the placement of the MajorVersion and MinorVersion attributes within a
client request to retrieve the global BGP configuration data for a specified autonomous system:
Cisco CRS-1 Series Carrier Routing System XML API Guide
9-92
<MajorVersion>1</MajorVersion>
<MinorVersion>0</MinorVersion>
<TaskIdInfo TaskGrouping="Single">
<TaskName>bgp</TaskName>
</TaskIdInfo>
</xsd:appinfo>
.
.
.
.
.
..
<xsd:documentation>
Common version information attributes
</xsd:documentation>
If there is a major version discrepancy, then the request fails.
If there is a minor version lag, that is, the client minor version is behind that of the router, then the
request is attempted.
If there is a minor version creep, that is, the client minor version is ahead of that of the router, then
the request fails.
If the version information has not been included in the request, then the request fails.
Chapter 9 Cisco CRS-1 Series XML Schema Versioning
OL-4596-01