module org-openroadm-database {

    yang-version 1;

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

    prefix org-openroadm-database;

    import org-openroadm-common-types {
      prefix org-openroadm-common-types;
      revision-date "2024-05-31";
    }

    organization "Open ROADM MSA";

    contact "OpenROADM.org";

    description
      "This module contains definitions for System Management.

     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 "2024-05-31" {
      description "Version 15.1";
    }

    revision "2024-03-29" {
      description "Version 15.0";
    }

    revision "2023-12-08" {
      description "Version 14.1";
    }

    revision "2023-09-29" {
      description "Version 14.0";
    }

    revision "2023-05-26" {
      description "Version 13.1";
    }

    revision "2023-03-31" {
      description "Version 13.0";
    }

    revision "2022-12-09" {
      description "Version 12.1";
    }

    revision "2022-09-30" {
      description "Version 12.0";
    }

    revision "2022-05-27" {
      description "Version 11.1";
    }

    revision "2022-03-25" {
      description "Version 11.0";
    }

    revision "2021-12-10" {
      description "Version 10.1";
    }

    revision "2021-09-24" {
      description "Version 10.0";
    }

    revision "2021-05-28" {
      description "Version 9.1";
    }

    revision "2021-03-26" {
      description "Version 9.0";
    }

    revision "2020-12-11" {
      description "Version 8.1";
    }

    revision "2020-09-25" {
      description "Version 8.0";
    }

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


    rpc db-backup {
      description
        "copy  running DB to user provided file to a given path";
      input {
        leaf filename {
          type string {
            length "10..255";
          }
          description
            "Path and file name is used with back-up.(xxx.DBS)";
        }
      }

      output {
        leaf status {
          type rpc-status;
          mandatory true;
          description "Successful or Failed";
        }

        leaf status-message {
          type string;
          description
            "Gives a more detailed status";
        }
      }
    }  // rpc db-backup

    rpc db-restore {
      description "Restore database ";
      input {
        leaf filename {
          type string {
            length "10..255";
          }
          description
            "PATH/file name use file name.(xxx.DBS)";
        }

        leaf nodeIDCheck {
          type boolean;
          default "true";
          description
            "Flag to indicate if sysNameCheck is required";
        }
      }

      output {
        leaf status {
          type rpc-status;
          mandatory true;
          description "Successful or Failed";
        }

        leaf status-message {
          type string;
          description
            "Gives a more detailed status";
        }
      }
    }  // rpc db-restore

    rpc db-activate {
      description "activate the database";
      input {
        leaf rollBackTimer {
          type string;
          description "rollbackTimer ";
        }
      }

      output {
        leaf status {
          type rpc-status;
          mandatory true;
          description "Successful or Failed";
        }

        leaf status-message {
          type string;
          description
            "Gives a more detailed status";
        }
      }
    }  // rpc db-activate

    rpc cancel-rollback-timer {
      description
        "Cancel roll back timer which user provisioned as part of activate command";
      input {
        leaf accept {
          type boolean;
          description
            " TRUE means rollback timer is cancelled and new load is accepted";
        }
      }

      output {
        leaf status {
          type rpc-status;
          mandatory true;
          description "Successful or Failed";
        }

        leaf status-message {
          type string;
          description
            "Gives a more detailed status";
        }
      }
    }  // rpc cancel-rollback-timer

    rpc database-init {
      description
        "Initialize the database to default DB";
      output {
        leaf status {
          type rpc-status;
          mandatory true;
          description "Successful or Failed";
        }

        leaf status-message {
          type string;
          description
            "Gives a more detailed status";
        }
      }
    }  // rpc database-init

    notification db-backup-notification {
      description
        "notification for db-backup operation events.";
      leaf status {
        type rpc-status;
        mandatory true;
        description "Successful or Failed";
      }

      leaf status-message {
        type string;
        description
          "Gives a more detailed status";
      }
    }  // notification db-backup-notification

    notification db-restore-notification {
      description
        "notification for db-restore operation events.";
      leaf status {
        type rpc-status;
        mandatory true;
        description "Successful or Failed";
      }

      leaf status-message {
        type string;
        description
          "Gives a more detailed status";
      }
    }  // notification db-restore-notification

    notification db-activate-notification {
      description
        "notification for database activation events.";
      leaf db-active-notification-type {
        type org-openroadm-common-types:activate-notification-type;
      }

      leaf status {
        type rpc-status;
        mandatory true;
        description "Successful or Failed";
      }

      leaf status-message {
        type string;
        description
          "Gives a more detailed status";
      }
    }  // notification db-activate-notification
  }  // module org-openroadm-database