module org-openroadm-common-service-types {

    yang-version 1;

    namespace
      "http://org/openroadm/common/service/types";

    prefix
      org-openroadm-common-service-types;

    import ietf-yang-types {
      prefix yang;
      revision-date "2013-07-15";
    }
    import ietf-inet-types {
      prefix inet;
      revision-date "2013-07-15";
    }
    import org-openroadm-routing-constraints {
      prefix
        org-openroadm-routing-constraints;
      revision-date "2024-03-29";
    }
    import org-openroadm-topology {
      prefix org-openroadm-topology;
      revision-date "2025-03-28";
    }
    import org-openroadm-common-equipment-types {
      prefix
        org-openroadm-common-equipment-types;
      revision-date "2019-11-29";
    }
    import org-openroadm-common-state-types {
      prefix
        org-openroadm-common-state-types;
      revision-date "2019-11-29";
    }
    import org-openroadm-common-node-types {
      prefix
        org-openroadm-common-node-types;
      revision-date "2021-05-28";
    }
    import org-openroadm-resource-types {
      prefix org-openroadm-resource-types;
      revision-date "2022-03-25";
    }
    import org-openroadm-otn-common-types {
      prefix
        org-openroadm-otn-common-types;
      revision-date "2021-09-24";
    }
    import org-openroadm-common-types {
      prefix org-openroadm-common-types;
      revision-date "2025-03-28";
    }
    import org-openroadm-equipment-states-types {
      prefix
        org-openroadm-equipment-states-types;
      revision-date "2019-11-29";
    }
    import org-openroadm-service-format {
      prefix org-openroadm-service-format;
      revision-date "2019-11-29";
    }
    import org-openroadm-common-attributes {
      prefix
        org-openroadm-common-attributes;
      revision-date "2021-09-24";
    }
    import org-openroadm-common-phy-codes {
      prefix
        org-openroadm-common-phy-codes;
      revision-date "2025-03-28";
    }
    import org-openroadm-common-optical-channel-types {
      prefix
        org-openroadm-common-optical-channel-types;
      revision-date "2025-03-28";
    }
    import org-openroadm-common-link-types {
      prefix
        org-openroadm-common-link-types;
      revision-date "2024-12-13";
    }
    import org-openroadm-resource {
      prefix org-openroadm-resource;
      revision-date "2025-03-28";
    }
    import org-openroadm-common-pluggable-types {
      prefix
        org-openroadm-common-pluggable-types;
      revision-date "2025-03-28";
    }

    organization "Open ROADM MSA";

    contact "OpenROADM.org";

    description
      "YANG definitions of common service 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 "2025-03-28" {
      description "Version 17.0";
    }

    revision "2024-12-13" {
      description "Version 16.1";
    }

    revision "2024-09-27" {
      description "Version 16.0";
    }

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


    identity service-resiliency-type-identity {
      description
        "A unique resiliency type identification of the service.";
    }

    identity unprotected {
      base service-resiliency-type-identity;
      description
        "the service is not protected in the OpenROADM layer";
    }

    identity unprotected-diversely-routed {
      base service-resiliency-type-identity;
      description
        "the service is not protected in the OpenROADM layer, but may be protected in a higher layer
   a coupled service that may be routed partially or fully disjointly is defined";
    }

    identity protected {
      base service-resiliency-type-identity;
      description
        "the service is protected in the OpenROADM layer : the protection is handled
autonomously in this layer";
    }

    identity restorable {
      base service-resiliency-type-identity;
      description
        "the service can be restored autonomously in the OpenROADM layer";
    }

    identity external-trigger-restorable {
      base service-resiliency-type-identity;
      description
        "the service can be restored in the OpenROADM layer, but the restoration is triggered
at a higher layer through service models' rpc";
    }

    typedef rpc-actions {
      type enumeration {
        enum "service-create" {
          value 1;
        }
        enum "service-feasibility-check" {
          value 2;
        }
        enum "service-delete" {
          value 3;
        }
        enum "equipment-notification" {
          value 4;
        }
        enum "temp-service-create" {
          value 5;
        }
        enum "temp-service-delete" {
          value 6;
        }
        enum "service-roll" {
          value 7;
        }
        enum "service-reconfigure" {
          value 8;
        }
        enum "service-restoration" {
          value 9;
        }
        enum "service-reversion" {
          value 10;
        }
        enum "service-reroute" {
          value 11;
        }
        enum "service-reroute-confirm" {
          value 12;
        }
        enum "network-re-optimization" {
          value 13;
        }
        enum
          "service-feasibility-check-bulk" {
          value 14;
        }
        enum "ber-test" {
          value 15;
        }
        enum "controller-parameters-setting" {
          value 16;
        }
        enum "optical-tunnel-create" {
          value 17;
        }
        enum "optical-tunnel-request-cancel" {
          value 18;
        }
        enum
          "fill-catalog-with-or-operational-modes" {
          value 19;
        }
        enum
          "fill-catalog-with-specific-operational-modes" {
          value 20;
        }
        enum
          "end-terminal-performance-info-request" {
          value 21;
        }
        enum
          "end-terminal-activation-request" {
          value 22;
        }
        enum
          "end-terminal-deactivation-request" {
          value 23;
        }
        enum "end-terminal-power-control" {
          value 24;
        }
        enum
          "rebalance-optical-power-service" {
          value 28;
        }
        enum
          "rebalance-optical-power-uni-link" {
          value 29;
        }
        enum
          "rebalance-optical-power-bi-link" {
          value 30;
        }
      }
      description
        "rpc-actions include all the rpc methods";
    }

    typedef payload-frame-type {
      type enumeration {
        enum "otu" {
          value 1;
          description "OTUk frame";
        }
        enum "flexo-x" {
          value 2;
          description
            "OTN mapped flexo frame";
        }
        enum "flexo-xe" {
          value 3;
          description
            "Ethernet optimized flexo frame";
        }
        enum "100ZR" {
          value 4;
          description
            "100ZR frame (100GBASE-ZR)";
        }
        enum "400ZR" {
          value 5;
          description "400ZR frame";
        }
        enum "800ZR" {
          value 6;
          description "800ZR frame";
        }
        enum "100ZRplus" {
          value 7;
          description "100ZR+ frame";
        }
        enum "200ZRplus" {
          value 8;
          description "200ZR+ frame";
        }
        enum "300ZRplus" {
          value 9;
          description "300ZR+ frame";
        }
        enum "400ZRplus" {
          value 10;
          description "400ZR+ frame";
        }
      }
    }

    typedef ethernet-encoding-type {
      type enumeration {
        enum "10GBASE-W" {
          value 1;
        }
        enum "10GBASE-R" {
          value 2;
        }
      }
    }

    typedef mapping-mode-type {
      type enumeration {
        enum "GFP-F" {
          value 1;
          reference
            "GFP-F - ITU-T G.7041 SubClause 7.1, Payload Only";

        }
        enum "GFP-E" {
          value 2;
          reference
            "GFP-E - ITU-T G.7041 SubClause 7.9, Payload + Preamble + Ordered Sets";

        }
        enum "PCS-Transparent" {
          value 3;
          reference
            "PCS-Transparent - ITU-T G.709 Subclause 17.2 , CBR10G3 mapping to ODU2e";

        }
      }
    }

    typedef service-layer-type {
      type enumeration {
        enum "wdm" {
          value 1;
        }
        enum "otn" {
          value 2;
        }
      }
    }

    typedef service-notification-types {
      type enumeration {
        enum "service-create-result" {
          value 1;
        }
        enum "service-reconfigure-result" {
          value 2;
        }
        enum "service-delete-result" {
          value 3;
        }
        enum "service-roll-result" {
          value 4;
        }
        enum "service-revert-result" {
          value 5;
        }
        enum "service-reroute-result" {
          value 6;
        }
        enum "service-restoration-result" {
          value 7;
        }
        enum
          "successful-path-computation-resource-reserved" {
          value 8;
        }
        enum "path-computation-failed" {
          value 9;
        }
        enum
          "end-terminal-activation-status" {
          value 10;
        }
      }
    }

    typedef end-terminal-activation-status-type {
      type enumeration {
        enum "activated" {
          value 1;
        }
        enum "deactivated" {
          value 2;
        }
      }
    }

    typedef connection-type {
      type enumeration {
        enum "service" {
          value 1;
        }
        enum "infrastructure" {
          value 2;
        }
        enum "roadm-line" {
          value 3;
        }
        enum "optical-tunnel" {
          value 4;
        }
        enum "end-terminal" {
          value 5;
          description
            "When xponder DCO pluggable optics on OpenROADM XPDR devices are
connected through non-OpenROADM ROADM devices, this connection type
represents that WDM service between the interface ports of those
optics. This connection type compliments optical-tunnel
connection-type.";
        }
        enum "point-to-point-with-ecc" {
          value 6;
          description
            "This connection type represents a service between a pair of xponder
DCO pluggable optics on OpenROADM XPDR devices, where one device is
at a remote location and the other device is at a central office
location, that are directly connected to each other without ROADM
devices in between. Connectivity to the remote XPDR device is
established via an embedded communication channel, such as GCC0 or
FCCO, on this WDM service. This service is already
provisioned on both devices to establish the connectivity from the
controller to the remote device. A service-create request with this
connection-type creates a service record in the controller utilizing
the path already provisioned. Similarly, a service-delete request
removes service record from the controller database without deleting
the provisioning on the devices to maintain connectivity from the
controller to the remote device.";
        }
        enum "point-to-point" {
          value 7;
          description
            "This connection type represents a service between a pair of xponder
DCO pluggable optics on OpenROADM XPDR devices that are directly
connected to each other without ROADM devices in between.";
        }
      }
    }

    typedef resource-status-type {
      type enumeration {
        enum "deployed" {
          value 1;
          description
            "find the best route using deployed network resources,
regardless of network failures; lifecycle-state must
be deployed and operational-state is ignored.";
        }
        enum "in-service" {
          value 2;
          description
            "find the best route using deployed network resources,
but route around failed resources; lifecycle-state
must be deployed and operational-state must be
inService.";
        }
        enum "planned" {
          value 3;
          description
            "find the best route using both deployed and planned
network resources; lifecycle-state must be planned
or deployed (deploying, deployed-updating, deployed-
augmented, and deploy-failed may be considered
planned states) and operational-state is ignored. if
planned is selected, due-date must be specified in
the service request.";
        }
      }
      default "deployed";
      description
        "identifies the state of network resources required to
complete a service request.  default is deployed";
    }

    typedef service-condition {
      type enumeration {
        enum "restored-temporarily" {
          value 1;
        }
        enum "re-routed-temporarily" {
          value 2;
        }
        enum "activated-for-service" {
          value 3;
        }
        enum "activated-for-further-check" {
          value 4;
        }
        enum
          "activated-for-troubleshooting-failure" {
          value 5;
        }
      }
    }

    typedef existing-resource-reuse-type {
      type enumeration {
        enum "regenerator" {
          value 1;
          description
            "Indicates reuse regenerator";
        }
        enum "wavelength" {
          value 2;
          description
            "Indicates reuse of wavelength";
        }
        enum "spectrum-portion" {
          value 3;
          description
            "Indicates reuse of frequency slot(s). Reuse the exact
or partial portion of the spectrum of the original service
specturm";
        }
        enum "xponder" {
          value 4;
          description
            "This could be a transponder/muxponder/switchponder";
        }
        enum "all" {
          value 99;
          description
            "Reuse all possible options";
        }
      }
      description
        "Used to indicate the type of resource that the existing service
can reuse wherever possible (best-effort)";
    }
  }  // module org-openroadm-common-service-types