build/o1/yang/o-ran-sc-odu-interface-v1.yang

   1 module o-ran-sc-odu-interface-v1 {
   2     yang-version 1;
   3     namespace "urn:o-ran:odu:interface:1.0";
   4     prefix rxad;
   5
   6     import ietf-inet-types { prefix inet; }
   7
   8     organization
   9         "O-RAN Software Community";
  10     contact
  11         "www.o-ran.org";
  12     description
  13         "This module defines active interface information visible to operators
  14
  15         Copyright 2020 the O-RAN Alliance.
  16
  17         Licensed under the Apache License, Version 2.0 (the 'License');
  18         you may not use this file except in compliance with the License.
  19         You may obtain a copy of the License at
  20
  21         http://www.apache.org/licenses/LICENSE-2.0
  22
  23         Unless required by applicable law or agreed to in writing, software
  24         distributed under the License is distributed on an 'AS IS' BASIS,
  25         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  26         See the License for the specific language governing permissions and
  27         limitations under the License.";
  28
  29     revision 2020-01-29 {
  30         description
  31             "initial revision";
  32         reference
  33             "O-RAN-OAM-Interface-Specification (O1)";
  34     }
  35
  36     grouping interface-info {
  37         leaf interface-name {
  38             type string;
  39             description
  40                 "The unique interface ID";
  41         }
  42         leaf interface-address {
  43             type inet:ip-address;
  44             mandatory true;
  45             description
  46                "The local IP address to listen on for incoming
  47                 client connections.  INADDR_ANY (0.0.0.0) or
  48                 INADDR6_ANY (0:0:0:0:0:0:0:0 a.k.a. ::) MUST be
  49                 used when the server is to listen on all IPv4 or
  50                 IPv6 addresses, respectively.";
  51         }
  52         leaf port {
  53             type inet:port-number;
  54             default "0";
  55             description
  56                "The local port number to listen on for incoming
  57                client connections.  An invalid default value (0)
  58                is used (instead of 'mandatory true') so that an
  59                application level data model may 'refine' it with
  60                an application specific default port number value.";
  61         }
  62         description
  63             "interface information";
  64     }
  65
  66     container odu {
  67         container interfaces {
  68             list interface {
  69                 key "interface-name";
  70                 uses interface-info;
  71                 description
  72                     "The list of active interfaces in RIC";
  73             }
  74             description
  75                 "State data container of the interfaces";
  76         }
  77         description
  78             "Root object for RIC interfaces";
  79     }
  80 }