Restore How

Table of contents
  1. 1. Restore How
    1. 1.1. Copy Plugin Parameters

Restore How

The Restore How lets you set some operational details for the restore. If you have set the global settings appropriately in the Site Settings page, you can just use the default values for the controls on this page.


Temporary Directory
ZMC creates temporary files and directories during restore on ZRM server or MySQL & MariaDB server depending on the backup method used.  Disk space usage and default values of this parameter are discussed  here.
MySQL Shutdown Options
The 'MySQL Shutdown' radio buttons let you specify whether the MySQL server should shut down during the restore process.

The options are:

  • Stop if required - MySQL server will be shutdown only for Full raw backup restoration.
  • Stop - MySQL server will be shutdown before files are restored. MySQL server will not be shutdown in case of Full logical backup restoration and incremental log backup restoration.
  • Don't stop - MySQL server will not be shutdown.  This option is not recommended for full raw backup restoration.
Restore replication files
Set this parameter if you are restoring a backup taken from one replication slave to another MySQL server to create a new slave. You can set the parameter to restore all files (, relay-bin.log files, SQL_LOAD*) or restore only file or none of the replication files.

The relay-bin.log are not restored when incremental backups are restored.  When the replication is restarted, the slave will start replicating from the full backup timestamp from the master.  You can replay the replication logs to the time of incremental backup by running the following commands from the master server:

mysqlbinlog <backup-directory>/slave-log | mysql -h <slave-machine>

Copy Plugin Parameters


If performing a restore to a remote MySQL server, specify the mechanism used to transfer files between the local ZMC server and the remote MySQL server. The recommended location for plugins is the /usr/share/mysql-zrm/pluginsdirectory.

Copy Option
Lets you select whether to use a Copy Plugin during the restore process. Set the 'Copy' radio button to Yes to opt for the Copy plugin. If the 'No' option of Copy is selected then rest of the input boxes in the panel can be ignored.

This plugin uses the Secure Shell protocol to transfer files between the MySQL server and the ZRM server. Since SSH is being used, the data transfer is secure. Unless you have set up SSH keys for the MySQL restore user, you will be prompted for a password when restoring from the backup set.
SSH User
SSH user name
Remote MySQL Binary path
Specify the path on the remote MySQL server under either of the two options.

The socket based plugin is called The socket copy plugin requires MySQL ZRM socket server package to be installed on all MySQL servers. The socket-server package installs xinetd/inetd socket server service and restarts xinetd/inetd.

The socket copy plugin uses the TCP protocol to transfer data between the MySQL server the ZRM server. It uses port 25300 by default on the MySQL server. You can change the port using the field displayed after you select the socket copy plugin.

Socket Remote Port

Enter the port you wish to use.

Remote MySQL Binary Path

Specify the path on the remote MySQL server where the MySQL binary commands are installed.

The Windows copy plugin is required for restoring any Windows-based MySQL server. It requires the ZRM for MySQL& MariaDB Windows client components described in the Installation Instructions. You must then enter the communications ports to use during restore (default is 10081) operations, and the retry count.

The retry count specifies the number of times ZRM will attempt to restore a raw backup in case shutting down the MySQL server takes more time than expected. Hence ZRM will only attempt to retry for the restore of the very first file that is attempted to be restored. The default value is 2.


Clicking the Next Step button  at the bottom takes you to the Run Restore page.