9.3。 RESTCONF监控模块

    “ietf-restconf-monitoring”模块定义了RESTCONF协议的监控信息。

    本模块使用[RFC6991]中的“ietf-yang-types”和“ietf-inet-types”模块来进行某些类型定义。

    <CODE BEGINS>

    file “ietf-restconf-monitoring@2017-01-26.yang”

    1. module ietf-restconf-monitoring {
    2.   namespace "urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring";
    3.   prefix "rcmon";
    5.   import ietf-yang-types { prefix yang; }
    6.   import ietf-inet-types { prefix inet; }
    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>";
    24.   description
    25.      "This module contains monitoring information for the
    26.       RESTCONF protocol.
    28.       Copyright (c) 2017 IETF Trust and the persons identified as
    29.       authors of the code.  All rights reserved.
    31.       Redistribution and use in source and binary forms, with or
    32.       without modification, is permitted pursuant to, and subject
    33.       to the license terms contained in, the Simplified BSD License
    34.       set forth in Section 4.c of the IETF Trust's Legal Provisions
    35.       Relating to IETF Documents
    36.       (http://trustee.ietf.org/license-info).
    38.       This version of this YANG module is part of RFC 8040; see
    39.       the RFC itself for full legal notices.";
    41.    revision 2017-01-26 {
    42.      description
    43.        "Initial revision.";
    44.      reference
    45.        "RFC 8040: RESTCONF Protocol.";
    46.    }
    48.    container restconf-state {
    49.      config false;
    50.      description
    51.        "Contains RESTCONF protocol monitoring information.";
    53.      container capabilities {
    54.        description
    55.          "Contains a list of protocol capability URIs.";
    57.        leaf-list capability {
    58.          type inet:uri;
    59.          description
    60.            "A RESTCONF protocol capability URI.";
    61.        }
    62.      }
    63.      container streams {
    64.        description
    65.          "Container representing the notification event streams
    66.           supported by the server.";
    67.         reference
    68.           "RFC 5277, Section 3.4, <streams> element.";
    70.        list stream {
    71.          key name;
    72.          description
    73.            "Each entry describes an event stream supported by
    74.             the server.";
    76.          leaf name {
    77.            type string;
    78.            description
    79.              "The stream name.";
    80.            reference
    81.              "RFC 5277, Section 3.4, <name> element.";
    82.          }
    84.          leaf description {
    85.            type string;
    86.            description
    87.              "Description of stream content.";
    88.            reference
    89.              "RFC 5277, Section 3.4, <description> element.";
    90.          }
    92.          leaf replay-support {
    93.            type boolean;
    94.            default false;
    95.            description
    96.              "Indicates if replay buffer is supported for this stream.
    97.               If 'true', then the server MUST support the 'start-time'
    98.               and 'stop-time' query parameters for this stream.";
    99.            reference
    100.              "RFC 5277, Section 3.4, <replaySupport> element.";
    101.          }
    103.          leaf replay-log-creation-time {
    104.            when "../replay-support" {
    105.              description
    106.                "Only present if notification replay is supported.";
    107.            }
    108.            type yang:date-and-time;
    109.            description
    110.              "Indicates the time the replay log for this stream
    111.               was created.";
    112.            reference
    113.              "RFC 5277, Section 3.4, <replayLogCreationTime>
    114.               element.";
    115.          }
    117.          list access {
    118.            key encoding;
    119.            min-elements 1;
    120.            description
    121.              "The server will create an entry in this list for each
    122.               encoding format that is supported for this stream.
    123.               The media type 'text/event-stream' is expected
    124.               for all event streams.  This list identifies the
    125.               subtypes supported for this stream.";
    127.            leaf encoding {
    128.              type string;
    129.              description
    130.                "This is the secondary encoding format within the
    131.                 'text/event-stream' encoding used by all streams.
    132.                 The type 'xml' is supported for XML encoding.
    133.                 The type 'json' is supported for JSON encoding.";
    134.            }
    136.            leaf location {
    137.              type inet:uri;
    138.              mandatory true;
    139.              description
    140.                "Contains a URL that represents the entry point
    141.                 for establishing notification delivery via
    142.                 server-sent events.";
    143.            }
    144.          }
    145.        }
    146.      }
    147.    }
    149.  }

    <CODE ENDS>