ordmodels/src/main/yang/org-openroadm-maintenance-testsignal.yang

   1 module org-openroadm-maintenance-testsignal {
   2   namespace "http://org/openroadm/maintenance-testsignal";
   3   prefix org-openroadm-maint-testsignal;
   4
   5   organization "Open ROADM MSA";
   6   contact
   7     "OpenROADM.org";
   8   description
   9     "YANG definitions for maintenance testsignal.
  10
  11      Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  12      AT&T Intellectual Property.  All other rights reserved.
  13
  14      Redistribution and use in source and binary forms, with or without modification,
  15      are permitted provided that the following conditions are met:
  16
  17      * Redistributions of source code must retain the above copyright notice, this
  18        list of conditions and the following disclaimer.
  19      * Redistributions in binary form must reproduce the above copyright notice,
  20        this list of conditions and the following disclaimer in the documentation and/or
  21        other materials provided with the distribution.
  22      * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  23        contributors may be used to endorse or promote products derived from this software
  24        without specific prior written permission.
  25
  26      THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  27      AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  28      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  29      IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  30      INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  31      NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  32      OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  33      WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35      POSSIBILITY OF SUCH DAMAGE.";
  36
  37   revision 2016-10-14 {
  38     description
  39       "Version 1.2";
  40   }
  41
  42   grouping maint-testsignal {
  43     container maint-testsignal {
  44       leaf enabled {
  45         type boolean;
  46         default "false";
  47         description
  48           "testsignal enabled flag";
  49       }
  50       leaf testPattern {
  51         when "../enabled = 'true'";
  52         type enumeration {
  53           enum "PRBS" {
  54             value 0;
  55             description
  56               "Unframed, inverted PN-31 pattern or PRBS31 pattern per IEEE 802.3 clause 50.3.8.2 (inverted PN-31at line rate)";
  57           }
  58           enum "PRBS31" {
  59             value 1;
  60             description
  61               "PRBS31 with standard mapping per G.709";
  62           }
  63           enum "PRBS23" {
  64             value 2;
  65             description
  66               "SONET/SDH Framed,inverted PN-23 pattern.";
  67           }
  68           enum "PRZEROS" {
  69             value 3;
  70             description
  71               "pseudo-random with zeros data pattern per IEEE 802.3 clause 49.2.8";
  72           }
  73           enum "IDLE" {
  74             value 4;
  75             description
  76               "Scrambled IDLE test-pattern per IEEE 802.3ba";
  77           }
  78         }
  79         description
  80           "Set test signal pattern";
  81       }
  82       leaf type {
  83         when "../enabled = 'true'";
  84         type enumeration {
  85           enum "fac" {
  86             value 0;
  87             description
  88               "test signal in the facility direction";
  89           }
  90           enum "term" {
  91             value 1;
  92             description
  93               "test signal in the terminal direction";
  94           }
  95         }
  96         default "fac";
  97         description
  98           "Set test signal type (or direction).";
  99       }
 100       leaf bitErrors {
 101         when "../enabled = 'true' and ../type = 'fac'";
 102         type uint32 {
 103           range "0..4294967295";
 104         }
 105         config false;
 106         description
 107           "bit errors for test signal in facility direction.";
 108       }
 109       leaf bitErrorsTerminal {
 110         when "../enabled = 'true' and ../type = 'term'";
 111         type uint32 {
 112           range "0..4294967295";
 113         }
 114         config false;
 115         description
 116           "bit errors for test signal in terminal direction.";
 117       }
 118       leaf syncSeconds {
 119         when "../enabled = 'true' and ../type = 'fac'";
 120         type string;
 121         config false;
 122         description
 123           "number of seconds the received facility test signal is in sync.";
 124       }
 125       leaf syncSecondsTerminal {
 126         when "../enabled = 'true' and ../type = 'term'";
 127         type string;
 128         config false;
 129         description
 130           "number of seconds the received terminal test signal is in sync.";
 131       }
 132     }
 133   }
 134 }