agent/yang/o-ran-sc-ric-alarm-v1.yang

   1 module o-ran-sc-ric-alarm-v1 {
   2     yang-version 1;
   3     namespace "urn:o-ran:ric:alarm:1.0";
   4     prefix rxad;
   5
   6     organization
   7         "O-RAN Software Community";
   8     contact
   9         "www.o-ran.org";
  10     description
  11         "This module defines active alarm information visible to operators
  12
  13         Copyright 2020 the O-RAN Alliance.
  14
  15         Licensed under the Apache License, Version 2.0 (the 'License');
  16         you may not use this file except in compliance with the License.
  17         You may obtain a copy of the License at
  18
  19         http://www.apache.org/licenses/LICENSE-2.0
  20
  21         Unless required by applicable law or agreed to in writing, software
  22         distributed under the License is distributed on an 'AS IS' BASIS,
  23         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  24         See the License for the specific language governing permissions and
  25         limitations under the License.";
  26
  27     revision 2020-01-29 {
  28         description
  29             "initial revision";
  30         reference
  31             "O-RAN-OAM-Interface-Specification (O1)";
  32     }
  33
  34     grouping alarm-info {
  35         leaf alarm-id {
  36             type string;
  37             description
  38                 "The unique alarm ID";
  39         }
  40         leaf alarm-text {
  41             type string;
  42             description
  43                 "The detailed text of the alarm";
  44         }
  45         leaf severity {
  46             type health-status;
  47             description
  48                 "The severity of the alarm";
  49         }
  50         leaf status {
  51             type health-status;
  52             description
  53                 "The status of the alarm";
  54         }
  55         leaf additional-info {
  56             type health-status;
  57             description
  58                 "Additional info about the alarm";
  59         }
  60         description
  61             "Alarm information";
  62     }
  63
  64     container ric {
  65         container alarms {
  66             config false;
  67             list alarm {
  68                 key "alarm-id";
  69                 uses alarm-info;
  70                 description
  71                     "The list of active alarms in RIC";
  72             }
  73             description
  74                 "State data container of the alarms";
  75         }
  76         description
  77             "Root object for RIC alarms";
  78     }
  79 }