8. RESTCONF模块

“ietf-restconf”模块定义了一个扩展和两个分组中的概念性定义，这些分组并不意味着被服务器实现为数据存储内容。 例如，“restconf”容器并不打算作为顶级数据节点来实现（在“/restconf/data”的URI下）。

请注意，“ietf-restconf”的模块没有任何协议可访问的对象，因此不显示YANG树形图。

<CODE BEGINS>

  1. file "ietf-restconf@2017-01-26.yang"
  3. module ietf-restconf {
  4.   yang-version 1.1;
  5.   namespace "urn:ietf:params:xml:ns:yang:ietf-restconf";
  6.   prefix "rc";
  8.   organization
  9.     "IETF NETCONF (Network Configuration) Working Group";
  11.   contact
  12.     "WG Web:   <https://datatracker.ietf.org/wg/netconf/>
  13.      WG List:  <mailto:netconf@ietf.org>
  15.      Author:   Andy Bierman
  16.                <mailto:andy@yumaworks.com>
  18.      Author:   Martin Bjorklund
  19.                <mailto:mbj@tail-f.com>
  21.      Author:   Kent Watsen
  22.                <mailto:kwatsen@juniper.net>";
  25.    description
  26.      "This module contains conceptual YANG specifications
  27.       for basic RESTCONF media type definitions used in
  28.       RESTCONF protocol messages.
  30.       Note that the YANG definitions within this module do not
  31.       represent configuration data of any kind.
  32.       The 'restconf-media-type' YANG extension statement
  33.       provides a normative syntax for XML and JSON
  34.       message-encoding purposes.
  37.   Copyright (c) 2017 IETF Trust and the persons identified as
  38.       authors of the code.  All rights reserved.
  40.       Redistribution and use in source and binary forms, with or
  41.       without modification, is permitted pursuant to, and subject
  42.       to the license terms contained in, the Simplified BSD License
  43.       set forth in Section 4.c of the IETF Trust's Legal Provisions
  44.       Relating to IETF Documents
  45.       (http://trustee.ietf.org/license-info).
  47.       This version of this YANG module is part of RFC 8040; see
  48.       the RFC itself for full legal notices.";
  52.   revision 2017-01-26 {
  53.     description
  54.       "Initial revision.";
  55.     reference
  56.       "RFC 8040: RESTCONF Protocol.";
  57.   }
  59.   extension yang-data {
  60.     argument name {
  61.       yin-element true;
  62.     }
  63.         description
  64.           "This extension is used to specify a YANG data template that
  65.            represents conceptual data defined in YANG.  It is
  66.            intended to describe hierarchical data independent of
  67.            protocol context or specific message-encoding format.
  68.            Data definition statements within a yang-data extension
  69.            specify the generic syntax for the specific YANG data
  70.            template, whose name is the argument of the 'yang-data'
  71.            extension statement.
  73.            Note that this extension does not define a media type.
  74.            A specification using this extension MUST specify the
  75.            message-encoding rules, including the content media type.
  77.            The mandatory 'name' parameter value identifies the YANG
  78.            data template that is being defined.  It contains the
  79.            template name.
  81.            This extension is ignored unless it appears as a top-level
  82.            statement.  It MUST contain data definition statements
  83.            that result in exactly one container data node definition.
  84.            An instance of a YANG data template can thus be translated
  85.            into an XML instance document, whose top-level element
  86.            corresponds to the top-level container.
  88.            The module name and namespace values for the YANG module using
  89.            the extension statement are assigned to instance document data
  90.            conforming to the data definition statements within
  91.            this extension.
  93.            The substatements of this extension MUST follow the
  94.            'data-def-stmt' rule in the YANG ABNF.
  96.            The XPath document root is the extension statement itself,
  97.            such that the child nodes of the document root are
  98.            represented by the data-def-stmt substatements within
  99.            this extension.  This conceptual document is the context
  100.            for the following YANG statements:
  102.              - must-stmt
  103.              - when-stmt
  104.              - path-stmt
  105.              - min-elements-stmt
  106.              - max-elements-stmt
  107.              - mandatory-stmt
  108.              - unique-stmt
  109.              - ordered-by
  110.              - instance-identifier data type
  112.            The following data-def-stmt substatements are constrained
  113.            when used within a 'yang-data' extension statement.
  115.              - The list-stmt is not required to have a key-stmt defined.
  116.              - The if-feature-stmt is ignored if present.
  117.              - The config-stmt is ignored if present.
  118.              - The available identity values for any 'identityref'
  119.                leaf or leaf-list nodes are limited to the module
  120.                containing this extension statement and the modules
  121.                imported into that module.
  122.           ";
  123.       }
  125.       rc:yang-data yang-errors {
  126.         uses errors;
  127.       }
  129.       rc:yang-data yang-api {
  130.         uses restconf;
  131.       }
  133.       grouping errors {
  134.         description
  135.           "A grouping that contains a YANG container
  136.            representing the syntax and semantics of a
  137.            YANG Patch error report within a response message.";
  139.         container errors {
  140.           description
  141.             "Represents an error report returned by the server if
  142.              a request results in an error.";
  144.           list error {
  145.             description
  146.               "An entry containing information about one
  147.                specific error that occurred while processing
  148.                a RESTCONF request.";
  149.             reference
  150.               "RFC 6241, Section 4.3.";
  152.             leaf error-type {
  153.               type enumeration {
  154.                 enum transport {
  155.                   description
  156.                     "The transport layer.";
  157.                 }
  158.                 enum rpc {
  159.                   description
  160.                     "The rpc or notification layer.";
  161.                 }
  162.                 enum protocol {
  163.                   description
  164.                     "The protocol operation layer.";
  165.                 }
  166.                 enum application {
  167.                   description
  168.                     "The server application layer.";
  169.                 }
  170.               }
  171.               mandatory true;
  172.               description
  173.                 "The protocol layer where the error occurred.";
  174.             }
  175.             leaf error-tag {
  176.               type string;
  177.               mandatory true;
  178.               description
  179.                 "The enumerated error-tag.";
  180.             }
  182.             leaf error-app-tag {
  183.               type string;
  184.               description
  185.                 "The application-specific error-tag.";
  186.             }
  188.             leaf error-path {
  189.               type instance-identifier;
  190.               description
  191.                 "The YANG instance identifier associated
  192.                  with the error node.";
  193.             }
  195.             leaf error-message {
  196.               type string;
  197.               description
  198.                 "A message describing the error.";
  199.             }
  201.             anydata error-info {
  202.                description
  203.                  "This anydata value MUST represent a container with
  204.                   zero or more data nodes representing additional
  205.                   error information.";
  206.             }
  207.           }
  208.         }
  209.       }
  211.       grouping restconf {
  212.         description
  213.           "Conceptual grouping representing the RESTCONF
  214.            root resource.";
  216.         container restconf {
  217.           description
  218.             "Conceptual container representing the RESTCONF
  219.              root resource.";
  222.              container data {
  223.                description
  224.                  "Container representing the datastore resource.
  225.                   Represents the conceptual root of all state data
  226.                   and configuration data supported by the server.
  227.                   The child nodes of this container can be any data
  228.                   resources that are defined as top-level data nodes
  229.                   from the YANG modules advertised by the server in
  230.                   the 'ietf-yang-library' module.";
  231.              }
  233.              container operations {
  234.                description
  235.                  "Container for all operation resources.
  237.                   Each resource is represented as an empty leaf with the
  238.                   name of the RPC operation from the YANG 'rpc' statement.
  240.                   For example, the 'system-restart' RPC operation defined
  241.                   in the 'ietf-system' module would be represented as
  242.                   an empty leaf in the 'ietf-system' namespace.  This is
  243.                   a conceptual leaf and will not actually be found in
  244.                   the module:
  246.                      module ietf-system {
  247.                        leaf system-reset {
  248.                          type empty;
  249.                        }
  250.                      }
  252.                   To invoke the 'system-restart' RPC operation:
  254.                      POST /restconf/operations/ietf-system:system-restart
  256.                   To discover the RPC operations supported by the server:
  258.                      GET /restconf/operations
  260.                   In XML, the YANG module namespace identifies the module:
  262.                     <system-restart
  263.                        xmlns='urn:ietf:params:xml:ns:yang:ietf-system'/>
  265.                   In JSON, the YANG module name identifies the module:
  267.                     { 'ietf-system:system-restart' : [null] }
  268.                  ";
  269.              }
  271.       leaf yang-library-version {
  272.         type string {
  273.           pattern '\d{4}-\d{2}-\d{2}';
  274.         }
  275.         config false;
  276.         mandatory true;
  277.         description
  278.           "Identifies the revision date of the 'ietf-yang-library'
  279.            module that is implemented by this RESTCONF server.
  280.            Indicates the year, month, and day in YYYY-MM-DD
  281.            numeric format.";
  282.       }
  283.     }
  284.   }
  285. }

<CODE ENDS>