netconfcentral logo

org-openroadm-optical-channel-interfaces

HTML

org-openroadm-optical-channel-interfaces@2020-05-29



  module org-openroadm-optical-channel-interfaces {

    yang-version 1;

    namespace
      "http://org/openroadm/optical-channel-interfaces";

    prefix
      org-openroadm-optical-channel-interfaces;

    import org-openroadm-device {
      prefix org-openroadm-device;
      revision-date "2020-05-29";
    }
    import org-openroadm-interfaces {
      prefix openROADM-if;
      revision-date "2019-11-29";
    }
    import org-openroadm-common-link-types {
      prefix
        org-openroadm-common-link-types;
      revision-date "2019-11-29";
    }
    import org-openroadm-common-optical-channel-types {
      prefix
        org-openroadm-common-optical-channel-types;
      revision-date "2020-05-29";
    }
    import org-openroadm-optical-operational-interfaces {
      prefix
        org-openroadm-optical-operational-interfaces;
      revision-date "2020-05-29";
    }

    organization "Open ROADM MSA";

    contact "OpenROADM.org";

    description
      "YANG definitions for device facility och interfaces.

     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.

     Also contains code components extracted from IETF Interfaces.  These code components
     are copyrighted and licensed as follows:

     Copyright (c) 2016 IETF Trust and the persons identified as the document authors.
     All rights reserved.

     This document is subject to BCP 78 and the IETF Trust’s Legal Provisions Relating
     to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of
     publication of this document. Please review these documents carefully, as they
     describe your rights and restrictions with respect to this document. Code Components
     extracted from this document must include Simplified BSD License text as described in
     Section 4.e of the Trust Legal Provisions and are provided without warranty as
     described in the Simplified BSD License.";

    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-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 och-attributes {
      description
        "Optical Channel attributes";
      leaf provision-mode {
        type org-openroadm-common-optical-channel-types:provision-mode-type;
        default "explicit";
        description
          "The provision-mode specified by the controller. Default to 'explicit' (ie, the set of optical parameter specified in MSA Optical Spec).
         The 'profile' provision-mode is introduced in MSA 5.0 to support the bookended xponder application";
      }

      leaf rate {
        when
          "../provision-mode = 'explicit'";
        type identityref {
          base org-openroadm-common-optical-channel-types:och-rate-identity;
        }
        description "rate";
      }

      leaf frequency {
        type org-openroadm-common-optical-channel-types:frequency-THz;
        description
          "Center Frequency in THz.";
      }

      leaf width {
        when
          "../provision-mode = 'explicit'";
        type org-openroadm-common-optical-channel-types:frequency-GHz;
        config false;
        description
          "Frequency width in GHz.";
      }

      leaf modulation-format {
        when
          "../provision-mode = 'explicit'";
        type org-openroadm-common-optical-channel-types:modulation-format;
        description "Modulation format";
      }

      leaf transmit-power {
        type org-openroadm-common-link-types:power-dBm;
        description
          "The target transmit power for this channel. When set, the xponder will work to ensure that port-current-power reaches this level. Applicable only to channel on top of xpdr-network port";
      }

      leaf optical-operational-mode {
        type string;
        description
          "Optical-operational-mode sets the xponder settings based on one of the operational mode capabilities as published by the device.  This attribute is mandatory when the provision-mode is set to profile.";
      }

      container operational-mode-params {
        when "../provision-mode = 'profile'";
        config false;
        description
          "The container containing the optical parameters for the specified operational mode.";
        uses org-openroadm-optical-operational-interfaces:optical-operational-modes-grp-attr;
      }  // container operational-mode-params
    }  // grouping och-attributes

    grouping och-container {
      description "OCH container group";
      container och {
        description
          "Optical Channel (OCh):
         Models the optical channel interfaces for an Optical White Box.";
        uses och-attributes;
      }  // container och
    }  // grouping och-container

    augment /org-openroadm-device:org-openroadm-device/org-openroadm-device:interface {
      when
        "org-openroadm-device:type = 'openROADM-if:opticalChannel'";
      description
        "augment for optical channel container";
      uses och-container;
    }
  }  // module org-openroadm-optical-channel-interfaces

Summary

  
  
Organization Open ROADM MSA
  
Module org-openroadm-optical-channel-interfaces
Version 2020-05-29
File org-openroadm-optical-channel-interfaces.yang
  
Prefix org-openroadm-optical-channel-interfaces
Namespace http://org/openroadm/optical-channel-interfaces
  
Cooked /cookedmodules/org-openroadm-optical-channel-interfaces/2020-05-29
YANG /src/org-openroadm-optical-channel-interfaces@2020-05-29.yang
XSD /xsd/org-openroadm-optical-channel-interfaces@2020-05-29.xsd
  
Abstract YANG definitions for device facility och interfaces. Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016, A...
  
Contact
OpenROADM.org

Description

 
YANG definitions for device facility och interfaces.

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.

Also contains code components extracted from IETF Interfaces.  These code components
are copyrighted and licensed as follows:

Copyright (c) 2016 IETF Trust and the persons identified as the document authors.
All rights reserved.

This document is subject to BCP 78 and the IETF Trust’s Legal Provisions Relating
to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents carefully, as they
describe your rights and restrictions with respect to this document. Code Components
extracted from this document must include Simplified BSD License text as described in
Section 4.e of the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.

Groupings

Grouping Objects Abstract
och-attributes provision-mode rate frequency width modulation-format transmit-power optical-operational-mode operational-mode-params Optical Channel attributes
och-container och OCH container group