module org-openroadm-pm {

    yang-version 1;

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

    prefix org-openroadm-pm;

    import ietf-yang-types {
      prefix yang;
      revision-date "2013-07-15";
    }
    import org-openroadm-common-types {
      prefix org-openroadm-common-types;
      revision-date "2024-05-31";
    }
    import org-openroadm-common-alarm-pm-types {
      prefix
        org-openroadm-common-alarm-pm-types;
      revision-date "2019-11-29";
    }
    import org-openroadm-resource {
      prefix org-openroadm-resource;
      revision-date "2024-03-29";
    }
    import org-openroadm-resource-types {
      prefix org-openroadm-resource-types;
      revision-date "2022-03-25";
    }
    import org-openroadm-pm-types {
      prefix org-openroadm-pm-types;
      revision-date "2022-12-09";
    }

    organization "Open ROADM MSA";

    contact "OpenROADM.org";

    description
      "YANG definitions of performance management.

      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 "2024-05-31" {
      description "Version 15.1";
    }

    revision "2024-03-29" {
      description "Version 15.0";
    }

    revision "2023-12-08" {
      description "Version 14.1";
    }

    revision "2023-09-29" {
      description "Version 14.0";
    }

    revision "2023-05-26" {
      description "Version 13.1";
    }

    revision "2023-03-31" {
      description "Version 13.0";
    }

    revision "2022-12-09" {
      description "Version 12.1";
    }

    revision "2022-09-30" {
      description "Version 12.0";
    }

    revision "2022-05-27" {
      description "Version 11.1";
    }

    revision "2022-03-25" {
      description "Version 11.0";
    }

    revision "2021-12-10" {
      description "Version 10.1";
    }

    revision "2021-09-24" {
      description "Version 10.0";
    }

    revision "2021-05-28" {
      description "Version 9.1";
    }

    revision "2021-03-26" {
      description "Version 9.0";
    }

    revision "2020-12-11" {
      description "Version 8.1";
    }

    revision "2020-09-25" {
      description "Version 8.0";
    }

    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-05-30" {
      description "Version 3.1.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 "2017-06-26" {
      description "Version 2.0";
    }

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


    feature historical-pm-retrieval {
      description
        "The device supports the ability to directly retrieve the historical
       PM data from the YANG model.";
    }

    rpc clear-pm {
      description
        "Command to initialize PM data";
      input {
        container device {
          description
            "Device of the resource, used only when the system using this
model report on more than one device. ";
          leaf node-id {
            type org-openroadm-common-node-types:node-id-type;
            description
              "Node Id is a globally unique identifier for a device.
Same as leafref value in model, if applicable.";
          }
        }  // container device

        container resource {
          choice resource {
            leaf circuit-pack-name {
              type string;
              mandatory true;
              description
                "Circuit-Pack identifier. Unique within the context of a device.
Same as leafref value in model, if applicable.";
            }
            container port {
              leaf circuit-pack-name {
                type string;
                mandatory true;
                description
                  "Circuit-Pack identifier. Unique within the context of a device.
Same as leafref value in model, if applicable.";
              }

              leaf port-name {
                type string;
                description
                  "Port identifier. Unique within the context of a circuit-pack.
Same as leafref value in model, if applicable.";
              }
            }  // container port
            leaf connection-name {
              type string;
              mandatory true;
              description
                "Connection name. Unique within the context of a device.
Same as leafref value in model, if applicable.";
            }
            leaf physical-link-name {
              type string;
              mandatory true;
              description
                "Physical Link identifier. Unique within the context of a device.
Same as leafref value in model, if applicable.";
            }
            leaf internal-link-name {
              type string;
              mandatory true;
              description
                "Internal Link identifier. Unique within the context of a device.
Same as leafref value in model, if applicable.";
            }
            leaf shelf-name {
              type string;
              mandatory true;
              description
                "Shelf-id identifier. Unique within the context of a device.
Same as leafref value in model, if applicable.";
            }
            leaf srg-number {
              type uint16;
              mandatory true;
              description
                "Shared Risk Group identifier. Unique within the context of a device.
Same as leafref value in model, if applicable.";
            }
            leaf degree-number {
              type uint16;
              mandatory true;
              description
                "Degree identifier. Unique within the context of a device.
Same as leafref value in model, if applicable.";
            }
            leaf service-name {
              type string;
              mandatory true;
              description
                "Service identifier. Unique within the context of a network.
Same as leafref value in model, if applicable.";
            }
            leaf interface-name {
              type string;
              mandatory true;
              description
                "Interface identifier.";
            }
            leaf odu-sncp-pg-name {
              type string;
              mandatory true;
              description
                "name of the odu-snc-pg";
            }
            leaf client-sncp-pg-name {
              type string;
              mandatory true;
              description
                "name of the client-snc-pg";
            }
            leaf circuit-pack-pg-name {
              type string;
              mandatory true;
              description
                "name of the circuit-pack-pg";
            }
            leaf other-resource-id {
              type string;
              mandatory true;
              description
                "resource-id for other.";
            }
            leaf node-id {
              type org-openroadm-common-node-types:node-id-type;
              mandatory true;
              description
                "Node Id is a globally unique identifier for a device.
Same as leafref value in model, if applicable.";
            }
            leaf amp-number {
              type uint8;
              mandatory true;
              description
                "number of the line-amplifier";
            }
            leaf xpdr-number {
              type uint16;
              mandatory true;
              description
                "number of the xponder";
            }

            case versioned-service {
              leaf versioned-service-name {
                type string;
                mandatory true;
                description
                  "Service identifier. Unique within the context of a network.
Same as leafref value in model, if applicable.";
              }

              leaf version-number {
                type uint64;
                mandatory true;
                description
                  "version-number of the service";
              }
            }  // case versioned-service
            leaf common-id {
              type string;
              mandatory true;
              description
                "Service identifier. Unique within the context of a network.
Same as leafref value in model, if applicable.";
            }
            container slot {
              leaf shelf-name {
                type string;
                mandatory true;
                description
                  "Shelf-id identifier. Unique within the context of a device.
Same as leafref value in model, if applicable.";
              }

              leaf slot-name {
                type string;
                mandatory true;
                description
                  "Slot-name identifier for a shelf slot. Unique within the context of a shelf.
Same as leafref value in model, if applicable.";
              }
            }  // container slot
            container cp-slot {
              leaf circuit-pack-name {
                type string;
                mandatory true;
                description
                  "Circuit-Pack identifier. Unique within the context of a device.
Same as leafref value in model, if applicable.";
              }

              leaf slot-name {
                type string;
                mandatory true;
                description
                  "Slot-name identifier for a circuit-pack cp-slot. Unique within the context of a circut-pack.
Same as leafref value in model, if applicable.";
              }
            }  // container cp-slot
          }  // choice resource
        }  // container resource

        container resourceType {
          leaf type {
            type resource-type-enum;
            mandatory true;
          }

          leaf extension {
            type string;
          }
        }  // container resourceType

        leaf pm-type {
          type enumeration {
            enum "current" {
              value 1;
            }
            enum "all" {
              value 2;
            }
          }
          default "current";
        }

        leaf granularity {
          type org-openroadm-pm-types:pm-granularity;
          default "15min";
        }
      }

      output {
        leaf status {
          type rpc-status;
          mandatory true;
          description "Successful or Failed";
        }

        leaf status-message {
          type string;
          description
            "Gives a more detailed status";
        }
      }
    }  // rpc clear-pm

    rpc collect-historical-pm-file {
      description
        "Command to query historical PM data.
       The device should be able to process an rpc request for 15min data
       and a separate request for 24hour data in parallel.";
      input {
        leaf from-bin-number {
          type uint16 {
            range "1..max";
          }
          default "1";
          description
            "The start bin-number of the range";
        }

        leaf to-bin-number {
          type uint16 {
            range "1..max";
          }
          default "1";
          description
            "The end bin-number of the range";
        }

        leaf granularity {
          type org-openroadm-pm-types:pm-granularity;
          default "15min";
          description
            "The granularity of the retrieve, default to 15 minutes PM";
        }
      }

      output {
        leaf pm-filename {
          type string {
            length "10..255";
          }
          mandatory true;
          description
            "The file name to write the historical PM data.
The controller should be able to use this name to retrieve the file via ftp/sftp.
The file name should be unique for each RPC request since a new RPC request
could be initiated while the file transfer of the previous file is still in progress.

The file content should be written in xml format based on the historical-pm-list
yang definition and the file should be gzip compressed.

If no data is to be returned, the file content should contain only an empty XML tag:
<historical-pm-list/>
This file would then be gzip compressed.";
        }

        leaf status {
          type rpc-status;
          mandatory true;
          description "Successful or Failed";
        }

        leaf status-message {
          type string;
          description
            "Gives a more detailed status";
        }
      }
    }  // rpc collect-historical-pm-file

    notification historical-pm-collect-result {
      description
        "This Notification is sent when the pm collection is successful or failed.";
      leaf pm-filename {
        type string {
          length "10..255";
        }
        mandatory true;
        description
          "The file name to write the historical PM data.
The controller should be able to use this name to retrieve the file via ftp/sftp.
The file name should be unique for each RPC request since a new RPC request
could be initiated while the file transfer of the previous file is still in progress.

The file content should be written in xml format based on the historical-pm-list
yang definition and the file should be gzip compressed.

If no data is to be returned, the file content should contain only an empty XML tag:
<historical-pm-list/>
This file would then be gzip compressed.";
      }

      leaf status {
        type rpc-status;
        mandatory true;
        description "Successful or Failed";
      }

      leaf status-message {
        type string;
        description
          "Gives a more detailed status";
      }
    }  // notification historical-pm-collect-result

    container current-pm-list {
      config false;
      description "List of current PMs.";
      list current-pm-entry {
        key "pm-resource-type pm-resource-type-extension pm-resource-instance";
        description
          "List of current PM entries";
        leaf pm-resource-instance {
          type instance-identifier;
          config false;
          mandatory true;
          description
            "Retrieves all PM associate with the resource instance";
        }

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

        leaf pm-resource-type-extension {
          type string;
          config false;
          description
            "The resource type extension when the type is not defined in the resource-type-enum.";
        }

        leaf retrieval-time {
          type yang:date-and-time;
          config false;
          mandatory true;
          description
            "Represents the time when the data is being read, not the bin start or end time.";
        }

        list current-pm {
          key "type extension location direction";
          config false;
          leaf type {
            type pm-names-enum;
            mandatory true;
          }

          leaf extension {
            type string;
            description
              "name of parameter, when enum value set to vendorExtension because
name not found in pm-names-enum";
          }

          leaf location {
            type org-openroadm-common-alarm-pm-types:location;
          }

          leaf direction {
            type org-openroadm-common-alarm-pm-types:direction;
          }

          list measurement {
            key "granularity";
            leaf granularity {
              type org-openroadm-pm-types:pm-granularity;
            }

            leaf pmParameterValue {
              type pm-data-type;
              config false;
              mandatory true;
            }

            leaf pmParameterUnit {
              type string;
              description
                "Unit PM parameter has been measured - frames, packets, u, etc";
            }

            leaf validity {
              type validity;
              mandatory true;
            }

            leaf start-time {
              type yang:date-and-time;
              config false;
              mandatory true;
              description
                "Represents the start time of the bin (15m, 24h granularity) or the start of data collection (notApplicable/untimed granularity).";
            }
          }  // list measurement
        }  // list current-pm
      }  // list current-pm-entry
    }  // container current-pm-list

    container historical-pm-list {
      if-feature historical-pm-retrieval;
      config false;
      description "List of historical PM";
      list historical-pm-entry {
        key "pm-resource-type pm-resource-type-extension pm-resource-instance";
        description
          "List of historical PM entries";
        leaf pm-resource-instance {
          type instance-identifier;
          config false;
          mandatory true;
          description
            "Retrieves all PM associate with the resource instance";
        }

        leaf pm-resource-type {
          type org-openroadm-resource-types:resource-type-enum;
          config false;
          mandatory true;
        }

        leaf pm-resource-type-extension {
          type string;
          config false;
          description
            "The resource type extension when the type is not defined in the resource-type-enum.";
        }

        list historical-pm {
          key "type extension location direction";
          leaf type {
            type pm-names-enum;
            mandatory true;
          }

          leaf extension {
            type string;
            description
              "name of parameter, when enum value set to vendorExtension because
name not found in pm-names-enum";
          }

          leaf location {
            type org-openroadm-common-alarm-pm-types:location;
          }

          leaf direction {
            type org-openroadm-common-alarm-pm-types:direction;
          }

          list measurement {
            key "granularity bin-number";
            leaf granularity {
              type org-openroadm-pm-types:pm-granularity;
              mandatory true;
            }

            leaf bin-number {
              type uint16 {
                range "1..max";
              }
              config false;
              mandatory true;
            }

            leaf pmParameterValue {
              type pm-data-type;
              config false;
              mandatory true;
            }

            leaf pmParameterUnit {
              type string;
              description
                "Unit PM parameter has been measured - frames, packets, u, etc";
            }

            leaf validity {
              type validity;
              mandatory true;
            }

            leaf completion-time {
              type yang:date-and-time;
              config false;
              mandatory true;
              description
                "The time at the end of the period; For example if bin starts at
01:15:00 and ends at 01:29:59, the completion-time is 01:29:59";
            }
          }  // list measurement
        }  // list historical-pm
      }  // list historical-pm-entry
    }  // container historical-pm-list
  }  // module org-openroadm-pm