3/22/24, 4:37 PM Print | HPE Support

Hewlett Packard Hewlett Packard Enterprise Support Center

Enterprise
Drivers & software

StoreOnce Catalyst Plug-in for Microsoft

SQL Server
Type: Software - Storage
Version: 1.6.0(12 Sep 2023)
Upgrade Requirement: Optional
Operating System(s): OS Independent

Description
The SQL Server Plug-in supports backup and restore of databases and associated logs to and
from an StoreOnce appliance using the StoreOnce Catalyst interface. The SQL Server Plug-in
supports StoreOnce Catalyst and Federated Catalyst backup targets connected over Ethernet or
Fibre Channel.

Release Notes
End User License Agreements:
HPE Software License Agreement v1
(https://downloads.hpe.com/pub/softlib2/software1/doc/p1796552785/v113125/eula-
en.html)

HPE StoreOnce Catalyst Plug-in 1.6.0 for MS SQL Release

Notes

Abstract
This document provides instructions on installing the SQL Server Plug-in. The document is
intended for backup administrators and Information Technology (IT) administrators familiar with
StoreOnce Systems and Microsoft SQL Server software.
Part Number: 20-SOCATAL-MSSQL-RN-ED1
Published: September 2023
Edition: 1
© Copyright Hewlett Packard Enterprise Development LP

© Copyright 2023 Hewlett Packard Enterprise Development LP

https://support.hpe.com/connect/s/print?softwareId=MTX_bcd9e7e7fffa42c38ca91b3961 1/8
3/22/24, 4:37 PM Print | HPE Support

The information contained herein is subject to change without notice. The only warranties for
Hewlett Packard Enterprise products and services are set forth in the express warranty
statements accompanying such products and services. Nothing herein should be construed as
constituting an additional warranty. Hewlett Packard Enterprise shall not be liable for technical or
editorial errors or omissions contained herein.
Confidential computer software. Valid license from Hewlett Packard Enterprise required for
possession, use, or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer
Software, Computer Software Documentation, and Technical Data for Commercial Items are
licensed to the U.S. Government under vendor's standard commercial license.

Acknowledgments

Microsoft® and Windows® are either registered trademarks or trademarks of Microsoft Corporation
in the United States and/or other countries.
The StoreOnce Plug-in for Microsoft SQL Server includes software developed by Jansson
(http://www.digip.org/jansson/ (http://www.digip.org/jansson/))) and by the OpenSSL Project
for use in the OpenSSL Toolkit (https://www.openssl.org/ (https://www.openssl.org/)).

Description
The SQL Server Plug-in supports backup and restore of databases and associated logs to and
from a StoreOnce appliance using the StoreOnce Catalyst interface. The SQL Server Plug-in
supports StoreOnce Catalyst and Federated Catalyst backup targets connected over Ethernet or
Fibre Channel. The plug-in has a command line interface and a graphical user interface that allow
users to register StoreOnce Catalyst stores; configure backup, restore, and delete jobs; view job
progress and a store summary; and view operations specifying user defined filters.
Update recommendation
Update recommendation: Optional
Supersede information
Supersedes: 1.5.0
Supported operating systems
Microsoft Windows Server 2008 R2 (x64)
Microsoft Windows Server 2012 R2 (x64)
Microsoft Windows Server 2012 (x64)
Microsoft Windows Server 2016 (x64)
Microsoft Windows Server 2019 (x64)
Microsoft Windows Server 2022 (x64)

Supported database versions

Microsoft SQL Server 2008 SP2 (x64) or above
Microsoft SQL Server 2012 (x64)

https://support.hpe.com/connect/s/print?softwareId=MTX_bcd9e7e7fffa42c38ca91b3961 2/8
3/22/24, 4:37 PM Print | HPE Support

Microsoft SQL Server 2014 (x64)

Microsoft SQL Server 2016 (x64)
Microsoft SQL Server 2017 (x64)
Microsoft SQL Server 2019 (x64)

Supported StoreOnce models and software

All StoreOnce models running StoreOnce software version 3.12.2 and later. However, HPE
recommends installing or upgrading to the latest version of StoreOnce software.
Languages
Languages supported for this release:
English
Internationalization of character set (UTF-8 compatible, European languages)

Enhancements
None
Fixes
SQL Server Plug-in 1.6.0 is integrated with higher version of Catalyst client library.
Issues and workarounds
The following issues and workarounds exist:
The SQL Server Plug-in does not have a catalog. If backups are deleted from the StoreOnce
appliance, there will be no record of the deleted backups. For additional security, backups can
be written to a secondary StoreOnce appliance.
When using Internet Explorer version 10, sometimes the GUI becomes inactive during a pop-
up box in response to user action. Minimize and maximize the GUI to make it active again.
SQL Transaction log backups can sometimes run slowly due to the preparation time involved.
It is recommended to split the log backups into several concurrent jobs to speed up overall
backup processing.

Installation, Upgrade, Repair, and Uninstallation of the SQL Server Plug-in

Before you begin the installation,
Ensure that Microsoft SQL Server and Microsoft SQL Server Management Studio (SSMS) are
installed. The installation process fails if Microsoft SQL Server and Microsoft SQL Server
Management Studio (SSMS) are not installed.
Ensure that .NET 3.5 based on CLR 2 is installed for SQL GUI to work. In system with
Windows 2017 and later the default option is .NET 4.5 based on CLR 4. Hence .NET 3.5 must
be manually enabled or installed on these systems for the SQL GUI to function correctly.

NOTE:
The SQL Server Plug-in installation requires administrator privileges. If you are logged in as a
nonadministrator, the installer will prompt for administrator credentials.

https://support.hpe.com/connect/s/print?softwareId=MTX_bcd9e7e7fffa42c38ca91b3961 3/8
3/22/24, 4:37 PM Print | HPE Support

The SQL Server Plug-in installation requires system privileges to be added to avoid
scheduled backup job failures. In Windows server 2017 and above, the system user and
administrative user have different access levels.
In the silent mode, if you are logged in as a nonadministrator there is no prompt for
administrator credentials. However, the installation will fail since there is no write permission
for a nonadministrator.
When upgrading the SQL Server Plug-in from version 1.3 to 1.4 and later, the SQL server
instance service must be restarted to enable the SQL server to recognize the new registry key
("HKEY_LOCAL_MACHINE\SOFTWARE\Hewlett Packard Enterprise\StoreOnce Catalyst
Plugins\SQL"). Hence a reboot is mandatory for the Extended stored procedure.
Downgrade of the StoreOnce plug-in software is not supported. Ensure that the plug-in
version is newer than the currently installed version.

Downloading the SQL Server Plug-in

Download the SQL Server Plug-in installer zip file. Find the file at
http://www.hpe.com/storage/storeonce/SQLServer
(http://www.hpe.com/storage/storeonce/SQLServer)
Operation modes
The install, uninstall, and upgrade functionalities can be performed by using one of the following
modes:
1. Graphical user interface (GUI) mode: In this mode, the user can define parameter values
through the GUI interface during the installation process.
2. Console mode: In this mode, the user can define parameter values through the command line
during the installation process.
3. Silent mode: There is no user interaction in this mode and the installation is completed with
default parameter values.

GUI mode
In the GUI mode, the user can define parameter values through the GUI interface during the
installation process.
Installing the SQL server plug-in
To install the SQL server plug-in using the GUI mode,
1. Run the following command to initiate the installation and open the installation wizard.
Command example: MSSQL-Win-1.6.0.<build no>.exe -i GUI

2. Click Next in the introduction screen to continue.

3. Read and accept the HPE End user License Agreement by selecting the I accept the terms of
the License Agreement check box. Click Next.
4. Click Start to start preinstallation checks.
5. After the preinstallation checks are complete, click Next to continue with the installation.
6. Specify the location to install the plug-in and click OK. Click Choose… to specify an alternative
location for the plug-in.

https://support.hpe.com/connect/s/print?softwareId=MTX_bcd9e7e7fffa42c38ca91b3961 4/8
3/22/24, 4:37 PM Print | HPE Support

7. Select the Enable network compression and network checksums check box if required and
then click Next. This check box is cleared by default.
8. In the Pre-Installation Summary screen, verify the details and then click Install. The
installation process begins.
9. When the installation is complete, click Done.

NOTE:
To view the details of the install, upgrade and uninstall, refer to the installation logs at
<installationPath>\HPE\StoreOnce\isvsupport\sql\installation\Logs
Upgrading the SQL server plug-in
To upgrade the SQL server plug-in using the GUI mode,
1. Run the following command:
Command example: MSSQL-Win-1.6.0.<build no>.exe -i GUI
2. Click Next in the introduction screen to continue.
3. Read and accept the HPE End user License Agreement by selecting the I accept the terms of
the License Agreement check box. Click Next.
4. Click Start to start preinstallation checks. Click OK in the Pre-Flight Check Status pop-up.
5. Click Next to continue with the upgrade.
6. When the upgrade is detected, click Yes to continue.
7. Optionally, select the Migrate to New Install Path check box to install the plug-in at a new
location. Click Next.
8. Review the details and then click Install. The upgrade begins.
9. When the upgrade is complete, click Done.

Repairing the SQL server plug-in

To repair the SQL server plug-in using the GUI mode,
1. Navigate to the installation folder using command line and run the uninstall command.
Command example: SQLPluginUninstall.exe -i GUI
2. In the SQLPluginUninstall screen, select Repair Product and click Next.
3. When the repair is complete, click Done.

Uninstalling the SQL server plug-in

The uninstall .exe file is located in the installation folder. To uninstall the SQL server plug-in using
the GUI mode,
1. Navigate to the installation folder using command line and run the uninstall command.
Command example: SQLPluginUninstall.exe -i GUI
2. In the SQLPluginUninstall screen, select Uninstall Product and click Next.
NOTE:
This step does not delete files and folders created during installation.
3. Optionally, select the Delete Config And Logs check box to delete log files from the install
path.
4. When the uninstall is complete, click Done.

https://support.hpe.com/connect/s/print?softwareId=MTX_bcd9e7e7fffa42c38ca91b3961 5/8
3/22/24, 4:37 PM Print | HPE Support

Console mode
In the console mode, the user can define parameter values through the command line during the
installation process.
Installing the SQL server plug-in
To install the SQL server plug-in using the console mode,
1. Run the following command in the command line.
Command example: MSSQL-Win-1.6.0.<build no>.exe -i console
2. Press Enter to continue. A new console window opens.
3. In the License Agreement screen, press Enter to go to the next page of the agreement. After
reviewing the complete agreement, press Y to accept the terms and conditions of the
agreement.
4. Press Enter to run the preflight checks before the installation.
5. After the preflight checks are complete, press Enter to initiate the installation in the default
install folder. Optionally, an alternative folder location can be provided through the command
line.
6. In the Network Compression and Network Checksums screen, enter Yes to enable or No to
disable the feature. The default selection is No.
7. Review the preinstallation summary and press Enter to initiate the installation.
8. When the installation is complete, press Enter to exit the installer.

NOTE:
To view the details of the install, upgrade and uninstall, refer to the installation logs at
<installationPath>\HPE\StoreOnce\isvsupport\sql\installation\Logs
Upgrading the SQL server plug-in
To upgrade the SQL server plug-in using the console mode,
1. Run the following command in the command line.
Command example: MSSQL-Win-1.6.0.<build no>.exe -i console
2. In the License Agreement screen, press Enter to go to the next page of the agreement. After
reviewing the complete agreement, press Y to accept the terms and conditions of the
agreement.
3. Press Enter to run the preflight checks before the installation.
4. After the preflight checks are complete, the upgrade is detected. Press Enter to initiate the
upgrade.
5. Review the preinstallation summary and press Enter to initiate the upgrade.
6. When the upgrade is complete, press Enter to exit the installer.

Uninstalling the SQL server plug-in

To uninstall the SQL server plug-in using the console mode,
1. Run the following command in the command line.
Command example: SQLPluginUninstall.exe -i console
2. Press Enter to continue.
3. Press Y to delete the configuration and log files or press N to retain the files.

https://support.hpe.com/connect/s/print?softwareId=MTX_bcd9e7e7fffa42c38ca91b3961 6/8
3/22/24, 4:37 PM Print | HPE Support

Silent mode
There is no user interaction in this mode and the installation is completed with default parameter
values.
Installing the SQL server plug-in
To install the plug-in in silent mode, run the following command in the command line. The
installer will execute the operation in the background and exit when installation is complete.
Command example: MSSQL-Win-1.6.0.<build no>.exe -i silent
NOTE:
To view the details of the install, upgrade and uninstall, refer to the installation logs at
<installationPath>\HPE\StoreOnce\isvsupport\sql\installation\Logs
Upgrading the SQL server plug-in
To upgrade the plug-in in silent mode, Run the following command in the command line. The
installer will execute the operation in the background and exit when the upgrade is complete.
Command example: MSSQL-Win-1.6.0.<build no>.exe –i silent
Uninstalling the SQL server plug-in
To uninstall the plug-in in silent mode, run the following command in the command line. The
installer will execute the operation in the background and exit when uninstall is complete.
Command example: SQLPluginUninstall.exe -i silent
NOTE:
In the silent mode uninstallation of the plug-in, the configuration and log files are retained by
default.
Related information
Product documentation
The latest documentation for StoreOnce Systems is available at the HPE Storage Information
Library website:
http://www.hpe.com/info/storeonce/docs (http://www.hpe.com/info/storeonce/docs)
The following documents provide information about the StoreOnce System:
StoreOnce System user guides
: These guides contain detailed information on using the Web Management Interface. They
also contain information on using the StoreOnce Catalyst feature.
StoreOnce System concepts and configuration guidelines
: This guide advises how to plan the workload being placed on the StoreOnce System to
optimize performance and minimize the impact of deduplication, replication, and
housekeeping operations from competing for resources.
StoreOnce System CLI Reference Guide
: This guide is the complete reference for the CLI command set. Some tasks can only be
carried out from the CLI.
Other useful websites:
Hewlett Packard Enterprise Website: http://www.hpe.com (http://www.hpe.com)
HPE Storage Products: https://www.hpe.com/us/en/storage.html
(https://www.hpe.com/us/en/storage.html)

https://support.hpe.com/connect/s/print?softwareId=MTX_bcd9e7e7fffa42c38ca91b3961 7/8
3/22/24, 4:37 PM Print | HPE Support

HPE Storage Information Library: http://www.hpe.com/info/storeonce/docs

(http://www.hpe.com/info/storeonce/docs)
HPE StoreOnce Support Matrix : https://www.hpe.com/Storage/StoreOnceSupportMatrix
(https://www.hpe.com/Storage/StoreOnceSupportMatrix)
Hewlett Packard Enterprise Technical Support website: http://www.hpe.com/support
(http://www.hpe.com/support)
HPE partner and store locator: https://findapartner.hpe.com/
(https://findapartner.hpe.com/)

Legal Disclaimer :Products sold prior to the November 1, 2015 separation of Hewlett-
Packard Company into Hewlett Packard Enterprise Company and HP Inc. may have
older product names and model numbers that differ from current models.

https://support.hpe.com/connect/s/print?softwareId=MTX_bcd9e7e7fffa42c38ca91b3961 8/8