Chat now with support
Chat with Support

NetVault Plug-in for MySQL 13.2 - User Guide

Introducing NetVault Plug-in for MySQL Installing and removing the plug-in Configuring the plug-in Backing up data Restoring data
Restoring data: an overview Restoring data Using advanced restore procedures for MySQL Standard/Community
Working with native MySQL replication Using the plug-in in a Failover Cluster environment Troubleshooting

Configuring default settings

Plug‑in for MySQL supports multiple MySQL Instances from a single MySQL Server, and each individual instance must be configured for use. The configuration options available vary, based on the OS in use on the MySQL Server and whether you use the MySQL Standard/Community option or MySQL Enterprise Backup option, MariaDB Server option, or MariaDB Server MariaDB-Backup option.

1
In the Navigation Pane, click Create Backup Job, and click Create New next to the Selections list.
2
In the selection tree, open the applicable client node.
3
Click Plug‑in for MySQL, and select Add New Server from the context menu.
4
On the Configure dialog box, complete the applicable fields:
•
MySQL Instance Name (required): Enter the applicable name for the instance of MySQL; by default, the local host name is used. This value is used in the NetVault WebUI. Quest strongly recommends that you use a generic name for the MySQL Instance instead of using a name associated with the machine on which the instance resides. This generic name improves portability and policy management across all affected clients.
For example, if the local host name is test_mysql_01_machine, and the suggested name for the MySQL Instance is the same, change the name for the instance to something such as local_mysql_server. You can then use the instance name, local_mysql_server, when you configure the instance for each client. Therefore, the instance name on all clients is local_mysql_server.
•
MySQL Edition (required): Select the applicable option: MySQL Standard/Community, MySQL Enterprise Backup, MariaDB Server, or MariaDB Server MariaDB-Backup option. The version that you are using determines which options are modifiable on this dialog box.
•
Username and Password (required): Enter the user name and password. Use an account that allows sufficient rights to read and write to the tables in the MySQL Instance’s database that is to be targeted for backup and restore, for example, an account with administrator privileges.
The user identified by Username and Password, is required to have at least the following MySQL or MariaDB privileges:
For Mysqldump and Mariadb-dump utilities:
•
SELECT, SHOW VIEW, TRIGGER, LOCK TABLES, PROCESS, RELOAD, FLUSH_TABLES, CREATE, and ALTER
For Mysqlbackup utility:
•
SELECT, BACKUP_ADMIN, RELOAD, SUPER, REPLICATION CLIENT, PROCESS, LOCK TABLES, DROP, and FILE
•
CREATE, INSERT, DROP, and UPDATE on the tables mysql.backup_progress and mysql.backup_history
 
•
SELECT and ALTER on mysql.backup_history
For Mariadb-backup utility:
•
SELECT, RELOAD, PROCESS, LOCK TABLES, and BINLOG MONITOR
CREATE, INSERT ON mysql.*
* 
IMPORTANT: Additional privileges could be required depending on backup contents, and backup method. Refer to MySQL Server Documentation and MariaDB Server Documentation for a complete list of requirements and privileges.
* 
IMPORTANT: NetVault references Username and Password values each time it attempts to access the MySQL database for a selected instance, that is, for both backups and restores. If either of these values is changed for the MySQL Instance, it must be updated in these fields; otherwise, NetVault cannot access the instance and job requests fail.
•
MySQL Base Directory (required): Enter the complete path to the base directory where the MySQL program files reside.
•
Windows-based Server: To locate the directory on Windows, query the Windows Registry for the “Location” value.
•
Linux-or UNIX-based Server: With a default installation of MySQL, the directory is located as follows:
"/var/lib/mysql"
•
MySQL Bin Directory: Enter the complete path to the directory that contains the MySQL executable files on the MySQL Server. By default, the directory is as follows:
•
Linux- or UNIX-based Server:
"<MySQLbaseDirectory>/bin"
•
Windows-based Server:
"<MySQLbaseDirectory>\bin"
 
* 
NOTE: The default path for the mysqlbackup utility varies depending on your environment and on whether you have customized the location. For example, with the Ubuntu 14 deb package, the utility is installed in /usr/bin/mysqlbackup by default.
•
Mysqldump Path or Mariadb-dump Path: Enter the complete path and filename for the mysqldump or mariadb-dump utility, which is used during the backup and restore process. If a default installation of MySQL was performed for the target instance, the default value might appear based on the OS in use on the MySQL Server:
•
Linux- or UNIX-based Server:
"<MySQLbaseDirectory>/bin/mysqldump"
•
Windows-based Server:
"<MySQLbaseDirectory>\bin\mysqldump.exe"
 
* 
IMPORTANT: If either the MySQL Bin Directory or the mysqldump path is set to the defaults listed earlier, the field can be left blank.
•
TCP Port (for Windows-based servers only): Each instance of MySQL requires its own port value for proper access. Default installations of MySQL use port 3306, which is displayed in this field by default. If a different port has been set up for the selected instance, enter the correct value.
 
* 
IMPORTANT: If multiple instances exist on a single MySQL Server, each is assigned its own port value, and this value must be entered in the Port Number field. This value is equivalent to what is revealed for the “port=” value, as found in the “my.ini” file for each instance.
•
Socket File Path (for Linux- and UNIX-based servers only): Enter the path and filename of the MySQL socket file. If a default installation of MySQL was performed, a default value is displayed in this field. By default, the socket file is located in the following directory:
"/tmp/mysql.sock"
 
* 
IMPORTANT: If a standard installation of MySQL was performed on the MySQL Server and the default directory was used, the Socket File path should remain at its default setting. However, if a different directory was selected during installation, enter the correct location in this field. To determine this path, issue the following command from a terminal session prompt on the MySQL Server:

“ show variables like ‘socket’ ”

If the correct Socket File variable is not entered, the plug-in does not perform backups and restores.
•
Default Character Set: The default character set is latin1. If you want to use a different character set for encoding, such as UTF-8, select it from the list.
5
If you are using MySQL Standard/Community, complete the following fields:
•
MyISAM Backup Method: If your environment uses the MyISAM storage engine or table type, select this check box, and then select the applicable suboption.
•
Lock & Copy Table Files (default selection): To use the standard method of locking, flushing, and copying the table files, select this option.
 
* 
TIP: The plug-in uses the MySQL “--single-transaction” option for InnoDB tables; however, MyISAM does not support this option. This option is useful when used with transactional tables, such as InnoDB; it is not useful with other types of tables, such as MyISAM. When the plug-in completes a Full Backup, it requires a consistent state for all table types in the targeted MySQL Instance. Also, the backup job runs mysqldump for each table that is backed up, which means that all tables are not backed up at the same time. This backup method ensures that you can select specific database objects to restore, if necessary, instead of restoring the full MySQL Instance.

If you prefer to use an online approach, in which tables are not locked to prevent updates, consider using a MySQL replication environment. In that environment, database users interact with the master MySQL Server, on which no tables are ever locked. The backups are taken from the slave MySQL Server. During the backup process, replication updates from the master server are paused until the backup is finished. For more information about using the plug-in with a replication setup, see Working with native MySQL replication.
•
Mysqldump: If the tables are subject to heavy use or loading, select this option to use the mysqldump utility instead of copying the tables. This setting might affect performance.
•
Enable MySQL Replication: If native MySQL Replication is enabled for this instance, select this check box. For more information, see Working with native MySQL replication.
•
Slave Instance: For replication-enabled instances, select this option if this instance is configured as a slave.
•
Master Instance: For replication-enabled instances, select this option if this instance is configured as the master.
 
* 
IMPORTANT: Do not select this option if you do not intend to configure replication; otherwise, backups fail.
•
Enable Point-In-Time Recovery: If you want to enable PIT backups and restores, select this check box. This setting lets you perform a recovery up to a point before, or after, data corruption occurs. To use this feature, enable the MySQL Binary Log as outlined in Enabling the Binary Log on the MySQL Server (Standard/Community option only).
•
Binary Log Index Path: If you selected the Enable Point in Time Recovery check box, use this field to specify the complete path to the Binary Log Index file. By default, the path and file are as follows:
•
Linux- or UNIX-based server:
<MySQLbaseDirectory>/data/<instanceName>-bin.index
•
Windows-based server:
<MySQLbaseDirectory>\data\<instanceName>-bin.index
 
* 
IMPORTANT: The plug-in is able to determine if a specified file in the Binary Log Index Path exists during configuration. However, it is unable to determine if the file specified is actually the Binary Log Index until the backup job is submitted. If it determines that the specified file is invalid, the job fails.
•
Relay Log Index Path: If you are configuring a Slave Instance, enter the complete path to the Relay Log Index file to include it in backups.
•
Linux- or UNIX-based server:
<MySQLbaseDirectory>/data/<instanceName>-relay-bin.index
•
Windows-based server:
<MySQLbaseDirectory>\data\<instanceName>-relay-bin.index
6
If you are using MySQL Enterprise Backup, complete the required Mysqlbackup Pathor Mariadb-backup Path field by entering the complete path to the directory where the mysqlbackup utility resides.
For Linux environments, Quest recommends that you use the NetVault script, .sh files, instead of running the mysqlbackup utility.
For example, if you are using Linux, the default paths to the .sh files include:
•
For MySQL Enterprise Backup 8.0: /usr/netvault/plugins/mysql/mysqlbackup-8.0.sh
 
* 
NOTE: If you choose to use the utility instead of the .sh files, be aware that the default path for the mysqlbackup utility varies depending on your environment and on whether you have customized the location. For example, with the Ubuntu 14 deb package, the utility is installed in /usr/bin/mysqlbackup by default.
For Windows environments, you can use the mysqlbackup utility.
7
If you are using MariaDB Server MariaDB-Backup, complete the required Mysqlbackup or Mariadb-backup Path field by entering the complete path to the directory where the Mariadb-backup utility resides.
8
If you are running MySQL Enterprise Backup (MEB), and Transparent Data Encryption (TDE) has been enabled in the MySQL instance, select the option Server uses Transparent Data Encryption. A user provided key can be entered in the Transparent Data Encryption Password field. If entered, the user provided password would be send to the MySQL Server to be used to encrypt the keyring data file that is included in the meta folder of the backup. If user provided password is entered, the same password would have to be used in the backup and in the restore. If the MySQL Server is using the keyring_encrypted_file plugin or the component_keyring_encrypted_file component the user provided password is used to provide the keyring file encryption password that has been set on the MySQL Server.
 
* 
NOTE: Transparent Data Encryption (TDE) only applies to MySQL Enterprise Backup (MEB). For more details, refer to the MySQL Documentation.

To save the settings, click OK.

Updating the configuration of an existing instance

After an instance of MySQL has been successfully configured and added to the plug-in for use, you can edit its configuration options by performing the following steps:

1
In the Navigation Pane, click Create Backup Job, and click Create New next to the Selections list.
2
In the selection tree, open the applicable client node.
3
Open the Plug‑in for MySQL node.
4
Click the applicable instance, and select Configure from the context menu.
The Configure dialog box is displayed with all previous settings revealed, allowing you to make any necessary modifications.
 
* 
IMPORTANT: In the Edit version, the MySQL Instance Name field is disabled. This field is for information only and displays the name of the selected instance.

Setting default actions for error conditions (optional)

MySQL backup jobs typically include multiple storage engines, databases, and tables. Occasionally during the execution of a backup job, an unsupported storage engine is encountered or a database or table is inaccessible. If this situation is encountered, it prevents one or more items from being backed up successfully, but the remaining items selected in the backup job are backed up. A MySQL DBA must determine what action should be taken when these conditions are encountered:

•
Should the backup job complete with warnings, complete without warnings, or fail?
•
Should the backup of items that completed successfully be retained or discarded?

The plug-in lets you set default options for backup and restore jobs. You can override these options on a per-job basis.

1
In the Navigation pane, click Change Settings.
2
On the Configuration page, click Server Settings or Client Settings, as applicable.
3
If you selected Client Settings, select the applicable client, and click Next.
4
On the NetVault Server Settings or Client Settings page, click Plugin Options.
In the Plug‑in for MySQL section, the following items are listed:
•
Locked Table: This issue occurs when a table selected for inclusion in the backup is locked by a client session other than the plug-in.
•
Manually Selected Table Unavailable: This issue occurs when an individual table is unavailable for backup for any reason,  such as being dropped since the backup job was defined
•
Manually Selected Database Unavailable: This issue occurs when an individual database is unavailable for backup for any reason, such as being dropped since the backup job was defined
•
Unsupported Storage Engine: This issue occurs when a table is encountered during the backup that has a type of storage engine that the plug-in does not support.
5
For each of these conditions, select one of the following settings:
•
Complete with Warnings — Saveset Retained: The job returns a status of “Backup Completed with warnings” and a backup saveset is created that includes the items that were successfully backed up.
•
Complete without Warnings — Saveset Retained: The job completes and returns a status of “Backup Completed.” The errors are logged in the NetVault binary logs and ignored on the Job Status page. A backup saveset is created that includes the items that were backed up.
•
Fail — Saveset Retained: The job returns a status of “Backup Failed.” However, a backup saveset is generated that includes the items that were successfully backed up.
•
Fail — No Saveset Retained: The job returns a status of “Backup Failed” and no saveset of backed-up objects is kept. That is, even if some of the objects were successfully backed up, the saveset is discarded.
 
* 
IMPORTANT: You can override the selected default action selected at the individual backup job level.
6
To save the settings, click Apply.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating