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