netconfcentral logo

org-openroadm-tca@2020-03-27



  module org-openroadm-tca {

    yang-version 1;

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

    prefix org-openroadm-tca;

    import ietf-yang-types {
      prefix yang;
      revision-date "2013-07-15";
    }
    import org-openroadm-common-alarm-pm-types {
      prefix
        org-openroadm-common-alarm-pm-types;
      revision-date "2019-11-29";
    }
    import org-openroadm-pm-types {
      prefix org-openroadm-pm-types;
      revision-date "2020-03-27";
    }
    import org-openroadm-resource-types {
      prefix org-openroadm-resource-types;
      revision-date "2019-11-29";
    }

    organization "Open ROADM MSA";

    contact "OpenROADM.org";

    description
      "YANG definitions of Threshold Crossing Alert types.

      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-03-27" {
      description "Version 7.0.0";
    }

    revision "2019-11-29" {
      description "Version 6.1.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-08-28" {
      description
        "Version 2.0.2 - added back the missing pmParameterName container";
    }

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

    revision "2017-06-26" {
      description "Version 2.0";
    }

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


    typedef threshold-enum {
      type enumeration {
        enum "high" {
          value 1;
          description "enum value for high";
        }
        enum "low" {
          value 2;
          description "enum value for low";
        }
      }
      description
        "typedef for threshold enum";
    }

    grouping tca-resource-grp {
      description "group for TCA resources";
      leaf tca-resource-instance {
        type instance-identifier;
        mandatory true;
        description
          "Retrieves all TCA assciated with the resource instance";
      }

      leaf tca-resource-type {
        type org-openroadm-resource-types:resource-type-enum;
        mandatory true;
        description
          "The supported tca-resource type associated with the given resource instance.";
      }

      leaf tca-resource-type-extension {
        type string;
        mandatory true;
        description
          "The resource type extension when the type is not defined in the resource-type-enum.";
      }
    }  // grouping tca-resource-grp

    grouping current-tca-group {
      description
        "TCA Data with current values";
      uses tca-resource-grp;

      leaf enabled {
        type boolean;
        mandatory true;
        description
          "Enable for the TCA entry";
      }

      list pm-entry {
        key "type extension location direction";
        description "List of PM entries";
        uses current-tca-pm-val-group;
      }  // list pm-entry
    }  // grouping current-tca-group

    grouping current-tca-pm-val-group {
      description "Grouping for the TCA PM";
      uses org-openroadm-pm-types:pm-names;

      leaf location {
        type org-openroadm-common-alarm-pm-types:location;
        description "Location PM type";
      }

      leaf direction {
        type org-openroadm-common-alarm-pm-types:direction;
        description "Direction PM type";
      }

      list measurement {
        key "granularity threshold-type";
        description
          "List for PM measurement";
        leaf granularity {
          type org-openroadm-pm-types:pm-granularity;
          description
            "Granularity for the PM entry";
        }

        leaf threshold-type {
          type threshold-enum;
          description "Threshold enum type";
        }

        leaf enabled {
          type boolean;
          description "Measurement enabled";
        }

        leaf threshold-value {
          type org-openroadm-pm-types:pm-data-type;
          mandatory true;
          description "Threshold value";
        }

        leaf threshold-default {
          type org-openroadm-pm-types:pm-data-type;
          config false;
          description
            "Threshold default value";
        }
      }  // list measurement
    }  // grouping current-tca-pm-val-group

    notification tca-notification {
      description "TCA notification";
      uses tca-resource-grp;

      leaf pm-type {
        type org-openroadm-pm-types:pm-names-enum;
        mandatory true;
        description "PM type";
      }

      leaf pm-extension {
        type string;
        mandatory true;
        description "PM extension";
      }

      leaf pm-location {
        type org-openroadm-common-alarm-pm-types:location;
        mandatory true;
        description "PM location";
      }

      leaf pm-direction {
        type org-openroadm-common-alarm-pm-types:direction;
        mandatory true;
        description "PM direction";
      }

      leaf pm-granularity {
        type org-openroadm-pm-types:pm-granularity;
        mandatory true;
        description "PM granularity";
      }

      leaf threshold-value {
        type org-openroadm-pm-types:pm-data-type;
        mandatory true;
        description "threshold value";
      }

      leaf threshold-type {
        type threshold-enum;
        mandatory true;
        description "Threshold Crossed";
      }

      leaf pm-value {
        type org-openroadm-pm-types:pm-data-type;
        mandatory true;
        description "PM Value";
      }

      leaf raise-time {
        type yang:date-and-time;
        mandatory true;
        description "PM raise time";
      }
    }  // notification tca-notification

    container potential-tca-list {
      description "List of current TCAs.";
      list tca-entry {
        key "tca-resource-type tca-resource-type-extension tca-resource-instance";
        description
          "List of current TCA entries";
        uses current-tca-group;
      }  // list tca-entry
    }  // container potential-tca-list
  }  // module org-openroadm-tca