hiroki | 096259b | 2018-12-07 09:33:24 -0800 | [diff] [blame] | 1 | module openconfig-alarm-types { |
| 2 | |
| 3 | yang-version "1"; |
| 4 | |
| 5 | // namespace |
| 6 | namespace "http://openconfig.net/yang/alarms/types"; |
| 7 | |
| 8 | prefix "oc-alarm-types"; |
| 9 | |
| 10 | // import some basic types |
| 11 | import openconfig-extensions { prefix oc-ext; } |
| 12 | |
| 13 | // meta |
| 14 | organization "OpenConfig working group"; |
| 15 | |
| 16 | contact |
| 17 | "OpenConfig working group |
| 18 | www.openconfig.net"; |
| 19 | |
| 20 | description |
| 21 | "This module defines operational state data related to alarms |
| 22 | that the device is reporting. |
| 23 | |
| 24 | This model reuses some data items defined in the draft IETF |
| 25 | YANG Alarm Module: |
| 26 | https://tools.ietf.org/html/draft-vallin-netmod-alarm-module-02 |
| 27 | |
| 28 | Portions of this code were derived from the draft IETF YANG Alarm |
| 29 | Module. Please reproduce this note if possible. |
| 30 | |
| 31 | IETF code is subject to the following copyright and license: |
| 32 | Copyright (c) IETF Trust and the persons identified as authors of |
| 33 | the code. |
| 34 | All rights reserved. |
| 35 | |
| 36 | Redistribution and use in source and binary forms, with or without |
| 37 | modification, is permitted pursuant to, and subject to the license |
| 38 | terms contained in, the Simplified BSD License set forth in |
| 39 | Section 4.c of the IETF Trust's Legal Provisions Relating |
| 40 | to IETF Documents (http://trustee.ietf.org/license-info)."; |
| 41 | |
| 42 | oc-ext:openconfig-version "0.2.0"; |
| 43 | |
| 44 | revision "2018-01-16" { |
| 45 | description |
| 46 | "Moved alarm identities into separate types module"; |
| 47 | reference "0.2.0"; |
| 48 | } |
| 49 | |
| 50 | // identity statements |
| 51 | identity OPENCONFIG_ALARM_TYPE_ID { |
| 52 | description |
| 53 | "Base identity for alarm type ID profiles"; |
| 54 | } |
| 55 | |
| 56 | identity AIS { |
| 57 | base OPENCONFIG_ALARM_TYPE_ID; |
| 58 | description |
| 59 | "Defines an alarm indication signal type of alarm"; |
| 60 | } |
| 61 | |
| 62 | identity EQPT { |
| 63 | base OPENCONFIG_ALARM_TYPE_ID; |
| 64 | description |
| 65 | "Defines an equipment related type of alarm that is specific |
| 66 | to the physical hardware"; |
| 67 | } |
| 68 | |
| 69 | identity LOS { |
| 70 | base OPENCONFIG_ALARM_TYPE_ID; |
| 71 | description |
| 72 | "Defines a loss of signal type of alarm"; |
| 73 | } |
| 74 | |
| 75 | identity OTS { |
| 76 | base OPENCONFIG_ALARM_TYPE_ID; |
| 77 | description |
| 78 | "Defines a optical transport signal type of alarm"; |
| 79 | } |
| 80 | |
| 81 | identity OPENCONFIG_ALARM_SEVERITY { |
| 82 | description |
| 83 | "Base identity for alarm severity profiles. Derived |
| 84 | identities are based on contents of the draft |
| 85 | IETF YANG Alarm Module"; |
| 86 | reference |
| 87 | "IETF YANG Alarm Module: Draft - typedef severity |
| 88 | https://tools.ietf.org/html/draft-vallin-netmod-alarm-module-02"; |
| 89 | |
| 90 | } |
| 91 | |
| 92 | identity UNKNOWN { |
| 93 | base OPENCONFIG_ALARM_SEVERITY; |
| 94 | description |
| 95 | "Indicates that the severity level could not be determined. |
| 96 | This level SHOULD be avoided."; |
| 97 | } |
| 98 | |
| 99 | identity MINOR { |
| 100 | base OPENCONFIG_ALARM_SEVERITY; |
| 101 | description |
| 102 | "Indicates the existence of a non-service affecting fault |
| 103 | condition and that corrective action should be taken in |
| 104 | order to prevent a more serious (for example, service |
| 105 | affecting) fault. Such a severity can be reported, for |
| 106 | example, when the detected alarm condition is not currently |
| 107 | degrading the capacity of the resource"; |
| 108 | } |
| 109 | |
| 110 | identity WARNING { |
| 111 | base OPENCONFIG_ALARM_SEVERITY; |
| 112 | description |
| 113 | "Indicates the detection of a potential or impending service |
| 114 | affecting fault, before any significant effects have been felt. |
| 115 | Action should be taken to further diagnose (if necessary) and |
| 116 | correct the problem in order to prevent it from becoming a more |
| 117 | serious service affecting fault."; |
| 118 | } |
| 119 | |
| 120 | identity MAJOR { |
| 121 | base OPENCONFIG_ALARM_SEVERITY; |
| 122 | description |
| 123 | "Indicates that a service affecting condition has developed |
| 124 | and an urgent corrective action is required. Such a severity |
| 125 | can be reported, for example, when there is a severe |
| 126 | degradation in the capability of the resource and its full |
| 127 | capability must be restored."; |
| 128 | } |
| 129 | |
| 130 | identity CRITICAL { |
| 131 | base OPENCONFIG_ALARM_SEVERITY; |
| 132 | description |
| 133 | "Indicates that a service affecting condition has occurred |
| 134 | and an immediate corrective action is required. Such a |
| 135 | severity can be reported, for example, when a resource becomes |
| 136 | totally out of service and its capability must be restored."; |
| 137 | } |
| 138 | |
| 139 | } |