sdnr/model/yang/ietf-netconf-with-defaults@2011-06-01.yang

   1 module ietf-netconf-with-defaults {
   2
   3    namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults";
   4
   5    prefix ncwd;
   6
   7    import ietf-netconf { prefix nc; }
   8
   9    organization
  10     "IETF NETCONF (Network Configuration Protocol) Working Group";
  11
  12    contact
  13     "WG Web:   <http://tools.ietf.org/wg/netconf/>
  14
  15      WG List:  <netconf@ietf.org>
  16
  17      WG Chair: Bert Wijnen
  18                <bertietf@bwijnen.net>
  19
  20      WG Chair: Mehmet Ersue
  21                <mehmet.ersue@nsn.com>
  22
  23      Editor: Andy Bierman
  24              <andy.bierman@brocade.com>
  25
  26      Editor: Balazs Lengyel
  27              <balazs.lengyel@ericsson.com>";
  28
  29    description
  30     "This module defines an extension to the NETCONF protocol
  31      that allows the NETCONF client to control how default
  32      values are handled by the server in particular NETCONF
  33      operations.
  34
  35      Copyright (c) 2011 IETF Trust and the persons identified as
  36      the document authors.  All rights reserved.
  37
  38      Redistribution and use in source and binary forms, with or
  39      without modification, is permitted pursuant to, and subject
  40      to the license terms contained in, the Simplified BSD License
  41      set forth in Section 4.c of the IETF Trust's Legal Provisions
  42      Relating to IETF Documents
  43      (http://trustee.ietf.org/license-info).
  44
  45      This version of this YANG module is part of RFC 6243; see
  46      the RFC itself for full legal notices.";
  47
  48    revision 2011-06-01 {
  49      description
  50        "Initial version.";
  51      reference
  52       "RFC 6243: With-defaults Capability for NETCONF";
  53    }
  54
  55    typedef with-defaults-mode {
  56       description
  57         "Possible modes to report default data.";
  58       reference
  59          "RFC 6243; Section 3.";
  60       type enumeration {
  61          enum report-all {
  62              description
  63                "All default data is reported.";
  64              reference
  65                "RFC 6243; Section 3.1";
  66          }
  67          enum report-all-tagged {
  68              description
  69                "All default data is reported.
  70                 Any nodes considered to be default data
  71                 will contain a 'default' XML attribute,
  72                 set to 'true' or '1'.";
  73              reference
  74                "RFC 6243; Section 3.4";
  75          }
  76          enum trim {
  77              description
  78                "Values are not reported if they contain the default.";
  79              reference
  80                "RFC 6243; Section 3.2";
  81          }
  82          enum explicit {
  83              description
  84                "Report values that contain the definition of
  85                 explicitly set data.";
  86              reference
  87                "RFC 6243; Section 3.3";
  88          }
  89      }
  90    }
  91
  92    grouping with-defaults-parameters {
  93      description
  94        "Contains the <with-defaults> parameter for control
  95         of defaults in NETCONF retrieval operations.";
  96
  97      leaf with-defaults {
  98        description
  99          "The explicit defaults processing mode requested.";
 100        reference
 101          "RFC 6243; Section 4.5.1";
 102
 103        type with-defaults-mode;
 104      }
 105    }
 106
 107    // extending the get-config operation
 108    augment /nc:get-config/nc:input {
 109        description
 110          "Adds the <with-defaults> parameter to the
 111           input of the NETCONF <get-config> operation.";
 112        reference
 113          "RFC 6243; Section 4.5.1";
 114
 115        uses with-defaults-parameters;
 116    }
 117
 118    // extending the get operation
 119    augment /nc:get/nc:input {
 120        description
 121          "Adds the <with-defaults> parameter to
 122           the input of the NETCONF <get> operation.";
 123        reference
 124          "RFC 6243; Section 4.5.1";
 125
 126        uses with-defaults-parameters;
 127    }
 128
 129    // extending the copy-config operation
 130    augment /nc:copy-config/nc:input {
 131        description
 132          "Adds the <with-defaults> parameter to
 133           the input of the NETCONF <copy-config> operation.";
 134        reference
 135          "RFC 6243; Section 4.5.1";
 136
 137        uses with-defaults-parameters;
 138    }
 139
 140 }