module ietf-alarms-x733 {

    yang-version 1.1;

    namespace
      "urn:ietf:params:xml:ns:yang:ietf-alarms-x733";

    prefix x733;

    import ietf-alarms {
      prefix al;
    }
    import ietf-yang-types {
      prefix yang;
      reference
        "RFC 6991: Common YANG Data Types";


    }

    organization "IETF CCAMP Working Group";

    contact
      "WG Web:   <https://trac.ietf.org/trac/ccamp>
     WG List:  <mailto:ccamp@ietf.org>

     Editor:   Stefan Vallin
               <mailto:stefan@wallan.se>

     Editor:   Martin Bjorklund
               <mailto:mbj@tail-f.com>";

    description
      "This module augments the ietf-alarms module with X.733 alarm
     parameters.

     The following structures are augmented with the X.733 event type
     and probable cause:

      1) alarms/alarm-inventory: all possible alarm types
      2) alarms/alarm-list: every alarm in the system
      3) alarm-notification: notifications indicating alarm-state
         changes
      4) alarms/shelved-alarms

     The module also optionally allows the alarm-management system
     to configure the mapping from the ietf-alarms' alarm keys
     to the ITU tuple (event-type, probable-cause).

     The mapping does not include a corresponding problem value
     specific to X.733.  The recommendation is to use the
     'alarm-type-qualifier' leaf, which serves the same purpose.

     The module uses an integer and a corresponding string for
     probable cause instead of a globally defined enumeration, in
     order to be able to manage conflicting enumeration definitions.
     A single globally defined enumeration is challenging to
     maintain.

     The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
     NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED',
     'MAY', and 'OPTIONAL' in this document are to be interpreted as
     described in BCP 14 (RFC 2119) (RFC 8174) when, and only when,
     they appear in all capitals, as shown here.

     Copyright (c) 2019 IETF Trust and the persons identified as
     authors of the code.  All rights reserved.

     Redistribution and use in source and binary forms, with or
     without modification, is permitted pursuant to, and subject to
     the license terms contained in, the Simplified BSD License set
     forth in Section 4.c of the IETF Trust's Legal Provisions
     Relating to IETF Documents
     (https://trustee.ietf.org/license-info).

     This version of this YANG module is part of RFC 8632; see
     the RFC itself for full legal notices.";

    reference
      "ITU-T Recommendation X.733: Information Technology
        - Open Systems Interconnection
        - System Management: Alarm Reporting Function";


    revision "2019-09-11" {
      description "Initial revision.";
      reference
        "RFC 8632: A YANG Data Model for Alarm Management";

    }


    feature configure-x733-mapping {
      description
        "The system supports configurable X733 mapping from
       the ietf-alarms' alarm-type to X733 event-type
       and probable-cause.";
    }

    typedef event-type {
      type enumeration {
        enum "other" {
          value 1;
          description "None of the below.";
        }
        enum "communications-alarm" {
          value 2;
          description
            "An alarm of this type is principally associated with the
           procedures and/or processes required to convey
           information from one point to another.";
        }
        enum "quality-of-service-alarm" {
          value 3;
          description
            "An alarm of this type is principally associated with a
           degradation in the quality of a service.";
        }
        enum "processing-error-alarm" {
          value 4;
          description
            "An alarm of this type is principally associated with a
           software or processing fault.";
        }
        enum "equipment-alarm" {
          value 5;
          description
            "An alarm of this type is principally associated with an
           equipment fault.";
        }
        enum "environmental-alarm" {
          value 6;
          description
            "An alarm of this type is principally associated with a
           condition relating to an enclosure in which the equipment
           resides.";
        }
        enum "integrity-violation" {
          value 7;
          description
            "An indication that information may have been illegally
           modified, inserted, or deleted.";
        }
        enum "operational-violation" {
          value 8;
          description
            "An indication that the provision of the requested service
           was not possible due to the unavailability, malfunction,
           or incorrect invocation of the service.";
        }
        enum "physical-violation" {
          value 9;
          description
            "An indication that a physical resource has been violated
           in a way that suggests a security attack.";
        }
        enum
          "security-service-or-mechanism-violation" {
          value 10;
          description
            "An indication that a security attack has been detected by
           a security service or mechanism.";
        }
        enum "time-domain-violation" {
          value 11;
          description
            "An indication that an event has occurred at an unexpected
           or prohibited time.";
        }
      }
      description
        "The event types as defined by X.733 and X.736.";
      reference
        "ITU-T Recommendation X.733: Information Technology
          - Open Systems Interconnection
          - System Management: Alarm Reporting Function
        ITU-T Recommendation X.736: Information Technology
          - Open Systems Interconnection
          - System Management: Security Alarm Reporting Function";

    }

    typedef trend {
      type enumeration {
        enum "less-severe" {
          value 0;
          description
            "There is at least one outstanding alarm of a
           severity higher (more severe) than that in the
           current alarm.";
        }
        enum "no-change" {
          value 1;
          description
            "The Perceived severity reported in the current
           alarm is the same as the highest (most severe)
           of any of the outstanding alarms";
        }
        enum "more-severe" {
          value 2;
          description
            "The Perceived severity in the current alarm is
           higher (more severe) than that reported in any
           of the outstanding alarms.";
        }
      }
      description
        "This type is used to describe the
       severity trend of the alarming resource.";
      reference
        "ITU-T Recommendation X.721: Information Technology
           - Open Systems Interconnection
           - Structure of management information:
             Definition of management information
             Module Attribute-ASN1Module";

    }

    typedef value-type {
      type union {
        type int64;
        type uint64;
        type decimal64 {
          fraction-digits 2;
        }
      }
      description
        "A generic union type to match the ITU choice of
       integer and real.";
    }
  }  // module ietf-alarms-x733