netconfcentral logo

org-openroadm-service

HTML

org-openroadm-service@2020-05-29



  module org-openroadm-service {

    yang-version 1;

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

    prefix org-openroadm-service;

    import ietf-yang-types {
      prefix yang;
      revision-date "2013-07-15";
    }
    import org-openroadm-routing-constraints {
      prefix
        org-openroadm-routing-constraints;
      revision-date "2020-05-29";
    }
    import org-openroadm-common-types {
      prefix org-openroadm-common-types;
      revision-date "2020-05-29";
    }
    import org-openroadm-resource-types {
      prefix org-openroadm-resource-types;
      revision-date "2019-11-29";
    }
    import org-openroadm-common-service-types {
      prefix
        org-openroadm-common-service-types;
      revision-date "2020-05-29";
    }
    import org-openroadm-controller-customization {
      prefix
        org-openroadm-controller-customization;
      revision-date "2020-05-29";
    }

    organization "Open ROADM MSA";

    contact "OpenROADM.org";

    description
      "YANG definitions of services.

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


    grouping service-feasibility-check-inputs {
      leaf connection-type {
        type org-openroadm-common-service-types:connection-type;
      }

      uses org-openroadm-common-service-types:resource-status;

      container service-a-end {
        uses org-openroadm-common-service-types:service-endpoint;
      }  // container service-a-end

      container service-z-end {
        uses org-openroadm-common-service-types:service-endpoint;
      }  // container service-z-end

      uses org-openroadm-routing-constraints:routing-constraints;

      uses org-openroadm-common-service-types:routing-metric;

      uses org-openroadm-common-service-types:service-resiliency;

      leaf propose-equipment {
        type enumeration {
          enum "never" {
            value 1;
          }
          enum "ifNeeded" {
            value 2;
          }
          enum "always" {
            value 3;
          }
        }
        default "ifNeeded";
        description
          "Whether or not this request can propose new equipment that could
be used to fulfill this request. If never, the request will just
use existing deployed and planned equipment. If ifNeeded, routes using existing equipment
will be preferred. If always, a route with proposed equipment shall be returned, if possible";
      }

      uses org-openroadm-common-service-types:service-information;
    }  // grouping service-feasibility-check-inputs

    grouping service-feasibility-check-outputs {
      uses org-openroadm-common-service-types:response-parameters;

      container service-a-end {
        uses org-openroadm-common-service-types:service-endpoint;

        list equipment-required {
          key "equipment-identifier";
          description
            "List of required equipment, including equipment type, state and
quantity";
          uses org-openroadm-common-service-types:equipment-info;
        }  // list equipment-required
      }  // container service-a-end

      container service-z-end {
        uses org-openroadm-common-service-types:service-endpoint;

        list equipment-required {
          key "equipment-identifier";
          description
            "List of required equipment, including equipment type, state and
quantity";
          uses org-openroadm-common-service-types:equipment-info;
        }  // list equipment-required
      }  // container service-z-end

      list intermediate-sites {
        key "clli";
        uses org-openroadm-common-service-types:service-endpoint;

        list equipment-required {
          key "equipment-identifier";
          description
            "List of required equipment, including equipment type, state and
quantity over entire route of service";
          uses org-openroadm-common-service-types:equipment-info;
        }  // list equipment-required
      }  // list intermediate-sites
    }  // grouping service-feasibility-check-outputs

    rpc service-create {
      description
        "Whether this request passed initial validation and was accepted for processing. Once the request completes processing, a
service-rpc-result Notification shall be sent.";
      input {
        leaf service-name {
          type string;
          mandatory true;
          description
            "Identifier for the service to be created in
the ROADM network, e.g., CLFI, CLCI, etc. This is reported against the service, but may not get reflected in the service in the network.";
        }

        leaf common-id {
          type string;
          description
            "To be used by the ROADM controller to identify the routing constraints received from planning application (PED).";
        }

        uses org-openroadm-common-service-types:service-order;

        uses org-openroadm-common-service-types:sdnc-request-header;

        uses org-openroadm-common-service-types:routing-metric;

        uses org-openroadm-common-service-types:service-resiliency;

        leaf connection-type {
          type org-openroadm-common-service-types:connection-type;
          mandatory true;
        }

        uses org-openroadm-common-service-types:resource-status;

        container service-a-end {
          uses org-openroadm-common-service-types:service-endpoint;

          uses org-openroadm-common-service-types:service-endpoint-project;
        }  // container service-a-end

        container service-z-end {
          uses org-openroadm-common-service-types:service-endpoint;

          uses org-openroadm-common-service-types:service-endpoint-project;
        }  // container service-z-end

        uses org-openroadm-routing-constraints:routing-constraints;

        uses org-openroadm-common-service-types:service-information;
      }

      output {
        uses org-openroadm-common-service-types:configuration-response-common;

        uses org-openroadm-common-service-types:response-parameters;
      }
    }  // rpc service-create

    rpc service-create-result-notification-request {
      description
        "This is the callback notification that the controller invokes on the carrier system.";
      input {
        uses org-openroadm-common-service-types:configuration-response-common;

        uses org-openroadm-common-service-types:service-identifiers-container;
      }

      output {
        uses org-openroadm-common-service-types:configuration-response-common;
      }
    }  // rpc service-create-result-notification-request

    rpc service-create-complex-result-notification-request {
      description
        "This is the callback notification that the controller invokes on the carrier system.";
      input {
        uses org-openroadm-common-service-types:configuration-response-common;

        uses org-openroadm-common-service-types:service-and-supporting-services;
      }

      output {
        uses org-openroadm-common-service-types:configuration-response-common;
      }
    }  // rpc service-create-complex-result-notification-request

    rpc service-delete-result-notification-request {
      description
        "This is the callback notification that the controller invokes on the carrier system.";
      input {
        uses org-openroadm-common-service-types:configuration-response-common;

        uses org-openroadm-common-service-types:service-identifiers-container;
      }

      output {
        uses org-openroadm-common-service-types:configuration-response-common;
      }
    }  // rpc service-delete-result-notification-request

    rpc service-delete-complex-result-notification-request {
      description
        "This is the callback notification that the controller invokes on the carrier system.";
      input {
        uses org-openroadm-common-service-types:configuration-response-common;

        uses org-openroadm-common-service-types:service-and-supporting-services;
      }

      output {
        uses org-openroadm-common-service-types:configuration-response-common;
      }
    }  // rpc service-delete-complex-result-notification-request

    rpc service-feasibility-check {
      description
        "Whether a service was possible to be created, and if so
the routing constraints match and the a and z end connection that have
to match
Takes a potential service and determines if it is possible in the network
using equipment that is installed on the network, formally planned or proposed for planning.
No resources are reserved, provisioned or planned as a result of this operation";
      input {
        leaf common-id {
          type string;
          mandatory true;
          description
            "To be used by the ROADM controller to identify the routing constraints
received from planning application (PED).";
        }

        uses org-openroadm-common-service-types:sdnc-request-header;

        uses service-feasibility-check-inputs;
      }

      output {
        uses org-openroadm-common-service-types:configuration-response-common;

        uses service-feasibility-check-outputs;
      }
    }  // rpc service-feasibility-check

    rpc service-feasibility-check-bulk {
      description
        "Whether a service was possible to be created, and if so
the routing constraints match and the a and z end connection that have
to match

Takes a list of potential services and determines if they are possible in the network
using equipment that is installed on the network, formally planned or proposed for planning.
All services are treated collectively to ensure that a given resource is not used more than once.
No resources are reserved, provisioned or planned as a result of this operation";
      input {
        uses org-openroadm-common-service-types:sdnc-request-header;

        list service-request-list {
          leaf common-id {
            type string;
            mandatory true;
            description
              "To be used by the ROADM controller to identify the routing constraints
received from planning application (PED).";
          }

          uses service-feasibility-check-inputs;
        }  // list service-request-list
      }

      output {
        uses org-openroadm-common-service-types:configuration-response-common;

        list service-response-list {
          uses service-feasibility-check-outputs;
        }  // list service-response-list
      }
    }  // rpc service-feasibility-check-bulk

    rpc service-delete {
      description
        "Whether this request passed initial validation and was accepted for processing. Once the request completes processing, a
service-rpc-result Notification shall be sent. Once the service has been deleted, it no longer will appear in the service list";
      input {
        uses org-openroadm-common-service-types:sdnc-request-header;

        container service-delete-req-info {
          leaf service-name {
            type string;
            mandatory true;
            description
              "Identifier for the service to be deleted in
the ROADM network, e.g., CLFI, CLCI, etc.";
          }

          leaf due-date {
            type yang:date-and-time;
            description
              "date and time service to be turned down. If missing, now.";
          }

          leaf tail-retention {
            type enumeration {
              enum "yes" {
                value 1;
                description
                  "tails are left intact ";
              }
              enum "no" {
                value 2;
                description
                  "tails are deleted";
              }
            }
            mandatory true;
          }
        }  // container service-delete-req-info
      }

      output {
        uses org-openroadm-common-service-types:configuration-response-common;
      }
    }  // rpc service-delete

    rpc equipment-notification {
      input {
        uses org-openroadm-common-service-types:sdnc-request-header;

        leaf equipment-id {
          type string;
          mandatory true;
        }

        leaf equipment-name {
          type string;
        }

        leaf equipment-type {
          type string;
          mandatory true;
          description
            "The set of valid value is derived from the equipment-type grouping used in the device model.";
        }

        leaf equipment-vendor {
          type string;
          mandatory true;
        }

        leaf equipment-customer {
          type string;
        }

        leaf equipment-clli {
          type string;
          mandatory true;
        }

        leaf equipment-ip {
          type string;
        }

        leaf controller-id {
          type string;
          mandatory true;
        }
      }

      output {
        uses org-openroadm-common-service-types:configuration-response-common;
      }
    }  // rpc equipment-notification

    rpc temp-service-create {
      input {
        leaf common-id {
          type string;
          mandatory true;
          description
            "To be used by the ROADM controller to identify the routing constraints received from planning application (PED).";
        }

        uses org-openroadm-common-service-types:service-order;

        uses org-openroadm-common-service-types:sdnc-request-header;

        leaf connection-type {
          type org-openroadm-common-service-types:connection-type;
          mandatory true;
        }

        uses org-openroadm-common-service-types:resource-status;

        container service-a-end {
          uses org-openroadm-common-service-types:service-endpoint;

          uses org-openroadm-common-service-types:service-endpoint-project;
        }  // container service-a-end

        container service-z-end {
          uses org-openroadm-common-service-types:service-endpoint;

          uses org-openroadm-common-service-types:service-endpoint-project;
        }  // container service-z-end

        uses org-openroadm-routing-constraints:routing-constraints;

        uses org-openroadm-common-service-types:service-information;

        uses org-openroadm-common-service-types:routing-metric;

        uses org-openroadm-common-service-types:service-resiliency;
      }

      output {
        uses org-openroadm-common-service-types:configuration-response-common;

        uses org-openroadm-common-service-types:response-parameters;
      }
    }  // rpc temp-service-create

    rpc temp-service-delete {
      input {
        leaf common-id {
          type string;
          mandatory true;
        }
      }

      output {
        uses org-openroadm-common-service-types:configuration-response-common;
      }
    }  // rpc temp-service-delete

    rpc service-roll {
      description
        "This rpc can be use to roll a service according to 2 possible options :
  A new path may (no path pre-calculation) or may not be calculated according
  to the parameters provided (which includes metrics). If path computation has been triggered
  and is successful, a new path is provided, and the service can be rolled according to that path.";
      input {
        leaf service-name {
          type string;
          mandatory true;
          description
            "Identifier for the service to be rolled in
the ROADM network, e.g., CLFI, CLCI, etc.";
        }

        leaf due-date {
          type yang:date-and-time;
          description
            "date and time service to be rolled";
        }

        uses org-openroadm-common-service-types:routing-metric;
      }

      output {
        uses org-openroadm-common-types:rpc-response-status;
      }
    }  // rpc service-roll

    rpc service-reconfigure {
      description
        "Whether this request passed initial validation and was accepted for processing. Once the request completes processing, a
service-rpc-result Notification shall be sent.";
      input {
        leaf service-name {
          type string;
          mandatory true;
          description
            "Existing identifier for the service to be
reconfigured in the ROADM network, e.g., CLFI, CLCI, etc.";
        }

        leaf new-service-name {
          type string;
          description
            "New identifier for the service to be
reconfigured in the ROADM network, e.g., CLFI, CLCI, etc.";
        }

        leaf common-id {
          type string;
          description
            "To be used by the ROADM controller to identify the routing
constraints received from planning application (PED).";
        }

        uses org-openroadm-common-service-types:service-order;

        leaf connection-type {
          type org-openroadm-common-service-types:connection-type;
        }

        uses org-openroadm-common-service-types:resource-status;

        container service-a-end {
          uses org-openroadm-common-service-types:service-endpoint;

          uses org-openroadm-common-service-types:service-endpoint-project;
        }  // container service-a-end

        container service-z-end {
          uses org-openroadm-common-service-types:service-endpoint;

          uses org-openroadm-common-service-types:service-endpoint-project;
        }  // container service-z-end

        uses org-openroadm-routing-constraints:routing-constraints;

        uses org-openroadm-common-service-types:service-information;

        uses org-openroadm-common-service-types:routing-metric;

        uses org-openroadm-common-service-types:service-resiliency;
      }

      output {
        uses org-openroadm-common-types:rpc-response-status;
      }
    }  // rpc service-reconfigure

    rpc service-restoration {
      description
        "Whether this request passed initial validation and was accepted for processing. Once the request completes processing, a
service-rpc-result Notification shall be sent.
This rpc can be use to reroute a service according to 2 possible options :
 	_Option1 : neither the backup-path-id nor the failure-case-id are provided, a new path shall be
    calculated according to the parameters provided (which includes metrics). If path computation
    is successful, a new path is provided, and the service is rerouted according to that path.
 	_Option2 : if a backup-path-id or a failure-case-id are provided, the service shall
    be rerouted according to the corresponding path. If path computation is triggered and successful,
    a new path is provided, and the service is rerouted according to that path.";
      input {
        leaf service-name {
          type string;
          mandatory true;
          description
            "Identifier for the service to be restored in
the ROADM network, e.g., CLFI, CLCI, etc.";
        }

        leaf option {
          type enumeration {
            enum "permanent" {
              value 1;
              description
                "A spare regen can be used to restore the
service permanently without reverting back to the
original regen";
            }
            enum "temporary" {
              value 2;
              description
                "a spare regen can be used to restore the
service temporarily.   The service needs to be reverted
back to the original regen transponder";
            }
          }
          mandatory true;
        }

        leaf backup-path-id {
          type uint8 {
            range "1..255";
          }
          description
            "When present, states that the service shall be rerouted according to a specific backup path";
        }

        leaf failure-case-id {
          type string;
          description
            "When present, states that the service shall be rerouted according to a specific backup path.
This last corresponds to the provided failure case id";
        }

        uses org-openroadm-common-service-types:routing-metric;
      }

      output {
        uses org-openroadm-common-types:rpc-response-status;
      }
    }  // rpc service-restoration

    rpc service-reversion {
      description
        "Whether this request passed initial validation and was accepted for processing. Once the request completes processing, a
service-rpc-result Notification shall be sent.";
      input {
        leaf service-name {
          type string;
          mandatory true;
          description
            "Identifier for the service to be reverted
in the ROADM network, e.g., CLFI, CLCI, etc. ";
        }

        leaf due-date {
          type yang:date-and-time;
          description
            "date and time service to be reverted";
        }
      }

      output {
        uses org-openroadm-common-types:rpc-response-status;
      }
    }  // rpc service-reversion

    rpc service-reroute {
      description
        "Whether this request was validated and processed correctly. If successful, it returns the proposed new route.
If acceptable, this request should be followed by a service-reroute-confirm to complete the reroute operation.";
      input {
        leaf service-name {
          type string;
          mandatory true;
          description
            "Identifier for the service to be re-routed in
the ROADM network, e.g., CLFI, CLCI, etc.";
        }

        uses org-openroadm-common-service-types:routing-metric;

        uses org-openroadm-common-service-types:service-resiliency;
      }

      output {
        uses org-openroadm-common-types:rpc-response-status;

        uses org-openroadm-routing-constraints:routing-constraints;
      }
    }  // rpc service-reroute

    rpc service-reroute-confirm {
      description
        "Whether this request passed initial validation and was accepted for processing. Once the request completes processing, a
service-rpc-result Notification shall be sent.";
      input {
        leaf service-name {
          type string;
          mandatory true;
          description
            "Identifier for the service to be re-routed in
the ROADM network, e.g., CLFI, CLCI, etc.";
        }

        uses org-openroadm-routing-constraints:routing-constraints;
      }

      output {
        uses org-openroadm-common-types:rpc-response-status;
      }
    }  // rpc service-reroute-confirm

    rpc network-re-optimization {
      input {
        leaf service-name {
          type string;
          description
            "Identifier for the service in the ROADM network,
e.g., CLFI, CLCI, etc. whose path is to be checked by the RNC
for re-optimization";
        }

        leaf a-end {
          type string;
          description
            "Services whose A-ends are terminated at the
specified office location are to be checked by the RNC for
re-optimization";
        }

        leaf z-end {
          type string;
          description
            "Services whose Z-ends are terminated at the
specified office location are to be checked by the RNC for
re-optimization ";
        }

        leaf pass-through {
          type string;
          description
            "Services that are pass-through (either via
regen or express) at the specified office location are to
be checked by the RNC for re-optimization";
        }

        leaf customer-code {
          type string;
          description
            "Services that belong to the specified customer
are to be checked by the RNC for re-optimization ";
        }

        uses org-openroadm-common-service-types:routing-metric;
      }

      output {
        uses org-openroadm-common-types:rpc-response-status;

        leaf optimization-candidate {
          type string;
        }
      }
    }  // rpc network-re-optimization

    notification service-rpc-result {
      description
        "This Notification indicates result of service RPC";
      leaf notification-type {
        type org-openroadm-common-service-types:service-notification-types;
      }

      uses org-openroadm-common-types:rpc-response-status;

      uses org-openroadm-common-service-types:service-notification-result;
    }  // notification service-rpc-result

    notification service-traffic-flow {
      description
        "This Notification indicates that traffic is flowing again on the service after an administrative action has completed";
      leaf service-name {
        type string;
        mandatory true;
        description
          "Identifier for the service being reported on";
      }

      leaf version-number {
        type uint64;
        description
          "Identifier for the versioned service";
      }

      leaf actual-date {
        type yang:date-and-time;
        description
          "Actual date and time traffic started flowing";
      }
    }  // notification service-traffic-flow

    notification service-notification {
      description
        "This Notification that a service has been added, modified or removed.
A resourceCreation notification shall contain the created service in its entirety.
A resourceModified notification shall contain just the modified field, plus the service identifier
A resourceDeleted notification shall just contain the service identifier";
      leaf notificationType {
        type org-openroadm-resource-types:resource-notification-type;
        description
          "Whether this notification indicates a service creation, service modification or service deletion.";
      }

      leaf version-number {
        type uint64;
        description
          "Identifier for the versioned service";
      }

      uses org-openroadm-common-service-types:service;
    }  // notification service-notification

    notification non-rpc-related-notification {
      description
        "Used to notify SDN controller that :
_a change occured in the data tree associated with the topology or the service Datastore of the RNC
_the attenuation on a ROADM to ROADM link as exceeded the value that can be accepted with current design
_the restoration of an optical OTN/WDM service";
      leaf notificationType {
        type org-openroadm-controller-customization:non-rpc-related-notification-type;
        description
          "This notification indicates whether a change occured in the data tree
associated with the topology or the service Datastore, an out of limit
attenuation on a WDM link, or the restoration of an optical WDM/OTN service.";
      }

      leaf notificationId {
        type string;
        description
          "Unique identifier for the notification.";
      }

      leaf notification-time {
        type yang:date-and-time;
        description
          "Time at which notification is raised";
      }

      leaf service-name {
        when
          "../notificationType = 'service-state-change' or ../notificationType = 'autonomous-optical-restoration-triggered'" {
          description
            "When Service Data store is modified, or a restoration has been triggered
service-name is provided";
        }
        type string;
      }

      leaf impacted-resource-type {
        when
          "../notificationType = 'topology-change' or ../notificationType = 'service-state-change'" {
          description
            "Used to provide additional information on the type of resource impacted by the
change in the data-store, to target more effectively consecutive request";
        }
        type string;
      }

      leaf impacted-resource-id {
        when
          "../notificationType = 'topology-change' or ../notificationType = 'service-state-change'" {
          description
            "Identifies the resource impacted by the change in the data-store";
        }
        type string;
      }

      leaf topology-layer {
        when
          "../notificationType = 'topology-change'" {
          description
            "indicates the layer associated with the topological change";
        }
        type enumeration {
          enum "openroadm-topology" {
            value 1;
          }
          enum "otn-topology" {
            value 2;
          }
        }
      }
    }  // notification non-rpc-related-notification

    container service-list {
      description
        "List of service. Can only be created, deleted, modified, etc. using special RPCs. Will only contain one service with a given name.
Does not contain historical (deleted or rather those passed their end time) or draft services. If two services exist with the same
name (with non-lapping start-end times for example), this table will contain the current one. If only planned services exist for
the name, the one with the earliest start time will be present
";
      list services {
        key "service-name";
        uses org-openroadm-common-service-types:service;
      }  // list services
    }  // container service-list

    container versioned-service-list {
      description
        "List of service, regardless of lifecycle state. Can only be created, deleted, modified, etc. using special RPCs. Can report more than one
version of a service, if supported by the implementation. May contain deleted services, multiple versions of the same service, as identified
by its name, etc.";
      list services {
        key "service-name version-number";
        leaf version-number {
          type uint64;
        }

        uses org-openroadm-common-service-types:service;
      }  // list services
    }  // container versioned-service-list

    container temp-service-list {
      description
        "List of temporary services Can only be created, deleted, modified, etc. using special RPCs.";
      list services {
        key "common-id";
        uses org-openroadm-common-service-types:service {
          refine service-name {
            mandatory false;
          }
        }
      }  // list services
    }  // container temp-service-list

    container controller-behaviour-settings {
      description
        "Parameters allowing to set the controller behaviour";
      uses org-openroadm-controller-customization:controller-parameters;
    }  // container controller-behaviour-settings
  }  // module org-openroadm-service

Summary

  
  
Organization Open ROADM MSA
  
Module org-openroadm-service
Version 2020-05-29
File org-openroadm-service.yang
  
Prefix org-openroadm-service
Namespace http://org/openroadm/service
  
Cooked /cookedmodules/org-openroadm-service/2020-05-29
YANG /src/org-openroadm-service@2020-05-29.yang
XSD /xsd/org-openroadm-service@2020-05-29.xsd
  
Abstract YANG definitions of services. Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016, All other rights reser...
  
Contact
OpenROADM.org

Description

 
YANG definitions of services.

 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

Groupings

Grouping Objects Abstract
service-feasibility-check-inputs connection-type resource-statusservice-a-end service-z-end hard-constraints soft-constraintsrouting-metricservice-resiliencypropose-equipment due-date end-date eventHorizonStart eventHorizonEnd nc-code nci-code secondary-nci-code customer customer-contact operator-contact service-layer clli-network-ref openroadm-network-ref openroadm-topology-ref sla-id bandwidth-calendaring bw-calendaring-parameters
service-feasibility-check-outputs response-parametersservice-a-end service-z-end intermediate-sites

Objects

Type Key
Mandatory config
Optional config
Not config
Object Type Abstract
controller-behaviour-settings container Parameters allowing to set the controller behaviour
   default-behaviour container Parameters in this container are used to define default behaviour in case optional parameters in rpc have not been defined
      default-backup-path-number leaf 0 means on the fly path calculation. Higher number corresponds to backup path pre-calculation, and states the number of paths to be calculated
      holdoff-time leaf time delay to initiate a protection or restoration event
      reversion leaf Concerns reversion for service that have a resiliency defined as restorable (restoration handled autonomously by the controller at the WDM/OTN layer)
      wait-to-restore leaf time delay to revert to initial path after conditions for reversion are satisfied
   failure-case-list container Use to provide information on failure cases associated with backup-path pre-calculation: If PCE supports the calculation of multiple backup-paths, these might be identified through a failure case-id corresponding to a node, physical-link or logical-link f...
      failure-case list Describes and identifies different failure-cases. Each of them can be associated with one or several backup-paths in the context of backup-path pre-calculation
         failure-case-id leaf Identifies a failure case
         failure-type leaf describes failure type that can be simulated in a planner or by a PCE to calculate a backup path
         logical-links leaf-list logical links as they appear in the otn-topology layer
         nodes leaf-list Nodes as they appear in the openroadm-topology or otn-topology layer
         physical-links leaf-list physical-links as they appear in the openroadm-topology layer
   margins container defines all margins operator may want to specify
      minimum-fiber-attenuation-bol-margin leaf Minimum fiber-attenuation margin to be considered for path calculation at begining of life. The path calculation shall be made considering on each link the engineered-spanloss (provided by an external sytem) _The RNC shall raise an ALARM to the northbound...
      minimum-osnr-margins list osnr margins to be considered may differ according to the rate and the modulation format
         line-rates leaf-list Line-rates to which the osnr-margin applies
         margin-id leaf defines a margin for specific line-rates and modulation formats
         minimum-osnr-margin-value leaf Minimum OSNR margin to be considered to keep an acceptable OSNR value at end of life for the associated line-rates and modulation-formats
         modulation-formats leaf-list Modulation-formats to which the osnr-margin applies
      threshold-observed-vs-design-attenuation leaf Defines the threshold used to raise an alarm when fiber initial attenuation is too close to the engineered-spanloss, meaning the value accounted for the design has been underestimated and a new design shall triggered.
      threshold-observed-vs-design-margin leaf Defines the threshold used to raise a warning when fiber measured attenuation comes too close to the engineered-spanloss, so that remaining margin is considered as too limited.
   metrics-policy container Defines how the RNC shall interpret the routing-metrics
      composite-metric-versus-selective leaf Defines the way the RNC shall interpret the priorities defined for the metrics: _ True corresponds to a weighted composite metric, _ False corresponds to a selective priority based metric
   non-rpc-related-notification-settings container Defines url, notification-type and type of events that shall / shall not trigger notifications
      non-rpc-related-notification-url-list list Used to record url to be used when forwarding non rpc related notifications.
         events-disabling-notification leaf-list List of events for which notifications to SDN-Controller are not desirabled. The filtering is currently activated only on topological changes which could lead to large volumes of data.
         events-triggering-notification leaf-list List of events for which notifications to SDN-Controller are desirabled. Has the priority with regards to events-disabling-notification. As an example if events-disabling-notification is set to all, events set in events-triggering-notification will be the...
         non-rpc-related-notification-type leaf Type of notification will trigger specific leaves.
         notification-url leaf Defines the url the notification is sent to.
   regeneration-policy container Defines rules to place regenerators when a service-feasibility-check rpc is invoked, or when a service-create rpc is invoked if spare regenerators are already in place
      forbidden-sites leaf-list Node-id of the sites regenerators shall not be placed
      global-placement leaf To priviledge the positioning in specific locations
      on-path-positioning leaf To position regenerators as far as possible on the path or optimizing performances
      path-symmetry leaf True corresponds to same location on A to Z and Z to A paths False allows positioning regenerators in different nodes for A to Z and Z to A paths
      preferred-sites leaf-list Node-id of the sites to be privileged when positioning regenerators in specific locations
   sla-definition container Definition of Service Level Agreements parameters
      sla-parameters list Defines several SLA profiles and associated expected behaviour
         preemption leaf False : service shall never be preempted True : preemption of the service is allowed
         restoration-priority leaf The service shall be restored according to the defined priority (First:1, latest:255). Services with highest priority will be restored first
         sla-id leaf sla-id as defined by the operator
   spectrum-filling container Spectrum may be filled according to specific rules to limit partitionning or to dedicate part of the spectrum to some specific clients (customer-code)
      spectrum-filling-rules list Defines a set of rules used to fill the spectrum
         priority leaf The rules shall be applied sequentially according to their defined priority (Highest:1, lowest:255). Rules with highest priority will be applied first
         RMSA-policy leaf Defines the Routing, Spectrum & Mode assignment policy to be applied
         rule-id leaf defines the rule identifier
         spectrum-range-of-appliance container Defines, when needed, the spectrum range to which the rule applies
            dedicated-customer leaf-list Applies only to spectrum-portion (both start and stop edge frequencies defined), when the spectrum-portion is dedicated to some customers. This list shall includes customer-codes identifying specific customers. No customer out of this list can share the b...
            dedicated-signal-bandwidth-multiple leaf Used for spectrum partitioning to reduce fragmentation. Defines the width of the service to be provisioned in the spectrum portion. As an example a spectrum portion can be dedicated to signals with a 50 GHz multiple spectral occupation, whereas another po...
            non-authorized-customer leaf-list Applies only to spectrum-portion (both start and stop edge frequencies defined), when the spectrum-portion is dedicated to some customers. This list shall includes customer-codes identifying specific customers, that are not allowed to share the bandwidth ...
            spectrum-portion-id leaf Identifies a spectrum portion with specific characteristics.
            start-edge-frequency leaf If present, this parameter states the lowest frequency to start filling the spectrum, or a spectrum portion if stop-bandwidth is also defined.
            stop-edge-frequency leaf If present and associated with a start frequency, this parameter states the upper frequency broundary to fill the spectrum portion. If present, in the absence of a start frequency, this parameter states the highest frequency to start filling the spectrum.
service-list container List of service. Can only be created, deleted, modified, etc. using special RPCs. Will only contain one service with a given name. Does not contain historical (deleted or rather those passed their end time) or draft services. If two services exist with th...
   services list service-name common-id order-id order-note sdnc-request-header service-resiliency routing-metric connection-type lifecycle-state resource-status administrative-state operational-state condition service-a-end service-z-end hard-constraints soft-constraints due-date end-date eventHorizonStart eventHorizonEnd nc-code nci-code secondary-nci-code customer customer-contact operator-contact service-layer clli-network-ref openroadm-network-ref openroadm-topology-ref sla-id bandwidth-calendaring bw-calendaring-parameters latency fiber-span-srlgs equipment-srgs supporting-service-name current-active-path-id topology backup-topology network-topology network-backup-topology is-bandwidth-locked
      administrative-state leaf Administrative State: Intended state of service
      backup-topology container backup-path
         backup-path list backup-path-id failure-case-id aToZ zToA
            aToZ list id hop-type device resource resourceType
               device container Device of the resource, used only when the system using this model report on more than one device.
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               hop-type leaf OID: /service-list/services/backup-topology/backup-path/aToZ/hop-type
               id leaf Unique identifier for this topology component within this service
               resource container resource
                  resource choice circuit-pack port connection physical-link internal-link shelf srg degree service interface odu-sncp-pg other device line-amplifier xponder versioned-service temp-service
                     circuit-pack case circuit-pack-name
                        circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     connection case connection-name
                        connection-name leaf Connection name. Unique within the context of a device. Same as leafref value in model, if applicable.
                     degree case degree-number
                        degree-number leaf Degree identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     device case node-id
                        node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
                     interface case interface-name type ethernet mc-ttp nmc-ctp och odu otu
                        ethernet container Ethernet Interfaces
                           speed leaf Set speed of the interface, unit mbps. This is for ETH facility.
                        interface-name leaf Interface identifier.
                        mc-ttp container Media Channel Trail Termination Point (MC-TTP)
                           max-freq leaf Maximum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                           min-freq leaf Minimum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                        nmc-ctp container Network Media Channel Connection Termination Point (NMC-CTP)
                           frequency leaf Center Frequency in THz. This is not constrained by mc-capabilities. It must fit (when combined with width) inside any containing media channel.
                           width leaf Frequency width in GHz. This is not constrained by mc-capabilities. It must fit (when combined with frequency) inside any containing media channel.
                        och container Optical Channel (OCh): Models the optical channel interfaces for an Optical White Box.
                           frequency leaf Center Frequency in THz.
                           modulation-format leaf Modulation format
                           rate leaf rate
                           width leaf Frequency width in GHz.
                        odu container Optical Channel Data Unit (ODU)
                           parent-odu-allocation container parent odu allocation
                              trib-port-number leaf Assigned tributary port number in parent OPU
                              trib-slots leaf-list Assigned trib slots occupied in parent OPU MSI
                           rate leaf rate identity of the ODU. 'identityref' is used to allow to extend for future higher rates
                        otu container Optical Channel Transport Unit (OTU)
                           rate leaf rate identity of the OTU. 'identityref' is used to allow to extend for future higher rates
                        type leaf The type of the interface.
                     internal-link case internal-link-name
                        internal-link-name leaf Internal Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     line-amplifier case amp-number
                        amp-number leaf number of the line-amplifier
                     odu-sncp-pg case odu-sncp-pg-name
                        odu-sncp-pg-name leaf name of the odu-snc-pg
                     other case other-resource-id
                        other-resource-id leaf resource-id for other.
                     physical-link case physical-link-name
                        physical-link-name leaf Physical Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     port case port
                        port container circuit-pack-name port-name
                           circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                           port-name leaf Port identifier. Unique within the context of a circuit-pack. Same as leafref value in model, if applicable.
                     service case service-name
                        service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                     shelf case shelf-name
                        shelf-name leaf Shelf-id identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     srg case srg-number
                        srg-number leaf Shared Risk Group identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     temp-service case common-id
                        common-id leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                     versioned-service case versioned-service-name version-number
                        version-number leaf version-number of the service
                        versioned-service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                     xponder case xpdr-number
                        xpdr-number leaf number of the xponder
               resourceType container type extension
                  extension leaf OID: /service-list/services/backup-topology/backup-path/aToZ/resourceType/extension
                  type leaf OID: /service-list/services/backup-topology/backup-path/aToZ/resourceType/type
            backup-path-id leaf Several backup paths may be used when backup-paths are pre-calculated. Backup-path-id avoids 0 which is associated with working path in current-active-path
            failure-case-id leaf A failure case Id can be used to associate a backup-path to a specific failure (srlg, OMS,...)
            zToA list id hop-type device resource resourceType
               device container Device of the resource, used only when the system using this model report on more than one device.
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               hop-type leaf OID: /service-list/services/backup-topology/backup-path/zToA/hop-type
               id leaf Unique identifier for this topology component within this service
               resource container resource
                  resource choice circuit-pack port connection physical-link internal-link shelf srg degree service interface odu-sncp-pg other device line-amplifier xponder versioned-service temp-service
                     circuit-pack case circuit-pack-name
                        circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     connection case connection-name
                        connection-name leaf Connection name. Unique within the context of a device. Same as leafref value in model, if applicable.
                     degree case degree-number
                        degree-number leaf Degree identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     device case node-id
                        node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
                     interface case interface-name type ethernet mc-ttp nmc-ctp och odu otu
                        ethernet container Ethernet Interfaces
                           speed leaf Set speed of the interface, unit mbps. This is for ETH facility.
                        interface-name leaf Interface identifier.
                        mc-ttp container Media Channel Trail Termination Point (MC-TTP)
                           max-freq leaf Maximum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                           min-freq leaf Minimum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                        nmc-ctp container Network Media Channel Connection Termination Point (NMC-CTP)
                           frequency leaf Center Frequency in THz. This is not constrained by mc-capabilities. It must fit (when combined with width) inside any containing media channel.
                           width leaf Frequency width in GHz. This is not constrained by mc-capabilities. It must fit (when combined with frequency) inside any containing media channel.
                        och container Optical Channel (OCh): Models the optical channel interfaces for an Optical White Box.
                           frequency leaf Center Frequency in THz.
                           modulation-format leaf Modulation format
                           rate leaf rate
                           width leaf Frequency width in GHz.
                        odu container Optical Channel Data Unit (ODU)
                           parent-odu-allocation container parent odu allocation
                              trib-port-number leaf Assigned tributary port number in parent OPU
                              trib-slots leaf-list Assigned trib slots occupied in parent OPU MSI
                           rate leaf rate identity of the ODU. 'identityref' is used to allow to extend for future higher rates
                        otu container Optical Channel Transport Unit (OTU)
                           rate leaf rate identity of the OTU. 'identityref' is used to allow to extend for future higher rates
                        type leaf The type of the interface.
                     internal-link case internal-link-name
                        internal-link-name leaf Internal Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     line-amplifier case amp-number
                        amp-number leaf number of the line-amplifier
                     odu-sncp-pg case odu-sncp-pg-name
                        odu-sncp-pg-name leaf name of the odu-snc-pg
                     other case other-resource-id
                        other-resource-id leaf resource-id for other.
                     physical-link case physical-link-name
                        physical-link-name leaf Physical Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     port case port
                        port container circuit-pack-name port-name
                           circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                           port-name leaf Port identifier. Unique within the context of a circuit-pack. Same as leafref value in model, if applicable.
                     service case service-name
                        service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                     shelf case shelf-name
                        shelf-name leaf Shelf-id identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     srg case srg-number
                        srg-number leaf Shared Risk Group identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     temp-service case common-id
                        common-id leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                     versioned-service case versioned-service-name version-number
                        version-number leaf version-number of the service
                        versioned-service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                     xponder case xpdr-number
                        xpdr-number leaf number of the xponder
               resourceType container type extension
                  extension leaf OID: /service-list/services/backup-topology/backup-path/zToA/resourceType/extension
                  type leaf OID: /service-list/services/backup-topology/backup-path/zToA/resourceType/type
      bandwidth-calendaring leaf True if service is active only during a specific time period
      bw-calendaring-parameters container bw-calendaring-coupled-services recurrence-pattern
         bw-calendaring-coupled-services list service-index service-name common-id version-number
            common-id leaf common-id of the service that may be associated to the considered service in temp-service-list
            service-index leaf service-number of the service that may be associated to the considered service
            service-name leaf service-name of the service that may be associated to the considered service in service-list
            version-number leaf common-id of the service that may be associated to the considered service in versioned-service-list
         recurrence-pattern list recurrence-id day-of-the-week start-time end-time
            day-of-the-week leaf-list Each day for which the service is active from stat-time to end-time
            end-time leaf end time expressed as hour:min:seconds
            recurrence-id leaf id of the pattern defining the time during which the service is active
            start-time leaf start time expressed as hour:min:seconds
      clli-network-ref leaf Assumption: a service would not span multiple clli-network layers. Reference to the network-id of the clli-network layer.
      common-id leaf To be used by the ROADM controller to identify the routing constraints received from planning application (PED).
      condition leaf Service Condition: Additional information about the state of the service. Only sent when applicable.
      connection-type leaf Connection type
      current-active-path-id leaf defines the current active path : '0' if active path is the working path id of the active backup path if protection or restoration has been triggered
      customer leaf To be included in ticket information. This is reported against the service, but may not get reflected in the service in the network.
      customer-contact leaf Customer contact information to be included in ticket information. This is reported against the service, but may not get reflected in the service in the network.
      due-date leaf Date and time service to be turn up. If time is not specified for a given date, default to midnight. Service turned up immediately if no due date is specified
      end-date leaf Date and time service to be removed
      equipment-srgs list srg-number
         srg-number leaf Shared Risk Group identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
      eventHorizonEnd leaf End time to ensure that the service is routable and viable. Required resources shall be considered reserved until this time. If not provided, defaults to end-date.
      eventHorizonStart leaf Start time to ensure that the service is routable and viable. Required resources shall be considered reserved from this time. If not provided, defaults to due-date.
      fiber-span-srlgs leaf-list Shared risk link group identifiers
      hard-constraints container customer-code co-routing-or-general
         co-routing-or-general choice general co-routing
            co-routing case co-routing
               co-routing container existing-service
                  existing-service leaf-list Diverse from existing services identified by facility CLFI
            general case diversity exclude include latency hop-count TE-metric distance
               distance container Maximum distance allowed
                  max-distance leaf OID: /service-list/services/hard-constraints/co-routing-or-general/general/distance/max-distance
               diversity container existing-service existing-service-applicability
                  existing-service leaf-list Diverse from existing services identified by facility CLFI
                  existing-service-applicability container site node srlg link equipment
                     equipment container Equipment Diversity Contraints
                        roadm-srg leaf ROADM shared-risk-group diversity
                        xponder-srg leaf xponder eqpt-srg-id diversity
                     link leaf OID: /service-list/services/hard-constraints/co-routing-or-general/general/diversity/existing-service-applicability/link
                     node leaf OID: /service-list/services/hard-constraints/co-routing-or-general/general/diversity/existing-service-applicability/node
                     site leaf OID: /service-list/services/hard-constraints/co-routing-or-general/general/diversity/existing-service-applicability/site
                     srlg leaf OID: /service-list/services/hard-constraints/co-routing-or-general/general/diversity/existing-service-applicability/srlg
               exclude container fiber-bundle srlg-id site node-id link-identifier supporting-service-name
                  fiber-bundle leaf-list OID: /service-list/services/hard-constraints/co-routing-or-general/general/exclude/fiber-bundle
                  link-identifier list Refers to link-id(s) from the network model. The openroadm-topology-ref + link-id identifies the link in the network model.
                     link-id leaf link-id from the network model.
                     link-network-id leaf network-id from the network model.
                  node-id leaf-list node-id from the device model; openroadm-network-ref + node-id from the network model.
                  site leaf-list site identifies the clli. clli from the device model; clli-network-ref + clli from the network model.
                  srlg-id leaf-list unique identifier for SRLG
                  supporting-service-name leaf-list Supporting service(s) to exclude from this route.
               hop-count container Maximum hops allowed
                  max-otn-hop-count leaf OID: /service-list/services/hard-constraints/co-routing-or-general/general/hop-count/max-otn-hop-count
                  max-wdm-hop-count leaf OID: /service-list/services/hard-constraints/co-routing-or-general/general/hop-count/max-wdm-hop-count
               include container fiber-bundle srlg-id site node-id link-identifier supporting-service-name
                  fiber-bundle leaf-list OID: /service-list/services/hard-constraints/co-routing-or-general/general/include/fiber-bundle
                  link-identifier list Refers to link-id(s) from the network model. The openroadm-topology-ref + link-id identifies the link in the network model.
                     link-id leaf link-id from the network model.
                     link-network-id leaf network-id from the network model.
                  node-id leaf-list node-id from the device model; openroadm-network-ref + node-id from the network model.
                  site leaf-list site identifies the clli. clli from the device model; clli-network-ref + clli from the network model.
                  srlg-id leaf-list unique identifier for SRLG
                  supporting-service-name leaf-list Supporting service(s) to include in this route.
               latency container Maximum latency allowed
                  max-latency leaf OID: /service-list/services/hard-constraints/co-routing-or-general/general/latency/max-latency
               TE-metric container Maximum cost allowed
                  max-otn-TE-metric leaf OID: /service-list/services/hard-constraints/co-routing-or-general/general/TE-metric/max-otn-TE-metric
                  max-wdm-TE-metric leaf OID: /service-list/services/hard-constraints/co-routing-or-general/general/TE-metric/max-wdm-TE-metric
         customer-code leaf-list OID: /service-list/services/hard-constraints/customer-code
      is-bandwidth-locked leaf Bandwidth lock (true, false) indicates whether the service is administratively prohibited from taking on more capacity - ie whether it can be used as a supporting service in any new service creations. Unlike administrative status, this does not impact any...
      latency leaf Latency on service
      lifecycle-state leaf Lifecycle State of service. Whether it is planned, deployed, in maintenance, etc.
      nc-code leaf NC code applied to wavelength service only. This is reported against the service, but may not get reflected in the service in the network.
      nci-code leaf NCI code applied to wavelength service only. This is reported against the service, but may not get reflected in the service in the network.
      network-backup-topology container backup-path
         backup-path list backup-path-id failure-case-id a-to-z z-to-a
            a-to-z list id network-resource network-resource-type
               id leaf Unique identifier for this network-topology component within this service
               network-resource container network-resource
               network-resource-type leaf OID: /service-list/services/network-backup-topology/backup-path/a-to-z/network-resource-type
                  network-resource choice network-resource-tp network-resource-link
                     network-resource-link case link-network-id link-id
                        link-id leaf link-id from the network model.
                        link-network-id leaf network-id from the network model.
                     network-resource-tp case tp-network-id tp-node-id tp-id
                        tp-id leaf tp-id from the network model.
                        tp-network-id leaf network-id from the network model.
                        tp-node-id leaf node-id from the network model.
            backup-path-id leaf Several backup paths may be used when backup-paths are pre-calculated. Backup-path-id avoids 0 which is associated with working path in current-active-path
            failure-case-id leaf A failure case Id can be used to associate a backup-path to a specific failure (srlg, OMS,...)
            z-to-a list id network-resource network-resource-type
               id leaf Unigue identifier for this network-topology component within this service
               network-resource container network-resource
               network-resource-type leaf OID: /service-list/services/network-backup-topology/backup-path/z-to-a/network-resource-type
                  network-resource choice network-resource-tp network-resource-link
                     network-resource-link case link-network-id link-id
                        link-id leaf link-id from the network model.
                        link-network-id leaf network-id from the network model.
                     network-resource-tp case tp-network-id tp-node-id tp-id
                        tp-id leaf tp-id from the network model.
                        tp-network-id leaf network-id from the network model.
                        tp-node-id leaf node-id from the network model.
      network-topology container a-to-z z-to-a
         a-to-z list id network-resource network-resource-type
            id leaf Unique identifier for this network-topology component within this service
            network-resource container network-resource
            network-resource-type leaf OID: /service-list/services/network-topology/a-to-z/network-resource-type
               network-resource choice network-resource-tp network-resource-link
                  network-resource-link case link-network-id link-id
                     link-id leaf link-id from the network model.
                     link-network-id leaf network-id from the network model.
                  network-resource-tp case tp-network-id tp-node-id tp-id
                     tp-id leaf tp-id from the network model.
                     tp-network-id leaf network-id from the network model.
                     tp-node-id leaf node-id from the network model.
         z-to-a list id network-resource network-resource-type
            id leaf Unigue identifier for this network-topology component within this service
            network-resource container network-resource
            network-resource-type leaf OID: /service-list/services/network-topology/z-to-a/network-resource-type
               network-resource choice network-resource-tp network-resource-link
                  network-resource-link case link-network-id link-id
                     link-id leaf link-id from the network model.
                     link-network-id leaf network-id from the network model.
                  network-resource-tp case tp-network-id tp-node-id tp-id
                     tp-id leaf tp-id from the network model.
                     tp-network-id leaf network-id from the network model.
                     tp-node-id leaf node-id from the network model.
      openroadm-network-ref leaf Assumption: a service would not span multiple openroadm-network layers. Reference to the network-id of the openroadm-network layer.
      openroadm-topology-ref leaf Assumption: a service would not span multiple topology layers. Reference to the network-id of either the openroadm-topology or the otn-topology layer depending upon service-layer (wdm or otn).
      operational-state leaf Operational State: Actual state of service
      operator-contact leaf Operator contact information to be included in ticket information. This is reported against the service, but may not get reflected in the service in the network.
      order-id leaf Order identifier for this service
      order-note leaf Additional details associated with the service order
      resource-status leaf identifies the state of network resources required to complete a service request.
      routing-metric container Describes the metrics used to route a service. All parameters of integer type, to set the priority of the routing criterion '0' means the criterion is not used, '1'coresponds to the highest priority, '255'coresponds to the lowest priority. Priority might ...
         adaptation-number leaf Metric associated with the adaptation between layers. Total path metric can can be calculated from the total number of transition between layers
         distance leaf Metric associated with the distance. Total path distance can be calculated from SRLG length of the OMS
         latency leaf Metric corresponding to the latency. Total path latency can be calculated from SRLG length of the OMS and the latency introduced by the equipment
         otn-hop-count leaf Metric corresponding to the number of hop in the otn layer
         otn-load leaf Metric corresponding to the load of the otn layer. Can be used to avoid using heavy loaded links/switchs
         otn-TE-metric leaf Used when routing shall be performed according to specific pre-defined metric associated with OTN (OTU/ODU level)
         wdm-hop-count leaf Metric corresponding to the number of hop in the wdm layer
         wdm-load leaf Metric corresponding to the load of the wdm layer Can be used to avoid using heavy loaded links
         wdm-TE-metric leaf Used when routing shall be performed according to specific pre-defined TE-Metric. Total path metric can be calculated from OMS TE-metric attribute defined in org-openroadm-link module
      sdnc-request-header container request-id rpc-action notification-url request-system-id
         notification-url leaf OID: /service-list/services/sdnc-request-header/notification-url
         request-id leaf OID: /service-list/services/sdnc-request-header/request-id
         request-system-id leaf OID: /service-list/services/sdnc-request-header/request-system-id
         rpc-action leaf OID: /service-list/services/sdnc-request-header/rpc-action
      secondary-nci-code leaf NC code applied to wavelength service only. This is reported against the service, but may not get reflected in the service in the network.
      service-a-end container service-format service-rate other-service-format-and-rate otu-service-rate odu-service-rate ethernet-encoding mapping-mode otn-attributes clli node-id tx-direction rx-direction optic-type router user-label ethernet-attributes project-id project-note
         clli leaf CLLI. Note this CLLI must match the site associated with the device-id of this endpoint
         ethernet-attributes container fec subrate-eth-sla
            fec leaf FEC / Forward Error Correction
            subrate-eth-sla container SLA (Service Level Agreement) for subrate Ethernet
               committed-burst-size leaf Committed Burst Size, unit in 1KB (K Byte). Range 16 | 32 | 64 | 128 | 512 | 1024. Default: 16
               committed-info-rate leaf Committed Information Rate (CIR), unit in Mbps. For example, 1250 Mbps
         ethernet-encoding leaf Ethernet encoding type
         mapping-mode leaf Mapping mode.
         node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
         odu-service-rate leaf ODU Rate of the requested service
         optic-type leaf OID: /service-list/services/service-a-end/optic-type
         other-service-format-and-rate leaf Used when service-format is set to other in the bookend xponder use case. The use of other-service-format-and-rate is not standardized in the Open ROADM MSA and intended to allow the controller to support non-Open ROADM service formats. This value encodes...
         otn-attributes container parent-odu-allocation fec tx-sapi tx-dapi tx-operator expected-sapi expected-dapi tim-act-enabled tim-detect-mode degm-intervals degthr-percentage reserved-tcm-layer tcm
            degm-intervals leaf G.806 - Consecutive bad intervals required for declare dDEG
            degthr-percentage leaf Percentage of errored blocks required to declare an interval bad, in units of 0.01%
            expected-dapi leaf The provisioned expected DAPI, to be compared with accepted TTI
            expected-sapi leaf The provisioned expected SAPI, to be compared with accepted TTI
            fec leaf FEC / Forward Error Correction
            parent-odu-allocation container parent odu allocation
               trib-port-number leaf Assigned tributary port number in parent OPU
               trib-slots-choice choice trib slot selection
                  opu case trib-slots
                     trib-slots leaf-list Assigned trib slots occupied in parent OPU MSI
                  opucn case opucn-trib-slots
                     opucn-trib-slots leaf-list Specify the list of OPUCn 5G tributary slots in the form of TS #A.B (G.709 Figure 20-9) in the case of provisioning the low order ODUk to the parent server ODUCn
            reserved-tcm-layer leaf-list OID: /service-list/services/service-a-end/otn-attributes/reserved-tcm-layer
            tcm list Tandem Connection Management
               degm-intervals leaf G.806 - Consecutive bad intervals required for declare dDEG
               degthr-percentage leaf Percentage of errored blocks required to declare an interval bad, in units of 0.01%
               expected-dapi leaf The provisioned expected DAPI, to be compared with accepted TTI
               expected-sapi leaf The provisioned expected SAPI, to be compared with accepted TTI
               layer leaf TCM layer
               ltc-act-enabled leaf enable/disable alarm transfer on detection of Loss of Tandem Connection (LTC)
               monitoring-mode leaf Monitoring mode of the TCM layer
               proactive-delay-measurement-enabled leaf enable/disable proactive Delay Measurement for TCM
               tcm-direction leaf Direction of TCM.
               tim-act-enabled leaf Enables TTI Mismatch consequent actions.
               tim-detect-mode leaf tim detect mode leaf
               tx-dapi leaf The provisioned 15 character transmit trace DAPI. Implementations shall add the [0] field automatically per ITU-T G.709
               tx-operator leaf The provisioned 32 character Operator Specific field
               tx-sapi leaf The provisioned 15 character transmit trace SAPI. Implementations shall add the [0] field automatically per ITU-T G.709
            tim-act-enabled leaf Enables TTI Mismatch consequent actions.
            tim-detect-mode leaf tim detect mode leaf
            tx-dapi leaf The provisioned 15 character transmit trace DAPI. Implementations shall add the [0] field automatically per ITU-T G.709
            tx-operator leaf The provisioned 32 character Operator Specific field
            tx-sapi leaf The provisioned 15 character transmit trace SAPI. Implementations shall add the [0] field automatically per ITU-T G.709
         otu-service-rate leaf OTU Rate of the requested service
         project-id leaf Project identifier for the service end point
         project-note leaf Additional details associated with the service end point project
         router container Needed for communication with DWDM pluggable
            ip-address leaf Router IP Address. This is reported against the service, but may not get reflected in the service in the network.
            node-id leaf Node id. This is reported against the service, but may not get reflected in the service in the network.
            url leaf URL needed for communication with DWDM pluggable. This is reported against the service, but may not get reflected in the service in the network.
         rx-direction container port lgx tail
            lgx container lgx-device-name lgx-port-name lgx-port-rack lgx-port-shelf
               lgx-device-name leaf OID: /service-list/services/service-a-end/rx-direction/lgx/lgx-device-name
               lgx-port-name leaf OID: /service-list/services/service-a-end/rx-direction/lgx/lgx-port-name
               lgx-port-rack leaf OID: /service-list/services/service-a-end/rx-direction/lgx/lgx-port-rack
               lgx-port-shelf leaf OID: /service-list/services/service-a-end/rx-direction/lgx/lgx-port-shelf
            port container From the device model perspective the port-device-name plus the port-circuit-pack-name plus the port-name uniquely identifies the port. From the network model perspective the openroadm-topology-ref plus port-device-name plus port-name uniquely identify th...
               port-circuit-pack-name leaf OID: /service-list/services/service-a-end/rx-direction/port/port-circuit-pack-name
               port-device-name leaf OID: /service-list/services/service-a-end/rx-direction/port/port-device-name
               port-name leaf OID: /service-list/services/service-a-end/rx-direction/port/port-name
               port-rack leaf OID: /service-list/services/service-a-end/rx-direction/port/port-rack
               port-shelf leaf OID: /service-list/services/service-a-end/rx-direction/port/port-shelf
               port-slot leaf OID: /service-list/services/service-a-end/rx-direction/port/port-slot
               port-sub-slot leaf OID: /service-list/services/service-a-end/rx-direction/port/port-sub-slot
               port-type leaf OID: /service-list/services/service-a-end/rx-direction/port/port-type
            tail container tail-roadm xponder-port tail-roadm-port-aid tail-roadm-port-rack-location
               tail-roadm container ROADM on which the transponder is connected to (TID, IP Address, or FQDN)
               tail-roadm-port-aid leaf This will provide the transponder port needed to inter-city ROADM connection
               tail-roadm-port-rack-location leaf Transponder's location
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               xponder-port container Muxponder port used in tail, that will get used as a service endpoint.
                  circuit-pack-name leaf OID: /service-list/services/service-a-end/rx-direction/tail/xponder-port/circuit-pack-name
                  port-name leaf OID: /service-list/services/service-a-end/rx-direction/tail/xponder-port/port-name
         service-format leaf Format of the requested service: Ethernet, OTU, etc.
         service-rate leaf Rate of the requested service in GBps
         tx-direction container port lgx tail
            lgx container lgx-device-name lgx-port-name lgx-port-rack lgx-port-shelf
               lgx-device-name leaf OID: /service-list/services/service-a-end/tx-direction/lgx/lgx-device-name
               lgx-port-name leaf OID: /service-list/services/service-a-end/tx-direction/lgx/lgx-port-name
               lgx-port-rack leaf OID: /service-list/services/service-a-end/tx-direction/lgx/lgx-port-rack
               lgx-port-shelf leaf OID: /service-list/services/service-a-end/tx-direction/lgx/lgx-port-shelf
            port container From the device model perspective the port-device-name plus the port-circuit-pack-name plus the port-name uniquely identifies the port. From the network model perspective the openroadm-topology-ref plus port-device-name plus port-name uniquely identify th...
               port-circuit-pack-name leaf OID: /service-list/services/service-a-end/tx-direction/port/port-circuit-pack-name
               port-device-name leaf OID: /service-list/services/service-a-end/tx-direction/port/port-device-name
               port-name leaf OID: /service-list/services/service-a-end/tx-direction/port/port-name
               port-rack leaf OID: /service-list/services/service-a-end/tx-direction/port/port-rack
               port-shelf leaf OID: /service-list/services/service-a-end/tx-direction/port/port-shelf
               port-slot leaf OID: /service-list/services/service-a-end/tx-direction/port/port-slot
               port-sub-slot leaf OID: /service-list/services/service-a-end/tx-direction/port/port-sub-slot
               port-type leaf OID: /service-list/services/service-a-end/tx-direction/port/port-type
            tail container tail-roadm xponder-port tail-roadm-port-aid tail-roadm-port-rack-location
               tail-roadm container ROADM on which the transponder is connected to (TID, IP Address, or FQDN)
               tail-roadm-port-aid leaf This will provide the transponder port needed to inter-city ROADM connection
               tail-roadm-port-rack-location leaf Transponder's location
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               xponder-port container Muxponder port used in tail, that will get used as a service endpoint.
                  circuit-pack-name leaf OID: /service-list/services/service-a-end/tx-direction/tail/xponder-port/circuit-pack-name
                  port-name leaf OID: /service-list/services/service-a-end/tx-direction/tail/xponder-port/port-name
         user-label leaf Label for service endpoint, defined by the user
      service-layer leaf Layer associated with service (e.g. wdm or otn)
      service-name leaf Identifier for the service to be created in the ROADM network, e.g., CLFI, CLCI, etc.
      service-resiliency container resiliency revertive wait-to-restore holdoff-time pre-calculated-backup-path-number coupled-service
         coupled-service container coupled-services
            coupled-services list service-index service-name common-id version-number
               common-id leaf common-id of the service that may be routed disjointly to the considered service in temp-service-list
               service-index leaf service-number of the service that may be routed disjointly to the considered service
               service-name leaf service-name of the service that may be routed disjointly to the considered service in service-list
               version-number leaf common-id of the service that may be routed disjointly to the considered service in versioned-service-list
         holdoff-time leaf time delay to initiate a protection or restoration event
         pre-calculated-backup-path-number leaf Associated to service-create / reconfigure / feasibility-check rpcs --> defines the target number of backup-paths to be calculated by PCE. This is an optional parameter : operator can provide it to conform with specific engineering rules. If not provided,...
         resiliency leaf describes the type of resiliency and the associated layer
         revertive leaf defines if the service shall revert to the initial working path after protection or restoration has been triggered and fault condition has disappeared
         wait-to-restore leaf time delay to revert to initial path after conditions for reversion are satisfied
      service-z-end container service-format service-rate other-service-format-and-rate otu-service-rate odu-service-rate ethernet-encoding mapping-mode otn-attributes clli node-id tx-direction rx-direction optic-type router user-label ethernet-attributes project-id project-note
         clli leaf CLLI. Note this CLLI must match the site associated with the device-id of this endpoint
         ethernet-attributes container fec subrate-eth-sla
            fec leaf FEC / Forward Error Correction
            subrate-eth-sla container SLA (Service Level Agreement) for subrate Ethernet
               committed-burst-size leaf Committed Burst Size, unit in 1KB (K Byte). Range 16 | 32 | 64 | 128 | 512 | 1024. Default: 16
               committed-info-rate leaf Committed Information Rate (CIR), unit in Mbps. For example, 1250 Mbps
         ethernet-encoding leaf Ethernet encoding type
         mapping-mode leaf Mapping mode.
         node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
         odu-service-rate leaf ODU Rate of the requested service
         optic-type leaf OID: /service-list/services/service-z-end/optic-type
         other-service-format-and-rate leaf Used when service-format is set to other in the bookend xponder use case. The use of other-service-format-and-rate is not standardized in the Open ROADM MSA and intended to allow the controller to support non-Open ROADM service formats. This value encodes...
         otn-attributes container parent-odu-allocation fec tx-sapi tx-dapi tx-operator expected-sapi expected-dapi tim-act-enabled tim-detect-mode degm-intervals degthr-percentage reserved-tcm-layer tcm
            degm-intervals leaf G.806 - Consecutive bad intervals required for declare dDEG
            degthr-percentage leaf Percentage of errored blocks required to declare an interval bad, in units of 0.01%
            expected-dapi leaf The provisioned expected DAPI, to be compared with accepted TTI
            expected-sapi leaf The provisioned expected SAPI, to be compared with accepted TTI
            fec leaf FEC / Forward Error Correction
            parent-odu-allocation container parent odu allocation
               trib-port-number leaf Assigned tributary port number in parent OPU
               trib-slots-choice choice trib slot selection
                  opu case trib-slots
                     trib-slots leaf-list Assigned trib slots occupied in parent OPU MSI
                  opucn case opucn-trib-slots
                     opucn-trib-slots leaf-list Specify the list of OPUCn 5G tributary slots in the form of TS #A.B (G.709 Figure 20-9) in the case of provisioning the low order ODUk to the parent server ODUCn
            reserved-tcm-layer leaf-list OID: /service-list/services/service-z-end/otn-attributes/reserved-tcm-layer
            tcm list Tandem Connection Management
               degm-intervals leaf G.806 - Consecutive bad intervals required for declare dDEG
               degthr-percentage leaf Percentage of errored blocks required to declare an interval bad, in units of 0.01%
               expected-dapi leaf The provisioned expected DAPI, to be compared with accepted TTI
               expected-sapi leaf The provisioned expected SAPI, to be compared with accepted TTI
               layer leaf TCM layer
               ltc-act-enabled leaf enable/disable alarm transfer on detection of Loss of Tandem Connection (LTC)
               monitoring-mode leaf Monitoring mode of the TCM layer
               proactive-delay-measurement-enabled leaf enable/disable proactive Delay Measurement for TCM
               tcm-direction leaf Direction of TCM.
               tim-act-enabled leaf Enables TTI Mismatch consequent actions.
               tim-detect-mode leaf tim detect mode leaf
               tx-dapi leaf The provisioned 15 character transmit trace DAPI. Implementations shall add the [0] field automatically per ITU-T G.709
               tx-operator leaf The provisioned 32 character Operator Specific field
               tx-sapi leaf The provisioned 15 character transmit trace SAPI. Implementations shall add the [0] field automatically per ITU-T G.709
            tim-act-enabled leaf Enables TTI Mismatch consequent actions.
            tim-detect-mode leaf tim detect mode leaf
            tx-dapi leaf The provisioned 15 character transmit trace DAPI. Implementations shall add the [0] field automatically per ITU-T G.709
            tx-operator leaf The provisioned 32 character Operator Specific field
            tx-sapi leaf The provisioned 15 character transmit trace SAPI. Implementations shall add the [0] field automatically per ITU-T G.709
         otu-service-rate leaf OTU Rate of the requested service
         project-id leaf Project identifier for the service end point
         project-note leaf Additional details associated with the service end point project
         router container Needed for communication with DWDM pluggable
            ip-address leaf Router IP Address. This is reported against the service, but may not get reflected in the service in the network.
            node-id leaf Node id. This is reported against the service, but may not get reflected in the service in the network.
            url leaf URL needed for communication with DWDM pluggable. This is reported against the service, but may not get reflected in the service in the network.
         rx-direction container port lgx tail
            lgx container lgx-device-name lgx-port-name lgx-port-rack lgx-port-shelf
               lgx-device-name leaf OID: /service-list/services/service-z-end/rx-direction/lgx/lgx-device-name
               lgx-port-name leaf OID: /service-list/services/service-z-end/rx-direction/lgx/lgx-port-name
               lgx-port-rack leaf OID: /service-list/services/service-z-end/rx-direction/lgx/lgx-port-rack
               lgx-port-shelf leaf OID: /service-list/services/service-z-end/rx-direction/lgx/lgx-port-shelf
            port container From the device model perspective the port-device-name plus the port-circuit-pack-name plus the port-name uniquely identifies the port. From the network model perspective the openroadm-topology-ref plus port-device-name plus port-name uniquely identify th...
               port-circuit-pack-name leaf OID: /service-list/services/service-z-end/rx-direction/port/port-circuit-pack-name
               port-device-name leaf OID: /service-list/services/service-z-end/rx-direction/port/port-device-name
               port-name leaf OID: /service-list/services/service-z-end/rx-direction/port/port-name
               port-rack leaf OID: /service-list/services/service-z-end/rx-direction/port/port-rack
               port-shelf leaf OID: /service-list/services/service-z-end/rx-direction/port/port-shelf
               port-slot leaf OID: /service-list/services/service-z-end/rx-direction/port/port-slot
               port-sub-slot leaf OID: /service-list/services/service-z-end/rx-direction/port/port-sub-slot
               port-type leaf OID: /service-list/services/service-z-end/rx-direction/port/port-type
            tail container tail-roadm xponder-port tail-roadm-port-aid tail-roadm-port-rack-location
               tail-roadm container ROADM on which the transponder is connected to (TID, IP Address, or FQDN)
               tail-roadm-port-aid leaf This will provide the transponder port needed to inter-city ROADM connection
               tail-roadm-port-rack-location leaf Transponder's location
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               xponder-port container Muxponder port used in tail, that will get used as a service endpoint.
                  circuit-pack-name leaf OID: /service-list/services/service-z-end/rx-direction/tail/xponder-port/circuit-pack-name
                  port-name leaf OID: /service-list/services/service-z-end/rx-direction/tail/xponder-port/port-name
         service-format leaf Format of the requested service: Ethernet, OTU, etc.
         service-rate leaf Rate of the requested service in GBps
         tx-direction container port lgx tail
            lgx container lgx-device-name lgx-port-name lgx-port-rack lgx-port-shelf
               lgx-device-name leaf OID: /service-list/services/service-z-end/tx-direction/lgx/lgx-device-name
               lgx-port-name leaf OID: /service-list/services/service-z-end/tx-direction/lgx/lgx-port-name
               lgx-port-rack leaf OID: /service-list/services/service-z-end/tx-direction/lgx/lgx-port-rack
               lgx-port-shelf leaf OID: /service-list/services/service-z-end/tx-direction/lgx/lgx-port-shelf
            port container From the device model perspective the port-device-name plus the port-circuit-pack-name plus the port-name uniquely identifies the port. From the network model perspective the openroadm-topology-ref plus port-device-name plus port-name uniquely identify th...
               port-circuit-pack-name leaf OID: /service-list/services/service-z-end/tx-direction/port/port-circuit-pack-name
               port-device-name leaf OID: /service-list/services/service-z-end/tx-direction/port/port-device-name
               port-name leaf OID: /service-list/services/service-z-end/tx-direction/port/port-name
               port-rack leaf OID: /service-list/services/service-z-end/tx-direction/port/port-rack
               port-shelf leaf OID: /service-list/services/service-z-end/tx-direction/port/port-shelf
               port-slot leaf OID: /service-list/services/service-z-end/tx-direction/port/port-slot
               port-sub-slot leaf OID: /service-list/services/service-z-end/tx-direction/port/port-sub-slot
               port-type leaf OID: /service-list/services/service-z-end/tx-direction/port/port-type
            tail container tail-roadm xponder-port tail-roadm-port-aid tail-roadm-port-rack-location
               tail-roadm container ROADM on which the transponder is connected to (TID, IP Address, or FQDN)
               tail-roadm-port-aid leaf This will provide the transponder port needed to inter-city ROADM connection
               tail-roadm-port-rack-location leaf Transponder's location
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               xponder-port container Muxponder port used in tail, that will get used as a service endpoint.
                  circuit-pack-name leaf OID: /service-list/services/service-z-end/tx-direction/tail/xponder-port/circuit-pack-name
                  port-name leaf OID: /service-list/services/service-z-end/tx-direction/tail/xponder-port/port-name
         user-label leaf Label for service endpoint, defined by the user
      sla-id leaf Service Level Agreement
      soft-constraints container customer-code co-routing-or-general
         co-routing-or-general choice general co-routing
            co-routing case co-routing
               co-routing container existing-service
                  existing-service leaf-list Diverse from existing services identified by facility CLFI
            general case diversity exclude include latency hop-count TE-metric distance
               distance container Maximum distance allowed
                  max-distance leaf OID: /service-list/services/soft-constraints/co-routing-or-general/general/distance/max-distance
               diversity container existing-service existing-service-applicability
                  existing-service leaf-list Diverse from existing services identified by facility CLFI
                  existing-service-applicability container site node srlg link equipment
                     equipment container Equipment Diversity Contraints
                        roadm-srg leaf ROADM shared-risk-group diversity
                        xponder-srg leaf xponder eqpt-srg-id diversity
                     link leaf OID: /service-list/services/soft-constraints/co-routing-or-general/general/diversity/existing-service-applicability/link
                     node leaf OID: /service-list/services/soft-constraints/co-routing-or-general/general/diversity/existing-service-applicability/node
                     site leaf OID: /service-list/services/soft-constraints/co-routing-or-general/general/diversity/existing-service-applicability/site
                     srlg leaf OID: /service-list/services/soft-constraints/co-routing-or-general/general/diversity/existing-service-applicability/srlg
               exclude container fiber-bundle srlg-id site node-id link-identifier supporting-service-name
                  fiber-bundle leaf-list OID: /service-list/services/soft-constraints/co-routing-or-general/general/exclude/fiber-bundle
                  link-identifier list Refers to link-id(s) from the network model. The openroadm-topology-ref + link-id identifies the link in the network model.
                     link-id leaf link-id from the network model.
                     link-network-id leaf network-id from the network model.
                  node-id leaf-list node-id from the device model; openroadm-network-ref + node-id from the network model.
                  site leaf-list site identifies the clli. clli from the device model; clli-network-ref + clli from the network model.
                  srlg-id leaf-list unique identifier for SRLG
                  supporting-service-name leaf-list Supporting service(s) to exclude from this route.
               hop-count container Maximum hops allowed
                  max-otn-hop-count leaf OID: /service-list/services/soft-constraints/co-routing-or-general/general/hop-count/max-otn-hop-count
                  max-wdm-hop-count leaf OID: /service-list/services/soft-constraints/co-routing-or-general/general/hop-count/max-wdm-hop-count
               include container fiber-bundle srlg-id site node-id link-identifier supporting-service-name
                  fiber-bundle leaf-list OID: /service-list/services/soft-constraints/co-routing-or-general/general/include/fiber-bundle
                  link-identifier list Refers to link-id(s) from the network model. The openroadm-topology-ref + link-id identifies the link in the network model.
                     link-id leaf link-id from the network model.
                     link-network-id leaf network-id from the network model.
                  node-id leaf-list node-id from the device model; openroadm-network-ref + node-id from the network model.
                  site leaf-list site identifies the clli. clli from the device model; clli-network-ref + clli from the network model.
                  srlg-id leaf-list unique identifier for SRLG
                  supporting-service-name leaf-list Supporting service(s) to include in this route.
               latency container Maximum latency allowed
                  max-latency leaf OID: /service-list/services/soft-constraints/co-routing-or-general/general/latency/max-latency
               TE-metric container Maximum cost allowed
                  max-otn-TE-metric leaf OID: /service-list/services/soft-constraints/co-routing-or-general/general/TE-metric/max-otn-TE-metric
                  max-wdm-TE-metric leaf OID: /service-list/services/soft-constraints/co-routing-or-general/general/TE-metric/max-wdm-TE-metric
         customer-code leaf-list OID: /service-list/services/soft-constraints/customer-code
      supporting-service-name leaf-list The service name that this runs over top. If connection-type is service, then this is the related connection-type = infrastructure service, for example.
      topology container topology corresponds to working-path which is the default path. It defines the initial path to which services defined as revertive may revert to when the failure condition disappear
         aToZ list id hop-type device resource resourceType
            device container Device of the resource, used only when the system using this model report on more than one device.
               node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
            hop-type leaf OID: /service-list/services/topology/aToZ/hop-type
            id leaf Unique identifier for this topology component within this service
            resource container resource
               resource choice circuit-pack port connection physical-link internal-link shelf srg degree service interface odu-sncp-pg other device line-amplifier xponder versioned-service temp-service
                  circuit-pack case circuit-pack-name
                     circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  connection case connection-name
                     connection-name leaf Connection name. Unique within the context of a device. Same as leafref value in model, if applicable.
                  degree case degree-number
                     degree-number leaf Degree identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  device case node-id
                     node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
                  interface case interface-name type ethernet mc-ttp nmc-ctp och odu otu
                     ethernet container Ethernet Interfaces
                        speed leaf Set speed of the interface, unit mbps. This is for ETH facility.
                     interface-name leaf Interface identifier.
                     mc-ttp container Media Channel Trail Termination Point (MC-TTP)
                        max-freq leaf Maximum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                        min-freq leaf Minimum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                     nmc-ctp container Network Media Channel Connection Termination Point (NMC-CTP)
                        frequency leaf Center Frequency in THz. This is not constrained by mc-capabilities. It must fit (when combined with width) inside any containing media channel.
                        width leaf Frequency width in GHz. This is not constrained by mc-capabilities. It must fit (when combined with frequency) inside any containing media channel.
                     och container Optical Channel (OCh): Models the optical channel interfaces for an Optical White Box.
                        frequency leaf Center Frequency in THz.
                        modulation-format leaf Modulation format
                        rate leaf rate
                        width leaf Frequency width in GHz.
                     odu container Optical Channel Data Unit (ODU)
                        parent-odu-allocation container parent odu allocation
                           trib-port-number leaf Assigned tributary port number in parent OPU
                           trib-slots leaf-list Assigned trib slots occupied in parent OPU MSI
                        rate leaf rate identity of the ODU. 'identityref' is used to allow to extend for future higher rates
                     otu container Optical Channel Transport Unit (OTU)
                        rate leaf rate identity of the OTU. 'identityref' is used to allow to extend for future higher rates
                     type leaf The type of the interface.
                  internal-link case internal-link-name
                     internal-link-name leaf Internal Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  line-amplifier case amp-number
                     amp-number leaf number of the line-amplifier
                  odu-sncp-pg case odu-sncp-pg-name
                     odu-sncp-pg-name leaf name of the odu-snc-pg
                  other case other-resource-id
                     other-resource-id leaf resource-id for other.
                  physical-link case physical-link-name
                     physical-link-name leaf Physical Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  port case port
                     port container circuit-pack-name port-name
                        circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                        port-name leaf Port identifier. Unique within the context of a circuit-pack. Same as leafref value in model, if applicable.
                  service case service-name
                     service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                  shelf case shelf-name
                     shelf-name leaf Shelf-id identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  srg case srg-number
                     srg-number leaf Shared Risk Group identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  temp-service case common-id
                     common-id leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                  versioned-service case versioned-service-name version-number
                     version-number leaf version-number of the service
                     versioned-service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                  xponder case xpdr-number
                     xpdr-number leaf number of the xponder
            resourceType container type extension
               extension leaf OID: /service-list/services/topology/aToZ/resourceType/extension
               type leaf OID: /service-list/services/topology/aToZ/resourceType/type
         zToA list id hop-type device resource resourceType
            device container Device of the resource, used only when the system using this model report on more than one device.
               node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
            hop-type leaf OID: /service-list/services/topology/zToA/hop-type
            id leaf Unique identifier for this topology component within this service
            resource container resource
               resource choice circuit-pack port connection physical-link internal-link shelf srg degree service interface odu-sncp-pg other device line-amplifier xponder versioned-service temp-service
                  circuit-pack case circuit-pack-name
                     circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  connection case connection-name
                     connection-name leaf Connection name. Unique within the context of a device. Same as leafref value in model, if applicable.
                  degree case degree-number
                     degree-number leaf Degree identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  device case node-id
                     node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
                  interface case interface-name type ethernet mc-ttp nmc-ctp och odu otu
                     ethernet container Ethernet Interfaces
                        speed leaf Set speed of the interface, unit mbps. This is for ETH facility.
                     interface-name leaf Interface identifier.
                     mc-ttp container Media Channel Trail Termination Point (MC-TTP)
                        max-freq leaf Maximum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                        min-freq leaf Minimum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                     nmc-ctp container Network Media Channel Connection Termination Point (NMC-CTP)
                        frequency leaf Center Frequency in THz. This is not constrained by mc-capabilities. It must fit (when combined with width) inside any containing media channel.
                        width leaf Frequency width in GHz. This is not constrained by mc-capabilities. It must fit (when combined with frequency) inside any containing media channel.
                     och container Optical Channel (OCh): Models the optical channel interfaces for an Optical White Box.
                        frequency leaf Center Frequency in THz.
                        modulation-format leaf Modulation format
                        rate leaf rate
                        width leaf Frequency width in GHz.
                     odu container Optical Channel Data Unit (ODU)
                        parent-odu-allocation container parent odu allocation
                           trib-port-number leaf Assigned tributary port number in parent OPU
                           trib-slots leaf-list Assigned trib slots occupied in parent OPU MSI
                        rate leaf rate identity of the ODU. 'identityref' is used to allow to extend for future higher rates
                     otu container Optical Channel Transport Unit (OTU)
                        rate leaf rate identity of the OTU. 'identityref' is used to allow to extend for future higher rates
                     type leaf The type of the interface.
                  internal-link case internal-link-name
                     internal-link-name leaf Internal Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  line-amplifier case amp-number
                     amp-number leaf number of the line-amplifier
                  odu-sncp-pg case odu-sncp-pg-name
                     odu-sncp-pg-name leaf name of the odu-snc-pg
                  other case other-resource-id
                     other-resource-id leaf resource-id for other.
                  physical-link case physical-link-name
                     physical-link-name leaf Physical Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  port case port
                     port container circuit-pack-name port-name
                        circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                        port-name leaf Port identifier. Unique within the context of a circuit-pack. Same as leafref value in model, if applicable.
                  service case service-name
                     service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                  shelf case shelf-name
                     shelf-name leaf Shelf-id identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  srg case srg-number
                     srg-number leaf Shared Risk Group identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  temp-service case common-id
                     common-id leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                  versioned-service case versioned-service-name version-number
                     version-number leaf version-number of the service
                     versioned-service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                  xponder case xpdr-number
                     xpdr-number leaf number of the xponder
            resourceType container type extension
               extension leaf OID: /service-list/services/topology/zToA/resourceType/extension
               type leaf OID: /service-list/services/topology/zToA/resourceType/type
temp-service-list container List of temporary services Can only be created, deleted, modified, etc. using special RPCs.
   services list service-name common-id order-id order-note sdnc-request-header service-resiliency routing-metric connection-type lifecycle-state resource-status administrative-state operational-state condition service-a-end service-z-end hard-constraints soft-constraints due-date end-date eventHorizonStart eventHorizonEnd nc-code nci-code secondary-nci-code customer customer-contact operator-contact service-layer clli-network-ref openroadm-network-ref openroadm-topology-ref sla-id bandwidth-calendaring bw-calendaring-parameters latency fiber-span-srlgs equipment-srgs supporting-service-name current-active-path-id topology backup-topology network-topology network-backup-topology is-bandwidth-locked
      administrative-state leaf Administrative State: Intended state of service
      backup-topology container backup-path
         backup-path list backup-path-id failure-case-id aToZ zToA
            aToZ list id hop-type device resource resourceType
               device container Device of the resource, used only when the system using this model report on more than one device.
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               hop-type leaf OID: /temp-service-list/services/backup-topology/backup-path/aToZ/hop-type
               id leaf Unique identifier for this topology component within this service
               resource container resource
                  resource choice circuit-pack port connection physical-link internal-link shelf srg degree service interface odu-sncp-pg other device line-amplifier xponder versioned-service temp-service
                     circuit-pack case circuit-pack-name
                        circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     connection case connection-name
                        connection-name leaf Connection name. Unique within the context of a device. Same as leafref value in model, if applicable.
                     degree case degree-number
                        degree-number leaf Degree identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     device case node-id
                        node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
                     interface case interface-name type ethernet mc-ttp nmc-ctp och odu otu
                        ethernet container Ethernet Interfaces
                           speed leaf Set speed of the interface, unit mbps. This is for ETH facility.
                        interface-name leaf Interface identifier.
                        mc-ttp container Media Channel Trail Termination Point (MC-TTP)
                           max-freq leaf Maximum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                           min-freq leaf Minimum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                        nmc-ctp container Network Media Channel Connection Termination Point (NMC-CTP)
                           frequency leaf Center Frequency in THz. This is not constrained by mc-capabilities. It must fit (when combined with width) inside any containing media channel.
                           width leaf Frequency width in GHz. This is not constrained by mc-capabilities. It must fit (when combined with frequency) inside any containing media channel.
                        och container Optical Channel (OCh): Models the optical channel interfaces for an Optical White Box.
                           frequency leaf Center Frequency in THz.
                           modulation-format leaf Modulation format
                           rate leaf rate
                           width leaf Frequency width in GHz.
                        odu container Optical Channel Data Unit (ODU)
                           parent-odu-allocation container parent odu allocation
                              trib-port-number leaf Assigned tributary port number in parent OPU
                              trib-slots leaf-list Assigned trib slots occupied in parent OPU MSI
                           rate leaf rate identity of the ODU. 'identityref' is used to allow to extend for future higher rates
                        otu container Optical Channel Transport Unit (OTU)
                           rate leaf rate identity of the OTU. 'identityref' is used to allow to extend for future higher rates
                        type leaf The type of the interface.
                     internal-link case internal-link-name
                        internal-link-name leaf Internal Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     line-amplifier case amp-number
                        amp-number leaf number of the line-amplifier
                     odu-sncp-pg case odu-sncp-pg-name
                        odu-sncp-pg-name leaf name of the odu-snc-pg
                     other case other-resource-id
                        other-resource-id leaf resource-id for other.
                     physical-link case physical-link-name
                        physical-link-name leaf Physical Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     port case port
                        port container circuit-pack-name port-name
                           circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                           port-name leaf Port identifier. Unique within the context of a circuit-pack. Same as leafref value in model, if applicable.
                     service case service-name
                        service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                     shelf case shelf-name
                        shelf-name leaf Shelf-id identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     srg case srg-number
                        srg-number leaf Shared Risk Group identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     temp-service case common-id
                        common-id leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                     versioned-service case versioned-service-name version-number
                        version-number leaf version-number of the service
                        versioned-service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                     xponder case xpdr-number
                        xpdr-number leaf number of the xponder
               resourceType container type extension
                  extension leaf OID: /temp-service-list/services/backup-topology/backup-path/aToZ/resourceType/extension
                  type leaf OID: /temp-service-list/services/backup-topology/backup-path/aToZ/resourceType/type
            backup-path-id leaf Several backup paths may be used when backup-paths are pre-calculated. Backup-path-id avoids 0 which is associated with working path in current-active-path
            failure-case-id leaf A failure case Id can be used to associate a backup-path to a specific failure (srlg, OMS,...)
            zToA list id hop-type device resource resourceType
               device container Device of the resource, used only when the system using this model report on more than one device.
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               hop-type leaf OID: /temp-service-list/services/backup-topology/backup-path/zToA/hop-type
               id leaf Unique identifier for this topology component within this service
               resource container resource
                  resource choice circuit-pack port connection physical-link internal-link shelf srg degree service interface odu-sncp-pg other device line-amplifier xponder versioned-service temp-service
                     circuit-pack case circuit-pack-name
                        circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     connection case connection-name
                        connection-name leaf Connection name. Unique within the context of a device. Same as leafref value in model, if applicable.
                     degree case degree-number
                        degree-number leaf Degree identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     device case node-id
                        node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
                     interface case interface-name type ethernet mc-ttp nmc-ctp och odu otu
                        ethernet container Ethernet Interfaces
                           speed leaf Set speed of the interface, unit mbps. This is for ETH facility.
                        interface-name leaf Interface identifier.
                        mc-ttp container Media Channel Trail Termination Point (MC-TTP)
                           max-freq leaf Maximum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                           min-freq leaf Minimum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                        nmc-ctp container Network Media Channel Connection Termination Point (NMC-CTP)
                           frequency leaf Center Frequency in THz. This is not constrained by mc-capabilities. It must fit (when combined with width) inside any containing media channel.
                           width leaf Frequency width in GHz. This is not constrained by mc-capabilities. It must fit (when combined with frequency) inside any containing media channel.
                        och container Optical Channel (OCh): Models the optical channel interfaces for an Optical White Box.
                           frequency leaf Center Frequency in THz.
                           modulation-format leaf Modulation format
                           rate leaf rate
                           width leaf Frequency width in GHz.
                        odu container Optical Channel Data Unit (ODU)
                           parent-odu-allocation container parent odu allocation
                              trib-port-number leaf Assigned tributary port number in parent OPU
                              trib-slots leaf-list Assigned trib slots occupied in parent OPU MSI
                           rate leaf rate identity of the ODU. 'identityref' is used to allow to extend for future higher rates
                        otu container Optical Channel Transport Unit (OTU)
                           rate leaf rate identity of the OTU. 'identityref' is used to allow to extend for future higher rates
                        type leaf The type of the interface.
                     internal-link case internal-link-name
                        internal-link-name leaf Internal Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     line-amplifier case amp-number
                        amp-number leaf number of the line-amplifier
                     odu-sncp-pg case odu-sncp-pg-name
                        odu-sncp-pg-name leaf name of the odu-snc-pg
                     other case other-resource-id
                        other-resource-id leaf resource-id for other.
                     physical-link case physical-link-name
                        physical-link-name leaf Physical Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     port case port
                        port container circuit-pack-name port-name
                           circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                           port-name leaf Port identifier. Unique within the context of a circuit-pack. Same as leafref value in model, if applicable.
                     service case service-name
                        service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                     shelf case shelf-name
                        shelf-name leaf Shelf-id identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     srg case srg-number
                        srg-number leaf Shared Risk Group identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     temp-service case common-id
                        common-id leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                     versioned-service case versioned-service-name version-number
                        version-number leaf version-number of the service
                        versioned-service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                     xponder case xpdr-number
                        xpdr-number leaf number of the xponder
               resourceType container type extension
                  extension leaf OID: /temp-service-list/services/backup-topology/backup-path/zToA/resourceType/extension
                  type leaf OID: /temp-service-list/services/backup-topology/backup-path/zToA/resourceType/type
      bandwidth-calendaring leaf True if service is active only during a specific time period
      bw-calendaring-parameters container bw-calendaring-coupled-services recurrence-pattern
         bw-calendaring-coupled-services list service-index service-name common-id version-number
            common-id leaf common-id of the service that may be associated to the considered service in temp-service-list
            service-index leaf service-number of the service that may be associated to the considered service
            service-name leaf service-name of the service that may be associated to the considered service in service-list
            version-number leaf common-id of the service that may be associated to the considered service in versioned-service-list
         recurrence-pattern list recurrence-id day-of-the-week start-time end-time
            day-of-the-week leaf-list Each day for which the service is active from stat-time to end-time
            end-time leaf end time expressed as hour:min:seconds
            recurrence-id leaf id of the pattern defining the time during which the service is active
            start-time leaf start time expressed as hour:min:seconds
      clli-network-ref leaf Assumption: a service would not span multiple clli-network layers. Reference to the network-id of the clli-network layer.
      common-id leaf To be used by the ROADM controller to identify the routing constraints received from planning application (PED).
      condition leaf Service Condition: Additional information about the state of the service. Only sent when applicable.
      connection-type leaf Connection type
      current-active-path-id leaf defines the current active path : '0' if active path is the working path id of the active backup path if protection or restoration has been triggered
      customer leaf To be included in ticket information. This is reported against the service, but may not get reflected in the service in the network.
      customer-contact leaf Customer contact information to be included in ticket information. This is reported against the service, but may not get reflected in the service in the network.
      due-date leaf Date and time service to be turn up. If time is not specified for a given date, default to midnight. Service turned up immediately if no due date is specified
      end-date leaf Date and time service to be removed
      equipment-srgs list srg-number
         srg-number leaf Shared Risk Group identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
      eventHorizonEnd leaf End time to ensure that the service is routable and viable. Required resources shall be considered reserved until this time. If not provided, defaults to end-date.
      eventHorizonStart leaf Start time to ensure that the service is routable and viable. Required resources shall be considered reserved from this time. If not provided, defaults to due-date.
      fiber-span-srlgs leaf-list Shared risk link group identifiers
      hard-constraints container customer-code co-routing-or-general
         co-routing-or-general choice general co-routing
            co-routing case co-routing
               co-routing container existing-service
                  existing-service leaf-list Diverse from existing services identified by facility CLFI
            general case diversity exclude include latency hop-count TE-metric distance
               distance container Maximum distance allowed
                  max-distance leaf OID: /temp-service-list/services/hard-constraints/co-routing-or-general/general/distance/max-distance
               diversity container existing-service existing-service-applicability
                  existing-service leaf-list Diverse from existing services identified by facility CLFI
                  existing-service-applicability container site node srlg link equipment
                     equipment container Equipment Diversity Contraints
                        roadm-srg leaf ROADM shared-risk-group diversity
                        xponder-srg leaf xponder eqpt-srg-id diversity
                     link leaf OID: /temp-service-list/services/hard-constraints/co-routing-or-general/general/diversity/existing-service-applicability/link
                     node leaf OID: /temp-service-list/services/hard-constraints/co-routing-or-general/general/diversity/existing-service-applicability/node
                     site leaf OID: /temp-service-list/services/hard-constraints/co-routing-or-general/general/diversity/existing-service-applicability/site
                     srlg leaf OID: /temp-service-list/services/hard-constraints/co-routing-or-general/general/diversity/existing-service-applicability/srlg
               exclude container fiber-bundle srlg-id site node-id link-identifier supporting-service-name
                  fiber-bundle leaf-list OID: /temp-service-list/services/hard-constraints/co-routing-or-general/general/exclude/fiber-bundle
                  link-identifier list Refers to link-id(s) from the network model. The openroadm-topology-ref + link-id identifies the link in the network model.
                     link-id leaf link-id from the network model.
                     link-network-id leaf network-id from the network model.
                  node-id leaf-list node-id from the device model; openroadm-network-ref + node-id from the network model.
                  site leaf-list site identifies the clli. clli from the device model; clli-network-ref + clli from the network model.
                  srlg-id leaf-list unique identifier for SRLG
                  supporting-service-name leaf-list Supporting service(s) to exclude from this route.
               hop-count container Maximum hops allowed
                  max-otn-hop-count leaf OID: /temp-service-list/services/hard-constraints/co-routing-or-general/general/hop-count/max-otn-hop-count
                  max-wdm-hop-count leaf OID: /temp-service-list/services/hard-constraints/co-routing-or-general/general/hop-count/max-wdm-hop-count
               include container fiber-bundle srlg-id site node-id link-identifier supporting-service-name
                  fiber-bundle leaf-list OID: /temp-service-list/services/hard-constraints/co-routing-or-general/general/include/fiber-bundle
                  link-identifier list Refers to link-id(s) from the network model. The openroadm-topology-ref + link-id identifies the link in the network model.
                     link-id leaf link-id from the network model.
                     link-network-id leaf network-id from the network model.
                  node-id leaf-list node-id from the device model; openroadm-network-ref + node-id from the network model.
                  site leaf-list site identifies the clli. clli from the device model; clli-network-ref + clli from the network model.
                  srlg-id leaf-list unique identifier for SRLG
                  supporting-service-name leaf-list Supporting service(s) to include in this route.
               latency container Maximum latency allowed
                  max-latency leaf OID: /temp-service-list/services/hard-constraints/co-routing-or-general/general/latency/max-latency
               TE-metric container Maximum cost allowed
                  max-otn-TE-metric leaf OID: /temp-service-list/services/hard-constraints/co-routing-or-general/general/TE-metric/max-otn-TE-metric
                  max-wdm-TE-metric leaf OID: /temp-service-list/services/hard-constraints/co-routing-or-general/general/TE-metric/max-wdm-TE-metric
         customer-code leaf-list OID: /temp-service-list/services/hard-constraints/customer-code
      is-bandwidth-locked leaf Bandwidth lock (true, false) indicates whether the service is administratively prohibited from taking on more capacity - ie whether it can be used as a supporting service in any new service creations. Unlike administrative status, this does not impact any...
      latency leaf Latency on service
      lifecycle-state leaf Lifecycle State of service. Whether it is planned, deployed, in maintenance, etc.
      nc-code leaf NC code applied to wavelength service only. This is reported against the service, but may not get reflected in the service in the network.
      nci-code leaf NCI code applied to wavelength service only. This is reported against the service, but may not get reflected in the service in the network.
      network-backup-topology container backup-path
         backup-path list backup-path-id failure-case-id a-to-z z-to-a
            a-to-z list id network-resource network-resource-type
               id leaf Unique identifier for this network-topology component within this service
               network-resource container network-resource
               network-resource-type leaf OID: /temp-service-list/services/network-backup-topology/backup-path/a-to-z/network-resource-type
                  network-resource choice network-resource-tp network-resource-link
                     network-resource-link case link-network-id link-id
                        link-id leaf link-id from the network model.
                        link-network-id leaf network-id from the network model.
                     network-resource-tp case tp-network-id tp-node-id tp-id
                        tp-id leaf tp-id from the network model.
                        tp-network-id leaf network-id from the network model.
                        tp-node-id leaf node-id from the network model.
            backup-path-id leaf Several backup paths may be used when backup-paths are pre-calculated. Backup-path-id avoids 0 which is associated with working path in current-active-path
            failure-case-id leaf A failure case Id can be used to associate a backup-path to a specific failure (srlg, OMS,...)
            z-to-a list id network-resource network-resource-type
               id leaf Unigue identifier for this network-topology component within this service
               network-resource container network-resource
               network-resource-type leaf OID: /temp-service-list/services/network-backup-topology/backup-path/z-to-a/network-resource-type
                  network-resource choice network-resource-tp network-resource-link
                     network-resource-link case link-network-id link-id
                        link-id leaf link-id from the network model.
                        link-network-id leaf network-id from the network model.
                     network-resource-tp case tp-network-id tp-node-id tp-id
                        tp-id leaf tp-id from the network model.
                        tp-network-id leaf network-id from the network model.
                        tp-node-id leaf node-id from the network model.
      network-topology container a-to-z z-to-a
         a-to-z list id network-resource network-resource-type
            id leaf Unique identifier for this network-topology component within this service
            network-resource container network-resource
            network-resource-type leaf OID: /temp-service-list/services/network-topology/a-to-z/network-resource-type
               network-resource choice network-resource-tp network-resource-link
                  network-resource-link case link-network-id link-id
                     link-id leaf link-id from the network model.
                     link-network-id leaf network-id from the network model.
                  network-resource-tp case tp-network-id tp-node-id tp-id
                     tp-id leaf tp-id from the network model.
                     tp-network-id leaf network-id from the network model.
                     tp-node-id leaf node-id from the network model.
         z-to-a list id network-resource network-resource-type
            id leaf Unigue identifier for this network-topology component within this service
            network-resource container network-resource
            network-resource-type leaf OID: /temp-service-list/services/network-topology/z-to-a/network-resource-type
               network-resource choice network-resource-tp network-resource-link
                  network-resource-link case link-network-id link-id
                     link-id leaf link-id from the network model.
                     link-network-id leaf network-id from the network model.
                  network-resource-tp case tp-network-id tp-node-id tp-id
                     tp-id leaf tp-id from the network model.
                     tp-network-id leaf network-id from the network model.
                     tp-node-id leaf node-id from the network model.
      openroadm-network-ref leaf Assumption: a service would not span multiple openroadm-network layers. Reference to the network-id of the openroadm-network layer.
      openroadm-topology-ref leaf Assumption: a service would not span multiple topology layers. Reference to the network-id of either the openroadm-topology or the otn-topology layer depending upon service-layer (wdm or otn).
      operational-state leaf Operational State: Actual state of service
      operator-contact leaf Operator contact information to be included in ticket information. This is reported against the service, but may not get reflected in the service in the network.
      order-id leaf Order identifier for this service
      order-note leaf Additional details associated with the service order
      resource-status leaf identifies the state of network resources required to complete a service request.
      routing-metric container Describes the metrics used to route a service. All parameters of integer type, to set the priority of the routing criterion '0' means the criterion is not used, '1'coresponds to the highest priority, '255'coresponds to the lowest priority. Priority might ...
         adaptation-number leaf Metric associated with the adaptation between layers. Total path metric can can be calculated from the total number of transition between layers
         distance leaf Metric associated with the distance. Total path distance can be calculated from SRLG length of the OMS
         latency leaf Metric corresponding to the latency. Total path latency can be calculated from SRLG length of the OMS and the latency introduced by the equipment
         otn-hop-count leaf Metric corresponding to the number of hop in the otn layer
         otn-load leaf Metric corresponding to the load of the otn layer. Can be used to avoid using heavy loaded links/switchs
         otn-TE-metric leaf Used when routing shall be performed according to specific pre-defined metric associated with OTN (OTU/ODU level)
         wdm-hop-count leaf Metric corresponding to the number of hop in the wdm layer
         wdm-load leaf Metric corresponding to the load of the wdm layer Can be used to avoid using heavy loaded links
         wdm-TE-metric leaf Used when routing shall be performed according to specific pre-defined TE-Metric. Total path metric can be calculated from OMS TE-metric attribute defined in org-openroadm-link module
      sdnc-request-header container request-id rpc-action notification-url request-system-id
         notification-url leaf OID: /temp-service-list/services/sdnc-request-header/notification-url
         request-id leaf OID: /temp-service-list/services/sdnc-request-header/request-id
         request-system-id leaf OID: /temp-service-list/services/sdnc-request-header/request-system-id
         rpc-action leaf OID: /temp-service-list/services/sdnc-request-header/rpc-action
      secondary-nci-code leaf NC code applied to wavelength service only. This is reported against the service, but may not get reflected in the service in the network.
      service-a-end container service-format service-rate other-service-format-and-rate otu-service-rate odu-service-rate ethernet-encoding mapping-mode otn-attributes clli node-id tx-direction rx-direction optic-type router user-label ethernet-attributes project-id project-note
         clli leaf CLLI. Note this CLLI must match the site associated with the device-id of this endpoint
         ethernet-attributes container fec subrate-eth-sla
            fec leaf FEC / Forward Error Correction
            subrate-eth-sla container SLA (Service Level Agreement) for subrate Ethernet
               committed-burst-size leaf Committed Burst Size, unit in 1KB (K Byte). Range 16 | 32 | 64 | 128 | 512 | 1024. Default: 16
               committed-info-rate leaf Committed Information Rate (CIR), unit in Mbps. For example, 1250 Mbps
         ethernet-encoding leaf Ethernet encoding type
         mapping-mode leaf Mapping mode.
         node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
         odu-service-rate leaf ODU Rate of the requested service
         optic-type leaf OID: /temp-service-list/services/service-a-end/optic-type
         other-service-format-and-rate leaf Used when service-format is set to other in the bookend xponder use case. The use of other-service-format-and-rate is not standardized in the Open ROADM MSA and intended to allow the controller to support non-Open ROADM service formats. This value encodes...
         otn-attributes container parent-odu-allocation fec tx-sapi tx-dapi tx-operator expected-sapi expected-dapi tim-act-enabled tim-detect-mode degm-intervals degthr-percentage reserved-tcm-layer tcm
            degm-intervals leaf G.806 - Consecutive bad intervals required for declare dDEG
            degthr-percentage leaf Percentage of errored blocks required to declare an interval bad, in units of 0.01%
            expected-dapi leaf The provisioned expected DAPI, to be compared with accepted TTI
            expected-sapi leaf The provisioned expected SAPI, to be compared with accepted TTI
            fec leaf FEC / Forward Error Correction
            parent-odu-allocation container parent odu allocation
               trib-port-number leaf Assigned tributary port number in parent OPU
               trib-slots-choice choice trib slot selection
                  opu case trib-slots
                     trib-slots leaf-list Assigned trib slots occupied in parent OPU MSI
                  opucn case opucn-trib-slots
                     opucn-trib-slots leaf-list Specify the list of OPUCn 5G tributary slots in the form of TS #A.B (G.709 Figure 20-9) in the case of provisioning the low order ODUk to the parent server ODUCn
            reserved-tcm-layer leaf-list OID: /temp-service-list/services/service-a-end/otn-attributes/reserved-tcm-layer
            tcm list Tandem Connection Management
               degm-intervals leaf G.806 - Consecutive bad intervals required for declare dDEG
               degthr-percentage leaf Percentage of errored blocks required to declare an interval bad, in units of 0.01%
               expected-dapi leaf The provisioned expected DAPI, to be compared with accepted TTI
               expected-sapi leaf The provisioned expected SAPI, to be compared with accepted TTI
               layer leaf TCM layer
               ltc-act-enabled leaf enable/disable alarm transfer on detection of Loss of Tandem Connection (LTC)
               monitoring-mode leaf Monitoring mode of the TCM layer
               proactive-delay-measurement-enabled leaf enable/disable proactive Delay Measurement for TCM
               tcm-direction leaf Direction of TCM.
               tim-act-enabled leaf Enables TTI Mismatch consequent actions.
               tim-detect-mode leaf tim detect mode leaf
               tx-dapi leaf The provisioned 15 character transmit trace DAPI. Implementations shall add the [0] field automatically per ITU-T G.709
               tx-operator leaf The provisioned 32 character Operator Specific field
               tx-sapi leaf The provisioned 15 character transmit trace SAPI. Implementations shall add the [0] field automatically per ITU-T G.709
            tim-act-enabled leaf Enables TTI Mismatch consequent actions.
            tim-detect-mode leaf tim detect mode leaf
            tx-dapi leaf The provisioned 15 character transmit trace DAPI. Implementations shall add the [0] field automatically per ITU-T G.709
            tx-operator leaf The provisioned 32 character Operator Specific field
            tx-sapi leaf The provisioned 15 character transmit trace SAPI. Implementations shall add the [0] field automatically per ITU-T G.709
         otu-service-rate leaf OTU Rate of the requested service
         project-id leaf Project identifier for the service end point
         project-note leaf Additional details associated with the service end point project
         router container Needed for communication with DWDM pluggable
            ip-address leaf Router IP Address. This is reported against the service, but may not get reflected in the service in the network.
            node-id leaf Node id. This is reported against the service, but may not get reflected in the service in the network.
            url leaf URL needed for communication with DWDM pluggable. This is reported against the service, but may not get reflected in the service in the network.
         rx-direction container port lgx tail
            lgx container lgx-device-name lgx-port-name lgx-port-rack lgx-port-shelf
               lgx-device-name leaf OID: /temp-service-list/services/service-a-end/rx-direction/lgx/lgx-device-name
               lgx-port-name leaf OID: /temp-service-list/services/service-a-end/rx-direction/lgx/lgx-port-name
               lgx-port-rack leaf OID: /temp-service-list/services/service-a-end/rx-direction/lgx/lgx-port-rack
               lgx-port-shelf leaf OID: /temp-service-list/services/service-a-end/rx-direction/lgx/lgx-port-shelf
            port container From the device model perspective the port-device-name plus the port-circuit-pack-name plus the port-name uniquely identifies the port. From the network model perspective the openroadm-topology-ref plus port-device-name plus port-name uniquely identify th...
               port-circuit-pack-name leaf OID: /temp-service-list/services/service-a-end/rx-direction/port/port-circuit-pack-name
               port-device-name leaf OID: /temp-service-list/services/service-a-end/rx-direction/port/port-device-name
               port-name leaf OID: /temp-service-list/services/service-a-end/rx-direction/port/port-name
               port-rack leaf OID: /temp-service-list/services/service-a-end/rx-direction/port/port-rack
               port-shelf leaf OID: /temp-service-list/services/service-a-end/rx-direction/port/port-shelf
               port-slot leaf OID: /temp-service-list/services/service-a-end/rx-direction/port/port-slot
               port-sub-slot leaf OID: /temp-service-list/services/service-a-end/rx-direction/port/port-sub-slot
               port-type leaf OID: /temp-service-list/services/service-a-end/rx-direction/port/port-type
            tail container tail-roadm xponder-port tail-roadm-port-aid tail-roadm-port-rack-location
               tail-roadm container ROADM on which the transponder is connected to (TID, IP Address, or FQDN)
               tail-roadm-port-aid leaf This will provide the transponder port needed to inter-city ROADM connection
               tail-roadm-port-rack-location leaf Transponder's location
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               xponder-port container Muxponder port used in tail, that will get used as a service endpoint.
                  circuit-pack-name leaf OID: /temp-service-list/services/service-a-end/rx-direction/tail/xponder-port/circuit-pack-name
                  port-name leaf OID: /temp-service-list/services/service-a-end/rx-direction/tail/xponder-port/port-name
         service-format leaf Format of the requested service: Ethernet, OTU, etc.
         service-rate leaf Rate of the requested service in GBps
         tx-direction container port lgx tail
            lgx container lgx-device-name lgx-port-name lgx-port-rack lgx-port-shelf
               lgx-device-name leaf OID: /temp-service-list/services/service-a-end/tx-direction/lgx/lgx-device-name
               lgx-port-name leaf OID: /temp-service-list/services/service-a-end/tx-direction/lgx/lgx-port-name
               lgx-port-rack leaf OID: /temp-service-list/services/service-a-end/tx-direction/lgx/lgx-port-rack
               lgx-port-shelf leaf OID: /temp-service-list/services/service-a-end/tx-direction/lgx/lgx-port-shelf
            port container From the device model perspective the port-device-name plus the port-circuit-pack-name plus the port-name uniquely identifies the port. From the network model perspective the openroadm-topology-ref plus port-device-name plus port-name uniquely identify th...
               port-circuit-pack-name leaf OID: /temp-service-list/services/service-a-end/tx-direction/port/port-circuit-pack-name
               port-device-name leaf OID: /temp-service-list/services/service-a-end/tx-direction/port/port-device-name
               port-name leaf OID: /temp-service-list/services/service-a-end/tx-direction/port/port-name
               port-rack leaf OID: /temp-service-list/services/service-a-end/tx-direction/port/port-rack
               port-shelf leaf OID: /temp-service-list/services/service-a-end/tx-direction/port/port-shelf
               port-slot leaf OID: /temp-service-list/services/service-a-end/tx-direction/port/port-slot
               port-sub-slot leaf OID: /temp-service-list/services/service-a-end/tx-direction/port/port-sub-slot
               port-type leaf OID: /temp-service-list/services/service-a-end/tx-direction/port/port-type
            tail container tail-roadm xponder-port tail-roadm-port-aid tail-roadm-port-rack-location
               tail-roadm container ROADM on which the transponder is connected to (TID, IP Address, or FQDN)
               tail-roadm-port-aid leaf This will provide the transponder port needed to inter-city ROADM connection
               tail-roadm-port-rack-location leaf Transponder's location
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               xponder-port container Muxponder port used in tail, that will get used as a service endpoint.
                  circuit-pack-name leaf OID: /temp-service-list/services/service-a-end/tx-direction/tail/xponder-port/circuit-pack-name
                  port-name leaf OID: /temp-service-list/services/service-a-end/tx-direction/tail/xponder-port/port-name
         user-label leaf Label for service endpoint, defined by the user
      service-layer leaf Layer associated with service (e.g. wdm or otn)
      service-name leaf Identifier for the service to be created in the ROADM network, e.g., CLFI, CLCI, etc.
      service-resiliency container resiliency revertive wait-to-restore holdoff-time pre-calculated-backup-path-number coupled-service
         coupled-service container coupled-services
            coupled-services list service-index service-name common-id version-number
               common-id leaf common-id of the service that may be routed disjointly to the considered service in temp-service-list
               service-index leaf service-number of the service that may be routed disjointly to the considered service
               service-name leaf service-name of the service that may be routed disjointly to the considered service in service-list
               version-number leaf common-id of the service that may be routed disjointly to the considered service in versioned-service-list
         holdoff-time leaf time delay to initiate a protection or restoration event
         pre-calculated-backup-path-number leaf Associated to service-create / reconfigure / feasibility-check rpcs --> defines the target number of backup-paths to be calculated by PCE. This is an optional parameter : operator can provide it to conform with specific engineering rules. If not provided,...
         resiliency leaf describes the type of resiliency and the associated layer
         revertive leaf defines if the service shall revert to the initial working path after protection or restoration has been triggered and fault condition has disappeared
         wait-to-restore leaf time delay to revert to initial path after conditions for reversion are satisfied
      service-z-end container service-format service-rate other-service-format-and-rate otu-service-rate odu-service-rate ethernet-encoding mapping-mode otn-attributes clli node-id tx-direction rx-direction optic-type router user-label ethernet-attributes project-id project-note
         clli leaf CLLI. Note this CLLI must match the site associated with the device-id of this endpoint
         ethernet-attributes container fec subrate-eth-sla
            fec leaf FEC / Forward Error Correction
            subrate-eth-sla container SLA (Service Level Agreement) for subrate Ethernet
               committed-burst-size leaf Committed Burst Size, unit in 1KB (K Byte). Range 16 | 32 | 64 | 128 | 512 | 1024. Default: 16
               committed-info-rate leaf Committed Information Rate (CIR), unit in Mbps. For example, 1250 Mbps
         ethernet-encoding leaf Ethernet encoding type
         mapping-mode leaf Mapping mode.
         node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
         odu-service-rate leaf ODU Rate of the requested service
         optic-type leaf OID: /temp-service-list/services/service-z-end/optic-type
         other-service-format-and-rate leaf Used when service-format is set to other in the bookend xponder use case. The use of other-service-format-and-rate is not standardized in the Open ROADM MSA and intended to allow the controller to support non-Open ROADM service formats. This value encodes...
         otn-attributes container parent-odu-allocation fec tx-sapi tx-dapi tx-operator expected-sapi expected-dapi tim-act-enabled tim-detect-mode degm-intervals degthr-percentage reserved-tcm-layer tcm
            degm-intervals leaf G.806 - Consecutive bad intervals required for declare dDEG
            degthr-percentage leaf Percentage of errored blocks required to declare an interval bad, in units of 0.01%
            expected-dapi leaf The provisioned expected DAPI, to be compared with accepted TTI
            expected-sapi leaf The provisioned expected SAPI, to be compared with accepted TTI
            fec leaf FEC / Forward Error Correction
            parent-odu-allocation container parent odu allocation
               trib-port-number leaf Assigned tributary port number in parent OPU
               trib-slots-choice choice trib slot selection
                  opu case trib-slots
                     trib-slots leaf-list Assigned trib slots occupied in parent OPU MSI
                  opucn case opucn-trib-slots
                     opucn-trib-slots leaf-list Specify the list of OPUCn 5G tributary slots in the form of TS #A.B (G.709 Figure 20-9) in the case of provisioning the low order ODUk to the parent server ODUCn
            reserved-tcm-layer leaf-list OID: /temp-service-list/services/service-z-end/otn-attributes/reserved-tcm-layer
            tcm list Tandem Connection Management
               degm-intervals leaf G.806 - Consecutive bad intervals required for declare dDEG
               degthr-percentage leaf Percentage of errored blocks required to declare an interval bad, in units of 0.01%
               expected-dapi leaf The provisioned expected DAPI, to be compared with accepted TTI
               expected-sapi leaf The provisioned expected SAPI, to be compared with accepted TTI
               layer leaf TCM layer
               ltc-act-enabled leaf enable/disable alarm transfer on detection of Loss of Tandem Connection (LTC)
               monitoring-mode leaf Monitoring mode of the TCM layer
               proactive-delay-measurement-enabled leaf enable/disable proactive Delay Measurement for TCM
               tcm-direction leaf Direction of TCM.
               tim-act-enabled leaf Enables TTI Mismatch consequent actions.
               tim-detect-mode leaf tim detect mode leaf
               tx-dapi leaf The provisioned 15 character transmit trace DAPI. Implementations shall add the [0] field automatically per ITU-T G.709
               tx-operator leaf The provisioned 32 character Operator Specific field
               tx-sapi leaf The provisioned 15 character transmit trace SAPI. Implementations shall add the [0] field automatically per ITU-T G.709
            tim-act-enabled leaf Enables TTI Mismatch consequent actions.
            tim-detect-mode leaf tim detect mode leaf
            tx-dapi leaf The provisioned 15 character transmit trace DAPI. Implementations shall add the [0] field automatically per ITU-T G.709
            tx-operator leaf The provisioned 32 character Operator Specific field
            tx-sapi leaf The provisioned 15 character transmit trace SAPI. Implementations shall add the [0] field automatically per ITU-T G.709
         otu-service-rate leaf OTU Rate of the requested service
         project-id leaf Project identifier for the service end point
         project-note leaf Additional details associated with the service end point project
         router container Needed for communication with DWDM pluggable
            ip-address leaf Router IP Address. This is reported against the service, but may not get reflected in the service in the network.
            node-id leaf Node id. This is reported against the service, but may not get reflected in the service in the network.
            url leaf URL needed for communication with DWDM pluggable. This is reported against the service, but may not get reflected in the service in the network.
         rx-direction container port lgx tail
            lgx container lgx-device-name lgx-port-name lgx-port-rack lgx-port-shelf
               lgx-device-name leaf OID: /temp-service-list/services/service-z-end/rx-direction/lgx/lgx-device-name
               lgx-port-name leaf OID: /temp-service-list/services/service-z-end/rx-direction/lgx/lgx-port-name
               lgx-port-rack leaf OID: /temp-service-list/services/service-z-end/rx-direction/lgx/lgx-port-rack
               lgx-port-shelf leaf OID: /temp-service-list/services/service-z-end/rx-direction/lgx/lgx-port-shelf
            port container From the device model perspective the port-device-name plus the port-circuit-pack-name plus the port-name uniquely identifies the port. From the network model perspective the openroadm-topology-ref plus port-device-name plus port-name uniquely identify th...
               port-circuit-pack-name leaf OID: /temp-service-list/services/service-z-end/rx-direction/port/port-circuit-pack-name
               port-device-name leaf OID: /temp-service-list/services/service-z-end/rx-direction/port/port-device-name
               port-name leaf OID: /temp-service-list/services/service-z-end/rx-direction/port/port-name
               port-rack leaf OID: /temp-service-list/services/service-z-end/rx-direction/port/port-rack
               port-shelf leaf OID: /temp-service-list/services/service-z-end/rx-direction/port/port-shelf
               port-slot leaf OID: /temp-service-list/services/service-z-end/rx-direction/port/port-slot
               port-sub-slot leaf OID: /temp-service-list/services/service-z-end/rx-direction/port/port-sub-slot
               port-type leaf OID: /temp-service-list/services/service-z-end/rx-direction/port/port-type
            tail container tail-roadm xponder-port tail-roadm-port-aid tail-roadm-port-rack-location
               tail-roadm container ROADM on which the transponder is connected to (TID, IP Address, or FQDN)
               tail-roadm-port-aid leaf This will provide the transponder port needed to inter-city ROADM connection
               tail-roadm-port-rack-location leaf Transponder's location
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               xponder-port container Muxponder port used in tail, that will get used as a service endpoint.
                  circuit-pack-name leaf OID: /temp-service-list/services/service-z-end/rx-direction/tail/xponder-port/circuit-pack-name
                  port-name leaf OID: /temp-service-list/services/service-z-end/rx-direction/tail/xponder-port/port-name
         service-format leaf Format of the requested service: Ethernet, OTU, etc.
         service-rate leaf Rate of the requested service in GBps
         tx-direction container port lgx tail
            lgx container lgx-device-name lgx-port-name lgx-port-rack lgx-port-shelf
               lgx-device-name leaf OID: /temp-service-list/services/service-z-end/tx-direction/lgx/lgx-device-name
               lgx-port-name leaf OID: /temp-service-list/services/service-z-end/tx-direction/lgx/lgx-port-name
               lgx-port-rack leaf OID: /temp-service-list/services/service-z-end/tx-direction/lgx/lgx-port-rack
               lgx-port-shelf leaf OID: /temp-service-list/services/service-z-end/tx-direction/lgx/lgx-port-shelf
            port container From the device model perspective the port-device-name plus the port-circuit-pack-name plus the port-name uniquely identifies the port. From the network model perspective the openroadm-topology-ref plus port-device-name plus port-name uniquely identify th...
               port-circuit-pack-name leaf OID: /temp-service-list/services/service-z-end/tx-direction/port/port-circuit-pack-name
               port-device-name leaf OID: /temp-service-list/services/service-z-end/tx-direction/port/port-device-name
               port-name leaf OID: /temp-service-list/services/service-z-end/tx-direction/port/port-name
               port-rack leaf OID: /temp-service-list/services/service-z-end/tx-direction/port/port-rack
               port-shelf leaf OID: /temp-service-list/services/service-z-end/tx-direction/port/port-shelf
               port-slot leaf OID: /temp-service-list/services/service-z-end/tx-direction/port/port-slot
               port-sub-slot leaf OID: /temp-service-list/services/service-z-end/tx-direction/port/port-sub-slot
               port-type leaf OID: /temp-service-list/services/service-z-end/tx-direction/port/port-type
            tail container tail-roadm xponder-port tail-roadm-port-aid tail-roadm-port-rack-location
               tail-roadm container ROADM on which the transponder is connected to (TID, IP Address, or FQDN)
               tail-roadm-port-aid leaf This will provide the transponder port needed to inter-city ROADM connection
               tail-roadm-port-rack-location leaf Transponder's location
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               xponder-port container Muxponder port used in tail, that will get used as a service endpoint.
                  circuit-pack-name leaf OID: /temp-service-list/services/service-z-end/tx-direction/tail/xponder-port/circuit-pack-name
                  port-name leaf OID: /temp-service-list/services/service-z-end/tx-direction/tail/xponder-port/port-name
         user-label leaf Label for service endpoint, defined by the user
      sla-id leaf Service Level Agreement
      soft-constraints container customer-code co-routing-or-general
         co-routing-or-general choice general co-routing
            co-routing case co-routing
               co-routing container existing-service
                  existing-service leaf-list Diverse from existing services identified by facility CLFI
            general case diversity exclude include latency hop-count TE-metric distance
               distance container Maximum distance allowed
                  max-distance leaf OID: /temp-service-list/services/soft-constraints/co-routing-or-general/general/distance/max-distance
               diversity container existing-service existing-service-applicability
                  existing-service leaf-list Diverse from existing services identified by facility CLFI
                  existing-service-applicability container site node srlg link equipment
                     equipment container Equipment Diversity Contraints
                        roadm-srg leaf ROADM shared-risk-group diversity
                        xponder-srg leaf xponder eqpt-srg-id diversity
                     link leaf OID: /temp-service-list/services/soft-constraints/co-routing-or-general/general/diversity/existing-service-applicability/link
                     node leaf OID: /temp-service-list/services/soft-constraints/co-routing-or-general/general/diversity/existing-service-applicability/node
                     site leaf OID: /temp-service-list/services/soft-constraints/co-routing-or-general/general/diversity/existing-service-applicability/site
                     srlg leaf OID: /temp-service-list/services/soft-constraints/co-routing-or-general/general/diversity/existing-service-applicability/srlg
               exclude container fiber-bundle srlg-id site node-id link-identifier supporting-service-name
                  fiber-bundle leaf-list OID: /temp-service-list/services/soft-constraints/co-routing-or-general/general/exclude/fiber-bundle
                  link-identifier list Refers to link-id(s) from the network model. The openroadm-topology-ref + link-id identifies the link in the network model.
                     link-id leaf link-id from the network model.
                     link-network-id leaf network-id from the network model.
                  node-id leaf-list node-id from the device model; openroadm-network-ref + node-id from the network model.
                  site leaf-list site identifies the clli. clli from the device model; clli-network-ref + clli from the network model.
                  srlg-id leaf-list unique identifier for SRLG
                  supporting-service-name leaf-list Supporting service(s) to exclude from this route.
               hop-count container Maximum hops allowed
                  max-otn-hop-count leaf OID: /temp-service-list/services/soft-constraints/co-routing-or-general/general/hop-count/max-otn-hop-count
                  max-wdm-hop-count leaf OID: /temp-service-list/services/soft-constraints/co-routing-or-general/general/hop-count/max-wdm-hop-count
               include container fiber-bundle srlg-id site node-id link-identifier supporting-service-name
                  fiber-bundle leaf-list OID: /temp-service-list/services/soft-constraints/co-routing-or-general/general/include/fiber-bundle
                  link-identifier list Refers to link-id(s) from the network model. The openroadm-topology-ref + link-id identifies the link in the network model.
                     link-id leaf link-id from the network model.
                     link-network-id leaf network-id from the network model.
                  node-id leaf-list node-id from the device model; openroadm-network-ref + node-id from the network model.
                  site leaf-list site identifies the clli. clli from the device model; clli-network-ref + clli from the network model.
                  srlg-id leaf-list unique identifier for SRLG
                  supporting-service-name leaf-list Supporting service(s) to include in this route.
               latency container Maximum latency allowed
                  max-latency leaf OID: /temp-service-list/services/soft-constraints/co-routing-or-general/general/latency/max-latency
               TE-metric container Maximum cost allowed
                  max-otn-TE-metric leaf OID: /temp-service-list/services/soft-constraints/co-routing-or-general/general/TE-metric/max-otn-TE-metric
                  max-wdm-TE-metric leaf OID: /temp-service-list/services/soft-constraints/co-routing-or-general/general/TE-metric/max-wdm-TE-metric
         customer-code leaf-list OID: /temp-service-list/services/soft-constraints/customer-code
      supporting-service-name leaf-list The service name that this runs over top. If connection-type is service, then this is the related connection-type = infrastructure service, for example.
      topology container topology corresponds to working-path which is the default path. It defines the initial path to which services defined as revertive may revert to when the failure condition disappear
         aToZ list id hop-type device resource resourceType
            device container Device of the resource, used only when the system using this model report on more than one device.
               node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
            hop-type leaf OID: /temp-service-list/services/topology/aToZ/hop-type
            id leaf Unique identifier for this topology component within this service
            resource container resource
               resource choice circuit-pack port connection physical-link internal-link shelf srg degree service interface odu-sncp-pg other device line-amplifier xponder versioned-service temp-service
                  circuit-pack case circuit-pack-name
                     circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  connection case connection-name
                     connection-name leaf Connection name. Unique within the context of a device. Same as leafref value in model, if applicable.
                  degree case degree-number
                     degree-number leaf Degree identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  device case node-id
                     node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
                  interface case interface-name type ethernet mc-ttp nmc-ctp och odu otu
                     ethernet container Ethernet Interfaces
                        speed leaf Set speed of the interface, unit mbps. This is for ETH facility.
                     interface-name leaf Interface identifier.
                     mc-ttp container Media Channel Trail Termination Point (MC-TTP)
                        max-freq leaf Maximum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                        min-freq leaf Minimum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                     nmc-ctp container Network Media Channel Connection Termination Point (NMC-CTP)
                        frequency leaf Center Frequency in THz. This is not constrained by mc-capabilities. It must fit (when combined with width) inside any containing media channel.
                        width leaf Frequency width in GHz. This is not constrained by mc-capabilities. It must fit (when combined with frequency) inside any containing media channel.
                     och container Optical Channel (OCh): Models the optical channel interfaces for an Optical White Box.
                        frequency leaf Center Frequency in THz.
                        modulation-format leaf Modulation format
                        rate leaf rate
                        width leaf Frequency width in GHz.
                     odu container Optical Channel Data Unit (ODU)
                        parent-odu-allocation container parent odu allocation
                           trib-port-number leaf Assigned tributary port number in parent OPU
                           trib-slots leaf-list Assigned trib slots occupied in parent OPU MSI
                        rate leaf rate identity of the ODU. 'identityref' is used to allow to extend for future higher rates
                     otu container Optical Channel Transport Unit (OTU)
                        rate leaf rate identity of the OTU. 'identityref' is used to allow to extend for future higher rates
                     type leaf The type of the interface.
                  internal-link case internal-link-name
                     internal-link-name leaf Internal Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  line-amplifier case amp-number
                     amp-number leaf number of the line-amplifier
                  odu-sncp-pg case odu-sncp-pg-name
                     odu-sncp-pg-name leaf name of the odu-snc-pg
                  other case other-resource-id
                     other-resource-id leaf resource-id for other.
                  physical-link case physical-link-name
                     physical-link-name leaf Physical Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  port case port
                     port container circuit-pack-name port-name
                        circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                        port-name leaf Port identifier. Unique within the context of a circuit-pack. Same as leafref value in model, if applicable.
                  service case service-name
                     service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                  shelf case shelf-name
                     shelf-name leaf Shelf-id identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  srg case srg-number
                     srg-number leaf Shared Risk Group identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  temp-service case common-id
                     common-id leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                  versioned-service case versioned-service-name version-number
                     version-number leaf version-number of the service
                     versioned-service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                  xponder case xpdr-number
                     xpdr-number leaf number of the xponder
            resourceType container type extension
               extension leaf OID: /temp-service-list/services/topology/aToZ/resourceType/extension
               type leaf OID: /temp-service-list/services/topology/aToZ/resourceType/type
         zToA list id hop-type device resource resourceType
            device container Device of the resource, used only when the system using this model report on more than one device.
               node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
            hop-type leaf OID: /temp-service-list/services/topology/zToA/hop-type
            id leaf Unique identifier for this topology component within this service
            resource container resource
               resource choice circuit-pack port connection physical-link internal-link shelf srg degree service interface odu-sncp-pg other device line-amplifier xponder versioned-service temp-service
                  circuit-pack case circuit-pack-name
                     circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  connection case connection-name
                     connection-name leaf Connection name. Unique within the context of a device. Same as leafref value in model, if applicable.
                  degree case degree-number
                     degree-number leaf Degree identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  device case node-id
                     node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
                  interface case interface-name type ethernet mc-ttp nmc-ctp och odu otu
                     ethernet container Ethernet Interfaces
                        speed leaf Set speed of the interface, unit mbps. This is for ETH facility.
                     interface-name leaf Interface identifier.
                     mc-ttp container Media Channel Trail Termination Point (MC-TTP)
                        max-freq leaf Maximum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                        min-freq leaf Minimum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                     nmc-ctp container Network Media Channel Connection Termination Point (NMC-CTP)
                        frequency leaf Center Frequency in THz. This is not constrained by mc-capabilities. It must fit (when combined with width) inside any containing media channel.
                        width leaf Frequency width in GHz. This is not constrained by mc-capabilities. It must fit (when combined with frequency) inside any containing media channel.
                     och container Optical Channel (OCh): Models the optical channel interfaces for an Optical White Box.
                        frequency leaf Center Frequency in THz.
                        modulation-format leaf Modulation format
                        rate leaf rate
                        width leaf Frequency width in GHz.
                     odu container Optical Channel Data Unit (ODU)
                        parent-odu-allocation container parent odu allocation
                           trib-port-number leaf Assigned tributary port number in parent OPU
                           trib-slots leaf-list Assigned trib slots occupied in parent OPU MSI
                        rate leaf rate identity of the ODU. 'identityref' is used to allow to extend for future higher rates
                     otu container Optical Channel Transport Unit (OTU)
                        rate leaf rate identity of the OTU. 'identityref' is used to allow to extend for future higher rates
                     type leaf The type of the interface.
                  internal-link case internal-link-name
                     internal-link-name leaf Internal Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  line-amplifier case amp-number
                     amp-number leaf number of the line-amplifier
                  odu-sncp-pg case odu-sncp-pg-name
                     odu-sncp-pg-name leaf name of the odu-snc-pg
                  other case other-resource-id
                     other-resource-id leaf resource-id for other.
                  physical-link case physical-link-name
                     physical-link-name leaf Physical Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  port case port
                     port container circuit-pack-name port-name
                        circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                        port-name leaf Port identifier. Unique within the context of a circuit-pack. Same as leafref value in model, if applicable.
                  service case service-name
                     service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                  shelf case shelf-name
                     shelf-name leaf Shelf-id identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  srg case srg-number
                     srg-number leaf Shared Risk Group identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                  temp-service case common-id
                     common-id leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                  versioned-service case versioned-service-name version-number
                     version-number leaf version-number of the service
                     versioned-service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                  xponder case xpdr-number
                     xpdr-number leaf number of the xponder
            resourceType container type extension
               extension leaf OID: /temp-service-list/services/topology/zToA/resourceType/extension
               type leaf OID: /temp-service-list/services/topology/zToA/resourceType/type
versioned-service-list container List of service, regardless of lifecycle state. Can only be created, deleted, modified, etc. using special RPCs. Can report more than one version of a service, if supported by the implementation. May contain deleted services, multiple versions of the same...
   services list version-number service-name common-id order-id order-note sdnc-request-header service-resiliency routing-metric connection-type lifecycle-state resource-status administrative-state operational-state condition service-a-end service-z-end hard-constraints soft-constraints due-date end-date eventHorizonStart eventHorizonEnd nc-code nci-code secondary-nci-code customer customer-contact operator-contact service-layer clli-network-ref openroadm-network-ref openroadm-topology-ref sla-id bandwidth-calendaring bw-calendaring-parameters latency fiber-span-srlgs equipment-srgs supporting-service-name current-active-path-id topology backup-topology network-topology network-backup-topology is-bandwidth-locked
      administrative-state leaf Administrative State: Intended state of service
      backup-topology container backup-path
         backup-path list backup-path-id failure-case-id aToZ zToA
            aToZ list id hop-type device resource resourceType
               device container Device of the resource, used only when the system using this model report on more than one device.
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               hop-type leaf OID: /versioned-service-list/services/backup-topology/backup-path/aToZ/hop-type
               id leaf Unique identifier for this topology component within this service
               resource container resource
                  resource choice circuit-pack port connection physical-link internal-link shelf srg degree service interface odu-sncp-pg other device line-amplifier xponder versioned-service temp-service
                     circuit-pack case circuit-pack-name
                        circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     connection case connection-name
                        connection-name leaf Connection name. Unique within the context of a device. Same as leafref value in model, if applicable.
                     degree case degree-number
                        degree-number leaf Degree identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     device case node-id
                        node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
                     interface case interface-name type ethernet mc-ttp nmc-ctp och odu otu
                        ethernet container Ethernet Interfaces
                           speed leaf Set speed of the interface, unit mbps. This is for ETH facility.
                        interface-name leaf Interface identifier.
                        mc-ttp container Media Channel Trail Termination Point (MC-TTP)
                           max-freq leaf Maximum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                           min-freq leaf Minimum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                        nmc-ctp container Network Media Channel Connection Termination Point (NMC-CTP)
                           frequency leaf Center Frequency in THz. This is not constrained by mc-capabilities. It must fit (when combined with width) inside any containing media channel.
                           width leaf Frequency width in GHz. This is not constrained by mc-capabilities. It must fit (when combined with frequency) inside any containing media channel.
                        och container Optical Channel (OCh): Models the optical channel interfaces for an Optical White Box.
                           frequency leaf Center Frequency in THz.
                           modulation-format leaf Modulation format
                           rate leaf rate
                           width leaf Frequency width in GHz.
                        odu container Optical Channel Data Unit (ODU)
                           parent-odu-allocation container parent odu allocation
                              trib-port-number leaf Assigned tributary port number in parent OPU
                              trib-slots leaf-list Assigned trib slots occupied in parent OPU MSI
                           rate leaf rate identity of the ODU. 'identityref' is used to allow to extend for future higher rates
                        otu container Optical Channel Transport Unit (OTU)
                           rate leaf rate identity of the OTU. 'identityref' is used to allow to extend for future higher rates
                        type leaf The type of the interface.
                     internal-link case internal-link-name
                        internal-link-name leaf Internal Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     line-amplifier case amp-number
                        amp-number leaf number of the line-amplifier
                     odu-sncp-pg case odu-sncp-pg-name
                        odu-sncp-pg-name leaf name of the odu-snc-pg
                     other case other-resource-id
                        other-resource-id leaf resource-id for other.
                     physical-link case physical-link-name
                        physical-link-name leaf Physical Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     port case port
                        port container circuit-pack-name port-name
                           circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                           port-name leaf Port identifier. Unique within the context of a circuit-pack. Same as leafref value in model, if applicable.
                     service case service-name
                        service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                     shelf case shelf-name
                        shelf-name leaf Shelf-id identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     srg case srg-number
                        srg-number leaf Shared Risk Group identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     temp-service case common-id
                        common-id leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                     versioned-service case versioned-service-name version-number
                        version-number leaf version-number of the service
                        versioned-service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                     xponder case xpdr-number
                        xpdr-number leaf number of the xponder
               resourceType container type extension
                  extension leaf OID: /versioned-service-list/services/backup-topology/backup-path/aToZ/resourceType/extension
                  type leaf OID: /versioned-service-list/services/backup-topology/backup-path/aToZ/resourceType/type
            backup-path-id leaf Several backup paths may be used when backup-paths are pre-calculated. Backup-path-id avoids 0 which is associated with working path in current-active-path
            failure-case-id leaf A failure case Id can be used to associate a backup-path to a specific failure (srlg, OMS,...)
            zToA list id hop-type device resource resourceType
               device container Device of the resource, used only when the system using this model report on more than one device.
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               hop-type leaf OID: /versioned-service-list/services/backup-topology/backup-path/zToA/hop-type
               id leaf Unique identifier for this topology component within this service
               resource container resource
                  resource choice circuit-pack port connection physical-link internal-link shelf srg degree service interface odu-sncp-pg other device line-amplifier xponder versioned-service temp-service
                     circuit-pack case circuit-pack-name
                        circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     connection case connection-name
                        connection-name leaf Connection name. Unique within the context of a device. Same as leafref value in model, if applicable.
                     degree case degree-number
                        degree-number leaf Degree identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     device case node-id
                        node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
                     interface case interface-name type ethernet mc-ttp nmc-ctp och odu otu
                        ethernet container Ethernet Interfaces
                           speed leaf Set speed of the interface, unit mbps. This is for ETH facility.
                        interface-name leaf Interface identifier.
                        mc-ttp container Media Channel Trail Termination Point (MC-TTP)
                           max-freq leaf Maximum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                           min-freq leaf Minimum Frequency in THz. Granularity is hardware dependent, based on pixel resolution. eg. ITU 12.5GHz frequency slots. Range covers C+L
                        nmc-ctp container Network Media Channel Connection Termination Point (NMC-CTP)
                           frequency leaf Center Frequency in THz. This is not constrained by mc-capabilities. It must fit (when combined with width) inside any containing media channel.
                           width leaf Frequency width in GHz. This is not constrained by mc-capabilities. It must fit (when combined with frequency) inside any containing media channel.
                        och container Optical Channel (OCh): Models the optical channel interfaces for an Optical White Box.
                           frequency leaf Center Frequency in THz.
                           modulation-format leaf Modulation format
                           rate leaf rate
                           width leaf Frequency width in GHz.
                        odu container Optical Channel Data Unit (ODU)
                           parent-odu-allocation container parent odu allocation
                              trib-port-number leaf Assigned tributary port number in parent OPU
                              trib-slots leaf-list Assigned trib slots occupied in parent OPU MSI
                           rate leaf rate identity of the ODU. 'identityref' is used to allow to extend for future higher rates
                        otu container Optical Channel Transport Unit (OTU)
                           rate leaf rate identity of the OTU. 'identityref' is used to allow to extend for future higher rates
                        type leaf The type of the interface.
                     internal-link case internal-link-name
                        internal-link-name leaf Internal Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     line-amplifier case amp-number
                        amp-number leaf number of the line-amplifier
                     odu-sncp-pg case odu-sncp-pg-name
                        odu-sncp-pg-name leaf name of the odu-snc-pg
                     other case other-resource-id
                        other-resource-id leaf resource-id for other.
                     physical-link case physical-link-name
                        physical-link-name leaf Physical Link identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     port case port
                        port container circuit-pack-name port-name
                           circuit-pack-name leaf Circuit-Pack identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                           port-name leaf Port identifier. Unique within the context of a circuit-pack. Same as leafref value in model, if applicable.
                     service case service-name
                        service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                     shelf case shelf-name
                        shelf-name leaf Shelf-id identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     srg case srg-number
                        srg-number leaf Shared Risk Group identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
                     temp-service case common-id
                        common-id leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                     versioned-service case versioned-service-name version-number
                        version-number leaf version-number of the service
                        versioned-service-name leaf Service identifier. Unique within the context of a network. Same as leafref value in model, if applicable.
                     xponder case xpdr-number
                        xpdr-number leaf number of the xponder
               resourceType container type extension
                  extension leaf OID: /versioned-service-list/services/backup-topology/backup-path/zToA/resourceType/extension
                  type leaf OID: /versioned-service-list/services/backup-topology/backup-path/zToA/resourceType/type
      bandwidth-calendaring leaf True if service is active only during a specific time period
      bw-calendaring-parameters container bw-calendaring-coupled-services recurrence-pattern
         bw-calendaring-coupled-services list service-index service-name common-id version-number
            common-id leaf common-id of the service that may be associated to the considered service in temp-service-list
            service-index leaf service-number of the service that may be associated to the considered service
            service-name leaf service-name of the service that may be associated to the considered service in service-list
            version-number leaf common-id of the service that may be associated to the considered service in versioned-service-list
         recurrence-pattern list recurrence-id day-of-the-week start-time end-time
            day-of-the-week leaf-list Each day for which the service is active from stat-time to end-time
            end-time leaf end time expressed as hour:min:seconds
            recurrence-id leaf id of the pattern defining the time during which the service is active
            start-time leaf start time expressed as hour:min:seconds
      clli-network-ref leaf Assumption: a service would not span multiple clli-network layers. Reference to the network-id of the clli-network layer.
      common-id leaf To be used by the ROADM controller to identify the routing constraints received from planning application (PED).
      condition leaf Service Condition: Additional information about the state of the service. Only sent when applicable.
      connection-type leaf Connection type
      current-active-path-id leaf defines the current active path : '0' if active path is the working path id of the active backup path if protection or restoration has been triggered
      customer leaf To be included in ticket information. This is reported against the service, but may not get reflected in the service in the network.
      customer-contact leaf Customer contact information to be included in ticket information. This is reported against the service, but may not get reflected in the service in the network.
      due-date leaf Date and time service to be turn up. If time is not specified for a given date, default to midnight. Service turned up immediately if no due date is specified
      end-date leaf Date and time service to be removed
      equipment-srgs list srg-number
         srg-number leaf Shared Risk Group identifier. Unique within the context of a device. Same as leafref value in model, if applicable.
      eventHorizonEnd leaf End time to ensure that the service is routable and viable. Required resources shall be considered reserved until this time. If not provided, defaults to end-date.
      eventHorizonStart leaf Start time to ensure that the service is routable and viable. Required resources shall be considered reserved from this time. If not provided, defaults to due-date.
      fiber-span-srlgs leaf-list Shared risk link group identifiers
      hard-constraints container customer-code co-routing-or-general
         co-routing-or-general choice general co-routing
            co-routing case co-routing
               co-routing container existing-service
                  existing-service leaf-list Diverse from existing services identified by facility CLFI
            general case diversity exclude include latency hop-count TE-metric distance
               distance container Maximum distance allowed
                  max-distance leaf OID: /versioned-service-list/services/hard-constraints/co-routing-or-general/general/distance/max-distance
               diversity container existing-service existing-service-applicability
                  existing-service leaf-list Diverse from existing services identified by facility CLFI
                  existing-service-applicability container site node srlg link equipment
                     equipment container Equipment Diversity Contraints
                        roadm-srg leaf ROADM shared-risk-group diversity
                        xponder-srg leaf xponder eqpt-srg-id diversity
                     link leaf OID: /versioned-service-list/services/hard-constraints/co-routing-or-general/general/diversity/existing-service-applicability/link
                     node leaf OID: /versioned-service-list/services/hard-constraints/co-routing-or-general/general/diversity/existing-service-applicability/node
                     site leaf OID: /versioned-service-list/services/hard-constraints/co-routing-or-general/general/diversity/existing-service-applicability/site
                     srlg leaf OID: /versioned-service-list/services/hard-constraints/co-routing-or-general/general/diversity/existing-service-applicability/srlg
               exclude container fiber-bundle srlg-id site node-id link-identifier supporting-service-name
                  fiber-bundle leaf-list OID: /versioned-service-list/services/hard-constraints/co-routing-or-general/general/exclude/fiber-bundle
                  link-identifier list Refers to link-id(s) from the network model. The openroadm-topology-ref + link-id identifies the link in the network model.
                     link-id leaf link-id from the network model.
                     link-network-id leaf network-id from the network model.
                  node-id leaf-list node-id from the device model; openroadm-network-ref + node-id from the network model.
                  site leaf-list site identifies the clli. clli from the device model; clli-network-ref + clli from the network model.
                  srlg-id leaf-list unique identifier for SRLG
                  supporting-service-name leaf-list Supporting service(s) to exclude from this route.
               hop-count container Maximum hops allowed
                  max-otn-hop-count leaf OID: /versioned-service-list/services/hard-constraints/co-routing-or-general/general/hop-count/max-otn-hop-count
                  max-wdm-hop-count leaf OID: /versioned-service-list/services/hard-constraints/co-routing-or-general/general/hop-count/max-wdm-hop-count
               include container fiber-bundle srlg-id site node-id link-identifier supporting-service-name
                  fiber-bundle leaf-list OID: /versioned-service-list/services/hard-constraints/co-routing-or-general/general/include/fiber-bundle
                  link-identifier list Refers to link-id(s) from the network model. The openroadm-topology-ref + link-id identifies the link in the network model.
                     link-id leaf link-id from the network model.
                     link-network-id leaf network-id from the network model.
                  node-id leaf-list node-id from the device model; openroadm-network-ref + node-id from the network model.
                  site leaf-list site identifies the clli. clli from the device model; clli-network-ref + clli from the network model.
                  srlg-id leaf-list unique identifier for SRLG
                  supporting-service-name leaf-list Supporting service(s) to include in this route.
               latency container Maximum latency allowed
                  max-latency leaf OID: /versioned-service-list/services/hard-constraints/co-routing-or-general/general/latency/max-latency
               TE-metric container Maximum cost allowed
                  max-otn-TE-metric leaf OID: /versioned-service-list/services/hard-constraints/co-routing-or-general/general/TE-metric/max-otn-TE-metric
                  max-wdm-TE-metric leaf OID: /versioned-service-list/services/hard-constraints/co-routing-or-general/general/TE-metric/max-wdm-TE-metric
         customer-code leaf-list OID: /versioned-service-list/services/hard-constraints/customer-code
      is-bandwidth-locked leaf Bandwidth lock (true, false) indicates whether the service is administratively prohibited from taking on more capacity - ie whether it can be used as a supporting service in any new service creations. Unlike administrative status, this does not impact any...
      latency leaf Latency on service
      lifecycle-state leaf Lifecycle State of service. Whether it is planned, deployed, in maintenance, etc.
      nc-code leaf NC code applied to wavelength service only. This is reported against the service, but may not get reflected in the service in the network.
      nci-code leaf NCI code applied to wavelength service only. This is reported against the service, but may not get reflected in the service in the network.
      network-backup-topology container backup-path
         backup-path list backup-path-id failure-case-id a-to-z z-to-a
            a-to-z list id network-resource network-resource-type
               id leaf Unique identifier for this network-topology component within this service
               network-resource container network-resource
               network-resource-type leaf OID: /versioned-service-list/services/network-backup-topology/backup-path/a-to-z/network-resource-type
                  network-resource choice network-resource-tp network-resource-link
                     network-resource-link case link-network-id link-id
                        link-id leaf link-id from the network model.
                        link-network-id leaf network-id from the network model.
                     network-resource-tp case tp-network-id tp-node-id tp-id
                        tp-id leaf tp-id from the network model.
                        tp-network-id leaf network-id from the network model.
                        tp-node-id leaf node-id from the network model.
            backup-path-id leaf Several backup paths may be used when backup-paths are pre-calculated. Backup-path-id avoids 0 which is associated with working path in current-active-path
            failure-case-id leaf A failure case Id can be used to associate a backup-path to a specific failure (srlg, OMS,...)
            z-to-a list id network-resource network-resource-type
               id leaf Unigue identifier for this network-topology component within this service
               network-resource container network-resource
               network-resource-type leaf OID: /versioned-service-list/services/network-backup-topology/backup-path/z-to-a/network-resource-type
                  network-resource choice network-resource-tp network-resource-link
                     network-resource-link case link-network-id link-id
                        link-id leaf link-id from the network model.
                        link-network-id leaf network-id from the network model.
                     network-resource-tp case tp-network-id tp-node-id tp-id
                        tp-id leaf tp-id from the network model.
                        tp-network-id leaf network-id from the network model.
                        tp-node-id leaf node-id from the network model.
      network-topology container a-to-z z-to-a
         a-to-z list id network-resource network-resource-type
            id leaf Unique identifier for this network-topology component within this service
            network-resource container network-resource
            network-resource-type leaf OID: /versioned-service-list/services/network-topology/a-to-z/network-resource-type
               network-resource choice network-resource-tp network-resource-link
                  network-resource-link case link-network-id link-id
                     link-id leaf link-id from the network model.
                     link-network-id leaf network-id from the network model.
                  network-resource-tp case tp-network-id tp-node-id tp-id
                     tp-id leaf tp-id from the network model.
                     tp-network-id leaf network-id from the network model.
                     tp-node-id leaf node-id from the network model.
         z-to-a list id network-resource network-resource-type
            id leaf Unigue identifier for this network-topology component within this service
            network-resource container network-resource
            network-resource-type leaf OID: /versioned-service-list/services/network-topology/z-to-a/network-resource-type
               network-resource choice network-resource-tp network-resource-link
                  network-resource-link case link-network-id link-id
                     link-id leaf link-id from the network model.
                     link-network-id leaf network-id from the network model.
                  network-resource-tp case tp-network-id tp-node-id tp-id
                     tp-id leaf tp-id from the network model.
                     tp-network-id leaf network-id from the network model.
                     tp-node-id leaf node-id from the network model.
      openroadm-network-ref leaf Assumption: a service would not span multiple openroadm-network layers. Reference to the network-id of the openroadm-network layer.
      openroadm-topology-ref leaf Assumption: a service would not span multiple topology layers. Reference to the network-id of either the openroadm-topology or the otn-topology layer depending upon service-layer (wdm or otn).
      operational-state leaf Operational State: Actual state of service
      operator-contact leaf Operator contact information to be included in ticket information. This is reported against the service, but may not get reflected in the service in the network.
      order-id leaf Order identifier for this service
      order-note leaf Additional details associated with the service order
      resource-status leaf identifies the state of network resources required to complete a service request.
      routing-metric container Describes the metrics used to route a service. All parameters of integer type, to set the priority of the routing criterion '0' means the criterion is not used, '1'coresponds to the highest priority, '255'coresponds to the lowest priority. Priority might ...
         adaptation-number leaf Metric associated with the adaptation between layers. Total path metric can can be calculated from the total number of transition between layers
         distance leaf Metric associated with the distance. Total path distance can be calculated from SRLG length of the OMS
         latency leaf Metric corresponding to the latency. Total path latency can be calculated from SRLG length of the OMS and the latency introduced by the equipment
         otn-hop-count leaf Metric corresponding to the number of hop in the otn layer
         otn-load leaf Metric corresponding to the load of the otn layer. Can be used to avoid using heavy loaded links/switchs
         otn-TE-metric leaf Used when routing shall be performed according to specific pre-defined metric associated with OTN (OTU/ODU level)
         wdm-hop-count leaf Metric corresponding to the number of hop in the wdm layer
         wdm-load leaf Metric corresponding to the load of the wdm layer Can be used to avoid using heavy loaded links
         wdm-TE-metric leaf Used when routing shall be performed according to specific pre-defined TE-Metric. Total path metric can be calculated from OMS TE-metric attribute defined in org-openroadm-link module
      sdnc-request-header container request-id rpc-action notification-url request-system-id
         notification-url leaf OID: /versioned-service-list/services/sdnc-request-header/notification-url
         request-id leaf OID: /versioned-service-list/services/sdnc-request-header/request-id
         request-system-id leaf OID: /versioned-service-list/services/sdnc-request-header/request-system-id
         rpc-action leaf OID: /versioned-service-list/services/sdnc-request-header/rpc-action
      secondary-nci-code leaf NC code applied to wavelength service only. This is reported against the service, but may not get reflected in the service in the network.
      service-a-end container service-format service-rate other-service-format-and-rate otu-service-rate odu-service-rate ethernet-encoding mapping-mode otn-attributes clli node-id tx-direction rx-direction optic-type router user-label ethernet-attributes project-id project-note
         clli leaf CLLI. Note this CLLI must match the site associated with the device-id of this endpoint
         ethernet-attributes container fec subrate-eth-sla
            fec leaf FEC / Forward Error Correction
            subrate-eth-sla container SLA (Service Level Agreement) for subrate Ethernet
               committed-burst-size leaf Committed Burst Size, unit in 1KB (K Byte). Range 16 | 32 | 64 | 128 | 512 | 1024. Default: 16
               committed-info-rate leaf Committed Information Rate (CIR), unit in Mbps. For example, 1250 Mbps
         ethernet-encoding leaf Ethernet encoding type
         mapping-mode leaf Mapping mode.
         node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
         odu-service-rate leaf ODU Rate of the requested service
         optic-type leaf OID: /versioned-service-list/services/service-a-end/optic-type
         other-service-format-and-rate leaf Used when service-format is set to other in the bookend xponder use case. The use of other-service-format-and-rate is not standardized in the Open ROADM MSA and intended to allow the controller to support non-Open ROADM service formats. This value encodes...
         otn-attributes container parent-odu-allocation fec tx-sapi tx-dapi tx-operator expected-sapi expected-dapi tim-act-enabled tim-detect-mode degm-intervals degthr-percentage reserved-tcm-layer tcm
            degm-intervals leaf G.806 - Consecutive bad intervals required for declare dDEG
            degthr-percentage leaf Percentage of errored blocks required to declare an interval bad, in units of 0.01%
            expected-dapi leaf The provisioned expected DAPI, to be compared with accepted TTI
            expected-sapi leaf The provisioned expected SAPI, to be compared with accepted TTI
            fec leaf FEC / Forward Error Correction
            parent-odu-allocation container parent odu allocation
               trib-port-number leaf Assigned tributary port number in parent OPU
               trib-slots-choice choice trib slot selection
                  opu case trib-slots
                     trib-slots leaf-list Assigned trib slots occupied in parent OPU MSI
                  opucn case opucn-trib-slots
                     opucn-trib-slots leaf-list Specify the list of OPUCn 5G tributary slots in the form of TS #A.B (G.709 Figure 20-9) in the case of provisioning the low order ODUk to the parent server ODUCn
            reserved-tcm-layer leaf-list OID: /versioned-service-list/services/service-a-end/otn-attributes/reserved-tcm-layer
            tcm list Tandem Connection Management
               degm-intervals leaf G.806 - Consecutive bad intervals required for declare dDEG
               degthr-percentage leaf Percentage of errored blocks required to declare an interval bad, in units of 0.01%
               expected-dapi leaf The provisioned expected DAPI, to be compared with accepted TTI
               expected-sapi leaf The provisioned expected SAPI, to be compared with accepted TTI
               layer leaf TCM layer
               ltc-act-enabled leaf enable/disable alarm transfer on detection of Loss of Tandem Connection (LTC)
               monitoring-mode leaf Monitoring mode of the TCM layer
               proactive-delay-measurement-enabled leaf enable/disable proactive Delay Measurement for TCM
               tcm-direction leaf Direction of TCM.
               tim-act-enabled leaf Enables TTI Mismatch consequent actions.
               tim-detect-mode leaf tim detect mode leaf
               tx-dapi leaf The provisioned 15 character transmit trace DAPI. Implementations shall add the [0] field automatically per ITU-T G.709
               tx-operator leaf The provisioned 32 character Operator Specific field
               tx-sapi leaf The provisioned 15 character transmit trace SAPI. Implementations shall add the [0] field automatically per ITU-T G.709
            tim-act-enabled leaf Enables TTI Mismatch consequent actions.
            tim-detect-mode leaf tim detect mode leaf
            tx-dapi leaf The provisioned 15 character transmit trace DAPI. Implementations shall add the [0] field automatically per ITU-T G.709
            tx-operator leaf The provisioned 32 character Operator Specific field
            tx-sapi leaf The provisioned 15 character transmit trace SAPI. Implementations shall add the [0] field automatically per ITU-T G.709
         otu-service-rate leaf OTU Rate of the requested service
         project-id leaf Project identifier for the service end point
         project-note leaf Additional details associated with the service end point project
         router container Needed for communication with DWDM pluggable
            ip-address leaf Router IP Address. This is reported against the service, but may not get reflected in the service in the network.
            node-id leaf Node id. This is reported against the service, but may not get reflected in the service in the network.
            url leaf URL needed for communication with DWDM pluggable. This is reported against the service, but may not get reflected in the service in the network.
         rx-direction container port lgx tail
            lgx container lgx-device-name lgx-port-name lgx-port-rack lgx-port-shelf
               lgx-device-name leaf OID: /versioned-service-list/services/service-a-end/rx-direction/lgx/lgx-device-name
               lgx-port-name leaf OID: /versioned-service-list/services/service-a-end/rx-direction/lgx/lgx-port-name
               lgx-port-rack leaf OID: /versioned-service-list/services/service-a-end/rx-direction/lgx/lgx-port-rack
               lgx-port-shelf leaf OID: /versioned-service-list/services/service-a-end/rx-direction/lgx/lgx-port-shelf
            port container From the device model perspective the port-device-name plus the port-circuit-pack-name plus the port-name uniquely identifies the port. From the network model perspective the openroadm-topology-ref plus port-device-name plus port-name uniquely identify th...
               port-circuit-pack-name leaf OID: /versioned-service-list/services/service-a-end/rx-direction/port/port-circuit-pack-name
               port-device-name leaf OID: /versioned-service-list/services/service-a-end/rx-direction/port/port-device-name
               port-name leaf OID: /versioned-service-list/services/service-a-end/rx-direction/port/port-name
               port-rack leaf OID: /versioned-service-list/services/service-a-end/rx-direction/port/port-rack
               port-shelf leaf OID: /versioned-service-list/services/service-a-end/rx-direction/port/port-shelf
               port-slot leaf OID: /versioned-service-list/services/service-a-end/rx-direction/port/port-slot
               port-sub-slot leaf OID: /versioned-service-list/services/service-a-end/rx-direction/port/port-sub-slot
               port-type leaf OID: /versioned-service-list/services/service-a-end/rx-direction/port/port-type
            tail container tail-roadm xponder-port tail-roadm-port-aid tail-roadm-port-rack-location
               tail-roadm container ROADM on which the transponder is connected to (TID, IP Address, or FQDN)
               tail-roadm-port-aid leaf This will provide the transponder port needed to inter-city ROADM connection
               tail-roadm-port-rack-location leaf Transponder's location
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               xponder-port container Muxponder port used in tail, that will get used as a service endpoint.
                  circuit-pack-name leaf OID: /versioned-service-list/services/service-a-end/rx-direction/tail/xponder-port/circuit-pack-name
                  port-name leaf OID: /versioned-service-list/services/service-a-end/rx-direction/tail/xponder-port/port-name
         service-format leaf Format of the requested service: Ethernet, OTU, etc.
         service-rate leaf Rate of the requested service in GBps
         tx-direction container port lgx tail
            lgx container lgx-device-name lgx-port-name lgx-port-rack lgx-port-shelf
               lgx-device-name leaf OID: /versioned-service-list/services/service-a-end/tx-direction/lgx/lgx-device-name
               lgx-port-name leaf OID: /versioned-service-list/services/service-a-end/tx-direction/lgx/lgx-port-name
               lgx-port-rack leaf OID: /versioned-service-list/services/service-a-end/tx-direction/lgx/lgx-port-rack
               lgx-port-shelf leaf OID: /versioned-service-list/services/service-a-end/tx-direction/lgx/lgx-port-shelf
            port container From the device model perspective the port-device-name plus the port-circuit-pack-name plus the port-name uniquely identifies the port. From the network model perspective the openroadm-topology-ref plus port-device-name plus port-name uniquely identify th...
               port-circuit-pack-name leaf OID: /versioned-service-list/services/service-a-end/tx-direction/port/port-circuit-pack-name
               port-device-name leaf OID: /versioned-service-list/services/service-a-end/tx-direction/port/port-device-name
               port-name leaf OID: /versioned-service-list/services/service-a-end/tx-direction/port/port-name
               port-rack leaf OID: /versioned-service-list/services/service-a-end/tx-direction/port/port-rack
               port-shelf leaf OID: /versioned-service-list/services/service-a-end/tx-direction/port/port-shelf
               port-slot leaf OID: /versioned-service-list/services/service-a-end/tx-direction/port/port-slot
               port-sub-slot leaf OID: /versioned-service-list/services/service-a-end/tx-direction/port/port-sub-slot
               port-type leaf OID: /versioned-service-list/services/service-a-end/tx-direction/port/port-type
            tail container tail-roadm xponder-port tail-roadm-port-aid tail-roadm-port-rack-location
               tail-roadm container ROADM on which the transponder is connected to (TID, IP Address, or FQDN)
               tail-roadm-port-aid leaf This will provide the transponder port needed to inter-city ROADM connection
               tail-roadm-port-rack-location leaf Transponder's location
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               xponder-port container Muxponder port used in tail, that will get used as a service endpoint.
                  circuit-pack-name leaf OID: /versioned-service-list/services/service-a-end/tx-direction/tail/xponder-port/circuit-pack-name
                  port-name leaf OID: /versioned-service-list/services/service-a-end/tx-direction/tail/xponder-port/port-name
         user-label leaf Label for service endpoint, defined by the user
      service-layer leaf Layer associated with service (e.g. wdm or otn)
      service-name leaf Identifier for the service to be created in the ROADM network, e.g., CLFI, CLCI, etc.
      service-resiliency container resiliency revertive wait-to-restore holdoff-time pre-calculated-backup-path-number coupled-service
         coupled-service container coupled-services
            coupled-services list service-index service-name common-id version-number
               common-id leaf common-id of the service that may be routed disjointly to the considered service in temp-service-list
               service-index leaf service-number of the service that may be routed disjointly to the considered service
               service-name leaf service-name of the service that may be routed disjointly to the considered service in service-list
               version-number leaf common-id of the service that may be routed disjointly to the considered service in versioned-service-list
         holdoff-time leaf time delay to initiate a protection or restoration event
         pre-calculated-backup-path-number leaf Associated to service-create / reconfigure / feasibility-check rpcs --> defines the target number of backup-paths to be calculated by PCE. This is an optional parameter : operator can provide it to conform with specific engineering rules. If not provided,...
         resiliency leaf describes the type of resiliency and the associated layer
         revertive leaf defines if the service shall revert to the initial working path after protection or restoration has been triggered and fault condition has disappeared
         wait-to-restore leaf time delay to revert to initial path after conditions for reversion are satisfied
      service-z-end container service-format service-rate other-service-format-and-rate otu-service-rate odu-service-rate ethernet-encoding mapping-mode otn-attributes clli node-id tx-direction rx-direction optic-type router user-label ethernet-attributes project-id project-note
         clli leaf CLLI. Note this CLLI must match the site associated with the device-id of this endpoint
         ethernet-attributes container fec subrate-eth-sla
            fec leaf FEC / Forward Error Correction
            subrate-eth-sla container SLA (Service Level Agreement) for subrate Ethernet
               committed-burst-size leaf Committed Burst Size, unit in 1KB (K Byte). Range 16 | 32 | 64 | 128 | 512 | 1024. Default: 16
               committed-info-rate leaf Committed Information Rate (CIR), unit in Mbps. For example, 1250 Mbps
         ethernet-encoding leaf Ethernet encoding type
         mapping-mode leaf Mapping mode.
         node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
         odu-service-rate leaf ODU Rate of the requested service
         optic-type leaf OID: /versioned-service-list/services/service-z-end/optic-type
         other-service-format-and-rate leaf Used when service-format is set to other in the bookend xponder use case. The use of other-service-format-and-rate is not standardized in the Open ROADM MSA and intended to allow the controller to support non-Open ROADM service formats. This value encodes...
         otn-attributes container parent-odu-allocation fec tx-sapi tx-dapi tx-operator expected-sapi expected-dapi tim-act-enabled tim-detect-mode degm-intervals degthr-percentage reserved-tcm-layer tcm
            degm-intervals leaf G.806 - Consecutive bad intervals required for declare dDEG
            degthr-percentage leaf Percentage of errored blocks required to declare an interval bad, in units of 0.01%
            expected-dapi leaf The provisioned expected DAPI, to be compared with accepted TTI
            expected-sapi leaf The provisioned expected SAPI, to be compared with accepted TTI
            fec leaf FEC / Forward Error Correction
            parent-odu-allocation container parent odu allocation
               trib-port-number leaf Assigned tributary port number in parent OPU
               trib-slots-choice choice trib slot selection
                  opu case trib-slots
                     trib-slots leaf-list Assigned trib slots occupied in parent OPU MSI
                  opucn case opucn-trib-slots
                     opucn-trib-slots leaf-list Specify the list of OPUCn 5G tributary slots in the form of TS #A.B (G.709 Figure 20-9) in the case of provisioning the low order ODUk to the parent server ODUCn
            reserved-tcm-layer leaf-list OID: /versioned-service-list/services/service-z-end/otn-attributes/reserved-tcm-layer
            tcm list Tandem Connection Management
               degm-intervals leaf G.806 - Consecutive bad intervals required for declare dDEG
               degthr-percentage leaf Percentage of errored blocks required to declare an interval bad, in units of 0.01%
               expected-dapi leaf The provisioned expected DAPI, to be compared with accepted TTI
               expected-sapi leaf The provisioned expected SAPI, to be compared with accepted TTI
               layer leaf TCM layer
               ltc-act-enabled leaf enable/disable alarm transfer on detection of Loss of Tandem Connection (LTC)
               monitoring-mode leaf Monitoring mode of the TCM layer
               proactive-delay-measurement-enabled leaf enable/disable proactive Delay Measurement for TCM
               tcm-direction leaf Direction of TCM.
               tim-act-enabled leaf Enables TTI Mismatch consequent actions.
               tim-detect-mode leaf tim detect mode leaf
               tx-dapi leaf The provisioned 15 character transmit trace DAPI. Implementations shall add the [0] field automatically per ITU-T G.709
               tx-operator leaf The provisioned 32 character Operator Specific field
               tx-sapi leaf The provisioned 15 character transmit trace SAPI. Implementations shall add the [0] field automatically per ITU-T G.709
            tim-act-enabled leaf Enables TTI Mismatch consequent actions.
            tim-detect-mode leaf tim detect mode leaf
            tx-dapi leaf The provisioned 15 character transmit trace DAPI. Implementations shall add the [0] field automatically per ITU-T G.709
            tx-operator leaf The provisioned 32 character Operator Specific field
            tx-sapi leaf The provisioned 15 character transmit trace SAPI. Implementations shall add the [0] field automatically per ITU-T G.709
         otu-service-rate leaf OTU Rate of the requested service
         project-id leaf Project identifier for the service end point
         project-note leaf Additional details associated with the service end point project
         router container Needed for communication with DWDM pluggable
            ip-address leaf Router IP Address. This is reported against the service, but may not get reflected in the service in the network.
            node-id leaf Node id. This is reported against the service, but may not get reflected in the service in the network.
            url leaf URL needed for communication with DWDM pluggable. This is reported against the service, but may not get reflected in the service in the network.
         rx-direction container port lgx tail
            lgx container lgx-device-name lgx-port-name lgx-port-rack lgx-port-shelf
               lgx-device-name leaf OID: /versioned-service-list/services/service-z-end/rx-direction/lgx/lgx-device-name
               lgx-port-name leaf OID: /versioned-service-list/services/service-z-end/rx-direction/lgx/lgx-port-name
               lgx-port-rack leaf OID: /versioned-service-list/services/service-z-end/rx-direction/lgx/lgx-port-rack
               lgx-port-shelf leaf OID: /versioned-service-list/services/service-z-end/rx-direction/lgx/lgx-port-shelf
            port container From the device model perspective the port-device-name plus the port-circuit-pack-name plus the port-name uniquely identifies the port. From the network model perspective the openroadm-topology-ref plus port-device-name plus port-name uniquely identify th...
               port-circuit-pack-name leaf OID: /versioned-service-list/services/service-z-end/rx-direction/port/port-circuit-pack-name
               port-device-name leaf OID: /versioned-service-list/services/service-z-end/rx-direction/port/port-device-name
               port-name leaf OID: /versioned-service-list/services/service-z-end/rx-direction/port/port-name
               port-rack leaf OID: /versioned-service-list/services/service-z-end/rx-direction/port/port-rack
               port-shelf leaf OID: /versioned-service-list/services/service-z-end/rx-direction/port/port-shelf
               port-slot leaf OID: /versioned-service-list/services/service-z-end/rx-direction/port/port-slot
               port-sub-slot leaf OID: /versioned-service-list/services/service-z-end/rx-direction/port/port-sub-slot
               port-type leaf OID: /versioned-service-list/services/service-z-end/rx-direction/port/port-type
            tail container tail-roadm xponder-port tail-roadm-port-aid tail-roadm-port-rack-location
               tail-roadm container ROADM on which the transponder is connected to (TID, IP Address, or FQDN)
               tail-roadm-port-aid leaf This will provide the transponder port needed to inter-city ROADM connection
               tail-roadm-port-rack-location leaf Transponder's location
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               xponder-port container Muxponder port used in tail, that will get used as a service endpoint.
                  circuit-pack-name leaf OID: /versioned-service-list/services/service-z-end/rx-direction/tail/xponder-port/circuit-pack-name
                  port-name leaf OID: /versioned-service-list/services/service-z-end/rx-direction/tail/xponder-port/port-name
         service-format leaf Format of the requested service: Ethernet, OTU, etc.
         service-rate leaf Rate of the requested service in GBps
         tx-direction container port lgx tail
            lgx container lgx-device-name lgx-port-name lgx-port-rack lgx-port-shelf
               lgx-device-name leaf OID: /versioned-service-list/services/service-z-end/tx-direction/lgx/lgx-device-name
               lgx-port-name leaf OID: /versioned-service-list/services/service-z-end/tx-direction/lgx/lgx-port-name
               lgx-port-rack leaf OID: /versioned-service-list/services/service-z-end/tx-direction/lgx/lgx-port-rack
               lgx-port-shelf leaf OID: /versioned-service-list/services/service-z-end/tx-direction/lgx/lgx-port-shelf
            port container From the device model perspective the port-device-name plus the port-circuit-pack-name plus the port-name uniquely identifies the port. From the network model perspective the openroadm-topology-ref plus port-device-name plus port-name uniquely identify th...
               port-circuit-pack-name leaf OID: /versioned-service-list/services/service-z-end/tx-direction/port/port-circuit-pack-name
               port-device-name leaf OID: /versioned-service-list/services/service-z-end/tx-direction/port/port-device-name
               port-name leaf OID: /versioned-service-list/services/service-z-end/tx-direction/port/port-name
               port-rack leaf OID: /versioned-service-list/services/service-z-end/tx-direction/port/port-rack
               port-shelf leaf OID: /versioned-service-list/services/service-z-end/tx-direction/port/port-shelf
               port-slot leaf OID: /versioned-service-list/services/service-z-end/tx-direction/port/port-slot
               port-sub-slot leaf OID: /versioned-service-list/services/service-z-end/tx-direction/port/port-sub-slot
               port-type leaf OID: /versioned-service-list/services/service-z-end/tx-direction/port/port-type
            tail container tail-roadm xponder-port tail-roadm-port-aid tail-roadm-port-rack-location
               tail-roadm container ROADM on which the transponder is connected to (TID, IP Address, or FQDN)
               tail-roadm-port-aid leaf This will provide the transponder port needed to inter-city ROADM connection
               tail-roadm-port-rack-location leaf Transponder's location
                  node-id leaf Node Id is a globally unique identifier for a device. Same as leafref value in model, if applicable.
               xponder-port container Muxponder port used in tail, that will get used as a service endpoint.
                  circuit-pack-name leaf OID: /versioned-service-list/services/service-z-end/tx-direction/tail/xponder-port/circuit-pack-name
                  port-name leaf OID: /versioned-service-list/services/service-z-end/tx-direction/tail/xponder-port/port-name
         user-label leaf Label for service endpoint, defined by the user
      sla-id leaf Service Level Agreement
      soft-constraints container customer-code co-routing-or-general
         co-routing-or-general choice general co-routing
            co-routing case co-routing
               co-routing container existing-service
                  existing-service leaf-list Diverse from existing services identified by facility CLFI
            general case diversity exclude include latency hop-count TE-metric distance
               distance container Maximum distance allowed
                  max-distance leaf OID: /versioned-service-list/services/soft-constraints/co-routing-or-general/general/distance/max-distance
               diversity container existing-service existing-service-applicability
                  existing-service leaf-list Diverse from existing services identified by facility CLFI
                  existing-service-applicability container site node srlg link equipment
                     equipment container Equipment Diversity Contraints
                        roadm-srg leaf ROADM shared-risk-group diversity
                        xponder-srg leaf xponder eqpt-srg-id diversity
                     link leaf OID: /versioned-service-list/services/soft-constraints/co-routing-or-general/general/diversity/existing-service-applicability/link
                     node leaf OID: /versioned-service-list/services/soft-constraints/co-routing-or-general/general/diversity/existing-service-applicability/node
                     site leaf OID: /versioned-service-list/services/soft-constraints/co-routing-or-general/general/diversity/existing-service-applicability/site
                     srlg leaf OID: /versioned-service-list/services/soft-constraints/co-routing-or-general/general/diversity/existing-service-applicability/srlg
               exclude container fiber-bundle srlg-id site node-id link-identifier supporting-service-name
                  fiber-bundle leaf-list OID: /versioned-service-list/services/soft-constraints/co-routing-or-general/general/exclude/fiber-bundle
                  link-identifier list Refers to link-id(s) from the network model. The openroadm-topology-ref + link-id identifies the link in the network model.
                     link-id leaf link-id from the network model.