yang/frr-module-translator.yang

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