netconfcentral logo

org-openroadm-alarm

HTML

org-openroadm-alarm@2020-05-29



  module org-openroadm-alarm {

    yang-version 1;

    namespace "http://org/openroadm/alarm";

    prefix org-openroadm-alarm;

    import ietf-yang-types {
      prefix yang;
      revision-date "2013-07-15";
    }
    import org-openroadm-resource {
      prefix org-openroadm-resource;
      revision-date "2020-05-29";
    }
    import org-openroadm-probable-cause {
      prefix org-openroadm-probable-cause;
      revision-date "2020-05-29";
    }

    organization "Open ROADM MSA";

    contact "OpenROADM.org";

    description
      "YANG definitions of an alarm.

     Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
     All other rights reserved.

     Redistribution and use in source and binary forms, with or without modification,
     are permitted provided that the following conditions are met:

     * Redistributions of source code must retain the above copyright notice, this
       list of conditions and the following disclaimer.
     * Redistributions in binary form must reproduce the above copyright notice,
       this list of conditions and the following disclaimer in the documentation and/or
       other materials provided with the distribution.
     * Neither the Members of the Open ROADM MSA Agreement nor the names of its
       contributors may be used to endorse or promote products derived from this software
       without specific prior written permission.

     THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
     INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
     OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
     WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     POSSIBILITY OF SUCH DAMAGE.";

    revision "2020-05-29" {
      description "Version 7.1.0";
    }

    revision "2020-03-27" {
      description "Version 7.0.0";
    }

    revision "2019-11-29" {
      description "Version 6.1.0";
    }

    revision "2019-09-27" {
      description "Version 6.0.0";
    }

    revision "2019-05-31" {
      description "Version 5.1.0";
    }

    revision "2019-03-29" {
      description "Version 5.0.0";
    }

    revision "2018-11-30" {
      description "Version 4.1.0";
    }

    revision "2018-09-28" {
      description "Version 4.0.0";
    }

    revision "2018-03-30" {
      description "Version 3.0.0";
    }

    revision "2017-12-15" {
      description "Version 2.2";
    }

    revision "2017-09-29" {
      description "Version 2.1";
    }

    revision "2017-07-28" {
      description
        "Version 2.0.1 - added revision-date to imports";
    }

    revision "2016-10-14" {
      description "Version 1.2";
    }


    typedef severity {
      type enumeration {
        enum "critical" {
          value 1;
        }
        enum "major" {
          value 2;
        }
        enum "minor" {
          value 3;
        }
        enum "warning" {
          value 4;
        }
        enum "clear" {
          value 5;
        }
        enum "indeterminate" {
          value 6;
        }
      }
      description
        "Severity, based on X.733 perceived severity";
    }

    grouping alarm {
      leaf id {
        type string;
        mandatory true;
        description
          "Uniquely id for this alarm, within the given management domain";
      }

      container resource {
        description "Resource under alarm";
        uses org-openroadm-resource:resource;
      }  // container resource

      container probableCause {
        description
          "Probable cause of alarm";
        uses org-openroadm-probable-cause:probable-cause;
      }  // container probableCause

      leaf raiseTime {
        type yang:date-and-time;
        mandatory true;
        description "Time alarm was raised";
      }

      leaf severity {
        type severity;
        mandatory true;
        description
          "Severity of alarm. Based on X.733 perceived severity.";
      }

      leaf circuit-id {
        type string;
        description
          "Circuit-id for alarm correlation.";
      }

      leaf additional-detail {
        type string;
        description
          "Provide additional descriptive text about the probable cause.";
      }

      leaf corrective-action {
        type string;
        description
          "Provide recommended corrective actions for this probable cause, i.e. replace or restart a circuit pack, check wiring for the reported source, or secondary failure to be correlated ";
      }
    }  // grouping alarm

    notification alarm-notification {
      description
        "Notification sent on initial alarm creation, as well as any time the alarm changes state, including clear";
      uses alarm;
    }  // notification alarm-notification

    container active-alarm-list {
      config false;
      description
        "List of currently active alarms. An alarm is removed from this table when the state transitions to clear.";
      list activeAlarms {
        key "id";
        uses alarm;
      }  // list activeAlarms
    }  // container active-alarm-list
  }  // module org-openroadm-alarm

Summary

  
  
Organization Open ROADM MSA
  
Module org-openroadm-alarm
Version 2020-05-29
File org-openroadm-alarm.yang
  
Prefix org-openroadm-alarm
Namespace http://org/openroadm/alarm
  
Cooked /cookedmodules/org-openroadm-alarm/2020-05-29
YANG /src/org-openroadm-alarm@2020-05-29.yang
XSD /xsd/org-openroadm-alarm@2020-05-29.xsd
  
Abstract YANG definitions of an alarm. Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016, All other rights reserve...
  
Contact
OpenROADM.org

Description

 
YANG definitions of an alarm.

Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
All other rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation and/or
  other materials provided with the distribution.
* Neither the Members of the Open ROADM MSA Agreement nor the names of its
  contributors may be used to endorse or promote products derived from this software
  without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

Typedefs

Typedef Base type Abstract
severity enumeration Severity, based on X.733 perceived severity

Groupings

Grouping Objects Abstract
alarm id resource probableCause raiseTime severity circuit-id additional-detail corrective-action

Objects

Type Key
Mandatory config
Optional config
Not config
Object Type Abstract
active-alarm-list container List of currently active alarms. An alarm is removed from this table when the state transitions to clear.
   activeAlarms list id resource probableCause raiseTime severity circuit-id additional-detail corrective-action
      additional-detail leaf Provide additional descriptive text about the probable cause.
      circuit-id leaf Circuit-id for alarm correlation.
      corrective-action leaf Provide recommended corrective actions for this probable cause, i.e. replace or restart a circuit pack, check wiring for the reported source, or secondary failure to be correlated
      id leaf Uniquely id for this alarm, within the given management domain
      probableCause container Probable cause of alarm
         cause leaf OID: /active-alarm-list/activeAlarms/probableCause/cause
         direction leaf Direction indication of the alarm.
         extension leaf OID: /active-alarm-list/activeAlarms/probableCause/extension
         location leaf location indication of the alarm.
         type leaf Type of alarm. Based on X.733 event Type.
      raiseTime leaf Time alarm was raised
      resource container Resource under alarm
         device container Device of the resource, used only when the system using this model report on more than one device.
            node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
         resource container resource
            resource choice circuit-pack port connection physical-link internal-link shelf srg degree service interface odu-sncp-pg other device line-amplifier xponder versioned-service temp-service
               circuit-pack case circuit-pack-name
                  circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
               connection case connection-name
                  connection-name leaf Connection name. Unique within the context of a device. Same as leafref value in model, if applicable.
               degree case degree-number
                  degree-number leaf Degree identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
               device case node-id
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               interface case interface-name
                  interface-name leaf Interface identifier.
               internal-link case internal-link-name
                  internal-link-name leaf Internal Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
               line-amplifier case amp-number
                  amp-number leaf number of the line-amplifier
               odu-sncp-pg case odu-sncp-pg-name
                  odu-sncp-pg-name leaf name of the odu-snc-pg
               other case other-resource-id
                  other-resource-id leaf resource-id for other.
               physical-link case physical-link-name
                  physical-link-name leaf Physical Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
               port case port
                  port container circuit-pack-name port-name
                     circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     port-name leaf Port identifier. Unique within the context of a circuit-pack. Same as leafref value in model, if applicable.
               service case service-name
                  service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
               shelf case shelf-name
                  shelf-name leaf Shelf-id identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
               srg case srg-number
                  srg-number leaf Shared Risk Group identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
               temp-service case common-id
                  common-id leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
               versioned-service case versioned-service-name version-number
                  version-number leaf version-number of the service
                  versioned-service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
               xponder case xpdr-number
                  xpdr-number leaf number of the xponder
         resourceType container type extension
            extension leaf OID: /active-alarm-list/activeAlarms/resource/resourceType/extension
            type leaf OID: /active-alarm-list/activeAlarms/resource/resourceType/type
      severity leaf Severity of alarm. Based on X.733 perceived severity.

Notifications

Notification Abstract
alarm-notification Notification sent on initial alarm creation, as well as any time the alarm changes state, including clear