附录B. NETCONF消息层的XML Schema

本部分是规范性的。

<CODE BEGINS> file “netconf.xsd”

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  3.            xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
  4.            targetNamespace="urn:ietf:params:xml:ns:netconf:base:1.0"
  5.            elementFormDefault="qualified"
  6.            attributeFormDefault="unqualified"
  7.            xml:lang="en"
  8.            version="1.1">
  10.     <xs:annotation>
  11.         <xs:documentation>
  12.             This schema defines the syntax for the NETCONF Messages layer
  13.             messages 'hello', 'rpc', and 'rpc-reply'.
  14.         </xs:documentation>
  15.     </xs:annotation>
  17.     <!--
  18.     import standard XML definitions
  19.     -->
  20.     <xs:import namespace="http://www.w3.org/XML/1998/namespace"
  21.         schemaLocation="http://www.w3.org/2001/xml.xsd">
  22.         <xs:annotation>
  23.             <xs:documentation>
  24.                 This import accesses the xml: attribute groups for the
  25.                 xml:lang as declared on the error-message element.
  26.             </xs:documentation>
  27.         </xs:annotation>
  28.     </xs:import>
  29.     <!--
  30.     message-id attribute
  31.     -->
  33.     <xs:simpleType name="messageIdType">
  34.         <xs:restriction base="xs:string">
  35.             <xs:maxLength value="4095"/>
  36.         </xs:restriction>
  37.     </xs:simpleType>
  38.     <!--
  39.        Types used for session-id
  40.       -->
  41.     <xs:simpleType name="SessionId">
  42.         <xs:restriction base="xs:unsignedInt">
  43.             <xs:minInclusive value="1"/>
  44.         </xs:restriction>
  45.     </xs:simpleType>
  46.     <xs:simpleType name="SessionIdOrZero">
  47.         <xs:restriction base="xs:unsignedInt"/>
  48.     </xs:simpleType>
  49.     <!--
  50.        <rpc> element
  51.       -->
  52.     <xs:complexType name="rpcType">
  53.         <xs:sequence>
  54.             <xs:element ref="rpcOperation"/>
  55.         </xs:sequence>
  56.         <xs:attribute name="message-id" type="messageIdType" use="required"/>
  57.         <!--
  58.         Arbitrary attributes can be supplied with <rpc> element.
  59.         -->
  60.         <xs:anyAttribute processContents="lax"/>
  61.     </xs:complexType>
  62.     <xs:element name="rpc" type="rpcType"/>
  63.     <!--
  64.        data types and elements used to construct rpc-errors
  65.       -->
  66.     <xs:simpleType name="ErrorType">
  67.       <xs:restriction base="xs:string">
  68.         <xs:enumeration value="transport"/>
  69.         <xs:enumeration value="rpc"/>
  70.         <xs:enumeration value="protocol"/>
  71.         <xs:enumeration value="application"/>
  72.       </xs:restriction>
  73.     </xs:simpleType>
  74.     <xs:simpleType name="ErrorTag">
  75.       <xs:restriction base="xs:string">
  76.         <xs:enumeration value="in-use"/>
  77.         <xs:enumeration value="invalid-value"/>
  78.         <xs:enumeration value="too-big"/>
  79.         <xs:enumeration value="missing-attribute"/>
  80.         <xs:enumeration value="bad-attribute"/>
  81.         <xs:enumeration value="unknown-attribute"/>
  82.         <xs:enumeration value="missing-element"/>
  83.         <xs:enumeration value="bad-element"/>
  84.         <xs:enumeration value="unknown-element"/>
  85.         <xs:enumeration value="unknown-namespace"/>
  86.         <xs:enumeration value="access-denied"/>
  87.         <xs:enumeration value="lock-denied"/>
  88.         <xs:enumeration value="resource-denied"/>
  89.         <xs:enumeration value="rollback-failed"/>
  90.         <xs:enumeration value="data-exists"/>
  91.         <xs:enumeration value="data-missing"/>
  92.         <xs:enumeration value="operation-not-supported"/>
  93.         <xs:enumeration value="operation-failed"/>
  94.         <xs:enumeration value="partial-operation"/>
  95.         <xs:enumeration value="malformed-message"/>
  96.       </xs:restriction>
  97.     </xs:simpleType>
  98.     <xs:simpleType name="ErrorSeverity">
  99.       <xs:restriction base="xs:string">
  100.         <xs:enumeration value="error"/>
  101.         <xs:enumeration value="warning"/>
  102.       </xs:restriction>
  103.     </xs:simpleType>
  104.     <xs:complexType name="errorInfoType">
  105.         <xs:sequence>
  106.             <xs:choice>
  107.                 <xs:element name="session-id" type="SessionIdOrZero"/>
  108.                 <xs:sequence minOccurs="0" maxOccurs="unbounded">
  109.                     <xs:sequence>
  110.                         <xs:element name="bad-attribute" type="xs:QName" minOccurs="0" maxOccurs="1"/>
  111.                         <xs:element name="bad-element" type="xs:QName" minOccurs="0" maxOccurs="1"/>
  112.                         <xs:element name="ok-element" type="xs:QName" minOccurs="0" maxOccurs="1"/>
  113.                         <xs:element name="err-element" type="xs:QName" minOccurs="0" maxOccurs="1"/>
  114.                         <xs:element name="noop-element" type="xs:QName" minOccurs="0" maxOccurs="1"/>
  115.                         <xs:element name="bad-namespace" type="xs:string" minOccurs="0" maxOccurs="1"/>
  116.                     </xs:sequence>
  117.                 </xs:sequence>
  118.             </xs:choice>
  119.         <!-- elements from any other namespace are also allowed
  120.         to follow the NETCONF elements -->
  121.         <xs:any namespace="##other" processContents="lax"
  122.         minOccurs="0" maxOccurs="unbounded"/>
  123.         </xs:sequence>
  124.     </xs:complexType>
  125.     <xs:complexType name="rpcErrorType">
  126.       <xs:sequence>
  127.         <xs:element name="error-type" type="ErrorType"/>
  128.         <xs:element name="error-tag" type="ErrorTag"/>
  129.         <xs:element name="error-severity" type="ErrorSeverity"/>
  130.         <xs:element name="error-app-tag" type="xs:string"
  131.                     minOccurs="0"/>
  132.         <xs:element name="error-path" type="xs:string" minOccurs="0"/>
  133.         <xs:element name="error-message" minOccurs="0">
  134.           <xs:complexType>
  135.             <xs:simpleContent>
  136.               <xs:extension base="xs:string">
  137.                 <xs:attribute ref="xml:lang" use="optional"/>
  138.               </xs:extension>
  139.             </xs:simpleContent>
  140.           </xs:complexType>
  141.         </xs:element>
  142.         <xs:element name="error-info" type="errorInfoType"
  143.                     minOccurs="0"/>
  144.       </xs:sequence>
  145.     </xs:complexType>
  146.     <!--
  147.        operation attribute used in <edit-config>
  148.       -->
  149.     <xs:simpleType name="editOperationType">
  150.       <xs:restriction base="xs:string">
  151.         <xs:enumeration value="merge"/>
  152.         <xs:enumeration value="replace"/>
  153.         <xs:enumeration value="create"/>
  154.         <xs:enumeration value="delete"/>
  155.         <xs:enumeration value="remove"/>
  156.       </xs:restriction>
  157.     </xs:simpleType>
  158.     <xs:attribute name="operation" type="editOperationType"/>
  159.     <!--
  160.        <rpc-reply> element
  161.       -->
  162.     <xs:complexType name="rpcReplyType">
  163.         <xs:choice>
  164.             <xs:element name="ok"/>
  165.             <xs:sequence>
  166.                 <xs:element ref="rpc-error"  minOccurs="0" maxOccurs="unbounded"/>
  167.                 <xs:element ref="rpcResponse"   minOccurs="0" maxOccurs="unbounded"/>
  168.             </xs:sequence>
  169.         </xs:choice>
  170.         <xs:attribute name="message-id" type="messageIdType"
  171.                   use="optional"/>
  172.         <!--
  173.         Any attributes supplied with <rpc> element must be returned
  174.         on <rpc-reply>.
  175.         -->
  176.         <xs:anyAttribute processContents="lax"/>
  177.     </xs:complexType>
  178.     <xs:element name="rpc-reply" type="rpcReplyType"/>
  179.     <!--
  180.     <rpc-error> element
  181.     -->
  182.     <xs:element name="rpc-error" type="rpcErrorType"/>
  183.     <!--
  184.     rpcOperationType: used as a base type for all
  185.     NETCONF operations
  186.     -->
  187.     <xs:complexType name="rpcOperationType"/>
  188.     <xs:element name="rpcOperation" type="rpcOperationType" abstract="true"/>
  189.     <!--
  190.     rpcResponseType: used as a base type for all
  191.     NETCONF responses
  192.     -->
  193.     <xs:complexType name="rpcResponseType"/>
  194.     <xs:element name="rpcResponse" type="rpcResponseType" abstract="true"/>
  195.           <!--
  196.              <hello> element
  197.             -->
  198.     <xs:element name="hello">
  199.         <xs:complexType>
  200.             <xs:sequence>
  201.                 <xs:element name="capabilities">
  202.                     <xs:complexType>
  203.                         <xs:sequence>
  204.                             <xs:element name="capability" type="xs:anyURI" maxOccurs="unbounded"/>
  205.                         </xs:sequence>
  206.                     </xs:complexType>
  207.                 </xs:element>
  208.                 <xs:element name="session-id" type="SessionId"
  209.                 minOccurs="0"/>
  211.             </xs:sequence>
  212.         </xs:complexType>
  213.     </xs:element>
  214. </xs:schema>

<CODE ENDS>