Chat now with support
Chat with Support

NetVault Plug-in for SQL Server 14.0 - User Guide

Introducing NetVault Plug-in for SQL Server Planning your SQL Server deployment Installing and removing the plug-in Configuring the plug-in Backing up data
Defining a backup strategy Understanding snapshot-based backups Reviewing the compression features Performing Online VDI backups Performing VSS backups in SQL Server Example of creating a full VDI backup of an AlwaysOn Availability Group on Windows Removing a SQL Server Instance
Restoring data Using the CLI with the plug-in Troubleshooting

Configuring plug-in options

The settings described in the following topic and subtopics apply to all backup and restore jobs and to individual clients. Additional logon settings are also available; for more information, see Entering logon credentials for all instances on a client and Entering default logon credentials for a specific SQL Server Instance.

1
Access the Configure dialog box.
•
For standalone clients or clients included in an AlwaysOn Availability Group:
a
In the Navigation pane, click Change Settings.
b
Click Server Settings or Client Settings, as applicable.
c
If you selected Client Settings, select the applicable client, and click Next.
d
On the Settings page, click Plugin Options.
e
Locate the Plug‑in for SQL Server section of the dialog box.
•
For Virtual Clients used in a failover cluster:
a
In the Navigation pane, click Create Backup Job, and click Create New next to the Selections list.
b
In the selection tree, open the applicable Virtual Client.
c
Click Plug‑in for SQL Server, and select Configure from the context menu.
2
Complete the applicable steps for your environment:
•
Configuring options for Windows environments
•
Configuring options for Linux environments
Configuring options for Windows environments
1
Complete the applicable fields:
•
Error Encountered During Checksum: SQL Server lets you specify the action that should be taken if an error is encountered when performing checksums on backups and restores. You can specify the default action to take on encountering checksum errors by selecting one of the following two options from the list:
•
Continue after error: This option is the default set during the plug-in installation. With this value selected, the backup or restore job continues in spite of checksum errors.
•
Stop on error: Select this option to set it as the default action. With this value selected, the backup or restore job stops when a checksum error is encountered.
•
New Database Found in Differential/Incremental Backup: This field applies only to Online VDI backups. If a new database is found while performing Transaction Log or Differential Database backups and the Instance Node is selected on the NetVault Selections page, you can ignore it or take a full backup. You can set this action globally for all Transaction Log and Differential Database backups by selecting the applicable action from the list:
•
Do full database backup: This option is the default set during the plug-in installation. Retain this option to perform a full backup of all databases added since the last Full Database backup.
•
Ignore: Select this option to ignore databases created since the last Full Database backup; that is, databases created after the last backup are left out of the Transaction Log or Differential Database backup.
•
Undo file for Standby Restores: For performing Standby Restores, the plug-in requires a temporary Undo File. It is required only when the Action After Restore field is set to With STANDBY.
Specify the directory path for the temporary UNDO.DAT file in this field.
•
Incomplete Backup of ALL Items Selected: The plug-in can do one of the following when this error condition occurs:
•
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.
If either of the following occurs, the plug-in overrides the Incomplete Backup of ALL Items Selected setting and responds as indicated:
•
If a fatal error occurs, the job returns a “Backup Failed” status.
•
If a Partial Database or Differential Partial Database backup is performed on a database whose backup target contains a read-only filegroup, the job returns a “Backup Completed with warnings” status.
•
Media Format during VSS Restores: Enter MTF, CPIO, or Default, or leave the field blank.
•
MTF, Default, or blank: If the backup target is tape-based, the plug-in always uses the MTF format. This behavior is used even if a tape target uses Linux or UNIX. MTF is always acceptable for restoring from a backup produced by this version and recent versions of the plug-in. You do not have to enter this setting. Entering Default or leaving the field blank is the equivalent of entering MTF.
•
CPIO: Do not use this setting unless instructed to do so by Quest Support. Quest might ask you to use this setting to restore a backup created and written to a Linux-based tape target with a previous version of the plug-in.
 
* 
IMPORTANT: Quest recommends that you leave this option blank and let NetVault determine the format to use. Only change this option if you need to override the default format during a restore from tape that failed. For more information, see Troubleshooting.
•
Check SQL Service Agent Status When Restoring msdb Database: If the restore job includes the msdb database, use this option to instruct the plug-in to check the running status of the SQL Server Service Agent. To restore the msdb database and to ensure exclusive access to the database, the SQL Server Service Agent must not be running.
If this option is selected and the restore job includes the msdb database, the plug-in checks the status of the SQL Server Service Agent. If the agent is running, the restore job fails before attempting to restore the msdb database.
If this option is not selected, the plug-in does not check the status of the SQL Server Service Agent, and continues the restore job. The job succeeds if the agent is not running and fails if the agent is running.
•
AlwaysOn Availability Groups Cluster: Use this option to notify the plug-in that your environment consists of AlwaysOn Availability Groups. if AlwaysOn Availability Groups are detected, the plug-in automatically selects this option.
2
To save the settings, click Apply.
3
If you are configuring the clients for an AlwaysOn Availability Group, repeat the preceding steps for each client in the group.

Configuring options for Linux environments

1
Complete the applicable fields:
•
Operating System VDI Client User Name: Enter the name of the OS root user under which the Client should run.
•
Operating System VDI Client User Group: Enter the name of the OS group under which the plug-in client should run. Make sure that you enter the root group to which the root user belongs.
•
VDI Client Library Location: Enter the path to the directory that contains the VDI Client library “libsqlvdi.so” file. The default directory is /opt/mssql/lib.
•
SQL Server ODBC Driver: Enter the name of the Microsoft ODBC Driver that the plug-in should use to connect to and query the SQL Server. For example, for SQL Server 2017 on Linux, Microsoft recommends that you use the default driver, Microsoft ODBC Driver 17 for SQL Server.
•
Sqlcmd Tool Location: Enter the path to the directory that contains the SQL Server sqlcmd utility. The default directory is /opt/mssql-tools/bin.
•
Undo file for Standby Restores: For performing Standby Restores, the plug-in requires a temporary Undo File. It is required only when the Action After Restore field is set to With STANDBY.
Specify the directory path for the temporary UNDO.DAT file in this field.
•
Incomplete Backup of ALL Items Selected: The plug-in can do one of the following when this error condition occurs:
•
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.
If either of the following occurs, the plug-in overrides the Incomplete Backup of ALL Items Selected setting and responds as indicated:
•
If a fatal error occurs, the job returns a “Backup Failed” status.
•
If a Partial Database or Differential Partial Database backup is performed on a database whose backup target contains a read-only filegroup, the job returns a “Backup Completed with warnings” status.
2
To save the settings, click Apply.

Entering logon credentials for all instances on a client

If all instances use the same logon credentials, use this procedure to specify the default credentials. The plug-in also lets you omit the name and password and use the Log on as account information defined for the NetVault Process Manager service.

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.
The client node can be a standalone server or Virtual Client.
3
Double-click Plug‑in for SQL Server.
4
Click the All Instances node, and select Configure from the context menu.
5
Complete the applicable fields:
•
Logon security mode: Based on the Authentication Mode set for the SQL Server Instance, you can specify either a Windows Administrator or a SQL Server Administrator account. To specify a Windows Administrator account, select Windows. For a SQL Server Administrator account, select SQL Server.
 
* 
IMPORTANT: You can only select SQL Server if the SQL Server Authentication Mode is set to Mixed Mode/SQL Authentication.

If you are using a Linux environment, you must enter the SQL Server Administrative (sa) account credentials. If you do not enter the credentials, the plug-in cannot access SQL Server and backup jobs fail.
•
Login Details: Depending on the option selected in the Logon security mode section, provide the appropriate account information in this section:
•
For Windows authentication, provide the following information:
•
Administrator User Name: Specify either a Local or Domain Windows Administrator user name.
•
Password: Enter the password associated with the user specified in the preceding field.
•
Windows Domain: If a Domain Administrator is specified in the Administrator User Name field, enter the name of the domain. You can leave this field blank if a Local Administrator user name is specified.
•
Login Timeout (Seconds) (0=Timeout disabled): This option specifies how long to wait, in seconds, before an instance returns from an attempt to log in to a SQL Server Instance. By default, the timeout value is set to 30 seconds; however, you can change the value during a network delay for a particular SQL Server Instance. The maximum that you can use is 800 seconds. If the value is set to 0, the option is disabled.
•
For SQL Server authentication, provide the following information:
•
Administrator User Name: Specify a SQL Server user with the sysadmin role. If you are using a Linux environment, enter the name for the sa account. The default name is sa.
•
Password: Enter the password associated with the user specified in the preceding field. If you are using a Linux environment, enter the password for the sa account.
•
Login Timeout (Seconds) (0=Timeout disabled): This option specifies how long to wait, in seconds, before an instance returns from an attempt to log in to a SQL Server Instance. By default, the timeout value is set to 30 seconds; however, you can change the value during a network delay for a particular SQL Server Instance. The maximum that you can use is 800 seconds. If the value is set to 0, the option is disabled.
6
To save the settings, click OK.

Configuring an instance at the All Instances level on a client

The Add Instance option in the context menu helps you add an instance under the All Instances node. This option is available if the All Instances node is selected. This option is similar to the Configure option; however, this option lets you specify the exact name of a SQL Server Instance.

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.
The client node can be a standalone server or Virtual Client.
3
Double-click Plug‑in for SQL Server.
4
Click the All Instances node, and select Add Instance from the context menu.
5
Complete the applicable fields:
•
Logon security mode: Based on the Authentication Mode set for the SQL Server Instance, you can specify either a Windows Administrator or a SQL Server Administrator account. To specify a Windows Administrator account, select Windows. For a SQL Server Administrator account, select SQL Server.
 
* 
IMPORTANT: You can only select SQL Server if the SQL Server Authentication Mode is set to Mixed Mode/SQL Authentication.

If you are using a Linux environment, you must enter the SQL Server Administrative (sa) account credentials.
•
Login Details: Depending on the option selected in the Logon security mode section, provide the appropriate account information in this section:
•
For Windows authentication, provide the following information:
•
Administrator User Name: Specify either a Local or Domain Windows Administrator user name.
•
Password: Enter the password associated with the user specified in the preceding field.
•
Windows Domain: If a Domain Administrator is specified in the Administrator User Name field, enter the name of the domain. You can leave this field blank if a Local Administrator user name is specified.
•
Login Timeout (Seconds) (0=Timeout disabled): This option specifies how long to wait, in seconds, before an instance returns from an attempt to log in to a SQL Server Instance. By default, the timeout value is set to 30 seconds; however, you can change the value during a network delay for a particular SQL Server Instance. The maximum that you can use is 800 seconds. If the value is set to 0, the option is disabled.
•
For SQL Server authentication, provide the following information:
•
Administrator User Name: Specify a SQL Server user with the sysadmin role. If you are using a Linux environment, enter the name for the sa account. The default name is sa.
•
Password: Enter the password associated with the user specified in the preceding field. If you are using a Linux environment, enter the password for the sa account.
•
Login Timeout (Seconds) (0=Timeout disabled): This option specifies how long to wait, in seconds, before an instance returns from an attempt to log in to a SQL Server Instance. By default, the timeout value is set to 30 seconds; however, you can change the value during a network delay for a particular SQL Server Instance. The maximum that you can use is 800 seconds. If the value is set to 0, the option is disabled.
•
Instance Name (Windows only): Type the name of the instance to configure. If it is a named instance, type the full instance name.
6
To save the settings, click OK.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating