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

   1 module o-ran-sc-odu-alarm-v1 {
   2   yang-version 1;
   3   namespace "urn:o-ran:odu: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 resource {
  41       type string;
  42       description
  43         "The alarm  'resource' which is
  44          basically the xpath to the entity
  45          which raises the alarm and the
  46          alarm-type-qualifier, which can be
  47          in our case a static string for all
  48          the alarms, e.g. 'O-RAN-SC:O-DU'.";
  49     }
  50     leaf alarm-text {
  51       type string;
  52       description
  53         "The detailed text of the alarm";
  54     }
  55     leaf severity {
  56       type string;
  57       description
  58         "The severity of the alarm";
  59     }
  60     leaf status {
  61       type string;
  62       description
  63         "The status of the alarm";
  64     }
  65     leaf additional-info {
  66       type string;
  67       description
  68         "Additional info about the alarm";
  69     }
  70     description
  71       "Alarm information";
  72   }
  73
  74   container odu {
  75     container alarms {
  76       config false;
  77       list alarm {
  78         key "alarm-id";
  79         uses alarm-info;
  80         description
  81           "The list of active alarms in RIC";
  82       }
  83       description
  84         "State data container of the alarms";
  85     }
  86     description
  87       "Root object for RIC alarms";
  88   }
  89 }