ntsimulator/yang/x-ran/xran-mplane-int.yang

   1 module xran-mplane-int {
   2   yang-version 1.1;
   3   namespace "urn:xran:mplane-interfaces:1.0";
   4   prefix "xran-mplane-int";
   5
   6   import ietf-inet-types {
   7     prefix "inet";
   8   }
   9
  10   import ietf-interfaces {
  11     prefix "if";
  12   }
  13
  14   import xran-interfaces {
  15     prefix "xran-int";
  16   }
  17
  18   organization "xRAN Forum";
  19
  20   contact
  21     "www.xran.org";
  22
  23   description
  24     "This module defines the YANG definitions for managng the xRAN Radio Unit
  25      management plane interface.
  26
  27      Copyright 2018 the xRAN Forum.
  28
  29      THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
  30      AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  31      IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  32      ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  33      LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  34      CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  35      SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  36      INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  37      CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  38      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  39      POSSIBILITY OF SUCH DAMAGE.
  40
  41      Redistribution and use in source and binary forms, with or without
  42      modification, are permitted provided that the following conditions are met:
  43
  44      * Redistributions of source code must retain the above copyright notice,
  45      this list of conditions and the above disclaimer.
  46      * Redistributions in binary form must reproduce the above copyright notice,
  47      this list of conditions and the above disclaimer in the documentation
  48      and/or other materials provided with the distribution.
  49      * Neither the Members of the xRAN Forum nor the names of its
  50      contributors may be used to endorse or promote products derived from
  51      this software without specific prior written permission.";
  52
  53   revision "2018-07-20" {
  54     description
  55       "version 1.0.0 - First release of the xRAN YANG M-Plane models.
  56
  57       This version of the model supports v01.00 of the corrsponding xRAN
  58       M-Plane Specification.";
  59     reference "XRAN-FH.MP.0-v01.00";
  60   }
  61
  62   typedef vlan-id {
  63     type uint16 {
  64       range 1..4094;
  65     }
  66     description
  67       "Type definition representing a single-tagged VLAN";
  68   }
  69   container mplane-info {
  70     description "top level container for management plane information";
  71     container searchable-mplane-access-vlans-info {
  72       description
  73         "These parameters shall be stored by the RU in reset persistant memory
  74         to enable it to be re-used to optimize VALN discovery procerdures.";
  75       leaf-list searchable-access-vlans {
  76         type vlan-id;
  77         description
  78           "A list of access VLANs that may be operational on the transport
  79           network. Can be used by the RU to optimize its VLAN searching - for
  80           M-plane operations.";
  81       }
  82       container vlan-range {
  83         description "the range of VLAN IDs that may be configured for M-Plane";
  84         leaf lowest-vlan-id {
  85           type vlan-id;
  86           description
  87             "Value of this parameter informs RU about lowest VID to be used
  88             in VLAN scan procedure";
  89         }
  90         leaf highest-vlan-id {
  91           type vlan-id;
  92           description
  93             "Value of this parameter informs RU about highest VID to be used
  94             in VLAN scan procedure";
  95         }
  96       }
  97     }
  98
  99     container m-plane-interfaces {
 100       description "information concerning m-plane interfaces";
 101       list m-plane-sub-interfaces {
 102         key "interface-name sub-interface";
 103         description "list of m-plane information";
 104         leaf interface-name {
 105           type leafref {
 106             path "/if:interfaces/if:interface/if:name";
 107           }
 108           description "the name of the interface";
 109         }
 110         leaf sub-interface {
 111           type leafref {
 112             path "/if:interfaces/if:interface[if:name = current()/../interface-name]/xran-int:vlan-id";
 113           }
 114           description
 115             "vlans used to communicate with management plane servers.";
 116         }
 117         container client-info {
 118           description "the NETCONF client information";
 119           list mplane-ipv4-info {
 120             key mplane-ipv4;
 121             description "list of IPv4 NETCONF clients";
 122             leaf mplane-ipv4 {
 123               type inet:ipv4-address;
 124               description "The IPv4 address of M-Plane client discovered by the RU
 125               or manually configured.";
 126             }
 127             leaf port {
 128               type inet:port-number;
 129               default "4334";
 130               description
 131                 "The port number the call home server listens on.";
 132             }
 133           }
 134           list mplane-ipv6-info {
 135             key mplane-ipv6;
 136             description "list of IPv6 NETCONF clients";
 137             leaf mplane-ipv6 {
 138               type inet:ipv6-address;
 139               description "The IPv6 address of M-Plane client discovered by the RU
 140               or manually configured.";
 141             }
 142             leaf port {
 143               type inet:port-number;
 144               default "4334";
 145               description
 146                 "The port number the call home server listens on.";
 147             }
 148           }
 149           leaf-list mplane-fqdn {
 150             type inet:domain-name;
 151             description "The discovered FQDN(s) of M-Plane client(s).";
 152           }
 153         }
 154       }
 155
 156       container m-plane-ssh-ports {
 157         description "leafs for managing SSH ports";
 158         leaf call-home-ssh-port {
 159           type inet:port-number;
 160           default 4334;
 161           description "call home server port number";
 162         }
 163         leaf server-ssh-port {
 164           type inet:port-number;
 165           default 830;
 166           description "SSH server port number";
 167         }
 168       }
 169     }
 170   }
 171 }