yang/frr-module-translator.yang

   1 // SPDX-License-Identifier: BSD-2-Clause
   2 module frr-module-translator {
   3   yang-version 1.1;
   4   namespace "http://frrouting.org/yang/frr-module-translator";
   5   prefix frr-module-translator;
   6
   7   organization
   8     "FRRouting";
   9   contact
  10     "FRR Users List:       <mailto:frog@lists.frrouting.org>
  11      FRR Development List: <mailto:dev@lists.frrouting.org>";
  12   description
  13     "A model for FRR YANG module translators.
  14
  15      Copyright 2020 FRRouting
  16
  17      Redistribution and use in source and binary forms, with or without
  18      modification, are permitted provided that the following conditions
  19      are met:
  20
  21      1. Redistributions of source code must retain the above copyright notice,
  22      this list of conditions and the following disclaimer.
  23
  24      2. Redistributions in binary form must reproduce the above copyright
  25      notice, this list of conditions and the following disclaimer in the
  26      documentation and/or other materials provided with the distribution.
  27
  28      THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  29      \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  30      LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  31      A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  32      HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  33      SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  34      LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  35      DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  36      THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  37      (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  38      OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.";
  39
  40   revision 2018-07-31 {
  41     description
  42       "Initial revision.";
  43   }
  44
  45   container frr-module-translator {
  46     leaf family {
  47       type string {
  48         length "0 .. 32";
  49       }
  50       mandatory true;
  51       description
  52         "Family of YANG models.";
  53     }
  54     list module {
  55       key "name";
  56       ordered-by user;
  57       description
  58         "YANG module.";
  59
  60       leaf name {
  61         type string;
  62         description
  63           "Module name.";
  64       }
  65       leaf deviations {
  66         type string;
  67         mandatory true;
  68         description
  69           "Module containing the YANG deviations.";
  70       }
  71       list mappings {
  72         key "custom";
  73         description
  74           "YANG mappings between the custom module and FRR native modules.";
  75
  76         leaf custom {
  77           type string {
  78             length "0 .. 256";
  79           }
  80           description
  81             "YANG path of the custom module.";
  82         }
  83         leaf native {
  84           type string {
  85             length "0 .. 256";
  86           }
  87           mandatory true;
  88           description
  89             "Corresponding path of the native YANG modules";
  90         }
  91       }
  92     }
  93   }
  94 }