Catalyst Plug-In For SAP HANA
Catalyst Plug-In For SAP HANA
Catalyst Plug-In For SAP HANA
Abstract
This document provides instructions on using the HP StoreOnce Backup system with systems running SAP HANA. This document
is intended for backup administrators and information technology (IT) administrators familiar with the HP StoreOnce Backup
system and SAP HANA software.
Always check www.hp.com/go/storage/docs for the most current plug-in documentation. (Select your product and then select
the “Installation” Information Type.)
Refer to the Data Agile BURA Compatibility Matrix on www.hp.com for supported client hardware.
The information contained herein is subject to change without notice. The only warranties for HP 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. HP shall
not be liable for technical or editorial errors or omissions contained herein.
Links to third-party websites take you outside the HP website. HP has no control over and is not responsible for information outside HP.com.
Acknowledgments
Revision History
Revision 1 July 2015
First edition, part number EH990-10564 for the SAP HANA Plug-in version 1.0 release
Contents
1 Overview..................................................................................................4
Prerequisites for the SAP HANA Plug-in........................................................................................4
2 HP StoreOnce Catalyst................................................................................5
What is StoreOnce Catalyst?.....................................................................................................5
Benefits of StoreOnce Catalyst....................................................................................................5
StoreOnce Catalyst Terminology.................................................................................................5
3 Configuring the HP StoreOnce Backup system for the SAP HANA Plug-in...........7
Creating StoreOnce Catalyst and Federated Catalyst stores............................................................7
Configuring StoreOnce Catalyst Store Access Control....................................................................7
Configuring StoreOnce Catalyst over Fibre Channel......................................................................8
Initial configuration..............................................................................................................9
Client configurations.............................................................................................................9
4 Installing the SAP HANA Plug-in.................................................................11
Downloading the SAP HANA Plug-in.........................................................................................11
Opening the SAP HANA Plug-in installer...................................................................................11
Installing and Configuring the SAP HANA Plug-in.......................................................................11
Manually configuring the SAP HANA Plug-in..............................................................................12
5 Uninstalling the SAP HANA Plug-in.............................................................14
6 Configuring SAP HANA Studio..................................................................15
7 Performing SAP HANA Operations using SAP HANA Studio..........................17
SAP HANA Backups...............................................................................................................17
SAP HANA Restores................................................................................................................18
SAP HANA Deletes.................................................................................................................21
8 Using SAP HANA CLI...............................................................................23
Configuring SAP HANA CLI.....................................................................................................23
Performing SAP HANA Backup operations.................................................................................23
Extracting the Backup ID of SAP HANA backup..........................................................................23
Cancelling SAP HANA Backup.................................................................................................24
Checking SAP HANA Backup for Recovery................................................................................24
Checking the integrity of SAP HANA backup objects...................................................................25
Performing SAP HANA restore operations..................................................................................25
Performing SAP HANA delete operations...................................................................................26
9 Performing HP StoreOnce Catalyst Copy Operations.....................................27
10 Troubleshooting......................................................................................29
11 Support and Other Resources...................................................................30
Contacting HP........................................................................................................................30
Related information.................................................................................................................30
Product documentation.......................................................................................................30
Other useful websites.........................................................................................................30
Typographic conventions.........................................................................................................31
12 Documentation feedback.........................................................................32
Index.........................................................................................................33
Contents 3
1 Overview
SAP HANA, an in-memory database, provides two primary backup and restore interfaces: file
(including NFS) and the more intelligent, third party Backint interface. The HP StoreOnce Catalyst
Plug-in for SAP HANA (SAP HANA Plug-in) delivers a Backint integration for backing up and
restoring SAP HANA instances directly to HP StoreOnce Catalyst. The plug-in backs up and restores
SAP HANA databases or logs in single server, scale out cluster, or cloud SAP HANA deployments.
The SAP HANA Plug-in supports HP StoreOnce Catalyst stores as well as Federated Catalyst stores.
NOTE: HP StoreOnce software versions 3.13 and later will support the Catalyst over Fibre
Channel interface (see StoreOnce supported software versions below).
SUSE Enterprise Linux 11 Service Pack 3 (Catalyst over StoreOnce 3.12.1 and later
Ethernet)
SUSE Enterprise Linux 11 Service Pack 3 (Catalyst over StoreOnce 3.13 and later
Fibre Channel)
Red Hat Enterprise Linux 6 Service Pack 5 (Catalyst over StoreOnce 3.12.1 and later
Fibre Channel and Ethernet)
IMPORTANT: A SAP HANA instance is required to install the SAP HANA Plug-in.
4 Overview
2 HP StoreOnce Catalyst
This chapter provides a brief overview of HP StoreOnce Catalyst.
IMPORTANT: For more information, including how to create, edit, and delete StoreOnce Catalyst
and Federated Catalyst stores, see the HP StoreOnce Backup system user guide for your product.
StoreOnce Catalyst stores the targets/device types in which backups are stored on
the HP StoreOnce Backup system
StoreOnce Catalyst Federated stores a group of up to eight service sets within the same cluster
that share backup jobs as a federation on the HP
StoreOnce Backup system
StoreOnce Catalyst items the items stored in the StoreOnce Catalyst stores on the HP
StoreOnce Backup system
StoreOnce Catalyst clients the generic term for applications that connect using the
StoreOnce Catalyst interface
StoreOnce Catalyst Optimized Backups backups performed on the media server or backup server
(instead of the HP StoreOnce Backup system) so only
Copy jobs true copies of the data (not mirror images). The backup
application specifies the source store (outbound copy job)
and target store (inbound copy job). Once copied, the two
versions are independent of each other and either version
can be deleted, moved, or added to from the backup
application.
StoreOnce Catalyst Optimized Copy the two stores negotiate so that only unique data is
transferred and the copy job is completed in a
bandwidth-efficient manner.
6 HP StoreOnce Catalyst
3 Configuring the HP StoreOnce Backup system for the SAP
HANA Plug-in
Creating StoreOnce Catalyst and Federated Catalyst stores
1. Log onto the HP StoreOnce Management Console (StoreOnce GUI) with administrator
privileges.
2. Navigate to HP StoreOnce→StoreOnce Catalyst→Stores.
3. Click Create.
4. If using an HP StoreOnce 6500 or B6200 Backup system, select a service set for the new
store and click OK. To create a Federated store, select multiple service sets; these become the
Federation members.
5. Change the store details as appropriate. A table describing the store details can be found in
the “StoreOnce Catalyst Stores page” section of the HP StoreOnce Backup system user guide
for your product.
a. Name the StoreOnce Catalyst or Federated Catalyst store to match the values entered
during the installer configuration.
b. Set the “Primary (Default) Transfer Policy” to Low Bandwidth.
IMPORTANT: Selecting Low Bandwidth ensures the best backup performance and
deduplication ratio.
8 Configuring the HP StoreOnce Backup system for the SAP HANA Plug-in
Initial configuration
1. Locate the Identifier at the top of the screen. This is the Fibre Channel address of the StoreOnce
Backup system and is used to identify the StoreOnce Backup system in the backup application.
It is in the format COFC-<device-id>; you may provide an Identifier Alias to make it easier
to identify from the backup application. This Catalyst over Fibre Channel Identifier is provided
to the backup application where an Ethernet address would otherwise be provided.
2. In the Target Ports section, HP recommends the default values. However, you can edit the
speed.
3. On the Fibre Channel Settings tab, in the Devices section, locate the World Wide Port Name
for each port on the StoreOnce Backup system. This is the information needed to connect the
client with the StoreOnce Backup system. Use this information to zone your client Fibre Channel
ports with your StoreOnce Fibre Channel ports.
4. Locate the Number of Logins and Devices per Initiator Port for each port. These values determine
the number of concurrent backup and restore connections allowed on each Fibre Channel
port on the HP StoreOnce Backup system.
• Number of Logins – defines the number of client-side ports that are zoned to connect to
that port on the StoreOnce Backup system and cannot be edited.
• Devices per Initiator Port – determines the number of backup and restore connections that
are allowed for each client login to that port on the StoreOnce Backup system. This value
should be increased if multiple concurrent backup streams are required; the maximum
allowed is 64 devices per login.
The number of paths available to a particular client is calculated as:
number of client ports zoned * number of StoreOnce node ports zoned
* devices per initiator port
Table 2 Example relationships between Device per Initiator Port and Number of Connections
on Windows
Number of concurrent
HP StoreOnce Backup backup and restore
Client-side system Devices per Initiator Port sessions (per service set)
Once the client has been Fibre Channel zoned with the StoreOnce appliance there are a number
of considerations for each operating system.
NOTE: Only backup is supported with Catalyst over Fibre Channel. All StoreOnce Catalyst copies
must take place over Ethernet. When configuring a StoreOnce Catalyst copy destination, ensure
than an Ethernet address is provided instead of a Catalyst over Fibre Channel address.
Client configurations
Linux Clients
StoreOnce Catalyst over Fibre Channel presents a device type of “Processor.” On Linux, these
devices files are created in /dev/sg*. By default, /dev/sg* devices are accessible by root users
only. If backups are run as a non-root user, first grant the backup user permissions to access these
device files using the chmod o+rwx /dev/sg* command.
10 Configuring the HP StoreOnce Backup system for the SAP HANA Plug-in
4 Installing the SAP HANA Plug-in
Downloading the SAP HANA Plug-in
Plug-in installation files are available at http://software.hp.com by navigating to HP
Storage→Storage Software→HP StoreOnce Free Software. (Refer to your sales contact for user ID
and password information.)
4. After the installer begins, the options menu will be displayed as follows:
Choose options
-------------------------------------
| Operation | Option |
| Install | 1 |
| Remove | 2 |
-------------------------------------
Press any key to exit
Pre-installation Summary
----------------------------------
Product : HP StoreOnce Catalyst SAP-HANA Plug-in
Version : 1.0
Installation Base : /hana/shared/HN1/hp/HP-Catalyst-SAP-HANA-Plugin
NOTE: HP StoreOnce Catalyst stores are not created automatically by the installer. See
“Configuring the HP StoreOnce Backup system for the SAP HANA Plug-in” (page 7) for details
on creating and configuring the StoreOnce Catalyst store for backup.
CATALYST_STORE_ADDRESS StoreOnce node address used for backups. Supply the Mandatory
address of the StoreOnce service set. Accepts IPv4, FQDN,
StoreOnce Catalyst over Fibre Channel, and IPv6. IPv6
addresses should be quoted, for example,
“fdca:cd45:5ab0:995::7”.
CATALYST_COPY1_STORE_NAME StoreOnce Catalyst store name used for the first StoreOnce Optional
Catalyst copy target
CATALYST_LOGFILE StoreOnce Catalyst log file located under the logs folder Mandatory
relative to the installation path (default is
Catalyst_SAPHANA.log)
CATALYST_LOGLEVEL Specifies the StoreOnce Catalyst client side logging level. Mandatory
Accepts ERROR, INFO, DEBUG, EXTENDED_DEBUG. The
default (HP recommended) is ERROR; set to INFO for
support investigations.
CATALYST_LOGSIZE Specifies the StoreOnce Catalyst client side maximum log Mandatory
file size (in MB)
APPLICATION_LOGFILE Application-specific log file located under the logs folder Mandatory
relative to the installation path (default is
Connector_SAPHANA.log)
APPLICATION_LOGSIZE Specifies the Application maximum log file size (in MB) Mandatory
APPLICATION_ROLLUP_LOGS Number of log files for application log rotation (default is Mandatory
10)
7. Enter y to continue.
8. Enter y to confirm that you want to proceed.
When the plug-in is uninstalled, a confirmation message is displayed.
IMPORTANT: You cannot perform SAP HANA backups until the SAP HANA Plug-in is reinstalled.
NOTE: You cannot backup, copy, restore, or delete until you successfully complete the following
steps.
1. On the Systems panel, right-click your system and select Backup and Recovery→Open Backup
Console. The following screen is displayed:
The “Backint Agent” field should display the location of the Backint executable that will be
used for backups. If the path is correct, it confirms that the SAP HANA Plug-in was installed
and is detected by SAP HANA.
IMPORTANT: If the Backint executable path is not displayed, ensure that the installation was
successful on all SAP HANA nodes. Also, click Refresh on the Configuration tab.
15
4. In the Data Backup section, in the “Backint Parameter File” field, enter the location of the
configuration file (the default is /hana/shared/hp/HP-Catalyst-SAP-HANA-Plugin/
config/plugin.conf). This path is provided in the SAP HANA installation summary.
SAP HANA Studio is now successfully configured.
IMPORTANT: SAP HANA Backint does not support SAP HANA-managed StoreOnce Catalyst
copy. Use the HP StoreOnce Catalyst Copy tool, located in the bin directory of the SAP HANA
Plug-in installation, to perform StoreOnce Catalyst copy operations. The tool uses the same
configuration file used for backup, restore, and delete operations. See “Performing HP StoreOnce
Catalyst Copy Operations” (page 27) for more information.
IMPORTANT: You can also perform “Log Backups” using the SAP HANA Plug-in. Use the Data
Backup configuration file, or create and assign a dedicated Log Backup configuration file within
SAP HANA Studio. You can send Data Backups using Backint and Log backups using “file”, or
both can be backed up usnig Backint.
2. Change the Destination Type to “Backint.” Customize the Backup Prefix field as needed. This
prefix can be used to identify the StoreOnce Catalyst item created during a backup.
3. Click Next. A backup summary is displayed.
4. Click Next.
5. The Log location should be listed. If not, add it now.
IMPORTANT: To restore from a StoreOnce Catalyst copy, you must modify the
CATALYST_STORE_ADDRESS and CATALYST_STORE_NAME parameters in your plug-in
configuration file. Modifying the copy-specific parameters is not enough when doing a restore
because the CATALYST_STORE_ADDRESS and CATALYST_STORE_NAME parameters are used
to determine the location of the Catalyst backups.
3. Right-click the backup to delete and select “Delete Data Backup” to delete an individual backup
or “Delete Older Backups” to delete all previous backups.
4. Select “Catalog and Backup Location” (HP recommended) to delete the catalog entry and the
StoreOnce Catalyst backup objects in the StoreOnce Catalyst store, then check File System
and/or Third-Party Backup Tool (Backint). Selecting “Catalog” does not delete the StoreOnce
Catalyst items from the StoreOnce Catalyst store.
NOTE: Deleting a backup does not delete the copies made using the HP StoreOnce Catalyst
Copy tool; use the same tool to delete StoreOnce Catalyst copied items. See “Performing HP
StoreOnce Catalyst Copy Operations” (page 27) for more information.
NOTE: If you are using the CLI for the first time on this sever, set the configuration file location
to the default location because the location might not have already been configured.
IMPORTANT: To restore from a StoreOnce Catalyst copy, you must modify the
CATALYST_STORE_ADDRESS and CATALYST_STORE_NAME parameters in your plug-in
configuration file. Modifying the copy-specific parameters is not enough when doing a restore
because the CATALYST_STORE_ADDRESS and CATALYST_STORE_NAME parameters are used
to determine the location of the Catalyst backups.
NOTE: HP recommends verifying that a backup exists before attempting to delete it.
NOTE: HP recommends using the COMPLETE option to delete the backup from both the server
and the catalog. To delete the backup from the catalog only, omit the COMPLETE option.
For more information, see the SAP article SQL Statements for Deleting Backups from the Backup
Catalog located here:
http://help.sap.com/saphelp_hanaplatform/helpdata/en/88/
642f787c69409e992cde90a38c3450/content.htm?frameset=/en/8b/
7ef236687c4abb98a920792d0ee629/frameset.htm¤t_toc=/en/00/
0ca1e3486640ef8b884cdf1a050fbb/plain.htm&node_id=362
NOTE: By default, the source and destination StoreOnce Catalyst store details are read from the
plugin.config file located in the config folder. This can be modified; see Table 5 (page 28).
The HP StoreOnce Catalyst Copy tool supports the following operations:
Table 4 StoreOnce Catalyst Copy Operations
Command Syntax Description
Copy ./StoreOnceCatalystCopy --copy Queue a copy job from the origin to the
./StoreOnceCatalystCopy –c destination StoreOnce Catalyst store. Different
options and filters can be user to choose which
objects to copy. The configuration file is read,
by default, to determine the origin and
destination addresses and StoreOnce Catalyst
store names. These names can be overridden
on the command line if necessary.
Copy operations of asynchronous,
non-blocking operations: after initiating a copy,
the command prompt will return. Use in
combination with --list to poll for completed
StoreOnce Catalyst copies.
List ./StoreOnceCatalystCopy --list List the status of all running and queued
./StoreOnceCatalystCopy -l StoreOnce Catalyst copy jobs. Filters can be
user to limit or filter the output.
27
The following options can be used with the commands above. Run ./StoreOnceCatalystCopy
--help for more details.
Table 5 Options to Modify Copy Operations
Option Description
filtertagsand Filter items based on their StoreOnce Catalyst tag (exact match only).
filtercreateddaterange Only display StoreOnce Catalyst items that were created within a specific date
range. The date should use local time in the dd/mm/yyyy-hr:min:sec format.
filterqueuedfromaddress Filter jobs according to the client address that queued the copy job.
preview Do not execute the command but preview what will happen if executed. HP
recommends always using the --preview option before calling “expire-items”
and “cancel.”
config Change the configuration file the parameters are read from.
IMPORTANT: The configuration file plugin.conf will be used by the HP StoreOnce Catalyst
Copy tool to determine the source and destination information. These details can be overridden
on the command line or by providing the tool with the name of a different configuration file.
◦ Connector_SAPHana.log
• /hana/shared/<SID>/HDB<INSTANCE#>/<HOSTNAME>/trace
◦ backint.log
◦ backup.log
The following table lists common SAP HANA Plug-in setup and installation problems and solutions.
Error message: No configuration file assigned under Provide the path to the configuration
Could not back up system “Backint Parameter File.” file.
<SID> See “Configuring SAP HANA Studio”
backup could not be (page 15) for more details.
completed, Backint exited
with exit code 1 instead of
0. console output: ERROR:
Option "-p=" is required for
operation "-f=".
Error message: The configuration file assigned does Verify the configuration file exists. If so,
Could not back up system not exist or is in the wrong format. compare the file with the template
<SID> (plugin_template.conf) to check
formatting and values.
backup could not be
completed, Backint exited
with exit code 1 instead of
0. console output: Logger
not initialized. Message :
Unable to read config file
'<file path>'
Backint agent is not shown in SAP The symbolic link to Backint does not Navigate to the /usr/sap/<SID>/
HANA Studio. exist. SYS/global/hdb/opt path and
ensure a symbolic link to “backint”
exists. This path assumes the installation
used the default path. If you changed
the location of the plug-in, update the
path and try again. If running on a
scale out SAP HANA appliance, ensure
the plug-in is installed on all nodes in
the cluster.
Error message: The backup ID is not valid. Check if the backup you are trying to
ERROR RECOVERY RECOVER DATA restore is valid by using the check
finished with error: [449] backup tool. See “Checking SAP
recovery strategy could not HANA Backup for Recovery” (page 24)
for more details.
be determined, [111014] The
backup with backup id '1430'
cannot be used for recovery
recoverSys failed
29
11 Support and Other Resources
Contacting HP
For worldwide technical support information, see the HP Support Center:
http://www.hp.com/go/hpsc
Before contacting HP, collect the following information:
• Product model names and numbers
• Technical support registration number (if applicable)
• Product serial numbers
• Error messages
• Operating system type and revision level
• Detailed questions
Related information
Product documentation
For the most recent user documentation, see the HP Enterprise Storage Information Library website:
www.hp.com/go/storage/docs
Select HP StoreOnce Backup and then select your product.
The following documents provide information about the HP StoreOnce Backup system:
• HP StoreOnce 6500 and B6200 Backup system user guide: This guide contains detailed
information on using the Web Management Interface. It also contains information on using
the HP StoreOnce Catalyst feature.
• HP StoreOnce 2700, 2900, 4500, 4700, and 4900 Backup system user guide: This guide
contains detailed information on using the Web Management Interface. It also contains
information on using the HP StoreOnce Catalyst feature.
• HP StoreOnce Backup system Concepts and Configuration Guidelines: This guide advises
how to plan the workload being placed on the HP StoreOnce Backup system in order to
optimize performance and minimize the impact of deduplication, replication, and housekeeping
operations competing for resources.
• HP StoreOnce Backup system CLI Reference Guide: This is the complete reference guide for
the CLI command set. Some tasks can only be carried out from the CLI.
Typographic conventions
Table 6 Document conventions
Convention Element
Blue text: Table 6 (page 31) • Cross-reference links and e-mail addresses
• A cross reference to the glossary definition of the term
in blue text
WARNING! Indicates that failure to follow directions could result in bodily harm or death.
CAUTION: Indicates that failure to follow directions could result in damage to equipment or data.
Typographic conventions 31
12 Documentation feedback
HP is committed to providing documentation that meets your needs. To help us improve the
documentation, send any errors, suggestions, or comments to Documentation Feedback
(docsfeedback@hp.com). Include the document title and part number, version number, or the URL
when submitting your feedback.
32 Documentation feedback
Index
A H
access control, configuring, 7 help
obtaining, 30
B HP
backup ID technical support, 30
extracting with CLI, 23 HP StoreOnce Catalyst, 5
backups benefits, 5
canceling using CLI, 24 defined, 5
checking for recovery, 24 terminology, 5
checking object integrity, 25
using CLI, 23 I
using SAP HANA Studio, 17 installing
benefits of HP StoreOnce Catalyst, 5 SAP HANA Plug-in, 11
C O
canceling opening
SAP HANA backups, 24 SAP HANA Plug-in, 11
Catalyst see HP StoreOnce Catalyst operations
CLI, 23 SAP HANA backups, 17
canceling SAP HANA backups, 24 SAP HANA deletes, 21
checking backup object integrity, 25 SAP HANA restores, 18
checking backups for recovery, 24 StoreOnce Catalyst copy, 27
configuring, 23 overview, 4
deletes, 26
extracting backup ID, 23 P
restores, 25 performing
SAP HANA backups, 23 SAP HANA backups, 17
command line interface see CLI SAP HANA deletes, 21
configuration file SAP HANA operations, 17
parameters, 13 SAP HANA restores, 18
configuring StoreOnce Catalyst copies, 27
access control, 7 prerequisites, 4
SAP HANA Plug-in, 11
SAP HANA Studio, 15 R
contacting HP, 30 restores
conventions using CLI, 25
document, 31 using SAP HANA Studio, 18
text symbols, 31
copy S
StoreOnce Catalyst, 27 SAP HANA
creating backups, 17
Catalyst stores, 7 CLI, 23
Federated Catalyst stores, 7 configuring CLI, 23
deletes, 21
D operations with SAP HANA Studio, 17
deletes restores, 18
using CLI, 26 SAP HANA Plug-in
using SAP HANA Studio, 21 configuring, 11
document installing, 11
conventions, 31 opening, 11
documentation prerequisites, 4
providing feedback on, 32 uninstalling, 14
related information, 30 SAP HANA Studio
configuring, 15
performing SAP HANA operations, 17
33
StoreOnce
Catalyst over Fibre Channel
prerequisites, 8
StoreOnce Catalyst copies
performing, 27
symbols in text, 31
T
technical support
HP, 30
terminology of HP StoreOnce Catalyst, 5
text symbols, 31
troubleshooting, 29
typographic conventions, 31
U
uninstalling
SAP HANA Plug-in, 14
using SAP HANA CLI, 23
W
websites, 30
34 Index