ordmodels/device/src/main/yang/org-openroadm-database@2016-10-14.yang

   1 module org-openroadm-database {
   2   namespace "http://org/openroadm/database";
   3   prefix org-openroadm-database;
   4
   5   import org-openroadm-common-types {
   6     prefix org-openroadm-common-types;
   7   }
   8
   9   organization "Open ROADM MSA";
  10   contact
  11     "OpenROADM.org";
  12   description
  13     "This module contains definitions for System Management.
  14
  15      Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  16      AT&T Intellectual Property.  All other rights reserved.
  17
  18      Redistribution and use in source and binary forms, with or without modification,
  19      are permitted provided that the following conditions are met:
  20
  21      * Redistributions of source code must retain the above copyright notice, this
  22        list of conditions and the following disclaimer.
  23      * Redistributions in binary form must reproduce the above copyright notice,
  24        this list of conditions and the following disclaimer in the documentation and/or
  25        other materials provided with the distribution.
  26      * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  27        contributors may be used to endorse or promote products derived from this software
  28        without specific prior written permission.
  29
  30      THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  31      AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  32      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  33      IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  34      INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  35      NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  36      OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  37      WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  38      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  39      POSSIBILITY OF SUCH DAMAGE.";
  40
  41   revision 2016-10-14 {
  42     description
  43       "Version 1.2";
  44   }
  45
  46   rpc db-backup {
  47     description
  48       "copy  running DB to user provided file to a given path";
  49     input {
  50       leaf filename {
  51         type string {
  52           length "10..255";
  53         }
  54         description
  55           "Path and file name is used with back-up.(xxx.DBS)";
  56       }
  57     }
  58     output {
  59       uses org-openroadm-common-types:rpc-response-status;
  60     }
  61   }
  62   rpc db-restore {
  63     description
  64       "Restore database ";
  65     input {
  66       leaf filename {
  67         type string {
  68           length "10..255";
  69         }
  70         description
  71           "PATH/file name use file name.(xxx.DBS)";
  72       }
  73       leaf nodeIDCheck {
  74         type boolean;
  75         default "true";
  76         description
  77           "Flag to indicate if sysNameCheck is required";
  78       }
  79     }
  80     output {
  81       uses org-openroadm-common-types:rpc-response-status;
  82     }
  83   }
  84   rpc db-activate {
  85     description
  86       "activate the database";
  87     input {
  88       leaf rollBackTimer {
  89         type string;
  90         description
  91           "rollbackTimer ";
  92       }
  93     }
  94     output {
  95       uses org-openroadm-common-types:rpc-response-status;
  96     }
  97   }
  98   rpc cancel-rollback-timer {
  99     description
 100       "Cancel roll back timer which user provisioned as part of activate command";
 101     input {
 102       leaf accept {
 103         type boolean;
 104         description
 105           " TRUE means rollback timer is cancelled and new load is accepted";
 106       }
 107     }
 108     output {
 109       uses org-openroadm-common-types:rpc-response-status;
 110     }
 111   }
 112   rpc database-init {
 113     description
 114       "Initialize the database to default DB";
 115     output {
 116       uses org-openroadm-common-types:rpc-response-status;
 117     } //output
 118   }
 119 }