module org-openroadm-de-operations {

    yang-version 1;

    namespace
      "http://org/openroadm/de/operations";

    prefix org-openroadm-de-operations;

    import org-openroadm-resource {
      prefix org-openroadm-resource;
      revision-date "2024-03-29";
    }
    import org-openroadm-common-types {
      prefix org-openroadm-common-types;
      revision-date "2024-05-31";
    }

    organization "Open ROADM MSA";

    contact "OpenROADM.org";

    description
      "YANG definitions of operations.

     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-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";
    }


    rpc restart {
      description
        "Restart a resource with warm/cold option. If no resource is provided or only the device name is provided, then the device itself will be restarted.
       Note that resources on the device will not be restartable";
      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 option {
          type enumeration {
            enum "warm" {
              value 1;
            }
            enum "cold" {
              value 2;
            }
          }
        }
      }

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

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

    notification restart-notification {
      description
        "This Notification is sent when a resource on a device has completed a restart. This is sent as a result of restarts triggered via the
       restart RPC and other means.  The resource identified is the from the RPC request or the equivalent if the restart was triggered another way.";
      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
    }  // notification restart-notification
  }  // module org-openroadm-de-operations