Professional Documents
Culture Documents
SAP HANA Server Installation and Update Guide
SAP HANA Server Installation and Update Guide
6 Parameter Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
6.1 action. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
7 Tutorials. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
9 Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
10 Appendix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
10.1 Configuration File Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
10.2 Important SAP Notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
The SAP HANA hdblcm tool is used to install either individual or multiple SAP HANA components in
combination with the server. Compared to previous SAP HANA installers, the SAP HANA hdblcm tool provides
an efficient and optimized installation path, allowing users to customize their SAP HANA installation by
selecting which components should be installed and updated. It is also now possible to perform installation in
interactive graphical or interactive command line interfaces, as well as configure the SAP HANA installation to
be automated, using command line, the configuration file, and batch mode.
It is worth noting, that the SAP HANA component installation concept has changed significantly with the fast-
paced development of SAP HANA itself. In the early releases, the SAP HANA components had to be installed
individually, which proved to be a time-consuming task. More recently, the SAP HANA unified installer was
developed to streamline the installation process by installing all required components from one call to the
installer. As of SPS 08, the unified installer is no longer shipped with SAP HANA.
With SAP HANA SPS 07, the SAP HANA hdblcm tool was introduced to offer the efficiency of installing all
components at one time, while providing further flexibility to customize and automate the installation. The
components can now be installed, upgraded, or uninstalled from one tool, in both command-line or graphical
interface.
As of SAP HANA SPS 08, it is possible to also perform post-installation configurations tasks, such as renaming
the system, adding or removing hosts, and reconfiguring the system, using hdblcm(gui). For more
information, see the SAP HANA Administration Guide.
Before starting the installation of SAP HANA, make sure that you have reviewed the SAP HANA Master Guide.
Related Information
The SAP HANA Platform Edition is bundled together with other products into editions as license bundles for
special purposes. This is a subset of the available editions:
● SAP HANA Enterprise Edition (including components for data replication and acquisition)
● SAP HANA Real-time-data edition (includes SAP Replication Server, SAP HANA edition)
● SAP HANA Database edition for BW
● SAP HANA Limited edition for Apps / Accelerators
● SAP HANA EDGE edition
Note
SAP HANA information composer is a Web-based environment that allows business users to upload data to
the SAP HANA database and to manipulate that data by creating information views. The SAP HANA
information composer is installed separately from the SAP HANA system.
In the SAP Software Download Center, you have access to the installation media and components for SAP
HANA.
You can find the installation media and components for SAP HANA in the following locations:
The responsibility for acquiring and installing SAP HANA depends on the chosen deployment model:
● If a customer chooses the SAP HANA tailored data center integration, the components of SAP HANA
have to be installed on validated hardware by a certified administrator.
● If a customer chooses an SAP HANA appliance, the components of SAP HANA can only be installed by
certified hardware partners on validated hardware running a specific operating system. Any other system
Related Information
Note
The components of SAP HANA can only be installed by certified hardware partners, or any person holding
E_HANAINS131 certification, on validated hardware running an approved operating system.
An SAP HANA system is composed of three main components: the host, the system, and the instance.
In everyday language, these terms may have different meanings, so it is important to clearly understand what
these terms mean when it comes to an SAP HANA installation.
Host
A host is the operating environment in which the SAP HANA database runs. The host provides all the
resources and services (CPU, memory, network, and operating system) that the SAP HANA database
requires. The host provides links to the installation directory, data directory, and log directory, or the storage
itself. The storage for an installation does not have to be on the host. For multiple-host systems, a shared
storage or a storage that is accessible on-demand from all hosts is required. For more information about
multiple-host system concepts, see Related Information.
Instance
An SAP HANA instance is the set of SAP HANA system components that are installed on one host. A system
can be distributed as several instances among several hosts, but each instance in a multiple-host system must
have the same instance number.
System
Related Information
The following graphic shows the file system for a single-host installation:
Interaction Modes
Interactive Mode Available for hdblcm or hdblcmgui. The person installing the system must enter
(Default) parameter specifications iteratively until the installation process finishes. For more details,
see the Interactive Installation information.
Batch Mode Available for hdblcm. The installation accepts the default values for all unspecified
parameters, and runs to completion without any additional input required. Batch mode
must be explicitly specified when the hdblcm installation tool is called. For more details,
see the Enabling Batch Mode information.
Installation parameter values can be entered in one or more of the following methods:
Interactively Using either command line interaction (hdblcm) or graphical interaction (hdblcmgui),
(Default) most parameters are requested interactively. Parameters that are not requested accept
the default value. For more details about which parameters are requested interactively,
see the Changeable Default Values information.
Command Line Installation parameters are given in their accepted syntax as a space delimited list after
Options the program name (hdblcm or hdblcmgui). The specified parameters replace the
defaults. If any mandatory parameters are left out, they are requested interactively (unless
batch mode is specified). All parameters can be entered from the command line. For more
details about the accepted parameter syntax, see the Installation Parameters information.
Configuration The configuration file is a plain text file, of parameters set to their default values, that can
File be generated, edited, and saved to be called during installation with either the hdblcm or
hdblcmgui tool. If any mandatory parameters are left out, they are requested
interactively (unless batch mode is specified). All parameters can be entered in the
configuration file. The specified parameters replace the defaults, but if you specify the
same parameter as a command line option and in the configuration file, the command line
version is used by the installer. For more details about the using the configuration file, see
the Automating with the Configuration File information.
Related Information
If there are multiple hosts in a system, it is called a multiple-host (or distributed) system.
The following graphic shows the file system for a multiple-host system with three hosts:
A multiple-host system is a system with more than one host, which can be configured as active worker hosts
or idle standby hosts. Both the hdblcm and hdblcmgui SAP HANA lifecycle management tools can be used to
install an SAP HANA multiple-host system in one of the installer modes, and with a combination of parameter
specification methods. To add hosts to an existing system, use the SAP HANA lifecycle manager (HLM) tool.
For more information about installing a multiple-host system, see the Related Information.
Interaction Modes
Interactive Available for hdblcm or hdblcmgui. The person installing the system must enter
Mode (Default) parameter specifications iteratively until the installation process finishes. For more
information about interactive installation, see Related Information.
Batch Mode Available for hdblcm. The installation accepts the default values for all unspecified
parameters, and runs to completion without any additional input required. Batch mode
Installation parameter values can be entered in one or more of the following methods:
Interactively Using either command line interaction (hdblcm) or graphical interaction (hdblcmgui),
(Default) most parameters are requested interactively. Parameters that are not requested accept
the default value.
To install a multiple-host system interactively with the hdblcm tool, both the action and
the addhosts parameters must be specified from the command line. The rest of the
installation can follow interactively.
For more information about which parameters are requested interactively and have
changeable default values, see Related Information.
Command Line Installation parameters are given in their accepted syntax as a space delimited list after the
Options program name (hdblcm or hdblcmgui). The specified parameters replace the defaults. If
any mandatory parameters are left out, they are requested interactively (unless batch
mode is specified). All parameters can be entered from the command line.
To install a multiple-host system, the action and addhosts parameters must be specified
in combination with hdblcm.
For more information about the accepted parameter syntax, see Related Information.
Configuration The configuration file is a plain text file, of parameters set to their default values, that can
File be generated, edited, and saved to be called during installation with either the hdblcm or
hdblcmgui tool. If any mandatory parameters are left out, they are requested interactively
(unless batch mode is specified). All parameters can be entered in the configuration file.
The specified parameters replace the defaults, but if you specify the same parameter as a
command line option and in the configuration file, the command line version is used by the
installer. For more information about the using the configuration file, see Related
Information.
Related Information
For SAP HANA several hardware and software requirements need to be fulfilled.
Note
You can find a complete list of all SAP HANA components and the respective SAP HANA hardware and
software requirements in the Product Availability Matrix (PAM) on the SAP Service Marketplace and in the
SAP Community Network.
Software Requirements
Note
Only the software installed by certified hardware partners, or any person holding the certification, is
recommended for use on the SAP HANA system. Do not install additional software on the SAP HANA
system. The person performing the SAP HANA installation has passed the certification exam. Check the
SAP Education resources for information about the SAP HANA certication exams.
For the SAP HANA system the following operating systems are available:
We strongly recommend that you set up an NTP server for the SAP HANA system landscape.
Note
If an NTP sever is not available this means that, for example, trace files from distributed hosts cannot be
displayed in the correct chronological order.
Hardware Requirements
During the update and the installation of the SAP HANA database (from the SAP HANA installation manager),
a hardware check is performed in order to ensure that problems do not arise due to wrong or unsupported
hardware configurations in combination with the SAP HANA platform. The check is a script that is
automatically called by the SAP HANA installer and aborts the installation process if it doesn't succeed.
Before installing or updating SAP HANA, consult the SAP HANA Product Availability Matrix (search for HANA)
to verify if the hardware you are planning to use is supported by SAP HANA. If the hardware is not supported,
the hardware check returns the results "not supported" in the system manufacturer, system product name,
CPU model, OS, memory total, or core count check results.
The check is automatically delivered with the SAP HANA software and can be executed as a standalone check
anytime. Execute the check by going to the /usr/sap/<SID>/HDB<instanceNumber>/exe/
python_support directory and running the Python script named HanaHwCheck.py. Due to some
dmidecode commands in the check it has to be executed as root.
We recommend dedicated server network communication of 10 GBit/s between the SAP HANA landscape and
the source system for efficient data replication.
Related Information
SAP Note 1944799 - SAP HANA Guidelines for SLES Operating System
SAP Note 2009879 - SAP HANA Guidelines for RedHat Enterprise Linux (RHEL)
SAP Community Network - SAP Certified Appliance Hardware for SAP HANA
The SAP HANA lifecycle management tool hdblcm requires certain file systems in order to successfully install
an SAP HANA system.
The file systems can be defined manually before installation and then specified during installation, or the
default file systems can be used. It is important that the file systems listed below are available and have the
recommended disk space before starting the hdblcm program.
Installation path /hana/shared/ The installation path (mount directory) requires disk space equal to
the default system RAM.
(sapmnt)
The mount directory is used for shared files between all hosts in an
SAP HANA system. This directory needs to be accessible to each of
the servers in the SAP HANA cluster.
Sub-directories:
System instance /usr/sap The system instance directory requires at least 50 GB disk space.
Sub-directories:
Data volume /hana/data/ The data path requires disk space equivalent at least three times
<SID> the size of the system RAM.
Log volume /hana/log/ The log path requires disk space at least equivalent to the default
<SID> system RAM.
It is strongly recommended to use the SAP HANA file system layout shown in the figure below:
Hosts running more than one SAP HANA system (sometimes referred to as multiple-SID installations) can
only be used for non-production purposes such as development, quality assurance, or testing.
For production systems with high availability, it is possible to share some temporarily unused resources
from the standby hosts. As soon as the standby resources are needed, they must become exclusively
available for the production system and no longer shared. For more details, refer to the high availability
information in the SAP HANA Administration Guide.
The file systems /hana/data/<SID> and /hana/log/<SID> may use shared file systems like NFS, or block
storage using the SAP HANA storage connector API with non-shared file systems. For more details, Related
Information.
The installation path (/hana/shared) is visible on all hosts. By default, the installation path is also used for
backup. However, backup directories should be manually configured, and must belong to a shared file system.
For more details, refer to the backup information in the SAP HANA Administration Guide.
Using the SAP HANA hdblcm and hdblcmgui tools, SAP HANA components can by installed, updated, or
uninstalled independently of each other. It is possible to perform installation and update tasks in interactive
mode or batch mode.
The SAP HANA lifecycle management toolset includes the installation, update, and configuration tool
hdblcm(gui) as well as the underlying LCM tools. To interact with the SAP HANA lifecycle management tools,
use one interaction mode with a combination of parameter specification methods.
Interaction Modes
Installation, update, and configuration tasks can be performed in one of the following interaction modes:
Interactive Available for graphical interface and command line interface tools. The person performing
Mode (Default) system installation, update, or configuration tasks must enter or confirm parameter
specifications iteratively until the process finishes. For more information about interactive
mode, see Related Information.
Batch Mode Available for command line interface tools only. The SAP HANA lifecycle management
command line tool accepts the default values for all unspecified parameters, and runs to
completion without any additional input required. Batch mode must be explicitly specified
when the command line tool is called. For more information about batch mode, see Related
Information.
SAP HANA lifecycle management parameter values can be entered in one or more of the following methods:
Interactively Using either command line interface or graphical interface, most parameters are
(Default) requested interactively. Default parameter values are proposed in brackets and can be
changed or confirmed. Parameters that are not requested (or specified via another
method) accept the default value.
Command Line Parameters are given in their accepted syntax as a space delimited list after the program
Options name (for example, hdblcm or hdblcmgui). The specified parameters replace the defaults.
If any mandatory parameters are excluded, they are requested interactively (unless batch
mode is specified). All parameters can be entered from the command line. For more
details about the accepted parameter syntax, see the inline help output (help) for the
individual SAP HANA lifecycle management tool.
Note
If parameters are specified in the command line, they override the corresponding parameters in the
configuration file. Parameters in the configuration file override default settings.
Related Information
Installation parameters are a fundamental aspect of the SAP HANA lifecycle management tools hdblcm and
hdblcmgui, and provide the opportunity to optimize and customize the system during installation.
Installation parameters are used for all methods of parameter specification - interactively, as command line
options, or with the configuration file. The following information is relevant for either installation mode
(interactive mode or batch mode).
The only mandatory parameter without a default value is the SAP system ID (SID, sid), which must be
specified. However, it is also recommended to define an instance number (number), since these two
parameters are meaningful to the identity of the system.
If the installation is run in batch mode from the installation medium, the minimum required parameters are the
SID and the passwords (specified in XML syntax and streamed in, or specified in the configuration file). In the
case that only the SID and passwords are entered as parameters, the other parameters automatically take
their default value.
In batch mode, if one of the mandatory parameters, without a default, is not specified, the installation fails with
an error. If an installation is not run in batch mode, but in interactive mode (default) instead, the missing
mandatory parameters are requested in the console.
When building a multiple-host system, the action and addhosts parameters are mandatory command-line
specifications for the hdblcm installer.
The installer uses the following default values unless you change them during installation.
Some default values are based on the predefined values on the current host. In a multiple-host system, it is
recommended to manually check the mandatory values on each hosts before installation.
autostart 0
(off)
client_path ${sapmnt}/${SID}/hdbclient
components client,hlm,server,studio
copy_repository /hana/shared/${SID}/hdbstudio_update
datapath /hana/data/${SID}
home /usr/sap/${SID}/home
install_hostagent 1
(on)
logpath /hana/log/${SID}
root_user root
sapmnt /hana/shared
shell /bin/sh
studio_path ${sapmnt}/${SID}/hdbstudio
studio_repository 1
(on)
system_usage custom
timezone UTC
Note
The default paths written in the form ${<parameter>} indicate that substitution of the parameter occurs
in the configuration file and in batch mode. Substitution also occurs in interactive mode in order to create a
suggested path. The advantage of substitution is that the SAP system ID (sid) and the installation path
(sapmnt, which is /hana/shared, by default) only need to be specified once, and are then substituted in to
the other parameter values. This ensures that the system has unique file system paths if multiple systems
are installed on the same host. However, if it is preferred to deviate from the default paths, it is necessary to
pay attention to the settings, especially in the configuration file, and when installing in batch mode.
vm [page 83]
Specifies the path of the Java runtime file. This parameter is only relevant if the SAP HANA studio is selected
for installation or update.
The following users are automatically created during the installation: <sid>adm, sapadm, and SYSTEM.
User Description
<sid>adm The operating system administrator.
● The user <sid>adm is the operating system user required for administrative
tasks such as starting and stopping the system.
● The user ID of the <sid>adm user is defined during the system installation. The
user ID and group ID of this operating system user must be unique and identical
on each host of a multiple-host system.
● The password of the <sid>adm user is set during installation with the password
parameter.
● If there is no SAP host agent available on the installation host, it is created during
the installation along with the user sapadm.
● If the SAP host agent is already available on the installation host, it is not modi
fied by the installer. The sapadm user and password are also not modified.
● The password of the sapadm user is set during installation with the sa
padm_password parameter.
● Initially, the SYSTEM user has all system permissions. Additional permissions can
be granted and revoked again, however the initial permissions can never be re
voked.
● The password of the SYSTEM user is set during installation with the sys
tem_user_password parameter.
Passwords are a mandatory parameter for installing an SAP HANA system. There are three methods for
configuring passwords.
Interactive Mode
Interactive installation is available for both graphical interface (hdblcmgui) and command line (hdblcm)
tools. Passwords are entered manually one-by-one as they are requested by the installer. This method is
preferred for quick, individual system installations.
Command Line
Configuring passwords in the command line is a two-step process. First, a simple text file with passwords in
XML syntax should be created and saved in the home directory of the root user. Then the file can be called
using standard input and the read_password_from_stdin parameter in the command line with batch mode.
Parameters specified in the command line override parameters specified in the configuration file. Since this
method is the most powerful and flexible method, it is often the preferred method for installing multiple SAP
HANA systems at one time.
Example
The following is an example of the password file in XML syntax:
Passwords.xml
<?xml version="1.0" encoding="UTF-8"?>
<Passwords>
<password>Adm1234</password>
<sapadm_password>Agent1234</sapadm_password>
<system_user_password>Sys1234</system_user_password>
<root_password>Root1234</root_password>
</Passwords>
Now, the password file (stored in the root user's home directory) is called from the command line using
standard input, the read_password_from_stdin=xml parameter, and batch mode:
Configuration File
It is possible to specify passwords in the configuration file. A configuration file template is created with all the
parameters set to their default values. The configuration file is edited to the preferred parameter values, then
it is saved, and the values are read by the installer during installation. This method is preferred for a one-step
Example
The following is an example of the configuration file, with configured password parameters:
configfile1.cfg
# Root User Password
root_password=Root1234
...
# SAP Host Agent (sapadm) Password
sapadm_password=Agent1234
...
# System Administrator Password
password=Adm1234
....
# Database User (SYSTEM) Password
system_user_password=Sys1234
Now, the configuration file (stored in the root user's home directory) is called from the command line using
the configfile parameter:
Interactive mode is an installation mode, which requires the person installing the SAP HANA system to enter
parameter specifications as they are requested by the installer.
It is now possible to install an SAP HANA system from a graphical interface, by running the SAP HANA lifecycle
management tool hdblcmgui.
Prerequisites
Procedure
○ Software directory
The software component directories are detected. Component locations can be added or changed.
○ Action of installation or update
○ Components to be installed or updated
○ Authorization data (passwords)
○ Installation parameters:
An SAP HANA system can be installed interactively from the command line. When the SAP HANA lifecycle
management tool hdblcm tool is called, mandatory parameters are requested by the installer.
Prerequisites
Procedure
Results
In order to provide flexibility, it is possible to install the same SAP HANA system in several ways. The
differences between installation methods are best depicted through a one-to-one comparison of the same
system installed with each available method.
In the following example, there is a hardware partner who plans to install several SAP HANA single-host
systems. His desired system has the following specifications:
He has several customers who have pre-ordered the single-host SAP HANA P01 system and he is expecting
more P01 orders. His goal is to iteratively improve his installation method to the point that he can automate his
ideally configured system installation on several hosts at the same time, come back later, and the installed
SAP HANA platforms will be finished and ready to ship. To reach his goal, he installs the same system (P01)
three times, using:
Since the hardware partner is still new to installing SAP HANA, he tries out the installation first from the
command line. He reviews the installation parameters and finds the corresponding parameter key-value pairs
for his desired P01 single-host system.
The hardware partner takes the parameter key-value pairs, and builds the command line input as follows:
Upon review of the parameter syntax, he realizes he did not need to specify sapmnt, datapath, or logpath
parameters because he chose the default values. The rest of the parameters could also have been given the
short-form syntax. Therefore, the same P01 system installation could be simplified to the following syntax:
Instance num 01 n 01
ber
Now that the hardware partner successfully installed from the command line, he wants to make use of the
configuration file, since his end goal is to automate the installation.
Since it was already discovered that only the SID, instance number, and group ID differ from the default values,
only they are specified in the configuration file. The hardware partner also realizes that there is automatic
substitution of the SID (sid) and installation path (sapmnt) throughout the configuration file according to
default values (for example, datapath default: /hana/data/${sid}), so he does not need to append the SID
(in this case, P01) to the paths.
Now, he can start the installer from the command line with the following simple command:
./hdblcm configfile=/home/root/HANA_install.cfg
Now the hardware partner can take the last step of automation with the SAP HANA lifecycle management tool
hdblcm and use batch mode. It is important to note, up this point the hardware partner has been interactively
entering passwords and confirming other default parameters as part of interactive mode. Batch mode runs the
installer without asking for any confirmation or parameter entry, thereby allowing installation to run to
completion from one push of a button.
There are two choices for password entry in batch mode. Either the passwords can be stored in an XML file
and passed to the installer as a stream by standard input, or they can be specified in the configuration file.
Since the hardware partner is already making use of the configuration file, he decides to enter the passwords
there. The only mandatory parameters in batch mode are the SID and passwords, so he checks the other
defaults of the mandatory installation values before continuing the installation. In batch mode, the installer
accepts default values for any unspecified parameters.
With the addition of passwords to the configuration file, it now looks like this:
./hdblcm configfile=/home/root/HANA_install.cfg b
A multiple-host SAP HANA system can be installed using all the methods listed above (with command line
options, in the configuration file, and in batch mode). Additionally, the graphical interface tool hdblcmgui can
also be used to build a multiple-host system. When installing a multiple-host system, the following applies:
● Using the SAP HANA lifecycle management tools, hdblcm or hdblcmgui, multiple hosts can be configured
during installation. Additional hosts cannot be added to existing systems with these tools.
● The addhosts parameter must be specified. It is also possible to specify additional options for hosts such
as: role, storage_partition, and group. For more details, refer to the addhosts parameter
information, and the multiple-host system concepts information.
● The root user on all hosts must be the same.
● If the root user name is something other than the default "root", the root user name must be specified
during installation with the parameter root_user.
Related Information
Installation automation is designed for anyone who wants to install a similar SAP HANA system multiple times
or start an unattended installation.
With the SAP HANA lifecycle management tool hdblcm, it is now possible to automate installation by using a
combination of the configuration file, command line options, and batch mode, so that an SAP HANA system
installation can be executed once without any follow-up selection.
To illustrate the purpose of installation automation, let us assume there is a hardware partner who offers SAP
HANA platforms (SAP HANA system installed on SAP verified hardware) in three sizes: Small, Large, and Extra
Large.
Automation is ideal for installations that run unattended. Before you start an automated installation, it is
recommended to consider the following.
Do the operating system and additional software Refer to the Hardware and Software Requirements.
components meet the requirements?
Do you know where the data volumes and the log vol For security reasons, the data device and log device
umes will be located? should not be the same. Refer to the SAP HANA Sys
tem Types.
Have you performed a hardware check? The installer performs a hardware check before in
stallation, for automated installation it is recom
mended to perform a manual hardware check first.
Refer to the Hardware and Software Requirements.
Where will you specify passwords? SYSTEM, <sid>adm, sapadm, and root passwords
must be specified in the configuration file or in an
XML file. Refer to the Specifying Passwords informa
tion.
How many worker hosts and standby hosts will there System processes and data are distributed among
be? How will they be grouped? worker hosts, including the original host. Standby
hosts do not perform tasks. Refer to the Multiple-
Host System Concepts.
How will storage devices be configured? External storage can be configured so that hosts
have shared or non-shared access. Refer to the Multi
ple-Host System Concepts.
The root user name must be the same for all hosts in If not, the root_user parameter must be specified
a multiple-host system. Will the root user name for all during installation. Refer to the root_user parameter
hosts be "root"? information.
Related Information
The configuration file is a text document where all available installation parameters can be specified.
When the configuration file has been prepared, it can be used in a number of ways:
● hdblcm with the configuration file - This method is the simplest. The installation parameter values are
read by the installer from the configuration file. If all mandatory parameters are specified in the file,
minimal interaction is required during installation. For more information, see Related Information.
● hdblcm with the configuration file and command line options - This method offers the most flexibility
and is designed to reuse a configuration file for another installation. For more information, see Related
Information.
● hdblcm with the configuration file and batch mode - This method is used for automated installation. It
can be used to automate installation for several instances in a multiple-host system, or combined with a
script to automate installation of several identical systems. For more information, see Related
Information.
For examples of installing with the configuration file, or for an example of the configuration file itself, refer to
the related information.
Related Information
Using the Configuration File with Command Line Options [page 39]
By defining a prepared configuration file during installation, specified parameter values are used by the
installer to build a customized SAP HANA system. Using the configuration file and command line options at
the same time allows for additional flexibility.
The configuration file is an installation tool for those who want to install several of the same system, or save
configuration parameters for reuse or for quick reference.
Prerequisites
Make sure you have done the following before you start preparing the configuration file.
● You have considered how to set up the required systems and directories. For more information, see
Related Information.
● You have considered which installation parameters the new system requires. For more information, see
Related Information.
Context
The configuration file is a plain text file of specified installation parameters, written in the same syntax as in the
command line (except without the leading two dashes --). A configuration file template can be generated,
edited, and saved to be called during installation.
The configuration file template provides a brief, commented-out summary of each parameter. Each parameter
is set to its default value. The parameters are divided into the following categories: general, server, client,
studio, and LifecycleManager.
Procedure
It is recommended that at least the SAP system ID (sid) and the instance number (number) are uniquely
defined. There are several required parameters, that are provided default values in case they are not
customized. For more information, refer to the default values.
Some file path parameters have automatic substitution values as part of the default file path, using the
sid (SAP HANA system ID) and sapmnt (installation path) parameters, so that the substituted values
create file paths that are unique and system-specific. For example, the default for the data file path is:
datapath=/hana/data/${sid}, where sid is automatically replaced by the unique SAP HANA system
ID.
You have generated the configuration file template, edited it, and saved it. The configuration file is now ready
for use during installation.
Related Information
By defining a prepared configuration file during installation, specified parameter values are used by the
installer to build a customized SAP HANA system.
Prerequisites
● You have prepared the configuration file. For more information, see Preparing the Configuration File.
● You are logged in as root user.
● If the SAP HANA studio is selected for installation, the Java Runtime Environment (JRE) is configured as
follows:
Procedure
Related Information
By defining a prepared configuration file during installation, specified parameter values are used by the
installer to build a customized SAP HANA system. Using the configuration file and command line options at
the same time allows for additional flexibility.
Prerequisites
● You have prepared the configuration file. For more information, see Preparing the Configuration File.
● You are logged in as root user.
● If the SAP HANA studio is selected for installation, the Java Runtime Environment (JRE) is configured as
follows:
Context
If parameter values are specified in both the configuration file and the command line, the command line values
override the configuration file values. This feature provides some extra flexibility for reuse, since an existing
configuration file could be used for a new installation where most of the values remain unchanged, but some
values could be modified on the command line ad-hoc.
Results
Example
The following example installs a multiple-host system with the addhosts parameter specified on the
command line, but all other parameters specified from the configuration file. If the addhosts parameter is
also specified in the configuration file, it is overwritten by the command line specification of addhosts.
./hdblcm action=install
addhosts=hanahost2:group=HA1:storage_partition=3,hanahost3:role=standby:group=H
A1 configfile=/var/tmp/H01_configfile
Related Information
Batch mode installation can be started from the command line alone or in combination with the configuration
file. It runs all installation tasks without prompting for additional confirmation or input. Batch mode is designed
to automate the installation process.
Prerequisites
● When using batch mode, passwords must either be defined in the configuration file, or passed to the
installer using an XML password file and streamed in via standard input. In both cases, it is necessary to
prepare the passwords. For more information, see Specifying Passwords.
Context
For those new to installation with the SAP HANA lifecycle management tool hdblcm, it is recommended to run
some test installations before using batch mode in a production environment.
Procedure
Results
Example
The following example installs the SAP HANA server, client, and HLM as a single-host system. The SAP
system ID and instance number are also specified from the command line. The system passwords are read
from a standard input stream by the installer. All other parameter defaults are automatically accepted and
no other input is requested in order to complete the installation.
If a configuration file is used in combination with batch mode, an identical system can be installed with a
simplified call from the command line. In the following example, passwords are defined in the configuration
file, in addition to the action, components, SAP system ID, and instance number.
It is possible to configure additional hosts for an SAP HANA system both during and after installation.
However, there are some slight differences with the tools used depending on when you decide to add a host to
the system.
● The SAP HANA lifecycle management tool (hdblcm) - By specifying the addhosts parameter during
installation with the hdblcm tool, it is possible to configure a multiple-host system interactively from the
command line, in combination with the configuration file, or in batch mode. Each installation method uses
the same addhosts parameter options. For information about the parameter options, see Related
Information.
● The SAP HANA lifecycle management tool (hdblcmgui) - It is possible to use the graphical installation
tool, alone or in combination with the configuration file, to install a multiple-host system. The host
parameters correspond to those used in the command line. For information about the parameter options,
see Related Information.
The following information only covers building a multiple-host system during installation. Before carrying out
the system installation, review the addhosts parameter options and how they can be set to optimize multiple-
host system performance.
Related Information
Host Types
When configuring a multiple-host system, the additional hosts must be defined as worker hosts or standby
hosts (worker is default). Worker machines process data; standby machines do not handle any processing and
instead just wait to take over processes in the case of worker machine failure.
Before installing a multiple-host system, it is important to consider whether high availability is necessary and
how hosts should be grouped to ensure preferred host auto-failover. For host auto-failover to be successful, if
the active (worker) host fails, the standby host takes over its role by starting its database instance using the
persisted data and log files of the failed host. The name server of one of the SAP HANA instances acts as the
cluster manager that pings all hosts regularly. If a failing host is detected, the cluster manager ensures that the
standby host takes over the role and the failing host is no longer allowed write access to the files (called
fencing) so that they do not become corrupted.
Host Grouping
Host grouping does not affect the load distribution among worker hosts - the load is distributed among all
workers in an SAP HANA system. If there are multiple standby hosts in a system, host grouping should be
considered, because host grouping decides the allocation of standby resources if a worker machine fails. If no
host group is specified, all hosts belong to one host group called "default". The more standby hosts in one host
group, the more failover security.
The installer distinguishes between two types of groups: sapsys groups, and host groups. The SAP system
group (sapsys group) is the group that defines all hosts in a system. Therefore, all hosts in a multiple-host
system must have the same sapsys group ID, which is the default configuration with hdblcm. A host group is
group of hosts that share the same standby resources only. Therefore, if the multiple-host system has one
standby host, it is important to leave all hosts in the same host group ("default") so that all hosts have access
to the standby host in case a worker host fails.
Storage Options
In single-host SAP HANA systems, it is possible to use plain attached storage devices, such as SCSI hard
drives, SSDs, or SANs. However, in order to build a multiple-host system with failover capabilities, the storage
must ensure the following:
There are two fundamentally different storage configurations which meet the two conditions above: shared
storage devices or separate storage devices with failover reassignment.
A shared storage subsystem, such as NFS or IBM's GPFS, is the commonly used storage option because it is
easy to ensure that the standby host has access to all active host files in the system. In a shared storage
solution, the externally attached storage subsystem devices are capable of providing dynamic mount points
for hosts. Since shared storage subsystems vary in their handling of fencing, it is the responsibility of the
hardware partner and their storage partners to develop a corruption-safe failover solution.
A shared storage system could be configured as in the diagram below, however mounts may differ among
hardware partners and their configurations.
In a non-shared environment, separate storage used in combination with the storage connector API are given
logical roles as numbers. If you install a multiple-host system using hdblcm, you must specify the logical role
(assigned by the storage connector API) as the storage_partition option in the addhosts parameter
during installation so that the storage devices are recognized correctly by the installer.
The SAP HANA lifecycle management tools hdblcm and hdblcmgui have the ability to build a multiple-host
system during installation in interactive mode, in batch mode, and with the available parameter specification
methods: interactively, using command line options, or with the configuration file.
Prerequisites
● The shared file systems for the data files and log files are configured so that they are present and mounted
on all hosts, including the primary host. The suggested locations for the file systems are as follows:
○ /hana/shared/
○ /hana/data/<SID>
○ /hana/log/<SID>
● (Optional) Additional storage is configured.
● Root user name must be the same for all hosts in a multiple-host system.
● If the root user name is not root, it must be specified as a parameter during installation using the
parameter root_user.
● You are logged in as root user.
● If the SAP HANA studio is selected for installation, the Java Runtime Environment (JRE) is configured as
follows:
Procedure
It is possible to specify the addhosts parameter, and other required system parameters in the
configuration file, and call the configuration file during multiple-host system installation.
○ Command line installation in batch mode
Start the command line installation tool:
./hdblcm action=install addhosts=<host options> sid=<SID>
number=<instance number> b
Multiple-host system installation can be carried out in batch mode. In this case, at least the action,
addhosts, sid, and batch parameters must be specified. It is recommended to check the file paths,
and specify the instance number (number) as well.
Related Information
We recommend to perform an SAP HANA system update from a local host. A local host is defined as a host
that is part of the SAP HANA system, which you are logged on to. Performing an update from a local host
minimizes the risk of failed update due to network glitches.
A remote host is defined as any host which establishes a connection to an SAP HANA host via HTTPS.
In the SAP HANA lifecycle management tool set, hdblcm(gui) is responsible for updating a system from a local
host, and the lifecycle manager updates from a remote host.
Related Information
An SAP HANA system can be updated from a local host using the SAP HANA lifecycle management tool
hdblcm(gui).
There are three methods for downloading an SAP HANA installation medium:
● Download the installation medium from Service Marketplace (SMP) - This method is only applicable when
updating to a new SPS.
● Use the Check for Updates functionality in the SAP HANA studio.
See the Download Software Components from SAP Service Marketplace and Prepare the Software Archive
for Update information.
● Download individual components from Service Marketplace (SMP).
Note
The installation medium cannot be patched manually with newer versions of SAP HANA components and
used for installation or update. The result is an error-prone installation.
The SAP HANA studio can be configured to check for software updates. Once updates are available, the
software must be downloaded, and the archive prepared before the update software can be installed.
Related Information
You can use your SAP HANA studio to check for available software component updates and download them
from SAP Service Marketplace.
Prerequisites
● In the SAP HANA studio preferences, you have configured connection properties to the SAP Service
Marketplace.
● Your SAP HANA system must be SPS 08 or newer and must have hdblcm installed.
Context
In order to update an SAP HANA system, you first need to download the corresponding update sources
(components) from SAP Service Marketplace. The SAP HANA studio provides functionality, which helps you
to easily check for available updates of the installed SAP HANA core components and download them locally
on the machine where the SAP HANA studio is started or on a shared file system. In addition to the
downloaded content you will be provided with a shell script, which can automatically extract the archives in a
directory structure, suitable for hdblcm or hdblcmgui.
Procedure
1. Right click on an SAP HANA system and choose Lifecycle Management Platform Lifecycle
Management Check for available software component updates .
2. Choose which versions of the available components you want to download or choose skip to skip the
download of a particular component. The current version column shown the version of the components,
which is currently installed on the SAP HANA system.
Note that you can also select and download SAP HANA core components which are not currently, but can
be installed on the system.
3. Review the selected components and choose a download directory.
4. To start the download process, choose Finish.
5. You can run the download process in background by pressing the Run In Background button. To get the
current progress of the download, open the Progress View ( Window Show View Other…
Progress ).
Next Steps
Related Information
After downloading the software components from SAP Service Marketplace, the software archive must be
prepared for the update.
Prerequisites
● You have downloaded the software components from SAP Service Marketplace using the SAP HANA
studio.
● You have copied the download directory to the SAP HANA host or in case it is a shared file system, make
sure it is accessible from the SAP HANA host.
Procedure
1. In the directory with the downloaded software component archive, there should be one additional shell
script – hdblcm_prepare.sh. Give execute permissions to the hdblcm_prepare.sh:
./hdblcm_prepare.sh
target_dir The target directory to extract the software com <current dir>/
ponent archives to component_root
The script outputs a message, containing the component root directory to be used with hdblcm (for
example, <component_root_dir>).
3. Start hdblcm or hdblcmgui with the option component_root=<component_root_dir>.
As an alternative to preparing for update in the SAP HANA studio, the update can be prepared manually by
making local package directories, that are recognized by the update tool.
Procedure
Example: /hana/local/downloads
2. Download SAP HANA packages from the SAP Service Marketplace to the local directory.
3. Create a directory, in to which the package contents can be unpacked.
Example: /hana/local/downloads/install
4. Unpack the archive in to the local directory.
Next Steps
You can now update the SAP HANA system with hdblcm or hdblcmgui.
Related Information
It is possible to update an SAP HANA system from a local host using the hdblcm or hdblcmgui lifecycle
management tools.
Prerequisites
● You are updating to a new SPS from an installation medium or you have prepared for update, either in the
SAP HANA studio or manually.
● You have stopped the data replication.
Context
Update, like installation, can be carried out using the following three methods:
● Interactive update
Procedure
cd <installation medium>/DATA_UNITS/HDB_LCM_LINUX_X86_64/
Note
If you prepared for update manually, change to the directory where you unpacked the archive.
2. Locate the SAP_HANA_DATABASE directory, and run the hdblcm update tool.
○ In interactive mode:
./hdblcm
./hdblcmgui
./hdblcm action=update
From the command line, it is possible to specify all necessary update parameters, and even run
update in batch mode. For more details, refer to the inline help: ./hdblcm action=update
help
○ Using the configuration file:
2. Edit the configuration file template, save it, and call it during update:
You can perform an automated update of an SAP HANA system with the SAP HANA lifecycle manager. The
update use cases are applying Support Package Stacks (SPS) for SAP HANA and applying Single Support
Packages for SAP HANA.
The necessary update content can be provided to the SAP HANA lifecycle manager in the following ways:
● Automated Update - If the SAP HANA appliance has Internet access, the SAP HANA lifecycle manager
can find and download available updates from SAP Service Marketplace. In this case, you can update your
SAP HANA system without leaving the SAP HANA studio. See Related Information.
● Alternative Update Methods
○ Manual Download from SMP - If the SAP HANA appliance does not have Internet access, you can find
and download the updates manually from SAP Service Marketplace. In this case, you have to provide
the location of the downloaded content to the SAP HANA lifecycle manager for SAP HANA. See
Related Information
○ SAP Solution Manager - If you have SAP Solution Manager, you can use it to update your SAP HANA
system like other SAP systems in your landscape. In this case, you have to register your SAP HANA
system using the System Landscape Directory (SLD). For more information, see Related Information.
Once this configuration is performed, the SAP HANA database server will regularly update the SLD
with data about your SAP HANA system. Afterward, SAP Solution Manager can access this data to
calculate updates for this system. You can then use the Maintenance Optimizer (MOPZ) in SAP
Solution Manager to generate an SPS and download the necessary archives to a specified location.
For more information, see Related Information. You can then provide the SPS location to the SAP
HANA lifecycle manager and it will apply it on the system.
Related Information
You can perform an automated update of SAP HANA using the SAP HANA lifecycle manager. An automated
update using the lifecycle manager is performed from the SAP HANA studio.
Prerequisites
● If you intend to execute the use case with Internet access, perform the following configuration. The SAP
HANA system needs access to the SAP Service Marketplace using HTTPS, unless you have already
downloaded and copied the target stack to your SAP HANA system. For more information about using
HTTPS to connect to SAP Service Marketplace, see proxy configuration settings in the SAP HANA
Administration Guide.
Caution
S-User is required
For more information about downloading the required content if you do not use SAP Service Marketplace,
see the procedure below.
● You have stopped the data replication before you start the automated update.
● You have performed a system backup before you start the automated update. Also note that during the
automated update there is a business downtime for your SAP HANA system.
● You know the <sid>adm, and database administrator passwords.
● You have applied a valid license key to the SAP HANA system.
● The SAP HANA database is up and running.
● The SAP Host Agent is up and running.
Context
You can use the SAP HANA lifecycle manager to update a single-host or multiple-host system. In a multiple-
host SAP HANA system, you have one primary SAP HANA host and several secondary SAP HANA hosts.
Depending on your SAP Host Agent version, for each host of the system, you might need to enter the
<sid>adm password in the user interface.
You can also use the SAP HANA lifecycle manager in the case of additionally added SAP HANA systems on a
single SAP HANA appliance (multiple SIDs on one host). In this case, the tool updates only one SID. To update
the rest of the SIDs, you need HLM installed per each SID.
Procedure
1. In your SAP HANA studio, add the system to which you want to connect.
2. In the context menu of the system node in the SAP HANA Systems view, choose Lifecycle Management
SAP HANA platform lifecycle management SAP HANA lifecycle manager .
If you have not previously defined them, you need to enter the user credentials for the <sid>adm user
when you call the SAP HANA lifecycle manager user interface for a specific SAP HANA system for the first
time.
○ User <sid>adm
○ You need to enter the user and password when calling the SAP HANA Update user interface for
the first time.
○ You can change the user and password in the context menu for the added system under
Properties SAP System Logon .
○ You can delete the user and password under Windows Preferences General Security
Secure Storage .
In the lifecycle manager, you can choose the following options in the Update SAP HANA System field:
After you have selected the update scenario (apply SPS or Single SP), you need to select the source for
the update from the Select the update source field:
○ Stack.xml file – XML file containing a model of SAP HANA in the form of product instances,
components, and their versions.
○ IMDB_SERVER*.SAR, IMDB_CLIENT*.SAR, IMC_STUDIO*.SAR, HANALDCTR*.SAR
(optionally, if you need it), SAPHOSTAGENT*.SAR – archives containing new content
needed for the update of the SAP HANA instances.
When updating to an SPS, you can download the files listed above from the SAP Service Marketplace:
Support Packages and Patches Browse our Download Catalog SAP NetWeaver and complementary
products SAP HANA SAP HANA Platform Edition Support Package Stack Download .
Support Packages and Patches Search for Support Packages and Patches . Search for IMDB Server,
for example. Make sure you do the same for the required archives, depending on the component you want
to update (IMDB_SERVER*.SAR, IMDB_CLIENT*.SAR, IMC_STUDIO*.SAR, HANALDCTR*.SAR,
SAPHOSTAGENT*.SAR). When downloading your preferred version, make sure that the selected archive is
suitable for your operating system.
All archives must be located in the same directory as the stack.xml file.
For information about using the Maintenance Optimizer (MOPZ) in SAP Solution Manager to generate an
SPS and download the necessary archives, see Related Information.
3. During the update, if you are prompted for them, enter the user name and password for the <sid>adm
user.
4. Select the proposed software releases.
5. Select the type of the source SAP HANA system. You have the following options:
○ Normal
Select this option if you are updating components of a regular SAP HANA system that is not running in
a high-availability environment. The system database must be running.
○ Primary
○ Secondary
Select this option if the SAP HANA system whose components you are updating is a secondary
system in a high-availability setup. During the update, SAP HANA content such as SAP HANA SHINE,
SAP HANA EPM Service, SAP HANA INA toolkit and cannot be deployed. Be aware that in this
scenario you cannot update your SAP HANA studio repository.
6. Follow the instructions of the wizard.
7. If you want to update your SAP HANA studio to the same version as your SAP HANA system, you need to
refer to the corresponding documentation.
For more information, see the SAP HANA Studio Installation and Update Guide.
Related Information
SAP HANA system components like the SAP HANA client, SAP HANA studio, HLM, Application Function
Libraries (AFL), SAP liveCache applications (SAP LCA), or SAP HANA smart data access (SDA) can be
updated on an SAP HANA system after installation from a local host using the SAP HANA lifecycle
management tool hdbclm(gui).
Prerequisites
The system component should have the same version as the SAP HANA DATABASE component. This leads to
the following possible variants:
The SAP HANA lifecycle management tool hdblcm(gui) does not allow you to update the SAP HANA system
component and the SAP HANA DATABASE to different SPS (revision) numbers.
Context
Note
As of SPS 08, the product-specific AFLs are released individually and are no longer released as part of SAP
HANA AFL. Therefore, before updating AFL, it is necessary to perform a migration. For more information,
see SAP Note 2014334 in Related Information.
Procedure
cd <installation medium>/DATA_UNITS/HDB_LCM_LINUX_X86_64/
./hdblcm
./hdblcm action=update
./hdblcmgui
○ In the command line interface: Enter the index for Update <system component> .
○ In the graphical interface: Select the Update <system component> checkbox.
5. Continue with the update, by entering the <sid>adm and SYSTEM passwords. Confirm the update.
A system component has been updated on the SAP HANA system. The component list has been updated. A
log has been produced.
Related Information
SAP HANA system components like Application Function Libraries (AFL), SAP liveCache applications (SAP
LCA), or SAP HANA smart data access (SDA) can be updated on an SAP HANA system after installation from
a remote host using the SAP HANA lifecycle manager.
Prerequisites
The system component should have the same version as the SAP HANA DATABASE component. This leads to
the following possible variants:
● Patch the SAP HANA system components to a higher patch number within the same SP (revision).
● Update both the SAP HANA system components and the SAP HANA system to higher SP (revision).
The SAP HANA lifecycle manager will not allow you to update SAP HANA system components and SAP HANA
DATABASE to different SP (revision) numbers.
Context
SAP HANA system components are not installed by default on your SAP HANA system. This also means that
you do not install system components when you perform an automated update of your SAP HANA system to a
higher SPS, either. First you must add them, and you can then update them using the general update options.
Note
As of SPS 08, the product-specific AFLs are released individually and are no longer released as part of SAP
HANA AFL. Therefore, before updating AFL, it is necessary to perform a migration. For more information,
see SAP Note 2014334 in Related Information.
1. In your SAP HANA studio, add the system to which you want to connect.
Note
Use the fully qualified host name for all configuration actions (including Add System).
2. In the context menu of the system node in the SAP HANA Systems view, choose Lifecycle Management.
If you have not previously defined them, you need to enter the user credentials for <SID>adm user when
you call the SAP HANA lifecycle manager user interface for a specific SAP HANA system for the first time.
○ User <SID>adm
○ You need to enter the user and password when calling the SAP HANA Update user interface for
the first time.
○ You can change the user and password in the context menu for the added system under
Properties SAP System Logon .
○ You can delete the user and password under Windows Preferences General Security
Secure Storage .
On the HLM user interface, you can choose the following options in the Update SAP HANA System field:
After you have selected the update scenario (apply SPS or Single SP), you need to select the source for
the update from the Select the update source field:
○ Stack.xml file – XML file containing a model of SAP HANA in the form of product instances,
components, and their versions.
○ IMDB_SERVER*.SAR, IMDB_CLIENT*.SAR, IMC_STUDIO*.SAR, HANALDCTR*.SAR
(optionally, if you need it), SAPHOSTAGENT*.SAR – archives containing new content
needed for the update of the SAP HANA instances.
When updating to an SPS, you can download the files listed above from the SAP Service Marketplace at:
http://service.sap.com/swdc -> Support Packages and Patches-> Browse our Download Catalog ->
SAP NetWeaver and complementary products -> SAP HANA -> SAP HANA Platform Edition ->Support
Package Stack Download.
http://service.sap.com/swdc -> Support Packages and Patches-> Search for Support Packages and
Patches ->Search for IMDB Server for example. Make sure you do the same for the required archives,
depending on the component you want to update (IMDB_SERVER*.SAR, IMDB_CLIENT*.SAR,
IMC_STUDIO*.SAR, HANALDCTR*.SAR, SAPHOSTAGENT*.SAR). When downloading your preferred
version, make sure that the selected archive is suitable for your operating system.
All archives must be located in the same directory as the stack.xml file.
For information about using the Maintenance Optimizer (MOPZ) in SAP Solution Manager to generate an
SPS and download the necessary archives, see SAP Solution Manager documentation.
3. During the update, if you are prompted for them, enter the user name and password for the <SID>adm
user.
4. Select the proposed software releases.
5. Select the update source and browse to the location of the system component.
6. Once the component version is displayed, choose the <Run> button. For some of the components you
have the option to skip the update.
7. Follow the instructions in the wizard.
Related Information
Each parameter section includes some or all of the following information, depending on the complexity of the
parameter:
6.1 action
Syntax
Remarks
The default for this parameter is action=install.
6.2 addhosts
Specifies additional hosts for the SAP HANA system as a comma-separated list. Individual host options are
specified by a colon-separated list.This parameter is used when configuring a multiple-host system during
installation.
Requirements
If the root user has a user name other than "root", the root_user parameter must
also be specified in combination with addhosts.
When used with hdblcm, the action parameter must be specified in combination with
addhosts.
addhosts=<host>[,<host2>]
Options
The following options can be used to configure the parameter:
● role - Specifies whether the host acts as worker or standby. A worker host
(default) is used for database processing. A standby host is idle and available for
failover in a high-availability environment.
● group - Specifies the host group ID for failover scenarios. If undefined, the host
group is named "default".
(The host group ID is NOT the same as the sapsys group ID, which is specified by
the parameter groupid).
● storage_partition -
Related Information
6.3 autostart
Syntax
autostart=[0|1]
6.4 batch
Runs the SAP HANA lifecycle management tool from the command line in batch mode using default values for
unspecified parameters. If mandatory values are omitted or if invalid values are specified, the program issues
an error message.
Syntax
batch
b
Related Information
6.5 certificates_hostmap
Specifies the hostname used for generation of self-signed SSL certificates for the SAP host agent. This
certificate is used by the SAP HANA lifecycle manager (HLM).
Requirements
The key-value pair action=install must be specified in combination with
certificates_hostmap.
or
Remarks
The default for this parameter is the current host.
Example
The following example generates certificates for two hosts in the long-form syntax:
./hdblcm action=install
certificates_hostmap=hananode01=server1.company.com
certificates_hostmap=hananode02=server2.company.com
The following example generates certificates for two hosts in the short-form syntax:
In this example, not all required installation parameters are specified in the command line. If this is the case,
the remaining mandatory parameters are requested interactively.
Related Information
6.6 checkmnt
Specifies a non-standard shared file system, which can be accessed by all hosts during installation. This
parameter is typically used when the SID is included in the mountpoint.
Syntax
checkmnt=<path>
Syntax
Remarks
The default for this parameter is client_path=<sapmnt>/<SID>/hdbclient.
6.8 component_dirs
Syntax
component_dirs=<component directory>
6.9 component_medium
Syntax
6.10 component_root
Syntax
Specifies the components to be installed in combination with the server: studio, client, HLM, AFL, LCAPPS. It is
also possible to specify all components, or to specify a combination of components as a comma-separated
list. The server is always installed, even if it is not explicitly specified.
Requirements
The parameter action must be specified in combination with components.
Syntax
action=[install|update] components[=all|afl|client|hlm|
lcapps|server|studio]
Remarks
The default for this parameter is components=client,hlm,server,studio and
is dependent on the installer finding installation sources for the components. If the
installation sources for some components are not found, those components are not
installed, but rest of the components are installed.
Example
The following example installs the SAP HANA client, the SAP HANA studio, and the SAP HANA database
(always installed, despite the specification):
In this example, not all required installation parameters are specified in the command line. If this is the case,
the remaining mandatory parameters are requested interactively.
Related Information
6.12 configfile
Loads a configuration file of call option key-value pairs to be passed to the SAP HANA lifecycle management
program.
Syntax
configfile=<file path>
Remarks
The configuration file makes installation and configuration tasks more efficient and
reliable. For more information, see Related Information.
Related Information
6.13 copy_repository
Specifies the target path to which the SAP HANA studio repository should be copied.
Syntax
copy_repository=<target path>
Remarks
The default for this parameter is copy_repository=/<sapmnt>/<SID>/
hdbstudio_update
6.14 datapath
Specifies the path to the data directory of the SAP HANA system.
Syntax
Remarks
The default for this parameter is datapath=/hana/data/<SID>.
Specifies a file path to which a template configuration file is exported. The call options in the template
configuration file are set to their default values, and can be edited.
Syntax
dump_configfile_template=<file path>
Remarks
The configuration file makes installation and configuration tasks more efficient and
reliable. For more information, see Related Information.
6.16 groupid
Specifies the SAP system (sapsys) group ID. This parameter is relevant only if a sapsys group does not already
exist on the host. If a sapsys group already exists, passing the groupid parameter does not alter the existing
group.
Syntax
Remarks
The default for this parameter is groupid=79.
6.17 help
Syntax
help
h
Remarks
A general help output is available for all SAP HANA lifecycle management programs.
Task-specific help output is available for some programs. Refer to the task
documentation for more details.
6.18 home
Specifies the home directory of the system administrator. This parameter is relevant only if the operating
system administrator (<sid>adm) does not exist prior to installation.
Syntax
home=<home directory>
Remarks
The default for this parameter is home=/usr/sap/<SID>/home.
6.19 host_agent_package
Specifies the RPM or SAR file of the SAP host agent. This parameter is only relevant if the HLM component is
selected for installation or update.
Syntax
6.20 hostname
Syntax
Remarks
Restrictions apply to host names in SAP systems. For more information, see SAP Note
611361 in Related Information.
The default for this parameter is the host name of the current machine.
Related Information
6.21 install_hostagent
Syntax
install_hostagent[=off]
Remarks
The default for this parameter is install_hostagent (on).
6.22 install_ssh_key
Syntax
install_ssh_key[=off]
Remarks
Syntax
internal_network=<address>
Example
The following example specifies the internal network address in prefix notation.
internal_network=192.168.1.0/24
6.24 list_systems
Displays a list of the installed SAP HANA systems on the current host, including the SAP system ID (SID),
instance number, version number, and hosts.
Syntax
list_systems
L
6.25 logpath
Specifies the path to the log directory of the SAP HANA system.
Syntax
Remarks
The default for this parameter is logpath=/hana/log/<SID>.
Requirements
This parameter must be used in combination with restrict_max_mem. For more
information, see Related Information.
Syntax
max_mem=<MB>
Remarks
Related Information
6.27 number
Requirements
The instance number must be a two-digit number between 00 and 97.
Syntax
number=<instance number>
n <instance number>
Remarks
The default value for this parameter is the next successive un-used instance number.
Lists all valid timezones, which can be specified by the timezone parameter.
Syntax
print_timezones
Related Information
6.29 read_password_from_stdin
Requirements
When using read_password_from_stdin in batch mode, the program looks for the
necessary passwords from an input stream. Therefore, the following two requirements
apply:
Syntax
read_password_from_stdin=xml
Remarks
Passwords can be specified in several ways depending on your installation method of
choice. For more details, refer to the information about passwords specification.
Example
The following example shows the file containing the passwords:
Related Information
6.30 repository
Defines the source path from which the SAP HANA studio repository should be copied.
Syntax
repository=<source path>
r <source path>
Remarks
If you do not specify this option, the repository contained in the installation kit is
copied.
6.31 restrict_max_mem
Requirements
This parameter must be used in combination with max_mem. For more information, see
Related Information.
Syntax
restrict_max_mem
Remarks
6.32 root_user
Syntax
root_user=<user name>
Remarks
The default for this parameter is root_user=root.
6.33 sapmnt
Specifies the path to the SAP mount directory, which can be used as a shared directory between multiple
hosts.
Syntax
sapmnt=<installation path>
Remarks
The default for this parameter is sapmnt=/hana/shared.
6.34 scope
Performs task on the SAP HANA System (all hosts) or only on the local instance.This parameter is available for
update only.
Syntax
scope=instance|system
Remarks
The default for this parameter is scope=system.
6.35 shell
Specifies a system administrator login shell. This parameter is relevant only if the operating system
administrator (<sid>adm) does not exist prior to installation.
Syntax
Remarks
The default for this parameter is shell=/bin/sh.
6.36 sid
Specifies a system ID. The SAP system ID (SID) is the identifier for the SAP HANA system.
Requirements
Syntax
sid=<SID>
s <SID>
Remarks
This parameter can be specified once and automatically substituted throughout all
parameter defaults, which use sid as part of their default value.
6.37 storage_cfg
Specifies a location where a global.ini is defined. It is possible to set up a storage connector, allowing SAP
HANA to use hardware vendor-specific scripts for automated resource allocation and input/output fencing
during failover.
Requirements
Resource allocation scripts are dependent on the hardware used. Therefore, only the
hardware partners can provide correct scripts.
Syntax
Related Information
6.38 studio_path
Syntax
studio_path=<installation path>
Remarks
The default for this parameter is studio_path=<sapmnt>/<SID>/hdbstudio.
Enables the copying of the SAP HANA studio repository. When enabled (default), the SAP HANA studio
repository is copied to the location defined by copy_repository from the location defined by repository.
Syntax
studio_repository[=off]
Remarks
The default for this parameter is studio_repository (on).
Related Information
6.40 system_usage
Specifies the usage type of the system to be installed. This setting is stored in the global.ini file, and can be
used to identify the intended usage of the system.
Syntax
system_usage=[production|test|development|custom]
Remarks
The default for this parameter is system_usage=custom.
For information about implementing the next steps of the system usage type, see the
SAP HANA Administration Guide.
Related Information
Syntax
system_user=<name>
Remarks
The default for this parameter is system_user=SYSTEM.
6.42 timezone
Specifies the timezone for the system administrator. This parameter is relevant only if the operating system
administrator (<sid>adm) does not exist prior to installation.
Syntax
timezone=<timezone>
Remarks
The default for this parameter is timezone=UTC.
Related Information
6.43 userid
Specifies the user ID of the system administrator. This parameter is relevant only if the operating system
administrator (<sid>adm) does not exist prior to installation.
Requirements
The user ID must be a value in the range of 1000-32000.
userid=<ID number>
U <ID number>
Remarks
The default value for this parameter is the next successive un-used user ID number.
6.44 version
Syntax
version
v
6.45 vm
Specifies the path of the Java runtime file. This parameter is only relevant if the SAP HANA studio is selected
for installation or update.
Syntax
vm=<Java path>
Remarks
The default value for this parameter is the Java runtime that is found in the
environment variable PATH, or the Java runtime specified with the environment
variable JAVA_HOME.
The following use case installs a multiple-host system, with two hosts (both worker). The installer reads the
parameters from a configuration file. The installation is run in batch mode, so that once the installation is
started, both host installations are configured without any further input required.
1. The following are the desired parameters for the SAP HANA server. They are specified in a combination of
command line options and configuration file:
batch b CLI
2. The reusable installation parameter values are saved in the following configuration file:
[Server]
# Additional Hosts
addhosts=hananode1
3. Now the installer can be called from the command line, with the remaining parameters read from the
configuration file. The installation is run in batch mode, so no follow-up confirmation is required.
The following use case uses the same configuration file as above. However, this time, the desired system
deviates slightly from the one defined the configuration file. By specifying parameters in the command line
which are already specified in the configuration file, the configuration file settings are effectively overwritten.
The command line parameters take precedence over the configuration file parameters.
1. The following are the desired parameters for the SAP HANA server. They are specified in a combination of
command line and configuration file:
2. The reusable installation parameter values are saved in the following configuration file:
[Server]
# Additional Hosts
addhosts=hananode1
3. Now the installer can be called from the command line, with the remaining parameters read from the
configuration file. The installation is run in batch mode, so no follow-up confirmation is required.
The following use case installs a single-host system. The installer reads the parameters from the command
line, and the passwords from a standard input stream. The installation is run in batch mode, so that once the
installation is started, the host is configured without any further input required.
1. The following are the desired parameters for the SAP HANA server, to be entered in command line in
combination with the call to the installer.
2. The following password file is prepared with the accepted XML syntax:
Related Information
The following sections in this chapter are optional tasks that can be performed as part of installation
management.
Related Information
After the installation has finished successfully, the SAP HANA system is up and running. So you do not need to
start the SAP HANA system.
Context
However, if required, you can start and stop the SAP HANA system from the command line in one of the
following ways:
Procedure
○ Start the SAP HANA system by entering the following command: /usr/sap/hostctrl/exe/
sapcontrol nr <Instance_Number> function Start
○ Stop the SAP HANA system by entering the following command: /usr/sap/hostctrl/exe/
sapcontrol nr <Instance_Number> –function Stop
● By using the HDB program:
a) Log on to the SAP HANA system host as user <sapsid>adm.
b) Execute one of the following commands:
○ Start the SAP HANA system by entering the following command: /usr/sap/<SAPSID>/
<Instance_Name>/HDB start
Example:
/usr/sap/KB1/HDB26/HDB start
○ Stop the SAP HANA system by entering the following command: /usr/sap/<SAPSID>/
<Instance_Name>/HDB stop
Example:
/usr/sap/KB1/HDB26/HDB stop
Note
The SAP HANA database does not start automatically by default when the SAP HANA system
is started. But you can enable an automated start of this kind. For more information, see
Related Information.
Related Information
It is possible to display the SAP HANA system processes from the command line.
Prerequisites
You are logged on to the SAP HANA host as the root user.
Display the SAP HANA system processes by running the following from the command line:
You can also display the SAP HANA system processes using the SAP Microsoft Management Console
(SAP MMC) from a Microsoft Windows PC.
Results
Example
Displaying the Process List
10.10.2013 14:55:01
GetProcessList
OK
name, description, dispstatus, textstatus, starttime, elapsedtime, pid
hdbdaemon, HDB Daemon, GREEN, Running, 2013 10 10 09:26:02, 3:28:59, 2606
hdbnameserver, HDB Nameserver, GREEN, Running, 2013 10 10 09:26:03, 3:28:58,
2624
hdbpreprocessor, HDB Preprocessor, GREEN, Running, 2013 10 10 09:26:11,
3:28:50, 2689
hdbindexserver, HDB Indexserver, GREEN, Running, 2013 10 10 09:26:13, 3:28:48,
2719
hdbxsengine, HDB XSEngine, GREEN, Running, 2013 10 10 09:26:13, 3:28:48, 2727
sapwebdisp_hdb, SAP WebDispatcher, GREEN, Running, 2013 10 10 09:29:06,
3:25:55, 3335
hdbcompileserver, HDB Compileserver, GREEN, Running, 2013 10 10 09:26:11,
3:28:50, 2693
As the most powerful database user, SYSTEM is not intended for use in production systems. Create a
restricted database user for updating and renaming a system.
For security reasons, the SYSTEM user might not be available during a system update. It is, therefore, required
to import the delivery units as another user.
A database user should be created with the following granted roles and object privileges:
Related Information
Prerequisites
By default the SAP HANA database is configured so that it is not started automatically when the SAP HANA
host is rebooted.
Context
If required, you can change this configuration by modifying the profile of the SAP HANA database as follows:
Procedure
Results
The SAP HANA database is started automatically when the SAP HANA host is rebooted.
To ensure that the SAP HANA database can always be restored to its most recent committed state, all data is
periodically copied to disk. Privacy of data on disk can be ensured by enabling data volume encryption.
Prerequisites
● You have installed a cryptographic service provider on the SAP HANA server. SAP HANA supports the
following cryptographic libraries:
○ CommonCryptoLib (recommended)
You must download CommonCryptoLib from SAP Service Marketplace. CommonCryptoLib is the
recommended cryptographic service provider. The default path for library lookup is set with the
environment variable <$DIR_SECURITY_LIB>. The default path is /usr/sap/<SID>/SYS/global/
security/lib.
○ OpenSSL
The OpenSSL library is installed by default as part of the operating system installation.
○ SAP Cryptographic Library
The SAP Cryptographic Library is supported for backward compatibility only in existing installations.
We recommend upgrading to CommonCryptoLib.
Caution
The distribution of the CommonCryptoLib is subject to and controlled by German export regulations
and is not available to all customers. In addition, usage of the CommonCryptoLib or OpenSSL library
may be subject to local regulations of your own country that may further restrict the import, use, and
export or re-export of cryptographic software. If you have any further questions about this issue,
contact your local SAP office.
● You are logged on to the SAP HANA host as the operating system user, <sid>adm.
Context
Data is stored in persistent disk volumes that are organized in pages. If data volume encryption is enabled, all
pages that reside in the data area on the disk are encrypted using the AES-256-CBC algorithm. Pages are
transparently decrypted as part of the load process. When pages reside in memory they are therefore not
encrypted and there is no performance overhead for in-memory page accesses. When changes to data are
persisted to disk, the relevant pages are automatically encrypted as part of the write operation.
Caution
Do not generate the root encryption key after you have enabled data volume encryption or created a
remote source in an SAP HANA smart data access scenario, since this would render the SAP HANA
database unusable.
Results
Encryption is now active. We recommend that you periodically change the encryption key used to encrypt
pages in the data area in line with your organization's security policy.
Related Information
If required, you can uninstall the previously installed SAP HANA components by running either the hdblcm or
hdblcmgui SAP HANA lifecycle management tools from the /<sapmnt>/<SID>/hdblcm directory.
Prerequisites
Procedure
1. An hdblcm directory, in which the uninstallation script is contained, is created during system installation.
cd /<sapmnt>/<SID>/hdblcm
2. Start the uninstallation script. This can be performed with both hdblcmgui and hdblcm.
1. Start the hdblcm tool from the command line with the uninstall parameter specified.
./hdblcm uninstall
It is also possible to uninstall individual components by specifying
components=<component1>,<component2> in combination with the uninstall parameter. For
detailed information about the uninstallation parameters, review the inline help before uninstalling
from the command line:
./hdblcm uninstall h
2. When the process is complete a log is produced.
Results
Related Information
The SAP HANA lifecycle management tools hdblcm and hdblcmgui write log files during installation. The
most recent log file is always available under /var/tmp/hdblcm.log or /var/tmp/hdblcmgui.log.
Additionally, a copy of the log files is archived in the directory hdb_<SID>_hdblcm_<action>_<date>..
Since the SAP HANA lifecycle management tools hdblcm and hdblcmgui are wrappers for underlying
component installers, it is also possible to check the component logs. It is recommended to review and
analyze the SAP HANA lifecycle management tools hdblcm and hdblcmgui logs first. Once the source of the
problem is narrowed down to a specific component, then the component logs can be further analyzed.
/var/tmp/hdb_<SID>_<action>_<time_stamp>
The following log files are written during performing the action:
You can also view the last three log files in the SAP HANA studio using the administration function Diagnosis
Files. For more information, see the SAP HANA Database - Administration Guide.
If the installation stops without fully installing, and you would like to remove the components and start over,
run the component uninstaller (hdbuninst) for each component individually. Then start the installation over
again using hdblcm.
Since hdblcm and hdblcmgui are wrapper tools, in some troubleshooting cases, it may be useful to pass
component options on to the underlying component tools (hdbinst or hdbupd) in combination with the call to
the hdblcm or hdblcmgui SAP HANA lifecycle management tools.
or
action=[install|update] pass_through_help h
hdbinst_client_ignore=<check1>[]...
hdbinst_client_path=<hdbinst_client_path>
hdbinst_client_sapmnt=<installation_path>
[default: hdbinst_client_sapmnt=/hana/shared]
hdbinst_plugin_ignore=<check1>[]...
hdbinst_plugin_nostart
hdbinst_server_ignore=<check1>[]...
hdbinst_server_import_content[=off]
hdbinst_server_xs_engine[=off]
hdbinst_server_xs_engine_http_port=<port>
hdbinst_server_xs_engine_https_port=<port>
hdbinst_studio_path=<hdbinst_studio_path>
hdbupd_server_ignore=<check1>[]...
hdbupd_server_import_content[=off]
hdbupd_server_nostart
hdbupd_server_xs_engine[=off]
hdbupd_server_xs_engine_http_port=<port>
hdbupd_server_xs_engine_https_port=<port>
If the installer crashes or loops it may make sense to trace the installer until the problem occurs, open a CSS
ticket, and attach the trace file for further analysis. You can switch on the installer trace by setting the
environment variable HDB_INSTALLER_TRACE_FILE to <tracefilename>. The directory containing the
trace file must already exist.
In addition to the main components installed in the default file systems described in Recommended File
System Layout [page 14], it may also be necessary to locate the temporary files from the SAP HANA system.
They can be found in the following directories:
The following is the configuration file template that is generated using the dump_configfile_template
parameter in combination with the hdblcm installer.
[General]
[Server]
# Additional Hosts
addhosts=
[LifecycleManager]
[Client]
[Studio]
Read the following SAP Notes before you start the installation. These SAP Notes contain the latest information
about the installation, as well as corrections to the installation documentation.
Make sure that you have the most up-to-date version of each SAP Note, which you can find on SAP Service
Marketplace at https://service.sap.com/notes .
1824819 Optimal settings for SLES 11 SP2 and SLES 11 for SAP SP2
Check the current SAP Notes for the various parts of SAP HANA by searching for any of the following
application areas:
The search also supports using the wildcard asterisk (*), so you can, for example, also search for BC-DB-HDB*
or similar and you will get results for all sub-components.
Reporting Incidents
If you encounter any problems with the software, report an incident on the SAP Service Marketplace at http://
service.sap.com/incident .
In addition, the Customer Interaction Center (CIC) is available 24 x 7 in every region to help you resolve any
issues you may run into (https://service.sap.com/supportcenters ).
The CIC requires a valid S-user number. To create an S-user ID, follow the steps in this guide (SAP Active
Global Support Reference Guide ).
When reporting an incident, you can choose from the above list of components for the relevant software part.
Coding Samples
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples
and are not intended to be used in a productive system environment. The Code is only intended to better
explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness
and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the
usage of the Code, unless damages were caused by SAP intentionally or by SAP's gross negligence.
Accessibility
The information contained in the SAP documentation represents SAP's current view of accessibility criteria as
of the date of publication; it is in no way intended to be a binding guideline on how to ensure accessibility of
software products. SAP specifically disclaims any liability with respect to this document and no contractual
obligations or commitments are formed either directly or indirectly by this document.
Gender-Neutral Language
As far as possible, SAP documentation is gender neutral. Depending on the context, the reader is addressed
directly with "you", or a gender-neutral noun (such as "sales person" or "working days") is used. If when
referring to members of both sexes, however, the third-person singular cannot be avoided or a gender-neutral
noun does not exist, SAP reserves the right to use the masculine form of the noun and pronoun. This is to
ensure that the documentation remains comprehensible.
Internet Hyperlinks
The SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended to serve as a
hint about where to find related information. SAP does not warrant the availability and correctness of this
related information or the ability of this information to serve a particular purpose. SAP shall not be liable for
any damages caused by the use of related information unless damages have been caused by SAP's gross
negligence or willful misconduct. Regarding link classification, see: http://help.sap.com/disclaimer