SAP HANA Server Installation Guide en
SAP HANA Server Installation Guide en
SAP HANA Server Installation Guide en
11 Tutorials. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .200
11.1 Tutorial: Automating Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
11.2 Tutorial: Using Custom Configuration Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
11.3 Tutorial: Installing a Multiple-Host System Using a Configuration File in Batch Mode. . . . . . . . . . . . 207
11.4 Tutorial: Overwriting Configuration File Parameters with Command Line Parameters. . . . . . . . . . . 208
11.5 Tutorial: Installing a Single-Host System with Passwords Read from XML Standard Input Stream
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
12 Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
12.1 Accessing the Underlying Installer Components (pass_through_help). . . . . . . . . . . . . . . . . . . . . . 213
12.2 Locating all SAP HANA File System Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
This guide describes how to install and update an SAP HANA system with the SAP HANA lifecycle management
(LCM) tools.
This SAP HANA Installation and Update Guide describes how to install or update an SAP HANA system and its
components with the SAP HANA database lifecycle manager (HDBLCM).
The SAP HANA database lifecycle manager 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
database lifecycle manager provides an efficient and optimized installation path, allowing you to customize
your 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 possible to also perform post-installation configurations tasks, such as renaming the system, adding or
removing hosts, and reconfiguring the system, using the SAP HANA database lifecycle manager. For more
information, see the SAP HANA Administration Guide.
The SAP HANA database lifecycle manager offers three user interfaces: a graphical user interface, a command-
line interface and a Web user interface. The Web user interface can be accessed in a standalone Web browser
or in the Platform Lifecycle Management view in the SAP HANA studio. Therefore, the SAP HANA database
lifecycle manager is capable of performing all actions offered in the SAP HANA platform lifecycle management
portfolio and is the only recommended tool for these actions.
Before starting the installation of SAP HANA, make sure that you have reviewed the SAP HANA Master Guide.
Related Information
For information about the capabilities available for your license and installation scenario, refer to the Feature
Scope Description for SAP HANA.
The SAP HANA platform edition is the technical foundation of the SAP HANA platform and various SAP HANA
editions. The SAP HANA platform edition comprises among others:
Note
For information about the feature capability of the SAP HANA server on Intel-based hardware platforms or
on IBM Power servers, see SAP HANA Hardware and Software Requirements in the SAP HANA Master
Guide.
Related Information
In the SAP Software Downloads, you have access to the installation media and components for SAP HANA.
Caution
It is essential to keep a copy of all installation media which may be required, for example, for disaster
recovery purposes. Installation media which has been superseded is routinely removed from the Software
Center and there is no guarantee that all database revisions will be permanently available.
Note
The items you have downloaded must be available on the host where the SAP HANA system will be
installed or already is installed.
Note
The items you have downloaded must be available on the host where the SAP HANA system will be
installed or is already installed.
Responsibilities
The responsibility for acquiring and installing SAP HANA depends on the chosen deployment model:
● If a customer chooses the SAP HANA Tailored Datacenter Integration, then the components of SAP
HANA must be installed on validated hardware by a certified administrator or official SAP HANA hardware
partner.
● If a customer chooses an SAP HANA appliance, then the components of SAP HANA can only be installed
by certified hardware partners on validated hardware running a specific operating system. Any other
system or content developed with systems of this type is not supported by SAP. For more information, see
the information page for the product version. Support Package Stacks (SPS) can be downloaded and
applied to appliances in accordance with agreements with the respective hardware partner.
Note
The SAP HANA Client is also available separately under the terms of the SAP Developer License
Agreement, from the SAP Development Tools public download site. The Developer Agreement licenses the
software "as is", without warranty or any other obligations on the part of SAP. Other than what is made
available on the SAP Community Website (SCN) by SAP at its sole discretion and by SCN members, SAP
does not offer support for software that is the subject of the Developer Agreement.
Before the installation and update of SAP HANA software components, the authenticity and integrity of the
software should be verified.
An SAP HANA system can be installed using the SAP HANA database lifecycle manager (HDBLCM). Since the
installation software is downloaded from outside your network, it cannot be trusted. Therefore, you should first
make sure that the components are authentic, before starting the SAP HANA database lifecycle manager
(HDBLCM).
To verify the signature the additional components, run hdblcm with the parameter verify_signature. For
more information, see SAP Note 2577617.
An SAP HANA system can be updated using the SAP HANA resident HDBLCM.
The SAP HANA resident HDBLCM is part of the system and is therefore considered secure. It validates the
authenticity of the database installation kit and delegates the execution to the SAP HANA database lifecycle
manager (HDBLCM) that is located inside the database installation kit. The SAP HANA database lifecycle
manager (HDBLCM) validates the authenticity of the selected additional components.
When updating SAP HANA using the SAP HANA resident HDBLCM, the software is verified for authenticity by
default. In case you need to perform an update without verifying the authenticity, run hdblcm with the
parameter verify_signature=off.
SAP HANA components can be installed and updated using the SAP HANA resident HDBLCM or the SAP
HANA database lifecycle manager (HDBLCM) shipped with the SAP HANA database installation kit. The latter
is not recommended as the database installation kit and its version must match the version of the installed SAP
HANA system.
When using the SAP HANA resident HDBLCM to install or update components, the authenticity verification is
only enabled by default if the SAP HANA database was installed or updated with an authentic signature. The
signature file is located under <inst_path>/<SID>/hdblcm/SIGNATURE.SMF). If you are not sure whether
the SAP HANA system was installed with a valid signature, you can run the SAP HANA resident HDBLCM with
the parameter verify_signature.
Related Information
Before installing or updating an SAP HANA system, it is important to understand the basic system concepts
and SAP HANA database lifecycle manager (HDBLCM) features in order to optimize the installation or update
process and avoid unnecessary reconfiguration.
An SAP HANA system is made up of the SAP HANA server and its components. The system can be installed on
one or multiple system hosts, which are configured to operate as worker or standby hosts. As of SAP HANA 2.0
Support Package Stack (SPS) 01, the SAP HANA system can only be installed or configured to be a tenant
database system. A tenant database system contains one system database and can contain multiple tenant
databases. A single-container system will be automatically converted to a tenant database system during the
upgrade to SPS 01.
The SAP HANA database lifecycle manager offers three user interfaces: graphical, command-line, and Web.
System installation can be performed using the graphical user or command-line interface. System update, or
component installation or update can be performed using any of the three user interfaces.
The SAP HANA database lifecycle manager can be run interactively, requiring step-by-step input, or it can be
run in batch mode, requiring no subsequent input. Defining installation and update parameters can be entered
interactively, in a configuration file, or in combination with the call to the program on the command line.
Note
The components of SAP HANA can only be installed by certified hardware partners, or any person holding
the required certification, on validated hardware running an approved operating system.
Related Information
Note
You can find a complete list of all SAP HANA components and the corresponding SAP HANA hardware and
software requirements in the Product Availability Matrix (PAM), in the SAP HANA Hardware Directory, and
in the SAP Community Network.
Note
Only software installed by certified hardware partners, or any person holding certification, is recommended
for use on the SAP HANA system. Do not install any other software on the SAP HANA system. The
components of SAP HANA can only be installed by certified hardware partners, or any person holding
certification. Furthermore, it must be installed on validated hardware running an approved operating
system.
For more information, see the blogs SAP Certified Technology Associate: C_HANATEC_13 – by the SAP
HANA Academy and Recent changes in the SAP HANA Technology certification program 2016 in the Related
Information section.
End of Maintenance
The software component version SAPUI5 TOOLS IDE PLUGIN 3.00 is out of maintenance. SAPUI5 TOOLS IDE
PLUGIN 3.00 is assigned to the activated instance HANA Studio SAPUI5 Plug-in of SAP HANA PLATFORM
EDITION 2.0 SPS05.
For alternatives for SAPUI5 TOOLS IDE PLUGIN 3.00, see SAPUI5 Tools for Eclipse – Now is the Time to Look
for Alternatives .
Note
You can perform a system copy of an SAP system with SAP HANA database as the source database and
also SAP HANA database as the target database. This is relevant if you want to change the hardware
platform on the SAP HANA system.
For more information, see the SAP NetWeaver Documentation on System Copy for your SAP NetWeaver
release.
For detailed information about the supported hardware, see Related Information in On-Premise in the SAP
HANA Master Guide.
For information about supported operating systems for SAP HANA, see SAP Note 2235581 - SAP HANA:
Supported Operating Systems.
Hardware Requirements
The supported hardware for SAP HANA depends on the deployment method (appliance or TDI). For more
information, see the Related Information in this section and in On-Premise in the SAP HANA Master Guide.
We strongly recommend setting up an NTP server for the SAP HANA system landscape.
Note
If an NTP sever is not available, this means, for example, that trace files from distributed hosts cannot be
displayed in the correct chronological order.
For information about hardware requirements for SAP HANA network connections, see SAP HANA Network
Requirements.
For installations on IBM Power Servers, Ethernet virtualization using dual VIOS is normally deployed. Natively
attached Ethernet cards can also be used however.
Related Information
SAP Note 1984787 - SUSE LINUX Enterprise Server 12: Installation notes
Red Hat Enterprise Linux (RHEL)
SAP Note 2009879 - SAP HANA Guidelines for Red Hat Enterprise Linux (RHEL) Operating System
SAP Note 2292690 - SAP HANA DB: Recommended OS settings for RHEL 7.2
Supported Hardware Platforms
SAP HANA Hardware - Certified Appliances
The SAP HANA database lifecycle manager (HDBLCM) requires certain file systems in order to successfully
install an SAP HANA system.
The file systems must be created and mounted manually before installation. The SAP HANA database lifecycle
manager (HDBLCM) will create all required subdirectories during installation. It is important that the file
systems listed below are available and have the recommended disk space before starting the SAP HANA
database lifecycle manager.
Root /
Installation path /hana/shared The mount directory is used for shared files between all hosts in an SAP
(sapmnt) HANA system. This directory needs to be accessible to each of the servers
in the SAP HANA cluster.
Subdirectories:
The following paths apply when the SAP HANA studio is installed:
System instance /usr/sap This is the path to the local SAP system instance directories.
Subdirectories:
Note
/usr/sap/<SID> must not be a mount point.
Data volume /hana/data The default path to the data directory is /hana/data/<SID>.
Log volume /hana/log The default path to the log directory is /hana/log/<SID>.
Note
SAP does support running multiple SAP HANA systems (SIDs) on a single production SAP HANA hardware
installation. This is restricted to single host / scale-up scenarios only. Please keep in mind that multi-SID
requires significant attention to various detailed tasks related to system administration and performance
management.
SAP does support running multiple SAP HANA systems (SIDs) on a single non-production (DEV, QA, test,
production fail-over, etc) single node or scale-out SAP HANA environment. For more information, see SAP
Note 1681092.
The installation path, data path, and log path must not point to the same directory.
A SAP HANA system cannot be installed under /usr/sap/<SID>. The directory /usr/sap must not be
shared across other hosts.
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
Directory names inside the data path and log path will not show the database ID for single-container
systems that were converted to tenant database systems.
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, see 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.
Related Information
An SAP HANA system is composed of three main components: the host, the system, and the instance.
For more information about the restrictions that apply to host names in SAP systems, see SAP Note 611361 in
Related Information.
System
A system is one or more instances with the same number. If a system has more than one instance, they must
be dispersed over several hosts as a multiple-host system. Every system has a unique SAP system ID (SID).
Instance (HDB)
An SAP HANA instance (HDB) is the smallest operational unit on a host. It is the set of SAP HANA system
components that are installed on one host. A single-host system contains one instance on the one host. A
multiple-host system contains several instances distributed across the multiple hosts (one per host). Every
system has an instance number, which is a two-digit identifier. Each instance in a multiple-host system must
have the same instance number.
System Database
The system database stores overall system landscape information, including knowledge of the tenant
databases that exist in the system. However, it doesn't own database-related topology information, that is,
information about the location of tables and table partitions in databases. Database-related topology
information is stored in the relevant tenant database catalog.
Tenant Databases
SAP HANA supports multiple isolated databases in a single SAP HANA system. These are referred to as tenant
databases.
Related Information
An SAP HANA system can be configured as a single-host or multiple-host system using the SAP HANA
database lifecycle manager.
A single-host system is the simplest system installation type. It is possible to run an SAP HANA system entirely
on one host and then scale the system up as needed. The SAP HANA database lifecycle manager can be used
The following graphic shows the file system for a single-host installation:
A multiple-host system is a system with more than one host, which can be configured as active worker hosts or
idle standby hosts. The SAP HANA database lifecycle manager can be used to install an SAP HANA multiple-
host system in one of the program interfaces, and with a combination of parameter specification methods. To
add hosts to an existing system, use the SAP HANA resident HDBLCM. For more information about installing a
multiple-host system, see the Related Information.
The server software is based on a flexible architecture that enables a distributed installation. This means that
load can be balanced between different hosts. The server software has to be installed in a shared file system.
This file system has to be mounted by all hosts that are part of the system.
Related Information
SAP HANA can be deployed in a number of configurations that are approved in varying degrees for production
environments (or not approved for production at all).
The server installation documentation is mainly written for SAP HANA deployment types which are completely
approved for production environments, that is to say, an SAP HANA system running on dedicated hardware, or
tenant database systems.
Tenant Databases
The tenant database deployment type makes it possible to run several SAP HANA instances on the same
hardware in a production environment. It provides an alternative to a virtualized deployment, which is only
production approved in some scenarios, and the MCOS (Multiple Components One System) deployment,
which is approved for production environments on a single production SAP HANA hardware installation. This is
restricted to single host / scale-up scenarios only. Please keep in mind that multi-SID requires significant
attention to various detailed tasks related to system administration and performance management. For more
information, see SAP Note 1681092.
An SAP HANA system is installed with support for tenant databases by default using the SAP HANA database
lifecycle manager (HDBLCM). You can specify a database isolation type during installation setting the optional
parameter db_isolation. High isolation can be configured to protect against unauthorized access at the
operating-system level by separating system administrator users and providing authenticated communication
within databases. By default, the isolation type is set to low isolation. For more information, see Database
Isolation in the SAP HANA Administration Guide or the SAP HANA Security Guide and db_isolation in Related
Information.
MCOD deployments are characterised by multiple applications on one SAP HANA system. SAP supports
deploying and running multiple applications on a single SAP HANA production database only for packaged
applications and scenarios listed on the "White List" included in SAP Note 1661202. If a particular packaged
Virtualized
SAP HANA systems can be run on virtual machines with restrictions to the hypervisor (including logical
partitions). For more information about running SAP HANA virtualized, see SAP Note 1788665, 2230704 and
2024433 in Related Information.
MCOS deployments are characterized by multiple SAP HANA systems on one host. This configuration is
approved for production environments as of SAP HANA Support Package Stack (SPS) 09. This is restricted to
single host / scale-up scenarios only. Please keep in mind that multi-SID requires significant attention to
various detailed tasks related to system administration and performance management. For more information
about running SAP HANA virtualized, see SAP Note 1681092 in Related Information.
It is approved for production environments for SAP HANA systems to share hardware between the SAP HANA
server and SAP HANA options. As of SPS 10, you have the option to install SAP HANA systems with multiple
host roles - including database server roles and SAP HANA option host roles - on one host, or give an existing
SAP HANA host additional roles during system update. For more information about configuring additional host
roles, see add_local_roles and add_roles in Related Information.
Caution
For information about the capabilities available for your license and installation scenario, refer to the
Feature Scope Description for SAP HANA.
Related Information
Note
Some of the virtualization platforms that are available for SAP HANA are only supported in non-production
environments. For more information on supported versions, see 1788665 - SAP HANA Support for
virtualized / partitioned (multi-tenant) environments.
VMware vSphere
SAP HANA is supported on VMware vSphere for scale-up, multi-VM and scale-out production environments,
including SAP HANA Tailored Datacenter Integration deployments. For more information, see Best Practices
and Recommendations for Scale-up Deployments of SAP HANA on VMware vSphere and Best Practices and
Recommendations for Scale-Out Deployments of SAP HANA on VMware vSphere.
Hitachi LPAR
Hitachi Unified Compute Platform for the SAP HANA Platform with logical partitioning (LPAR) in a scale-up or
multi-VM configuration is a pre-configured virtual appliance ready to plug into a network to provide real-time
access to operational data for use in analytic models. SAP HANA on Hitachi solutions with logical partitioning
are based on a number of bare metal appliance configurations with modifications that are required for running
logical partitions (LPARs) in dedicated mode. For more information, see Hitachi Unified Compute Platform for
the SAP HANA Platform with Logical Partitioning in a Scale-Up Configuration Using Hitachi Compute Blade 2500
and Hitachi Virtual Storage Platform.
Huawei FusionSphere
SAP HANA is supported for production and non-production use in a virtualized environment using Huawei
FusionSphere. For more information, see Best Practices for Deploying SAP HANA on Huawei FusionSphere
Virtualization Platform and Guide for Deploying SAP HANA on Huawei FusionSphere Virtualization.
SAP HANA is supported on the KVM (Kernel-based Virtual Machine) hypervisor in a non-production
environment. For more information, see SAP HANA ON KVM BEST PRACTICES RESOURCE GUIDE.
SAP HANA can be run in virtualized environments using XEN and KVM for virtual single VM deployments for
test and development scenarios. Both the XEN and KVM hypervisor are built into SUSE Linux Enterprise Server
for SAP Applications. For more information, see SAP Note 2284516 - SAP HANA virtualized on SUSE Linux
Enterprise hypervisors .
IBM PowerVM
SAP HANA can be deployed on IBM PowerVM for IBM Power Systems. PowerVM is a combination of hardware,
PowerVM Hypervisor, and software, which includes other virtualization features, such as the Virtual I/O Server.
For more information, see IBM PowerVM Best Practices.
Related Information
SAP Note 1788665 - SAP HANA Support for virtualized and partitioned (multi-tenant) environments
Best Practices and Recommendations for Scale-up Deployments of SAP HANA on VMware vSphere
Best Practices and Recommendations for Scale-Out Deployments of SAP HANA on VMware vSphere
Hitachi Unified Compute Platform for the SAP HANA Platform with Logical Partitioning in a Scale-Up
Configuration Using Hitachi Compute Blade 2500 and Hitachi Virtual Storage Platform
Best Practices for Deploying SAP HANA on Huawei FusionSphere Virtualization Platform
Guide for Deploying SAP HANA on Huawei FusionSphere Virtualization
SAP HANA ON KVM BEST PRACTICES RESOURCE GUIDE
SAP Note 2284516 - SAP HANA virtualized on SUSE Linux Enterprise hypervisors
IBM PowerVM Best Practices
SAP HANA with Virtualization
Note
The local secure store can optionally be used instead of the instance SSFS (secure store in the file system).
After the installation of the local secure store has finished successfully, the local secure store must be
activated before it can be used. For more information, see Activate the Local Secure Store (LSS).
To activate the local secure store during installation, run hdblcm with the parameter
secure_store=localsecurestore.
Restriction
The local secure store (LSS) is not supported by SAP HANA Dynamic Tiering. For more information, see
SAP Note 2935272.
For more information, see the section on the local secure store in the SAP HANA Security Guide.
Related Information
SAP HANA supports multiple isolated databases in a single SAP HANA system. These are referred to as tenant
databases.
An SAP HANA system is capable of containing more than one tenant database.
A system always has exactly one system database, used for central system administration, and any number of
tenant databases (including zero). An SAP HANA system is identified by a single system ID (SID). Databases
are identified by a SID and a database name. From the administration perspective, there is a distinction
between tasks performed at system level and those performed at database level. Database clients, such as the
SAP HANA cockpit, connect to specific databases.
All the databases share the same installation of database system software, the same computing resources, and
the same system administration. However, each database is self-contained and fully isolated with its own:
Although database objects such as schemas, tables, views, procedures, and so on are local to the database,
cross-database SELECT queries are possible. This supports cross-application reporting, for example.
An SAP HANA database consists of multiple servers, for example, name server, index server, preprocessor
server, and so on. The databases in an SAP HANA system run different combinations of these servers. The
most important server is the index server. It contains the actual data stores and the engines for processing the
data and runs in every tenant database.
Only the system database runs the name server. The name server contains landscape information about the
system as a whole, including which tenant databases exist. It also provides index server functionality for the
system database. The name server does not own information about the location of tables and table partitions
in tenant databases. Database-related information is stored in the relevant tenant database catalog.
Tenant databases require only an own index server. Servers that do not persist data, such as the compile
server and the preprocessor server, run on the system database and serve all databases.
Note
For a full list and description of all SAP HANA servers, see Server Components of the SAP HANA Database.
The following figure shows a sample system with three databases (system database and three tenant
databases) on a single host.
Note
If the SAP HANA XS classic server is available, it runs embedded in the (master) index server of the tenant
database by default, although it can be added as a separate service if necessary. The SAP Web Dispatcher,
which runs as a separate database service on the host of the system database, is used to route incoming
HTTP requests from clients to the correct XS classic server based on virtual host names. This is part of
network configuration. In addition to the system-internal Web Dispatcher, you can implement an external
Web Dispatcher for load distribution. See the section on using the SAP Web Dispatcher for load balancing
with tenant databases.
Related Information
To ensure system availability, an instance of the system database runs on all hosts (worker and standby) in a
single master and multiple workers configuration. Tenant databases can be created on worker hosts and
existing databases can be scaled out through the addition of services. If a host fails, the standby instance will
fail over all active databases and their services. Like in a single-host system, the master candidate for a failing
host is determined. On that host the system database is restarted, if necessary. Up to three hosts can be
configured to act as the master host of a system. These three hosts can be set up in the clients with the
database name to be reconnected to a tenant database even in the case of a host auto-failover of the master
host with the system database.
The following figure shows a tenant database system with three tenant databases distributed across three
hosts. Tenant database DB1 has only one index server on host 1, while DB2 and DB3 are distributed across
several hosts. Tenant database DB2, for example, is divided into three database shards, each of them with its
own index server on a different host. In this context, a database shard is the union of all tables, partitions and
replicas of one database that reside on one index server. Tenant database DB3 consists of two shards, one on
host 2 and one on host 3. System administrators can specify the host when they create the tenant database, or
they can let SAP HANA chose an appropriate host based on load-balancing algorithms.
Scale-Out Recommendations
When planning your SAP HANA deployment with tenant databases, various options exist with regard to scale-
up versus scale-out.
In general, scaling up offers some performance advantages over scaling out, as memory access is local and
minor overhead associated with inter-node network communication is avoided.
Related Information
The system database is created during either installation or conversion from a single-container system to a
tenant database system. The system database contains information about the system as a whole, as well as all
its tenant databases. It is used for central system administration.
A system has exactly one system database. It contains the data and users for system administration. System
administration tools, such as the SAP HANA cockpit, can connect to this database. The system database
stores overall system landscape information, including knowledge of the tenant databases that exist in the
system. However, it doesn't own database-related topology information, that is, information about the location
of tables and table partitions in databases. Database-related topology information is stored in the relevant
tenant database catalog.
Administration tasks performed in the system database apply to the system as a whole and all of its databases
(for example, system-level configuration settings), or can target specific tenant databases (for example,
backup of a tenant database). For more information, see Administration of Tenant Databases.
● The system database does not have the same functionality as a tenant database.
● The system database is not a database with full SQL support.
● The system database cannot be distributed across multiple hosts, in other words, scale-out is not possible.
● If you need a full-featured SAP HANA database, you always have to create at least one tenant database.
● The system database does not support Application Function Libraries (AFL) and SAP liveCache
applications.
Related Information
Read-only queries between tenant databases in the same SAP HANA system are possible. This supports cross-
application reporting. Cross-database access must be explicitly enabled.
Every tenant database is self-contained with its own isolated set of database users and isolated database
catalog. However, to support for example cross-application reporting, cross-database SELECT queries are
possible. This means that database objects such as tables and views can be local to one database but be read
by users from other databases in the same system.
The following object types on remote databases can be accessed using cross-database access:
● Schemas
● Rowstore and columnstore tables (not including virtual tables)
● SQL views (not including monitoring views)
● Graphical calculation views
○ If they only use supported object types as data sources
○ If they don’t use procedure-based analytic privileges
● Synonyms
The following object types on the local tenant database can access database objects on the remote tenant
database:
● SQL views
● Scripted and graphical calculation views
● Procedures
● Synonyms
The SAP HANA modeler supports modeling of graphical calculation views using tables and other graphical
calculation views as data sources from different tenant databases. For more information, see Tenant Databases
Support for Modeling Graphical Calculation Views in the SAP HANA Modeling Guide (For SAP HANA Studio).
Related Information
Every tenant database is self-contained and isolated in terms of users, database catalog, repository, logs, and
so on. However, to protect against unauthorized access at the operating system (OS) level, it's possible to
increase isolation further through OS user separation and authenticated communication within databases.
OS User Separation
By default, all database processes run under the default OS user <sid>adm. If it's important to mitigate against
cross-database attacks through OS mechanisms, you can configure the system for high isolation. In this way,
the processes of individual tenant databases must run under dedicated OS users belonging to dedicated OS
groups, instead of all database processes running under <sid>adm. Database-specific data on the file system
is then protected using standard OS file and directory permissions.
Note
Authenticated Communication
In addition, once high isolation has been configured, internal database communication is secured using the
Transport Layer Security (TLS)/Secure Sockets Layer (SSL) protocol. Certificate-based authentication is used
to ensure that only the processes belonging to the same database can communicate with each other. It’s also
possible to configure internal communication so that all data communication within databases is encrypted.
Note
Configuration
You can specify the isolation level of the system during installation. The default isolation level is low. It’s also
possible to change the isolation level of an existing system (from low to high or from high to low) at any time.
For more information, see Increase the System Isolation Level in the SAP HANA Administration Guide. Once high
isolation has been configured, a dedicated OS user and group must exist for every tenant database. Otherwise,
it's not possible to create or start a tenant database.
Internal database communication is secured with the same mechanism used for securing other internal SAP
HANA communication channels. Once high isolation has been configured, authenticated communication
within databases is enabled without any change required to the default TLS/SSL configuration for internal
communication. However, encryption of data communication may need to be configured explicitly.
Related Information
In SAP HANA systems there is a distinction between administration tasks performed at system level and those
performed at database level.
Some administration tasks are performed in the system database and apply globally to the system and all its
databases. They include for example:
Some administration tasks are performed in the tenant database and apply only to that database. They include
for example:
Administration Tools
Several tools are available for the administration of SAP HANA. While all tools support database-level
administration, system-level administration of tenant databases requires the SAP HANA cockpit (for example,
monitoring availability of tenant databases, creating and deleting tenant databases).
For more information about the SAP HANA cockpit and other administration tools, see the section on
administration tools in the SAP HANA Administration Guide.
Tenant Databases
The System Database [page 35]
Creating and Configuring Tenant Databases
SAP HANA Administration Tools
Monitoring and Managing Tenant Databases
The SAP HANA database lifecycle manager (HDBLCM) is used to perform SAP HANA platform lifecycle
management (LCM) tasks, including installing, updating, and configuring an SAP HANA system. The SAP
HANA database lifecycle manager is designed to accommodate hardware partners and administrators, and so
it offers a variety of usage techniques.
The SAP HANA database lifecycle manager is used by means of program interface type, program interaction
mode, and parameter entry mode. Before using the SAP HANA database lifecycle manager, you should choose
which user interface you prefer to use and how you want to modify the platform LCM task to achieve your
desired result. You modify the actions of the platform LCM tools using parameters. Parameters can be modified
in a number of ways, for example, in the entry field of a graphical interface, as a call option with the program
call, or in a configuration file. These options can be mixed and matched depending on the parameters you need
to use and the program interaction mode you choose.
Command-Line Interface
The first choice to make is which SAP HANA database lifecycle manager (HDBLCM) interface type you prefer
to use. The SAP HANA HDBLCM program can be run as a graphical user interface, a command-line interface,
or as Web user interface in a Web browser (the Web user interface is not available for all platform LCM tasks).
Once you've chosen the graphical user, command-line, or Web user interface, you can decide if you prefer to
interactively enter parameter values, or give all required parameters with the call to the platform LCM tool, and
let it run unattended to completion. Interactive mode is available for all user interfaces, and is the default mode
for program interaction. To use interactive mode, you simply call the SAP HANA HDBLCM user interface, and
enter parameter values as they are requested by the program. Advanced interactive mode involves entering
some parameter values interactively and providing some parameter values as call options or in a configuration
file. This is the recommended interaction mode if you'd like to modify parameter default values which are not
requested in interactive mode. Batch mode is an advanced platform LCM interaction method because all
required parameters must be provided with the call to the LCM program on the command line. Batch mode is
designed for large-scale platform LCM tasks, which would be time consuming to perform interactively.
Platform LCM parameters can be entered interactively (only available for interactive mode or advanced
interactive mode), as a call option on the command line, or via a configuration file. If you are performing
platform LCM tasks in advanced interactive mode, you can choose any of the three parameter entry methods
(or use more than one). If you are using batch mode, you must enter parameter values either as call options to
the SAP HANA database lifecycle manager or from a configuration file. The syntax for the parameters as call
options can be found in the Parameter Reference. The configuration file is generated as a blank template, then
edited, and called as a call option.
5.1 Choosing the Correct SAP HANA HDBLCM for Your Task
It is important to distinguish between the version of the SAP HANA database lifecycle manager (HDBLCM) that
is available on the installation medium and the version that is unpacked during installation, and subsequently
used to perform administration and configuration tasks after the SAP HANA system has been installed.
The SAP HANA database lifecycle manager is available in two varieties - an installation medium version to
perform installation and update, and a resident version for update and configuration that is unpacked on the
SAP HANA host during installation or update. The SAP HANA resident HDBLCM has been designed to be
version-compatible. That means, every time you install or update an SAP HANA system, you can be sure that
any subsequent configuration tasks performed with the SAP HANA database lifecycle manager will work as
expected because the installation or update tool and the configuration tool are of the same version and have
been tested together. The SAP HANA resident HDBLCM is located at <sapmnt>/<SID>/hdblcm.
SAP HANA platform lifecycle management tasks can be performed from a graphical, command-line and Web
user interface.
Related Information
Use the Graphical User Interface to Perform Platform LCM Tasks [page 43]
Use the Command-Line Interface to Perform Platform LCM Tasks [page 44]
Using the Web User Interface [page 45]
SAP HANA platform lifecycle management tasks can be performed from a graphical interface.
Procedure
1. Change to the directory where the SAP HANA database lifecycle manager is located:
Option Description
In general, installation and update is carried out from the installation medium. Configuration tasks are
performed using the SAP HANA resident HDBLCM. For more information about the two SAP HANA
database lifecycle manager types, see Related Information.
./hdblcmgui
3. Enter parameter values in the requested fields. In addition, you can specify parameter key-value pairs as
call options or in the configuration file template.
Note
If parameter key-value pairs are specified as command-line options, they override the corresponding
parameters in the configuration file. Parameters in the configuration file override default settings.
For more information about program interaction modes and parameter values entry methods, see Related
Information.
Related Information
Choosing the Correct SAP HANA HDBLCM for Your Task [page 42]
Entering Platform LCM Parameters as Call Options from the Command Line [page 57]
Procedure
1. Change to the directory where the SAP HANA database lifecycle manager is located:
Option Description
In general, installation and update is carried out from the installation medium. Configuration tasks are
performed using the SAP HANA resident HDBLCM. For more information about the two SAP HANA
database lifecycle manager types, see Related Information.
./hdblcm
○ Interactive parameter entry - If you call the SAP HANA platform LCM tool only, the program runs in
interactive mode. Parameter default values are suggested in brackets, and can be accepted with Enter.
Otherwise, enter a non-default value, then select Enter.
○ Command-line parameter entry as call options - If you enter parameter key-value pairs as call
options with the call to the SAP HANA platform LCM tool, the program runs in advanced interactive
mode and requests values for any parameter values which you didn't specify in the original input. If you
entered the batch mode call option, the program runs to completion without any further requests,
unless a mandatory parameter was left out of the original input, in which case, the program fails to
perform the platform LCM task.
○ Configuration file parameter entry - If you enter parameter key-value pairs in the configuration file
template, and enter the configuration file path as a call option with the call to the SAP HANA platform
LCM tool, the program runs in advanced interactive mode and requests values for any parameter
values which you didn't specify in the original input. If you entered the batch mode call option, the
program runs to completion without any further requests, unless a mandatory parameter was left out
of the original input, in which case, the program fails to perform the platform LCM task.
Note
If parameter key-value pairs are specified as command-line options, they override the corresponding
parameters in the configuration file. Parameters in the configuration file override default settings.
For more information about program interaction modes and parameter values entry methods, see Related
Information.
Related Information
Choosing the Correct SAP HANA HDBLCM for Your Task [page 42]
Performing LCM Tasks by Parameter Entry Method [page 54]
Performing LCM Tasks by Program Interaction Mode [page 50]
Entering Platform LCM Parameters as Call Options from the Command Line [page 57]
SAP HANA platform lifecycle management tasks can be performed using the SAP HANA database lifecycle
manager (HDBLCM) Web user interface.
The SAP HANA database lifecycle manager (HDBLCM) Web user interface is hosted by the SAP Host Agent,
which is installed on the SAP HANA host. When installing or updating the SAP HANA system, as part of the SAP
HANA resident HDBLCM configuration, the SAP HANA system deploys its artifacts on the SAP Host Agent,
thus enabling the Web user interface.
All Web user interface actions are always performed in the context of an already installed and registered SAP
HANA system. In order to access the SAP HANA database lifecycle manager Web user interface you need to log
on as the system administrator user <sid>adm.
The communication between the Web browser and the SAP Host Agent is always done over HTTPS, which
requires that the SAP Host Agent has a secure sockets layer (SSL) certificate (PSE) in its security directory. For
more information about SSL certificate handling, see Related Information.
The backend is provided by the special executable hdblcmweb, which is started automatically by the SAP Host
Agent as soon as an action is triggered from the Web user interface and terminates after the action completes.
Note
You should never start hdblcmweb manually. For security reasons, hdblcmweb is always started with
system administrator user <sid>adm privileges. If you require logging with individual users (to ensure
personalized logging), use the SAP HANA database lifecycle manager graphical user or command-line
interface.
Make sure that the system administrator user <sid>adm has permissions to read the paths, passed as
parameters in the Web user interface (for example, the SAP HANA database installation kit or locations
with SAP HANA components).
One platform LCM task, which is worth special attention is the update of the SAP HANA system and
components. The SAP HANA system updates are always performed by the installation kit SAP HANA database
lifecycle manager in the graphical user and command-line interfaces, (and not the SAP HANA resident
HDBLCM). This is because the SAP HANA database lifecycle manager, in the graphical user and command-line
interfaces, is not forward compatible. Meaning that only the new version of the tool knows how to update an
older system.
On the other hand, all scenarios in the Web user interface are handled by the SAP HANA resident HDBLCM,
which is part of the system. For this reason, as a first step before even starting the update process, you are
required to enter a location of an SAP HANA database installation kit. After detecting the kit, the update Web
user interface is loaded from the installation kit and the installation kit SAP HANA database lifecycle manager
starts serving as backend until the update process finishes. It is as if you start the SAP HANA database lifecycle
manager directly from the installation kit in graphical user or command-line interface.
Related Information
The SAP HANA database lifecycle manager (HDBLCM) can be accessed as a Web user interface in either a
standalone browser or in the SAP HANA cockpit.
Prerequisites
You should verify that the following prerequisites are fulfilled before trying to access the SAP HANA database
lifecycle manager from a Web browser.
Note
For more information about supported Web browsers for the SAP HANA database lifecycle manager
Web interface, see the browser support for sap.m library in the SAPUI5 Developer Guide.
Context
The Web user interface supports only the following SAP HANA platform lifecycle management tasks:
Procedure
Option Description
Web browser Enter the SAP HANA database lifecycle manager (HDBLCM) URL in an HTML5-enabled browser:
https://<hostname>:1129/lmsl/HDBLCM/<SID>/index.html
Note
The URL is case sensitive. Make sure you enter upper and lower case letters correctly.
1. Enter the URL of the SAP HANA cockpit administration and monitoring console in your browser.
SAP HANA
https://<host_FQDN>:<port>
cockpit
Note
FQDN = fully qualified domain name
2. Drill down on the name of the system from My Resources or from a group.
3. The links in Platform Lifecycle Management each launch additional functionality, giving you expanded
capabilities for managing the resource.
Results
The SAP HANA database lifecycle manager is displayed as a Web user interface in either a standalone browser
or in the SAP HANA cockpit.
Related Information
In the SAP HANA database lifecycle manager (HDBLCM) Web user interface, you can log off from an SAP
HANA system and close all connections to the system. To be able to connect to system again, you must log on.
Procedure
Note
If you have problems with the Web user interface, see SAP Note 2078425 for steps you can take to
troubleshoot and resolve them.
Note
The Web browser used to render the platform lifecycle management Web user interface in the SAP HANA
studio cannot be changed via Windows Preferences General Web Browser .
Related Information
SAP Note 2078425 - Troubleshooting note for SAP HANA Platform Management tool hdblcm
SAP HANA platform lifecycle management tasks can be performed in interactive mode, advanced interactive
mode and batch mode.
Interactive mode is a method for running SAP HANA platform lifecycle management (LCM) tools which starts
the program and requires you to enter parameter values successively before the program is run. Interactive
mode is the default mode for the SAP HANA platform LCM tools.
Context
In general, installation and update is carried out from the installation medium. Configuration tasks are
performed using the SAP HANA resident HDBLCM. For more information about the different SAP HANA
database lifecycle manager types, see Related Information.
The SAP HANA platform LCM tools offer a wide variety of parameters which can modify the platform LCM task
you are performing. Some parameters can be modified in interactive mode when the graphical user, command-
line, or Web user interface requests a value for a given parameter.
Procedure
1. Change to the directory where the SAP HANA database lifecycle manager is located:
Option Description
To access the SAP HANA database lifecycle manager Web user interface, see Related Information.
To start the SAP HANA platform LCM tools in interactive mode, simply do not enter the parameter for
batch mode (--batch or -b) as a call option. You can enter any other required parameters as call options
or load a configuration file. The program runs in interactive mode and requests any missing parameters
values, which must be verified or changed. You are provided with a summary of parameter values, which
you can accept to run the program to completion, or reject to exit the program.
Related Information
Choosing the Correct SAP HANA HDBLCM for Your Task [page 42]
Use the Web User Interface to Perform Platform LCM Tasks [page 47]
Interactive mode is a method for running SAP HANA platform lifecycle management (LCM) tools which starts
the program and requires you to enter parameter values successively before the program is run. If you would
like to enter call options not available in interactive mode, or make use of the configuration file, you can use a
combination of interactive mode and advanced parameter entry methods.
Context
In general, installation and update is carried out from the installation medium. Configuration tasks are
performed using the SAP HANA resident HDBLCM. For more information about the different SAP HANA
database lifecycle manager types, see Related Information.
The SAP HANA platform LCM tools offer a wide variety of parameters which can modify the platform LCM task
you are performing. Some parameters can be modified in interactive mode when the graphical user, command-
line, or Web user interface requests a value for a given parameter. However, some parameters are not available
in interactive mode, and must be specified either as a call option with the call to the platform LCM tool, or from
within a configuration file.
Using the configuration file for interactive mode is recommended if you plan to perform the exact same
platform LCM task multiple times.
2. Change to the directory where the SAP HANA database lifecycle manager is located:
Option Description
3. If you plan to use a configuration file, prepare it with the following steps:
a. Generate the configuration file template using the SAP HANA platform lifecycle management tool:
Run the SAP HANA platform LCM tool using the parameter dump_configfile_template as a call
option. Specify an action and a file path for the template. A configuration file template and a password
file template are created.
or
If you are using a configuration file, you must use the call option --configfile=<file path>.
Related Information
Choosing the Correct SAP HANA HDBLCM for Your Task [page 42]
Batch mode is a method for running the SAP HANA database lifecycle manager which starts the program and
runs it to completion without requiring you to interact with it any further. All required parameter values must be
passed as call options or from a configuration file.
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
In general, installation and update is carried out from the installation medium. Configuration tasks are
performed using the SAP HANA resident HDBLCM. For more information about the different SAP HANA
database lifecycle manager types, see Related Information.
If you are new to performing the desired SAP HANA platform LCM task in batch mode, it is recommended to
run some tests before using batch mode in a production environment.
Procedure
1. Change to the directory where the SAP HANA database lifecycle manager is located:
Option Description
or
Example
The following example installs the SAP HANA server and client 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.
Related Information
Choosing the Correct SAP HANA HDBLCM for Your Task [page 42]
Specifying Passwords [page 76]
Use LCM Configuration Files to Enter Parameters [page 55]
Entering Platform LCM Parameters as Call Options from the Command Line [page 57]
SAP HANA platform lifecycle management (LCM) parameter values can be entered in a variety of methods:
interactively by iteratively providing values in either the graphical interface or command prompt, as command-
line options with the call to the platform LCM tool, or in a configuration file.
SAP HANA platform lifecycle management parameter values allow you to customize your SAP HANA
installation, update, or configuration. Parameter values can be entered by one or more of the following
methods:
Interactively Using either command line interface, the graphical interface or the Web user interface,
(Default) most parameters are 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.
Configuration The configuration file is a plain text file, for which a template of parameter key-value pairs
File can be generated, edited, and saved to be called in combination with the program call. If
any mandatory parameters are not specified, they are requested interactively (unless
batch mode is used). All parameters can be entered in the configuration file. For more
information about the configuration file, see Related Information.
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.
SAP HANA platform LCM interactive mode is default interaction mode for all platform LCM programs and
interfaces.
You can run the graphical, command-line, or Web user interface in interactive mode by simply starting the
program, and entering parameter values as they are requested by the program. In interactive mode, parameter
default values are suggested in brackets and can be accepted with Enter .
Not all parameters are requested in interactive mode. If you would like to configure a parameter not offered in
interactive mode, you must enter it as a call option with the call to the platform LCM program, or use
corresponding configuration file for the platform LCM task.
By defining a prepared configuration file during installation, specified parameter values are used by the SAP
HANA platform lifecycle management (LCM) tools to build a customized SAP HANA system.
Context
The configuration file is a plain text file of specified 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 with the call to the SAP HANA database lifecycle manager (HDBLCM).
Procedure
1. Change to the directory where the SAP HANA database lifecycle manager is located:
Option Description
In general, installation and update is carried out from the installation medium. Configuration tasks are
performed using the SAP HANA resident HDBLCM. For more information about the two SAP HANA
database lifecycle manager types, see Related Information.
2. Generate the configuration file template using the SAP HANA platform lifecycle management tool:
Run the SAP HANA platform LCM tool using the parameter dump_configfile_template as a call
option. Specify an action and a file path for the template. A configuration file template and a password file
template are created.
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.
4. Start the SAP HANA platform lifecycle management tool:
Run the SAP HANA platform LCM tool using the parameter configfile as a call option. Specify the file
path of the edited template.
You can specify the path to a directory in which custom configuration files are saved using the parameter
custom_cfg as a call option.
Call options are available for every SAP HANA platform LCM program.
● The parameter is not available in interactive mode, but can be entered as a call option.
● You are using batch mode.
● You are using a configuration file, but would like to override a parameter in the configuration file with a new
value.
● You are installing an SAP HANA multiple-host system from the command line.
Call options start with a double dash (--) if they are written in long-form syntax. Some parameters also have
short-form syntax, in which they are preceded with a single dash (-). For more information about call option
syntax, see the Parameter Reference topics.
Related Information
SAP HANA platform lifecycle management tasks can be performed on multiple-host systems centrally, by
running the SAP HANA database lifecycle manager (HDBLCM) from any worker host and using remote
execution to replicate the call on all remaining system hosts. Otherwise, the platform LCM tasks can be
executed first on a worker host, and then re-executed manually on each remaining host. This method is
considered decentralized execution.
The following is an example of an SAP HANA system update performed centrally and decentrally.
SAP HANA platform lifecycle management (LCM) tasks can be performed centrally on multiple-host SAP
HANA systems in a number of ways depending on the available certificate keys and the remote execution
configuration.
An SAP HANA system must be installed with root user credentials. During installation a secure shell (SSH) key
is configured so that future platform LCM tasks can be performed remotely on multiple-host SAP HANA
systems without requiring the root user password.
By default, the SAP HANA database lifecycle manager (HDBLCM) uses SSH during SAP HANA system
installation or update. In order to use SSH, the SFTP subsystem must be active. Install the SAP Host Agent on
Note
Platform LCM tasks cannot be executed remotely via SSH as the system administrator user <sid>adm.
The root user name must be the same for all hosts in a multiple-host system. The password of the root user
must be identical on all hosts. If the passwords are not identical on all hosts or if you do not want to pass the
passwords to the SAP HANA database lifecycle manager (HDBLCM), SSH keys can be distributed between the
hosts in advance. Alternatively, platform LCM tasks can be executed without root credentials by using the SAP
Host Agent.
Related Information
SAP Note 1944799 - SAP HANA Guidelines for SLES Operating System Installation
SAP Note 2009879 - SAP HANA Guidelines for Red Hat Enterprise Linux (RHEL) Operating System
Using SAP Host Agent to Execute Platform LCM Tasks [page 59]
Platform LCM tasks can be executed without root credentials by using the SAP Host Agent. The SAP Host
Agent is installed and updated by default during SAP HANA system installation and update.
The SAP HANA database lifecycle manager (HDBLCM) relies on the SAP Host Agent for the following
functionality to work:
Note
The SAP HANA cockpit uses the SAP Host Agent to execute tasks as the system administrator user
<sid>adm, for example, stopping and starting the system, or troubleshooting a system experiencing
performance problems.
If execution on the remote hosts is done via SSH (default, --remote_execution=ssh), the SAP HANA
database lifecycle manager is able to connect to a remote host via SSH and install and configure the SAP Host
Agent. In contrast, the remote execution via SAP Host Agent (--remote_execution=saphostagent)
requires that the SAP Host Agent is installed and configured on all involved hosts in advance, which includes:
Caution
Use the call option --use_http with caution, because passwords are also transferred in plain text via
HTTP.
Related Information
To enable secure communication with the SAP Host Agent over HTTPS, the SAP Host Agent needs a secure
sockets layer (SSL) certificate in its security directory. This certificate is also used by the SAP HANA database
lifecycle manager (HDBLCM) Web-based user interface because the Web pages are served by the SAP Host
Agent.
The SAP HANA database lifecycle manager handles certificate management during system installation,
update, or rename, as well as during the addition of new hosts as follows:
● If there is no certificate in the SAP Host Agent security directory, the SAP HANA database lifecycle
manager generates one. The SAP HANA host name is used as the default certificate owner. The certificate
owner can be changed by using the call option --
certificates_hostmap=<fully_qualified_domain_name>.
● If there is an existing certificate, the following applies:
○ If the certificate host name is not passed to the SAP HANA database lifecycle manager, or if the
certificate host name is the same as the owner of the current certificate, the current certificate is
preserved.
○ If the certificate host name is passed via the call option --certificates_hostmap and it differs from
the owner of the current certificate, a new certificate is generated.
○ During update of an SAP HANA system, if the certificates on all hosts are in place, the call option --
certificates_hostmap is ignored and the current certificates are preserved.
If you want to use your own SSL certificates, see the SAP Host Agent documentation in Related Information.
Related Information
When starting platform LCM tasks as the system administrator user <sid>adm, the SAP HANA database
lifecycle manager (HDBLCM) requires the usage of SAP Host Agent for execution of remote and local
operations.
The following tasks in the SAP HANA database lifecycle manager can be performed as the system
administrator user <sid>adm:
Make sure that SAP Host Agent is installed and configured (HTTPS-enabled) on all hosts of the SAP HANA
system.
Note
Platform LCM tasks cannot be executed remotely via SSH as the system administrator user <sid>adm.
Note
Make sure that the system administrator user <sid>adm has permissions to read the paths passed as
parameters (for example, the locations of the SAP HANA components).
You can add hosts to an SAP HANA system using the SAP HANA database lifecycle manager (HDBLCM)
resident program in combination with the SAP Host Agent in the command-line interface.
Prerequisites
● The SAP HANA system has been installed with its server software on a shared file system (export options
rw, no_root_squash).
● The host which is to be added has access to the installation directories <sapmnt> and <sapmnt>/<SID>.
● The SAP Host Agent is installed on the host which is to be added. The SAP Host Agent will create
the<sapsys> group, if it does not exist prior to installation. Make sure that the group ID of the <sapsys>
Procedure
cd <sapmnt>/<SID>/hdblcm
./hdblcm --remote_execution=saphostagent
Results
You have added one or more new hosts to an SAP HANA system. The SAP HANA system you have configured is
a multiple-host system.
The new hosts have been added to the SAP HANA landscape information. The new hosts have been added to
the landscape information of the system database.
This configuration task can also be performed in batch mode and using a configuration file. For more
information about the available configuration methods, see Using the SAP HANA Platform LCM Tools.
In some circumstances platform LCM actions must be executed on each individual host of the multiple-host
system. This is referred to as decentralized execution.
Typically, SAP HANA platform lifecycle management actions, such as update, rename, and inter-service
communication configuration, can be performed on a multiple-host system from one host. This is referred to
as centralized execution and requires SSH or root credentials. For more information, see Centralized
Execution of Platform LCM Tasks in Related Information.
In some circumstances, a secure shell (SSH) key may not be installed or root credentials are not available. In
this case, the platform LCM actions must be executed on each individual host of the multiple-host system,
which is also known as decentralized execution. For more information about decentralized execution, see SAP
Note 2048681 in Related Information.
Related Information
SAP Note 2048681 - Performing SAP HANA platform lifecycle management administration tasks on multiple-
host systems without SSH or root credentials
Executing Platform LCM Tasks [page 57]
Centralized Execution of Platform LCM Tasks [page 58]
If you have already familiarized yourself with the way the SAP HANA database lifecycle manager (HDBLCM)
works, you may be interested in additional information like log and trace files, Linux kernel parameter settings,
or troubleshooting.
Related Information
5.6.1 Logging
SAP HANA platform lifecycle management processes are logged by the system. The log files are stored in the
following path:
/var/tmp/hdb_<SID>_<action>_<time stamp>
The following log files are written while performing the action:
You can also view diagnostic files in the SAP HANA database explorer using the administration function. For
more information, see View Diagnostic Files in the SAP HANA Database Explorer in the SAP HANA
Administration Guide.
Instant Logging
If an LCM action crashes or hangs before the execution is finished, even if no LCM action trace is enabled,
HDBLCM writes a trace, which has the function of a preliminary (unformatted) log file. Upon program
completion, this preliminary logfile is removed and replaced by the real, formatted log file.
The environment variable HDBLCM_LOGDIR_COPY=<target directory> creates a copy of the log directory.
Log Collection
If you perform platfom LCM actions on multiple-host SAP HANA systems, all log files are collected to a local
folder to make error analysis more convenient.
Related Information
The following table describes the parameters and limits that are set by the SAP HANA database lifecycle
manager (HDBLCM) during the installation or update of an SAP HANA database. The actual values may differ,
depending on your system configuration.
Note
The SAP HANA database lifecycle manager (HDBLCM) will only change existing values if they are lower
than the default values.
The SAP Host Agent can automatically optimize the following Linux Kernel Parameters:
● net.ipv4.ip_local_port_range
● net.ipv4.ip_local_reserved_ports
To configure the SAP Host Agent, make sure that the /etc/sysctl.conf configuration does not contain any
of these two parameters. Afterwards, configure the SAP Host Agent profile parameters as described in SAP
Note 401162.
kernel.shmall System-wide limit of total shared memory, in 4k ● RAM >= 35.5 TB: /etc/
pages (shmmax * sysctl.conf
shmmni) /
65536
● RAM < 35.5 TB:
(0.9 * <RAM
in bytes>) /
4096
Related Information
SAP Note 2382421 - Optimizing the Network Configuration on HANA- and OS-Level
SAP Note 401162 - Linux: Avoiding TCP IP port conflicts and start problems
The SAP HANA database lifecycle manager (HDBLCM) is a wrapper tool that calls the underlying HDB tools to
perform the platform LCM action. If something unexpected happens when using HDBLCM, and the LCM action
cannot be completed, you can check the logs and separately run the affected underlying tools.
Caution
We only recommend the following underlying tools to be used for troubleshooting purposes.
<installation path>/
<SID>/global/hdb/
install/bin
and
/usr/sap/<SID>/SYS/
global/hdb/
install/bin
and
/usr/sap/<SID>/SYS/
global/hdb/
install/bin
and
/usr/sap/<SID>/SYS/
global/hdb/
install/bin
hdbmodify This command line tool removes and adds <installation path>/
remote hosts. <SID>/global/hdb/
Furthermore, the listen interface can be install/bin
changed ('local', 'global', 'internal'). and
/usr/sap/<SID>/SYS/
global/hdb/
install/bin
and
/usr/sap/<SID>/SYS/
global/hdb/
install/bin
SAP HANA system components can be installed, updated, or uninstalled using the SAP HANA database
lifecycle manager (HDBLCM).
Note
To install or uninstall the Solution Manager Diagnostics Agent, use Software Provisioning Manager
(SWPM). For more information about the setting up the Solution Manager Diagnostics Agent using
SWPM, see SAP Note 1858920 in Related Information.
Note
SAP LT replication configuration is a part of SL Toolset 1.0. For more information about configuring SAP
LT replication, see SAP Note 1891393 in Related Information.
For more information about installing, updating, and uninstalling the SAP HANA mandatory components and
SAP HANA additional components, see the SAP HANA Server Installation and Update Guide. For more
information about installing, updating, and uninstalling the SAP HANA options, see SAP HANA option
documentation in Related Information.
Caution
Be aware that you need additional licenses for SAP HANA options. For more information, see Important
Disclaimer for Features in SAP HANA Platform, Options and Capabilities in Related Information.
Related Information
You can check the installation of an SAP HANA system using the SAP HANA database lifecycle manager
(HDBLCM) resident program in the command-line interface for troubleshooting.
Prerequisites
● The SAP HANA system has been installed with its server software on a shared file system (export options
rw, no_root_squash).
Procedure
cd <sapmnt>/<SID>/hdblcm
./hdblcm --action=check_installation
Results
The check tool outputs basic information about the configuration of the file system, system settings,
permission settings, and network configuration. The checks are based on the property file stored in the
following path:
<sapmnt>/<SID>/global/hdb/install/support/hdbcheck.xml
Use the generated log files as a reference in the case of troubleshooting. The log file is stored in the following
path:
/var/tmp/hdb_<SID>_hdblcm_check_installation_<time stamp>/hdblcm.log
Related Information
The SAP HANA database lifecycle manager (HDBLCM) is used to install an SAP HANA system, including
server, client, studio, and additional components, in a graphical user interface or the command-line interface.
The SAP HANA system can be uninstalled or configured using the resident version of the SAP HANA database
lifecycle manager (HDBLCM).
Related Information
The SAP HANA database lifecycle manager (HDBLCM) is used to install an SAP HANA system. Installation
parameters are a fundamental aspect of the SAP HANA database lifecycle manager (HDBLCM), 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.
The SAP HANA database lifecycle manager (HDBLCM) uses the following default values during installation
unless you change them.
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.
autoadd_xs_roles 1
(on)
autostart 0
(off)
client_path <sapmnt>/<SID>/hdbclient
components client,server,studio
configure_python python2
copy_repository /hana/shared/<SID>/hdbstudio_update
create_initial_tenant 1
(on)
datapath /hana/data/<SID>
db_isolation low
groupid 79
home /usr/sap/<SID>/home
import_xs_content 1
(on)
install_hostagent y
(on)
install_ssh_key y
(on)
logpath /hana/log/<SID>
lss_inst_path /lss/shared
lss_userid <SID>crypt
lss_user_home /usr/sap/<SID>/lss/home
lss_user_shell /bin/sh
max_mem 0
org_manager_user XSA_ADMIN
org_name orgname
prod_space_name PROD
remote_execution ssh
repository y
(on)
restrict_max_mem (off)
root_user root
sapmnt /hana/shared
shell /bin/sh
studio_path <sapmnt>/<SID>/hdbstudio
studio_repository 1
(on)
system_usage custom
workergroup default
xs_components <xsac_monitoring,xsac_services,xsac_ui5_fesv3,xsac_
portal_serv, xsac_alm_pi_ui,xsac_xsa_cockpit>
xs_components_nostart none
xs_customer_space_isolat 1
ion
(on)
xs_routing_mode <ports>
xs_sap_space_isolation 1
(on)
Note
To substitute parameters in configuration files and batch mode, they must be written in the form $
{<parameter>}. 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.
Related Information
The following users are automatically created during the installation: <sid>adm, sapadm, SYSTEM, and
<sid>crypt.
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 identifier (UID) of the <sid>adm user is defined during the system installation.
● The password of the <sid>adm user is set during installation with the password parame
ter.
● If you do not want the operating system user <sid>adm and its primary group to be created
automatically, you can create it before installation. This might be the case if you use central
user management such as Lightweight Directory Access Protocol (LDAP) or Network Infor
mation System (NIS). The SAP HANA database lifecycle manager (HDBLCM) will not mod
ify the properties of any existing user or group.
The following requirements apply:
○ The name of the user must follow the schema <sid>adm. All letters must be lower
case.
○ The user should have a UID greater than 999.
○ The primary group of the user must be sapsys. The default GID of the sapsys group
is 79.
○ The UID of this operating system user and GID of its primary group must be unique and
identical on each host of a multiple-host system.
● If there is no SAP Host Agent available on the installation host, it is created during the instal
lation along with the user sapadm.
● If the SAP Host Agent is already available on the installation host, it is not modified by the
installer. The sapadm user and password are also not modified.
● The password of the sapadm user is set during installation with the sapadm_password
parameter.
● If you do not want the user sapadm and its primary group to be created automatically, you
can create it before installation.
The following requirements apply:
○ The primary group of the user must be sapsys. The default GID of the sapsys group
is 79.
○ The GID of the primary group of the sapadm user must be unique and identical on
each host of a multiple-host system.
● Initially, the SYSTEM user has all system permissions. Additional permissions can be
granted and revoked again, however the initial permissions can never be revoked.
● Two SYSTEM users area created: one for the system database and one for the tenant data
base.
● The password of the SYSTEM user is set during installation with the
system_user_password parameter.
<sid>crypt
The trusted local secure store (LSS) user.
● The user <sid>crypt owns the storage of the encryption keys and other similarly sensitive
data.
● The user <sid>crypt is the only trusted user of the local secure store. Only processes
called by a trusted user are accepted by the LSS right away.
Related Information
Predefined Users
Operating System User sidadm
Predefined XS Advanced Users
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 the SAP HANA database lifecycle manager in the graphical user interface,
the command-line interface, and the Web user interface. 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
In the command line, passwords can be specified by passing them to the standard input stream of the SAP
HANA database lifecycle manager. The SAP HANA database lifecycle manager is called using the
read_password_from_stdin parameter in the command line with batch mode. For security reasons, you
may want to consider providing encrypted passwords along with a tool that decrypts the passwords and
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
installation that can be re-created several times. If passwords are specified in the configuration file, its
permission settings should limit access to the root user, for security reasons.
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:
Related Information
The SAP HANA database lifecycle manager can be used to install an SAP HANA single-host system in one of
the program interfaces, and with a combination of parameter specification methods.
A single-host system is the simplest system installation type. It is possible to run an SAP HANA system entirely
on one host and then scale the system up as needed.
The following graphic shows the file system for a single-host installation:
A single-host SAP HANA system can be installed using the SAP HANA database lifecycle manager (HDBLCM)
graphical user interface.
Prerequisites
Context
The following procedure describes the installation of an SAP HANA system in interactive mode by entering
parameters interactively. This procedure may also be performed in advanced interactive mode, with
parameters entered as call options or from a configuration file. For more information about interaction modes
and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.
As of SAP HANA 2.0 SPS 01, the multi-container database mode is the only database mode. By default, a single
tenant database is created during installation. You can add additional tenant databases later using the SAP
HANA cockpit. SAP HANA options hosts or host roles can be automatically provisioned to a system that is
installed with a single tenant. If the SAP HANA system contains multiple tenant databases, the SAP HANA
options host or host role must be manually provisioned to the tenant.
Note
Not all parameters are requested interactively. Some parameters have default values that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file. For more information about changeable default values, see Related Information.
Procedure
Option Description
Note
If you downloaded the components to a different directory, change to the directory where you
unpacked the archive.
./hdblcmgui
The SAP HANA database lifecycle manager graphical user interface appears.
Note
To activate the local secure (LSS) store during installation, run hdblcmgui with the parameter
secure_store=localsecurestore.
3. Select a detected software component or add a software component location by selecting Add Component
Location. Then select Next.
4. Select Install New System, then select Next.
5. Select the components you would like to install, then select Next.
6. Select Single-Host System as the System Type, then select Next.
7. Specify the SAP HANA system properties.
For a list of all system properties, see System Properties in Related Information.
8. After specifying all system properties, review the summary, and select Install.
Results
After installing the SAP HANA system, you may want to perform configuration tasks. For more information, see
Managing the SAP HANA System After Installation or the platform lifecycle management section of the SAP
HANA Administration Guide.
Related Information
A single-host SAP HANA system can be installed using the SAP HANA database lifecycle manager (HDBLCM)
command-line interface.
Prerequisites
Context
The following procedure describes the installation of an SAP HANA system in interactive mode and entering
parameters interactively. This procedure may also be performed in advanced interactive mode or batch mode,
with parameters entered as call options or from a configuration file. For more information about interaction
modes and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.
As of SAP HANA 2.0 SPS 01, the multi-container database mode is the only database mode. By default, a single
tenant database is created during installation. You can add additional tenant databases later using the SAP
HANA cockpit. SAP HANA options hosts or host roles can be automatically provisioned to a system that is
installed with a single tenant. If the SAP HANA system contains multiple tenant databases, the SAP HANA
options host or host role must be manually provisioned to the tenant.
Note
Not all parameters are requested interactively. Some parameters have default values that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file. For more information about changeable default values, see Related Information.
Procedure
Note
If you downloaded the components to a different directory, change to the directory where you
unpacked the archive.
2. Start the SAP HANA database lifecycle manager interactively in the command line:
./hdblcm
Note
To activate the local secure (LSS) store during installation, run hdblcm with the parameter
secure_store=localsecurestore.
3. Select the index for Install New System, then select Enter .
4. Select the components you would like to install as a comma-separated list, then select Enter .
5. Specify the SAP HANA system properties.
For a list of all system properties, see System Properties in Related Information.
6. After specifying all system properties, review the summary, and select y.
Results
After installing the SAP HANA system, you may want to perform configuration tasks. For more information, see
Managing the SAP HANA System After Installation or the platform lifecycle management section of the SAP
HANA Administration Guide.
Related Information
The SAP HANA database lifecycle manager can be used to install an SAP HANA multiple-host system in one of
the program interfaces, and with a combination of parameter specification methods.
A multiple-host system is a system with more than one host, which can be configured as active worker hosts or
idle standby hosts. The server software is based on a flexible architecture that enables a distributed
installation. This means that load can be balanced between different hosts. The server software has to be
installed in a shared file system. This file system has to be mounted by all hosts that are part of the system.
The following graphic shows the file system for a multiple-host installation using a shared file system:
To create a multiple-host system after installing a single-host system, hosts must be added to the SAP HANA
system. To add hosts to an existing system, use the SAP HANA resident HDBLCM. For more information about
host addition, see Related Information or the SAP HANA Administration Guide.
The following information only covers building a multiple-host system during installation.
It is important to review multiple-host system concepts like host grouping and storage options before installing
a multiple-host system.
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 wait to take over processes in the case of worker machine failure.
As an in-memory database, SAP HANA is not only concerned with maintaining the reliability of its data in the
event of failures, but also with resuming operations with most of that data loaded back in memory as quickly as
possible. Host auto-failover is a local fault recovery solution that can be used as a supplemental or alternative
measure to system replication. One (or more) standby hosts are added to a SAP HANA system, and configured
to work in standby mode.
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. The crash of a single service does not trigger failover since
services are normally restarted by hdbdaemon. For more information, see Setting Up Host Auto-Failover in the
SAP HANA Administration Guide.
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.
If you use SAP Business Warehouse to apply a temperature-based data strategy you can significantly optimize
the usage of memory and hardware resources by reserving one node of the scaled-out HANA landscape
exclusively for warm data. Due to information lifecycle management, multi-temperature strategies are often
applied, whereby data is classified by access frequency as either hot, warm, or cold. Depending on this
classification and data usage, this data is stored in different memory areas.
A multi-temperature memory strategy may be required for different reasons, for example:
The standard SAP HANA sizing guidelines allow for a data footprint of 50% of the available RAM. This ensures
that all data can be kept in RAM at all times and there is sufficient space for intermediate result sets. These
sizing guidelines can be significantly relaxed on the extension group, since 'warm' data is accessed:
● less frequently
● with reduced performance SLAs
● with less CPU-intensive processes
● only partially at the same time.
To implement a multi-temperature memory strategy, you can assign hosts to worker groups. Hot and warm
data is then distributed across hosts. To increase performance and memory usage, a slave node is assigned to
For more information, see Data Temperature: Extension Node for Business Warehouse in the SAP HANA
Administration Guide and SAP Note 2453736.
In single-host SAP HANA systems, it is possible to use local file systems residing on direct-attached internal or
external storage devices, such as SCSI hard drives, SSDs, SAN storage, or NAS. However, in order to build a
multiple-host system with failover capabilities this is not sufficient. Either the chosen file system type or the
SAN Infrastructure along with a SAP HANA functionality capable of disc fencing must ensure the following:
● The standby host has file access to data and log volumes of the failed host.
● The failed worker host no longer has access to write to files - called fencing.
There are two fundamentally different storage configurations which meet the two conditions above: shared
storage devices or separate storage devices with failover reassignment. Do not confuse "shared storage"
with the installation directory /hana/shared that must be shared across all hosts.
A shared storage subsystem, which is accessed using file systems such as NFS or IBM's GPFS, makes it 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 which is specific for the file system used to
access that storage subsystem. An NFSv3 storage solution must be used in combination with the storage
connector supplied by the hardware partner. NFSv4 and GPFS storage solutions can optionally be used with a
storage connector.
A shared storage system could be configured as in the diagram below, however mounts may differ among
hardware partners and their configurations. For more information, see the SAP HANA Storage Whitepaper
available in SAP Note 1900823 in Related Information.
It is also possible to assign every SAP HANA host a separate storage, which has nothing mounted except the
shared area. A SAN storage must be used in combination with the SAP Fiber Channel Storage Connector,
which SAP HANA offers storage technology vendors. During failover, SAP HANA uses the storage connector
API to tell the storage device driver to remount the required data and logs volumes to the standby host and
fence off the same volumes from the failed host.
Related Information
Prerequisites
● The SAP HANA system must be installed with its server software on a shared file system:
○ Create an installation directory, e.g. /hana/shared/.
○ Depending on the storage solution, set the export options rw,no_root_squash for the installation
directory.
○ Mount the installation directory on all hosts.
○ If you want to install the Local Secure Store (LSS), the installation path must be created manually
before the installation and mounted on all hosts, e.g. /lss/shared/.
Context
The following procedure describes the installation of an SAP HANA system in interactive mode by entering
parameters interactively. This procedure may also be performed in advanced interactive mode, with
parameters entered as call options or from a configuration file. For more information about interaction modes
and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.
As of SAP HANA 2.0 SPS 01, the multi-container database mode is the only database mode. By default, a single
tenant database is created during installation. You can add additional tenant databases later using the SAP
HANA cockpit. SAP HANA options hosts or host roles can be automatically provisioned to a system that is
installed with a single tenant. If the SAP HANA system contains multiple tenant databases, the SAP HANA
options host or host role must be manually provisioned to the tenant.
Note
Not all parameters are requested interactively. Some parameters have default values that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file. For more information about changeable default values, see Related Information.
Procedure
Option Description
Note
If you downloaded the components to a different directory, change to the directory where you
unpacked the archive.
2. Start the SAP HANA database lifecycle manager interactively in the graphical user interface:
./hdblcmgui
The SAP HANA database lifecycle manager graphical user interface appears.
Note
To activate the local secure (LSS) store during installation, run hdblcmgui with the parameter
secure_store=localsecurestore.
3. Select a detected software component or add a software component location by selecting Add Component
Location. Then select Next.
4. Select Install New System, then select Next.
5. Select the components you would like to install, then select Next.
6. Select Multiple-Host System as the System Type, and select Add Host to specify host parameters for the
additional hosts.
Installation Path Specifies the path to the SAP mount directory, which can be used as a shared
directory between multiple hosts.
Non-standard Shared File System 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 in
cluded in the mountpoint.
Role Specifies the purpose of the SAP HANA host. Although multiple host roles
may be assigned, check the corresponding documentation for the SAP HANA
option for what configurations are supported in production environments.
○ Database Worker (worker) - A worker host (default) is used for database
processing.
○ Database Standby (standby) - A standby host is idle and available for fail
over in a high-availability environment.
○ Database Elastic Compute Server (compute) - Database elastic compute
server
○ Dynamic Tiering Worker (extended_storage_worker) - Worker host for
SAP HANA dynamic tiering
○ Dynamic Tiering Standby (extended_storage_standby) - Standby host for
SAP HANA dynamic tiering
○ Accelerator for SAP ASE Worker (ets_worker) - Worker host for SAP
HANA accelerator for SAP ASE
○ Accelerator for SAP ASE Standby (ets_standby) - Standby host for SAP
HANA accelerator for SAP ASE
○ Streaming Analytics (streaming) - Host for SAP HANA streaming analyt
ics
○ XS advanced runtime worker (xs_worker) - Host for SAP HANA XS ad
vanced runtime
○ XS advanced runtime standby (xs_standby) - Standby host for SAP HANA
XS advanced runtime
High-Availability Group Specifies the host group ID for failover scenarios. If undefined, the host group
is named "default".
Worker Group Specifies the worker group of the host. If undefined, the worker group is
named "default". If you are using extension node for Business Warehouse, you
must name the worker group "worker_dt".
Storage Partition Specifies the storage partition number, which is a logical role number assigned
to non-shared storage devices in a storage connector API. Standby hosts do
not have a storage partition.
Results
A multiple-host SAP HANA system is installed. A log file is stored in the following path:
/var/tmp/hdb_<SID>_<action>_<time stamp>
After installing the SAP HANA system, you may want to perform configuration tasks. For more information, see
Managing the SAP HANA System After Installation or the platform lifecycle management section of the SAP
HANA Administration Guide.
A multiple-host SAP HANA system can be installed using the SAP HANA database lifecycle manager
(HDBLCM) command-line interface.
Prerequisites
● The SAP HANA system must be installed with its server software on a shared file system:
○ Create an installation directory, e.g. /hana/shared/.
○ Depending on the storage solution, set the export options rw,no_root_squash for the installation
directory.
○ Mount the installation directory on all hosts.
○ If you want to install the Local Secure Store (LSS), the installation path must be created manually
before the installation and mounted on all hosts, e.g. /lss/shared/.
● Depending on the desired storage solution, shared storage devices or separate storage devices with
failover reassignment, different configurations apply:
○ In a shared file system, the data files and log files are configured so that they are present and mounted
on all hosts, including the primary host.
○ In a system that uses separate storage devices, each host only has access to its own data files and log
files.
Context
The following procedure describes the installation of an SAP HANA system in interactive mode and entering
parameters interactively. This procedure may also be performed in advanced interactive mode or batch mode,
with parameters entered as call options or from a configuration file. For more information about interaction
modes and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.
As of SAP HANA 2.0 SPS 01, the multi-container database mode is the only database mode. By default, a single
tenant database is created during installation. You can add additional tenant databases later using the SAP
HANA cockpit. SAP HANA options hosts or host roles can be automatically provisioned to a system that is
installed with a single tenant. If the SAP HANA system contains multiple tenant databases, the SAP HANA
options host or host role must be manually provisioned to the tenant.
Note
Not all parameters are requested interactively. Some parameters have default values that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file. For more information about changeable default values, see Related Information.
Procedure
Option Description
Note
If you downloaded the components to a different directory, change to the directory where you
unpacked the archive.
./hdblcm
Note
To activate the local secure (LSS) store during installation, run hdblcm with the parameter
secure_store=localsecurestore.
Note
A Non-standard Shared File System which can be accessed by all hosts during installation can be set
during installationwith the checkmnt parameter. This parameter is typically used when the SID is
included in the mountpoint.
3. Select the index for Install New System, then select Enter .
4. Select the components you would like to install as a comma-separated list, then select Enter .
5. Specify the installation path, and the local host name:
Installation Path Specifies the path to the SAP mount directory, which can be used as a
shared directory between multiple hosts.
6. Select y to the question Do you want to add additional hosts to the system?, and enter the following details
for the additional host:
Role Specifies the purpose of the SAP HANA host. Although multiple host roles
may be assigned, check the corresponding documentation for the SAP HANA
option for what configurations are supported in production environments.
○ Database Worker (worker) - A worker host (default) is used for database
processing.
○ Database Standby (standby) - A standby host is idle and available for fail
over in a high-availability environment.
○ Database Elastic Compute Server (compute) - Database elastic compute
server
○ Dynamic Tiering Worker (extended_storage_worker) - Worker host for
SAP HANA dynamic tiering
○ Dynamic Tiering Standby (extended_storage_standby) - Standby host for
SAP HANA dynamic tiering
○ Accelerator for SAP ASE Worker (ets_worker) - Worker host for SAP
HANA accelerator for SAP ASE
○ Accelerator for SAP ASE Standby (ets_standby) - Standby host for SAP
HANA accelerator for SAP ASE
○ Streaming Analytics (streaming) - Host for SAP HANA streaming analyt
ics
○ XS advanced runtime worker (xs_worker) - Host for SAP HANA XS ad
vanced runtime
○ XS advanced runtime standby (xs_standby) - Standby host for SAP HANA
XS advanced runtime
Host Failover Group Specifies the host group ID for failover scenarios. If undefined, the host group
is named "default".
Worker Group Specifies the worker group of the host. If undefined, the worker group is
named "default". If you are using extension node for Business Warehouse, you
must name the worker group "worker_dt".
Storage Partition Specifies the storage partition number, which is a logical role number assigned
to non-shared storage devices in a storage connector API. Standby hosts do
not have a storage partition.
Results
A multiple-host SAP HANA system is installed. A log file is stored in the following path:
/var/tmp/hdb_<SID>_<action>_<time stamp>
After installing the SAP HANA system, you may want to perform configuration tasks. For more information, see
Managing the SAP HANA System After Installation or the platform lifecycle management section of the SAP
HANA Administration Guide.
The SAP HANA database lifecycle manager can be used to install the XS Advanced Runtime.
Note
From SPS 11, SAP HANA includes an additional run-time environment for application development: SAP
HANA extended application services (XS), advanced model. SAP HANA XS advanced model represents an
evolution of the application server architecture within SAP HANA by building upon the strengths (and
expanding the scope) of SAP HANA extended application services (XS), classic model. SAP recommends
that customers and partners who want to develop new applications use SAP HANA XS advanced model. If
you want to migrate existing XS classic applications to run in the new XS advanced run-time environment,
SAP recommends that you first check the features available with the installed version of XS advanced; if the
XS advanced features match the requirements of the XS classic application you want to migrate, then you
can start the migration process.
SAP HANA extended application services, advanced model provides a comprehensive platform for the
development and execution of native data-intensive applications. It requires the installation of the XS advanced
runtime.
In support of this data-integrated application paradigm, SAP HANA Extended Application Services provide a
comprehensive set of embedded services that provide end-to-end support for Web-based applications. This
includes a lightweight web server, configurable OData support, JavaScript execution and, of course, full access
to SQL and SQLScript.
These SAP HANA Extended Application Services are provided by the SAP HANA XS server, which provides
lightweight application services that are fully integrated into SAP HANA. It allows clients to access the SAP
HANA system via HTTP. Controller applications can run completely natively on SAP HANA, without the need for
an additional external application server.
The application services can be used to expose the database data model, with its tables, views and database
procedures, to clients. This can be done in a declarative way using OData services or by writing native
For more information about SAP HANA XS advanced, see the SAP HANA Developer Guide (For SAP HANA XS
Advanced Model).
SAP HANA Extended Application Services, advanced model, is available not only on the SAP HANA media but
also as a separate component on SAP Marketplace. Users with the required S-User ID can download the latest
version of XS advanced component in the package SAP EXTENDED APP SERVICES 1 from the following
location:
● SAP HANA PLATFORM EDITION 1.0 XS ADVANCED RUNTIME SAP EXTENDED APP SERVICES 1
● SAP HANA PLATFORM EDITION 2.0 SAP EXTENDED APP SERVICES 1
Tip
SAP HANA Extended Application Services, advanced model, is backwards compatible; you can provide
access to new features by installing the latest version of the XS advanced component even on older
versions of SAP HANA. To download the package SAP EXTENDED APP SERVICES 1, see SAP Software
Download Center in Related Information below.
Related Information
It is important to review single-host and multiple-host system concepts before installing a SAP HANA system
that includes the XS advanced runtime.
Host Types
When configuring a multiple-host system with XS advanced runtime, the additional hosts must be defined as
xs_worker hosts or xs_standby hosts. Worker machines run XS applications; standby machines do not handle
any processing and instead just wait to take over processes in the case of worker machine failure.
XS advanced runtime host roles can be assigned automatically during installation. Assign worker and standby
roles to all hosts and choose Automatically assign XS Advanced Runtime roles to the hosts with database roles
when prompted. The installer will then assign the role xs_worker to every worker host and xs_standby to every
standby host. To create a multiple-host system with dedicated xs_worker and xs_standby hosts, assign host
roles to each host individually during installation. Do not choose the option to assign XS Advanced host roles
automatically.
Single-Host Setup
A single-host system is the simplest system installation type. It is possible to run an SAP HANA system entirely
on one host and then scale the system up as needed. The host must have the database worker and xs_worker
host roles assigned.
A multiple-host system is a system with more than one host, which can be configured as active worker hosts or
idle standby hosts. The server software is based on a flexible architecture that enables a distributed
installation. This means that load can be balanced between different hosts. The server software has to be
installed in a shared file system. This file system has to be mounted by all hosts that are part of the system.
In a basic multi-host system all worker hosts also act as XS worker hosts.
A dedicated standby host can be added to the basic multi-host setup. It will act as a failover host in the case of
worker machine failure for both worker and XS worker hosts.
SAP HANA extended application services, advanced model provides a comprehensive platform for the
development and execution of native data-intensive applications. Worker and XS worker host roles can
therefore be assigned to different hosts. To create a multiple-host system with a dedicated XS worker host,
hosts must be assigned manually during installation.
Starting from SAP HANA SPS03 (Rev. 34) and XS advanced model SPS03 (Rev. 1), you can choose the location
of the XS advanced platform data during installation, for example, in the (default) System database or in a
specific tenant database.
The XS advanced default domain is configured during XS advanced installation and defines the URL on which
XS advanced platform services and applications are exposed. After installation, you can change the default
domain settings by means of the property default_domain within the SAP HANA configuration file for the
xscontroller service.
Note
The URL that exposes each individual service and application also depends on the routing mode.
For more information about domains, see 2245631 in Related Information below.
Routing requests for XS advanced applications can be based either on port numbers or host names. For more
details about which end-points are opened for each routing mode, see Public Endpoints in Related Information.
Using the host-name routing mode is recommended for productive use. Application URLs in host-name routing
mode are more user-friendly since they contain the name of the application.
Note
It is not recommended or supported to change the routing mode configuration after installation.
For more information about domains and routing configuration, see 2245631 in Related Information.
Related Information
Starting from SAP HANA 2.0 SPS 03 (Rev. 34) and the latest XS advanced revision, it is possible to choose the
location of the XS advanced platform data during installation. The location of the XS advanced platform data
has implications on the following:
● The location of SAP HANA users (either platform or XS advanced application users)
● Backup and recovery of the XS advanced platform
Tip
For more information about where to find and download the latest revision of the XS advanced run-time
platform, see Installing an SAP HANA System Including the XS Advanced Run Time in Related Information
below.
When you are installing and setting up the XS advanced-model platform in an SAP HANA MDC system, the
setup options you choose have implications on the location on the data stored and used by the XS advanced
platform. The following table lists the type of data involved:
Users SAP HANA users who access the XS advanced platform, for example, with the
following tools:
Platform data Data uploaded to the XS advanced platform, for example: applications, build
packs, application run time environments, application droplets
System application data Data stored by System applications, for example, the audit-log service, the de
ploy service, and the product installer
Custom application data Data stored by custom applications deployed to the XS advanced platform
The information provided in this section explains how to install XS advanced model into either the system
database or a tenant database; discusses the various setup options, and describes the implications of the
configuration choices available.
As of SAP HANA SPS05, XS advanced is installed in the default tenant database by default. During first-time
installation of SAP HANA and XS advanced, the SAP HANA database lifecycle manager (HDBLCM), displays
the following system prompt in the command output:
Output Code
If you are installing XS advanced in an existing SAP HANA system that already contains tenant databases, you
can specify the name of an existing tenant database as the target location to install the XS advanced
persistence data, as illustrated in the following example command-line prompt:
Output Code
You can choose to install XS advanced platform data into a single tenant database, as illustrated in the
following diagram:
Note
This setup is also automatically used when migrating an SAP HANA system from Single Database
Container (SDC) configuration to a Multiple Database Container (MDC) configuration, where XS advanced
is already installed.
After installation, you can register additional tenant databases for XS advanced, as illustrated in the following
diagram:
Note
This setup enables you to separate data from different XS advanced applications in different tenant
databases. For more information, see Maintaining Tenant Databases in XS Advanced in Related Information
below.
Data Location
Installing XS advanced in a tenant database allows you to keep all XS advanced related data in a single
database. Compared to installing XS advanced in the system database, this tenant-database setup helps you to
overcome the restrictions mentioned in the System-database setup concerning backup and recovery and
moving XS-advanced-related data to another SAP HANA system.
Note
If the tenant database containing the XS advanced platform data is deleted, XS advanced services will not
continue to work. For this reason, the XS advanced services must be stopped.
Installing XS advanced into a tenant database helps you to overcome restrictions that exist for backup and
recovery compared to installing XS advanced in the System database. Where XS advanced is installed in a
tenant database, note the following important points:
● Keeping all XS-advanced-related data in a single tenant database ensures the consistency of the data
contained in the backup. For this reason, neither XS advanced services nor XS advanced applications need
Note
If you configure custom XS advanced applications to use additional tenant databases, the cross-database
consistency of the backup cannot be ensured if XS advanced continues to run during the backup operation.
For this reason, it is recommended to stop XS advanced services during the backup operation.
For more information about backup and recovery tasks, see Backup and Recovery in XS Advanced in Related
Information below.
Installing XS advanced in a tenant database enables the copying or moving of XS-advanced-related data to
other SAP HANA systems. You can choose to move all tenant databases or only those tenant databases that
are used by XS advanced; tenant databases in the same system that are not registered for use by XS advanced
do not have to be moved. Bear in mind, however, that if you move the tenant databases used by XS advanced,
the same version of XS advanced must be installed on both the source and target SAP HANA system. In
addition, all tenant databases registered for XS advanced (that is; containing XS-advanced-related data) must
be moved together to the target system.
Note
For more information about how to find out which tenant databases contain XS advanced related data and
how to select the XS advanced platform data in the target system, see Displaying the XS Advanced
Database Setup [page 106] and Selecting the XS Advanced Database After Backup and Recovery [page
107] below.
To find out which tenant databases are relevant to backup XS advanced, open a command shell, log on to the
SAP HANA system as <sid>adm, and run the following command:
XSA list-tenants
The list-tenants command displays a list of all tenant databases that contain XS advanced related data;
these databases must be included in an XS advanced backup. The list-tenants command also displays
Output Code
...
DB name: MYTENANT
[...]
XS advanced platform persistence: YES
[...]
Tip
The tenant database containing the XS advanced platform data is the database you need to select after
restoring XS advanced data to an SAP HANA system.
After restoring XS-advanced-related data to an SAP HANA system, for example, during a tenant-database
move or after a backup-and-recovery operation, you have to inform the system-wide XS advanced services
where to find the XS advanced platform data that was recovered. You can use the command XSA select-
xsa-runtime-db with the -n (database name) option after logging on the SAP HANA system as <sid>adm in
a command shell, as shown in the following example:
Tip
Use the name of the tenant database displayed in the output of the XSA list-tenants command.
When using the command XSA select-xsa-runtime-db, bear in mind the following important points:
Related Information
The XS advanced installation provides the option to keep XS advanced platform data in the system database,
while custom applications are configured to use a tenant database as storage, as illustrated by the following
diagram:
Note
For more information about tenant databases, see Maintaining Tenant Databases in XS Advanced in Related
Information below.
Data Location
In this setup, XS advanced platform data is kept in the System database. System applications store their data
in the system database, too. Custom applications store their data in the default tenant database. This way, XS
advanced platform data and custom application data are strictly separated. As a consequence, even when all
tenant databases are deleted, XS advanced platform services are still functional.
Caution
If a tenant database containing XS advanced custom application data is deleted, the data of affected
applications is deleted, too, and the corresponding applications need to be re-deployed.
In this (default) setup, only SAP HANA users created in the system database can be used to access the XS
advanced platform or XS advanced applications, even if an XS advanced application stores its data in a tenant
database.
Note
To access the actual data stored in the respective database, the XS advanced platform and XS advanced
applications use technical SAP HANA users that are created in the corresponding tenant database.
In order to save all XS advanced related data, the system database needs to be backed up together with all
other tenant databases containing XS advanced data, as described in Backup & Recovery in Related
Information below.
It is essential to understand that it is not possible to restore a backup of the System database into a tenant
database. Moving XS-advanced-related data to a different SAP HANA system is only possible by creating a
complete system copy of the source SAP HANA system.
An SAP HANA system with XS advanced runtime can be installed in a single-host or multi-host environment
using the SAP HANA database lifecycle manager (HDBLCM).
Prerequisites
● The most recent version of the SAP HANA and SAP HANA XS advanced runtime installation packages are
downloaded, and all packages are of an equivalent support or revision level.
● The SAP HANA system must be installed with its server software on a shared file system:
○ Create an installation directory, e.g. /hana/shared/.
○ Depending on the storage solution, set the export options rw,no_root_squash for the installation
directory.
○ Mount the installation directory on all hosts.
○ If you want to install the Local Secure Store (LSS), the installation path must be created manually
before the installation and mounted on all hosts, e.g. /lss/shared/.
● Depending on the desired storage solution, shared storage devices or separate storage devices with
failover reassignment, different configurations apply:
○ In a shared file system, the data files and log files are configured so that they are present and mounted
on all hosts, including the primary host.
○ In a system that uses separate storage devices, each host only has access to its own data files and log
files.
The suggested locations for the file systems are as follows:
Context
The following procedure describes the installation of an SAP HANA system in interactive mode by entering
parameters interactively. This procedure may also be performed in advanced interactive mode, with
parameters entered as call options or from a configuration file. For more information about interaction modes
and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.
As of SAP HANA 2.0 SPS 01, the multi-container database mode is the only database mode. By default, a single
tenant database is created during installation. You can add additional tenant databases later using the SAP
HANA cockpit. SAP HANA options hosts or host roles can be automatically provisioned to a system that is
installed with a single tenant. If the SAP HANA system contains multiple tenant databases, the SAP HANA
options host or host role must be manually provisioned to the tenant.
If you want to add the XS advanced runtime to an existing SAP HANA system, see Installing or Updating SAP
HANA Components in Related Information.
Note
Not all parameters are requested interactively. Some parameters have default values that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file. For more information about changeable default values, see Related Information.
Procedure
Option Description
2. Start the SAP HANA database lifecycle manager interactively in the graphical user interface:
./hdblcmgui
Note
To activate the local secure (LSS) store during installation, run hdblcmgui with the parameter
secure_store=localsecurestore.
3. On the Select Software Component Locations page, if the SAP HANA XS advanced runtime component
appears on the list, click Next; otherwise:
a. Click Add Component Location.
b. Type the path to the missing installation package and click OK.
4. Select Install New System, then select Next.
5. Select SAP HANA XS advanced runtime, then select Next.
6. Select Single-Host System or Multiple-Host System as the System Type, and select Add Host to specify host
parameters for each additional host.
Installation Path Specifies the path to the SAP mount directory, which can be used as a shared
directory between multiple hosts.
Non-standard Shared File System 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 in
cluded in the mountpoint.
Note
For XS advanced runtime installations, the fully-qualified host name must
be specified.
Role Specifies the purpose of the SAP HANA host. Although multiple host roles
may be assigned, check the corresponding documentation for the SAP HANA
option for what configurations are supported in production environments.
○ Database Worker (worker) - A worker host (default) is used for database
processing.
○ Database Standby (standby) - A standby host is idle and available for fail
over in a high-availability environment.
○ Database Elastic Compute Server (compute) - Database elastic compute
server
○ Dynamic Tiering Worker (extended_storage_worker) - Worker host for
SAP HANA dynamic tiering
○ Dynamic Tiering Standby (extended_storage_standby) - Standby host for
SAP HANA dynamic tiering
○ Accelerator for SAP ASE Worker (ets_worker) - Worker host for SAP
HANA accelerator for SAP ASE
○ Accelerator for SAP ASE Standby (ets_standby) - Standby host for SAP
HANA accelerator for SAP ASE
○ Streaming Analytics (streaming) - Host for SAP HANA streaming analyt
ics
○ XS advanced runtime worker (xs_worker) - Host for SAP HANA XS ad
vanced runtime
○ XS advanced runtime standby (xs_standby) - Standby host for SAP HANA
XS advanced runtime
High-Availability Group Specifies the host group ID for failover scenarios. If undefined, the host group
is named "default".
Worker Group Specifies the worker group of the host. If undefined, the worker group is
named "default". If you are using extension node for Business Warehouse, you
must name the worker group "worker_dt".
Storage Partition Specifies the storage partition number, which is a logical role number assigned
to non-shared storage devices in a storage connector API. Standby hosts do
not have a storage partition.
XS advanced runtime host roles can be assigned automatically during installation. Assign worker and
standby roles to all hosts and choose Automatically assign XS Advanced Runtime roles to the hosts with
database roles when prompted. The installer will then assign the role xs_worker to every worker host and
xs_standby to every standby host. To create a multiple-host system with dedicated xs_worker and
xs_standby hosts, assign host roles to each host individually during installation. Do not choose the option
to assign XS Advanced host roles automatically.
Component Description
GUI for HALM for XSA The XS Advanced Application Lifecycle Management graphical user interface
allows you to install, update, and uninstall SAP HANA products and software
components in the SAP HANA XS Advanced model.
SAP File Processing SAP File Processing provides structured information from unstructured files.
The rich set of HTTP APIs enables application programmers to integrate File
Processing features in client applications.
SAP Enterprise Architecture Designer SAP Enterprise Architecture Designer for SAP HANA lets you capture, analyze,
for SAP HANA and present your organization's landscapes, strategies, requirements, proc
esses, data, and other artifacts in a shared environment. Using industry-stand
ard notations and techniques, organizations can leverage rich metadata and
use models and diagrams to drive understanding and promote shared out
comes in creating innovative systems, information sets, and processes to sup
port goals and capabilities.
SAP HANA Runtime Tools SAP HANA provides a selection of tools to help in the various phases of the de
sign-time development and run-time administration of Multi-Target Applica
tions (MTA) on XS advanced.
SAPUI5 Frontend Server The SAPUI5 Frontend Server provides access to the SAPUI5 Demo Kit as part
of the XS Advanced environment. The Demo Kit also provides you with techni
cal documentation and samples.
SAP Web IDE Web Client SAP Web IDE for SAP HANA is a comprehensive browser-based IDE for the de
velopment of complex applications comprised of Web-based or mobile UIs,
business logic, and extensive SAP HANA data models.
XS Advanced Portal Services With XS Advanced Portal Services you can develop and run portal services for
custom apps running on XS Advanced.
XS Monitoring SAP HANA XS Advanced Model includes a Web-based tool that enables you to
maintain important parts of the application-development environment, for ex
ample, security and authentication methods.
XS Services In SAP HANA XS Advanced, application developers can make use of a catalog
of services managed by a service broker, for example, for job schedules or
user accounts and OAuth clients.
XSAC XMLA Interface For HANA XMLA enables you to send MDX queries via http against SAP HANA calcula
tion views following the XML/A-protocol. With XMLA, you write multi-dimen
sional-expressions (MDX) queries wrapped in an XMLA document. An XML for
Analysis (XMLA) application running in SAP HANA application services (SAP
HANA XS) is used to provide the consumption model for client applications ex
changing MDX queries (wrapped in XMLA documents) with the SAP HANA da
tabase.
XS Advanced Cockpit The XS Advanced Cockpit provides the central web user interface for XS ad
vanced runtime. As an application developer or an administrator, cockpit ena
bles you to manage your applications, services, and resources. Cockpit is an
auto-content app delivered with XS advanced runtime. The Cockpit provides
an overview of the Organizations and Spaces the logged in user has access to.
Within the Spaces, the application developer can manage his/her applications
and related resources like service instances. It also provides access to the
Service Marketplace and the details of the Services enabled for the corre
sponding Organization.
9. After specifying all system properties, review the summary, and select Install.
A SAP HANA system with XS advanced runtime is installed. A log file is available.
Next Steps
After installing the SAP HANA system, you may want to perform configuration tasks. For more information, see
Managing the SAP HANA System After Installation or the platform lifecycle management section of the SAP
HANA Administration Guide.
For certain versions of SAP Host Agent it is necessary to configure the TCP/IP port ranges (50000-50999,
51000-51500) manually after installation. This is explained in detail in SAP Note 401162 .
In the XSA Public area the XSA administrator is responsible for deploying the domain-specific certificates.
These can be either self-signed or issued by the global certificate authority (CA). The certificates can be
deployed in the xs client using the set-certificate command. This is explained in detail in SAP Note
2243019 . However, by default, the system generates self-signed certificates that the administrator can
manually and securely distribute among the clients. For more information, seeNetwork and Communication
Security with SAP HANA XS Advanced in the SAP HANA Security Guide.
Note
In production XSA installations, replace the self-signed certificate with one trusted in your organization.
Related Information
An SAP HANA system with XS advanced runtime can be installed in a single-host or multi-host environment
using the SAP HANA database lifecycle manager (HDBLCM).
Prerequisites
● The most recent version of the SAP HANA and SAP HANA XS advanced runtime installation packages are
downloaded, and all packages are of an equivalent support or revision level.
● The SAP HANA system must be installed with its server software on a shared file system:
○ Create an installation directory, e.g. /hana/shared/.
○ Depending on the storage solution, set the export options rw,no_root_squash for the installation
directory.
○ Mount the installation directory on all hosts.
○ If you want to install the Local Secure Store (LSS), the installation path must be created manually
before the installation and mounted on all hosts, e.g. /lss/shared/.
● Depending on the desired storage solution, shared storage devices or separate storage devices with
failover reassignment, different configurations apply:
○ In a shared file system, the data files and log files are configured so that they are present and mounted
on all hosts, including the primary host.
○ In a system that uses separate storage devices, each host only has access to its own data files and log
files.
The suggested locations for the file systems are as follows:
○ /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. The password of the root user
must be identical on all hosts.
● If the root user name is not root, it must be specified as a parameter during installation using the
parameter root_user.
The following procedure describes the installation of an SAP HANA system in interactive mode and entering
parameters interactively. This procedure may also be performed in advanced interactive mode or batch mode,
with parameters entered as call options or from a configuration file. For more information about interaction
modes and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.
As of SAP HANA 2.0 SPS 01, the multi-container database mode is the only database mode. By default, a single
tenant database is created during installation. You can add additional tenant databases later using the SAP
HANA cockpit. SAP HANA options hosts or host roles can be automatically provisioned to a system that is
installed with a single tenant. If the SAP HANA system contains multiple tenant databases, the SAP HANA
options host or host role must be manually provisioned to the tenant.
If you want to add the XS advanced runtime to an existing SAP HANA system, see Installing or Updating SAP
HANA Components in Related Information.
Note
Not all parameters are requested interactively. Some parameters have default values that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file. For more information about changeable default values, see Related Information.
Procedure
Option Description
2. Start the SAP HANA database lifecycle manager interactively in the command line:
./hdblcm
3. Select the index for Install New System, then select Enter .
4. Select server, xs and any other components you would like to install as a comma-separated list, then select
Enter .
Installation Path Specifies the path to the SAP mount directory, which can be used as a
shared directory between multiple hosts.
6. If you want to install a single-host system, select n to the question Do you want to add hosts to the system?.
If you want to install a multi-host system, select y and enter the following details for each additional host:
Note
For XS advanced runtime installations, the fully-qualified host name must
be specified.
Role Specifies the purpose of the SAP HANA host. Although multiple host roles
may be assigned, check the corresponding documentation for the SAP HANA
option for what configurations are supported in production environments.
○ Database Worker (worker) - A worker host (default) is used for database
processing.
○ Database Standby (standby) - A standby host is idle and available for fail
over in a high-availability environment.
○ Database Elastic Compute Server (compute) - Database elastic compute
server
○ Dynamic Tiering Worker (extended_storage_worker) - Worker host for
SAP HANA dynamic tiering
○ Dynamic Tiering Standby (extended_storage_standby) - Standby host for
SAP HANA dynamic tiering
○ Accelerator for SAP ASE Worker (ets_worker) - Worker host for SAP
HANA accelerator for SAP ASE
○ Accelerator for SAP ASE Standby (ets_standby) - Standby host for SAP
HANA accelerator for SAP ASE
○ Streaming Analytics (streaming) - Host for SAP HANA streaming analyt
ics
○ XS advanced runtime worker (xs_worker) - Host for SAP HANA XS ad
vanced runtime
○ XS advanced runtime standby (xs_standby) - Standby host for SAP HANA
XS advanced runtime
Host Failover Group Specifies the host group ID for failover scenarios. If undefined, the host group
is named "default".
Worker Group Specifies the worker group of the host. If undefined, the worker group is
named "default". If you are using extension node for Business Warehouse, you
must name the worker group "worker_dt".
Storage Partition Specifies the storage partition number, which is a logical role number assigned
to non-shared storage devices in a storage connector API. Standby hosts do
not have a storage partition.
Component Description
xsac_file_proc SAP File Processing provides structured information from unstructured files.
The rich set of HTTP APIs enables application programmers to integrate File
Processing features in client applications.
xsac_hana_ea_d SAP Enterprise Architecture Designer for SAP HANA lets you capture, analyze,
and present your organization's landscapes, strategies, requirements, proc
esses, data, and other artifacts in a shared environment. Using industry-stand
ard notations and techniques, organizations can leverage rich metadata and
use models and diagrams to drive understanding and promote shared out
comes in creating innovative systems, information sets, and processes to sup
port goals and capabilities.
xsac_hrtt SAP HANA provides a selection of tools to help in the various phases of the de
sign-time development and run-time administration of Multi-Target Applica
tions (MTA) on XS advanced.
xsac_mess_srv In SAP HANA XS, advanced model, the messaging service is an application
service that enables consumer applications to receive messages sent by pro
ducer applications depending on the topics or queues that consumer applica
tions are subscribed to. The messaging service represents a message broker
for remote communication between systems using the Apache ActiveMQ li
brary with JMS (Java Message Service) specification. It uses ActiveMQ as
message-oriented middleware, which enables the service to provide scalabil
ity, high availability, reliability, and security for enterprise messaging.
xsac_monitoring SAP HANA XS Advanced Model includes a Web-based tool that enables you to
maintain important parts of the application-development environment, for ex
ample, security and authentication methods.
xsac_portal_serv With XS Advanced Portal Services you can develop and run portal services for
custom apps running on XS Advanced.
xsac_sap_web_ide SAP Web IDE for SAP HANA is a comprehensive browser-based IDE for the de
velopment of complex applications comprised of Web-based or mobile UIs,
business logic, and extensive SAP HANA data models.
xsac_services In SAP HANA XS Advanced, application developers can make use of a catalog
of services managed by a service broker, for example, for job schedules or
user accounts and OAuth clients.
xsac_ui5_fesv4 The SAPUI5 Frontend Server provides access to the SAPUI5 Demo Kit as part
of the XS Advanced environment. The Demo Kit also provides you with techni
cal documentation and samples.
xsac_ui5_sb The UI5 service provides resources to SAP UI5 applications which are needed
to run their graphical user interfaces. In a typical XS advanced installation, one
service is installed at any point in time and the service corresponds to an UI5
release. UI5 applications no longer need to refer to a particular UI5 service that
they depend on; they can refer to the UI5 Service Broker, which serves the
bootstrap URL of the service they require.
xsac_xmla_int XMLA enables you to send MDX queries via http against SAP HANA calcula
tion views following the XML/A-protocol. With XMLA, you write multi-dimen
sional-expressions (MDX) queries wrapped in an XMLA document. An XML for
Analysis (XMLA) application running in SAP HANA application services (SAP
HANA XS) is used to provide the consumption model for client applications ex
changing MDX queries (wrapped in XMLA documents) with the SAP HANA da
tabase.
xsac_xsa_cockpit The XS Advanced Cockpit provides the central web user interface for XS ad
vanced runtime. As an application developer or an administrator, cockpit ena
bles you to manage your applications, services, and resources. Cockpit is an
auto-content app delivered with XS advanced runtime. The Cockpit provides
an overview of the Organizations and Spaces the logged in user has access to.
Within the Spaces, the application developer can manage his/her applications
and related resources like service instances. It also provides access to the
Service Marketplace and the details of the Services enabled for the corre
sponding Organization.
9. After specifying all system properties, review the summary, and select y.
Results
A SAP HANA system with XS advanced runtime is installed. A log file is available.
Next Steps
After installing the SAP HANA system, you may want to perform configuration tasks. For more information, see
Managing the SAP HANA System After Installation or the platform lifecycle management section of the SAP
HANA Administration Guide.
For certain versions of SAP Host Agent it is necessary to configure the TCP/IP port ranges (50000-50999,
51000-51500) manually after installation. This is explained in detail in SAP Note 401162 .
In the XSA Public area the XSA administrator is responsible for deploying the domain-specific certificates.
These can be either self-signed or issued by the global certificate authority (CA). The certificates can be
deployed in the xs client using the set-certificate command. This is explained in detail in SAP Note
2243019 . However, by default, the system generates self-signed certificates that the administrator can
manually and securely distribute among the clients. For more information, seeNetwork and Communication
Security with SAP HANA XS Advanced in the SAP HANA Security Guide.
In production XSA installations, replace the self-signed certificate with one trusted in your organization.
Related Information
It's possible to set up the XS advanced runtime behind a reverse proxy, for example, for load balancing.
You can set up the XS advanced runtime behind a reverse proxy in such a way that XS advanced applications
and system services can be reached both externally and internally between applications. Before you do so, it is
important that you understand how routing works in an XS advanced landscape.
XS advanced applications are exposed to the end user by URLs that are based on the XS advanced default
domain and routing mode. This is also true for system components like the XS controller and UAA (User
Account and Authentication). You can specify both the default domain and the routing mode during
installation.
Tip
To see the URL of each individual application use the xs apps command. For more information about the
XS command-line interface, see the SAP HANA Developer Guide.
Note
It's possible to create further domains for XS advanced applications in addition to the default domain. The
information provided in this documentation applies equally to such additionally created domains.
Example
If your XS advanced default domain is hana.example.com, your application URLs would have the format:
hana.example.com:50500, hana.example.com:50501, and so on.
Hostname-based Routing
If you select hostname-based routing mode during installation, applications are exposed using a sub-domain of
the XS advanced default domain (for example, the XS advanced default domain prefixed with a hostname
unique for each application). In this case, the TCP port is the same for each application.
Example
If your XS advanced default domain is hana.example.com, your app URLs would have the format:
myapp1.hana.example.com, myapp2.hana.example.com, and so on.
Note
Changing the default domain requires some downtime of your applications because all applications are re-
staged during XS Controller startup.
Request Flows
This means that the XS advanced default domain must be mapped in your DNS to the SAP HANA host on
which the XSA Web Dispatcher is running. This is the same host that runs as the xscontroller service.
Note
If you are using hostname-based routing, the XS advanced default domain and all its subdomains must be
mapped by means of a wildcard DNS entry.
Note
In a high-availability setup, several instances of the XSA Web Dispatcher might be running on different
hosts. In this case, the reverse proxy must forward requests to the currently active system. For more
information, see the section on high availability in the SAP HANA Administration Guide.
As a result, the DNS entry for the XS advanced default domain must point to the host running the reverse
proxy.
If you are using port-based routing, the reverse proxy forwards requests on each individual application port
running on the default domain to the XSA Web Dispatcher. If you are using hostname-based routing, the
reverse proxy forwards requests on the XS advanced default domain and each subdomain to the XSA Web
Dispatcher.
Related Information
Route internal requests on the XS advanced default domain directly to the XS advanced Web Dispatcher to
optimize request performance and enable app-to-app calls even when the XS advanced default domain cannot
be reached from behind the reverse proxy.
To route internal requests on the XS advanced default domain directly to the XS advanced Web Dispatcher, you
must map the XS advanced default domain to the SAP HANA host on which the XS advanced Web Dispatcher
is running on every host with an XS advanced host role (xs_* , for example xs_worker).
Note
Routing internal requests as described here also allows you to avoid trust-related issues between the
reverse proxy and the XS advanced Web Dispatcher during installation. For more information, see the
section on establishing the trust relationship.
Note
The certificate you install on the XS advanced Web Dispatcher (see section on establishing the trust
relationship) must have both the SAP HANA host running the XS advanced Web Dispatcher and the default
domain in its “subjectAltName” section.
You can route internal requests directly to the XS advanced Web Dispatcher using a local DNS proxy or altering
the /etc/hosts file.
The most convenient way to route internal requests directly to the XS advanced Web Dispatcher is to set up a
local DNS proxy server on each SAP HANA host with an xs_* role. Configure the DNS proxy on each host so
that the following domains map to the host running the XS advanced Web Dispatcher:
● <xsa-default-domain>
● *.<xsa-default-domain>
Altering /etc/hosts
Another way to route requests directly to backend applications is by altering the /etc/hosts file on all SAP
HANA hosts with an xs_* role. The mapping depends on the routing mode:
● Port-based routing mode: You just must map the XS advanced default domain.
● Hostname-based routing mode: You must map the XS advanced default domain and the sub-domains used
by XS advanced applications and system services individually. This is because /etc/hosts mapping does
not support wildcard mappings.
Related Information
How you set up the trust relationship depends on the layer at which routing is performed. This in turn affects
the installation process.
If the reverse proxy does not terminate SSL (for example, by routing on network layer 4), no 3rd party
components are involved in the certificate setup. In this way, the trust relationship works immediately after
installation; no manual steps are required. This is therefore the preferred setup.
Tip
SAP Note 2300936 describes an SAP Web Dispatcher setup in plain routing mode (that is, without SSL
termination).
To change the certificates for XS advanced domains after installation, use the xs set-certificate and xs
trust-certificate commands. For more information, see SAP Note 2243019.
If the reverse proxy does layer 7-based routing (at https level) and terminates SSL, trust must be established
between:
● The reverse proxy and the XS advanced Web Dispatcher (Platform Router)
● XS advanced applications and the reverse proxy
Establishing Trust Between the Reverse Proxy and the XS advanced Web Dispatcher
To establish trust between the reverse proxy and the XS advanced Web Dispatcher, install a custom certificate
already trusted by the reverse proxy in the XS advanced Web Dispatcher (see also SAP Note 2243019).
If the XS controller is stopped, log on to your SAP HANA system as <sid>adm and use the XS advanced
service command:
Alternatively, extract the XS advanced Web Dispatcher's public certificate (a self-signed certificate available
right after installation) and install it on the reverse proxy. To find the certificate file, log on the system as
<sid>adm and save the file: /hana/shared/<SID>/xs/controller/controller_data/ssl-pub/
router/default.root.crt.pem
It is recommended to use a publicly signed server certificate for the reverse proxy; with a publicly signed
certificate, it is not necessary to configure anything in XS advanced.
If you are not using a publicly signed server certificate, the following steps are required to ensure that the XS
advanced platform router trusts the public certificate of the reverse proxy:
If the XS controller is running, log on to the XS advanced platform with the XS advanced command-line
interface and perform the following steps:
If the XS controller is not running, log on to your SAP HANA system as <sid>adm and use the following XSA
command to install the certificate locally:
Note
Applications need to be re-staged and restarted for these changes to become effective.
To restart all applications at the same time, use the XSA command-line interface, as illustrated in the following
examples:
XSA restage-at-startup
XSA restart
Note
To use the XSA command, you must log on as the operating-system user <SID>adm.
During installation, requests are made to the XS advanced default domain. Therefore, if the default domain
points to a reverse proxy, certificate trust must already be set up between the reverse proxy and the XS
advanced Web Dispatcher at this point in time. To establish this, the following solutions exist:
● xs_cert_pem: The path to the default domain certificate file in PEM format that the reverse proxy trusts.
● xs_cert_key: The path to the default domain certificate key file in PKCS8 format that the reverse proxy
trusts
● xs_trust_pem: The path to an additional trust certificate (to trust the reverse proxy)
1. Before installation, map the XS advanced default domain (and its sub-domains if you are using hostname-
based routing) to the SAP HANA host running the XS advanced Web Dispatcher.
2. Run the XS advanced installation.
3. Establish the trust relationship.
4. Map the default domain to the reverse proxy.
If you decide to map the default domain using the /etc/hosts file, it is sufficient to map the following domains
temporarily during installation. After successful installation and certificate setup, you can remove the mapping
again:
● <xsa-default-domain>
● auditlog-server.<xsa-default-domain>
● auditlog-broker.<xsa-default-domain>
● deploy-service.<xsa-default-domain>
Related Information
SAP Note 2300936 - Host Auto-Failover and System Replication Setup with SAP HANA extended application
services, advanced model
SAP Note 2243019 - Providing SSL certificates for domains defined in SAP HANA extended application
services, advanced model
XS CLI: Domains
Routing Internal Requests to Backend Applications [page 126]
System Properties
SAP HANA System ID Specifies a system ID. The SAP system ID (SID) is the identifier for the
SAP HANA system.
Instance Number Specifies the instance number of the SAP HANA system.
Local Host Worker Group Specifies the worker group of the host. If undefined, the worker group is
named "default". If you are using extension node for Business Ware
house, you must name the worker group "worker_dt".
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.
Restrict maximum memory allocation? Specifies whether maximum memory allocation is restricted for a new
system.
Restart system after machine reboot? Restarts system after machine reboot.
Location of Data Volumes Specifies the path to the data directory of the SAP HANA system.
Location of Log Volumes Specifies the path to the log directory of the SAP HANA system.
Location of Persistent Memory Volume Specifies the location of persistent memory volumes. This setting is
stored in the global.ini file.
Edit Certificate Host... Specifies the hostname used for generation of self-signed SSL certifi-
cates for the SAP Host Agent.
System Administrator User ID Specifies the user ID of the system administrator. This parameter is rele
vant only if the operating system administrator (<sid>adm) does not
exist prior to installation.
ID of User Group (sapsys) 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.
System Administrator Login 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.
System Administrator Home Directory Specifies the home directory of the system administrator. This parame
ter is relevant only if the operating system administrator (<sid>adm)
does not exist prior to installation.
Automatically assign XS Advanced Runtime roles Assigns XS_WORKER and XS_STANDBY host roles. The host role
to the hosts with database roles XS_WORKER will be assigned to all worker hosts, the host role
XS_STANDBY will be assigned to all standby hosts. To create a multiple-
host system with dedicated xs_worker and xs_standby hosts, assign host
roles to each host individually during installation. Do not choose the op
tion to assign XS Advanced host roles automatically.
XS Advanced Tenant Database The tenant database in which the XS advanced runtime is installed.
Organization Name For Space "SAP" Sets the name of the customer organization. Organizations enable devel
opers to collaborate by sharing resources, services, and applications. Ac
cess to the shared resources, services, and applications is controlled by
the organization manager (default: orgname).
Customer Space Name Sets the name of the customer space for the SAP HANA XS advanced
runtime. In an organization, spaces enable users to access shared re
sources that can be used to develop, deploy, and maintain applications
(default: PROD).
Run Applications in Customer Space with Run applications in customer space with a separate OS user
Separate OS User
Routing Mode Specifies the routing mode to be used for XS advanced runtime installa
tions. For more information on routing configurations, see SAP Note
2245631 .
XS Advanced Admin User Creates an SAP HANA XS advanced runtime admin user. An admin user
can add and manage users, view users, edit organization roles, view the
organization quota, and perform other administrative tasks (default:
XSA_ADMIN).
XS Advanced App Working Path Specifies the XS advanced runtime app working path for runtime data of
application instances. For best performance, specify a local directory,
which is then created on all XS_WORKER hosts.
XS Advanced Domain Name Specifies the domain name of an xs_worker host. The domain name has
to resolve to the SAP HANA host which is running the xscontroller and
xsuaaserver service.
XS Advanced SAP Space OS User ID OS user ID used for running XS advanced runtime applications in SAP
space
XS Advanced Customer Space OS User ID OS user ID used for running XS Advanced applications in customer space
Installation Path for Local Secure Store Specifies the installation path for local secure store.
Local Secure Store User ID Specifies the user ID for the local secure store.
Local Secure Store User Group ID Specifies the group ID for the local secure store.
Local Secure Store User Home Directory Specifies the user home directory for the local secure store.
Local Secure Store User Login Shell Specifies the user login shell for the local secure store.
Related Information
SAP HANA system components like the SAP HANA client, SAP HANA studio, and additional system
components like Application Function Libraries (AFL, EML and the product-specific AFLs IBP, RTL, TRP, VCH,
XRP), SAP liveCache applications (SAP LCA or LCAPPS plug-in), SAP HANA EPM-MDS (EPMMDS plug-in), XS
advanced runtime applications, SAP HANA smart data access (SDA), or SAP HANA XS Advanced Runtime can
be updated using the SAP HANA database lifecycle manager (HDBLCM).
To update an SAP HANA system, you need to first download the individual components from Service
Marketplace (SMP). This can be done manually, from the SAP HANA studio, or using the SAP HANA database
lifecycle manager (HDBLCM) Web user interface. Once the component packages have been prepared, the
system update can be triggered from any of the three SAP HANA database lifecycle manager user interfaces.
Before starting the update for the components in your SAP HANA landscape several prerequisites have to be
fulfilled. For more information, see Prerequisites in the SAP HANA Master Guide.
If you need to upgrade the operating system first, disable the automatic start of the SAP HANA system. For
more information, see autostart in Related Information and Upgrade an Existing SAP HANA System in the SAP
HANA Master Guide.
We recommend to perform an SAP HANA system update from a local host, 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 a failed
update due to network glitches.
For security reasons, the SYSTEM user might not be available during a system update. It is, therefore, required
to create a lesser-privileged database user for updating a system. For more information, see Create a Lesser-
Privileged Database User for Update in Related Information.
Note
If you have SAP HANA options installed, review the section about tenant databases in the administration
guide of the corresponding option for additional information before proceeding. Be aware that you need
additional licenses for SAP HANA options and capabilities. For more information, see Important Disclaimer
for Features in SAP HANA Platform, Options and Capabilities.
Related Information
An SAP HANA system can be updated from a local host using the SAP HANA database lifecycle manager.
It is possible to check for available updates of the SAP HANA system and components using the SAP HANA
database lifecycle manager Web user interface or from the SAP HANA studio. If updates are available, the
software must be downloaded, and the archive prepared before the update software can be installed.
There are three methods for downloading an SAP HANA installation medium:
Caution
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.
Note
Before updating your SAP HANA system to SAP HANA 2.0, ensure that all applications that use this system
are released for SAP HANA 2.0.
Related Information
Before downloading software components using the SAP HANA studio, configure the connection to SAP
Service Marketplace (SMP). As of SPS 12, configuring the connection is only required if you want to connect to
and update an SAP HANA system version SPS 11 or lower.
Procedure
Note
Note
Next Steps
After configuring the connection from the SAP HANA studio to SAP Service Marketplace, download the
software components from the SAP Service Marketplace. For more information about downloading software
components using the SAP HANA studio, see Related Information.
Related Information
Download Components from SAP Service Marketplace Using the SAP HANA Studio [page 136]
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 Support Package Stack (SPS) 08 or newer and must have been installed
with the SAP HANA database lifecycle manager, so that the versions of the currently installed components
are correctly detected. Otherwise this information won't be available, but you can still proceed with the
download.
● You need to provide system administrator user (<sid>adm) credentials.
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 are provided with a shell script (hdblcm_prepare.sh), which must be run to extract the archives
in a directory structure, so that subsequent installation or update with the SAP HANA database lifecycle
manager works as expected.
Note
As of SPS 12, you can use your SAP HANA database lifecycle manager (HDBLCM) Web user interface to
check for available software component updates and download them from SAP Support Portal. The
following procedure only applies if you connect to an SAP HANA system version SPS 11 or lower.
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.
Next Steps
After downloading components from the SAP Service Marketplace using the SAP HANA studio, prepare the
software archive so that it is detected by the SAP HANA database lifecycle manager during update. For more
information about preparing the software archive, see Related Information.
Related Information
Download Components from SAP Support Portal Using the Web User Interface [page 137]
Prepare the Software Archive for the Update [page 139]
You can use your SAP HANA database lifecycle manager (HDBLCM) Web user interface to check for available
software component updates and download them from SAP Support Portal.
Prerequisites
Note
Alternatively, you can download the components to a shared location to which the SAP HANA system
has access or copy the downloaded components to the SAP HANA system manually.
You should verify that the following prerequisites are fulfilled before trying to access the SAP HANA database
lifecycle manager from a Web browser.
Note
For more information about supported Web browsers for the SAP HANA database lifecycle manager
Web interface, see the browser support for sap.m library in the SAPUI5 Developer Guide.
Procedure
Option Description
Web browser Enter the SAP HANA database lifecycle manager (HDBLCM) URL in an HTML5-enabled browser:
https://<hostname>:1129/lmsl/HDBLCM/<SID>/index.html
Note
The URL is case sensitive. Make sure you enter upper and lower case letters correctly.
1. Enter the URL of the SAP HANA cockpit administration and monitoring console in your browser.
SAP HANA
https://<host_FQDN>:<port>
cockpit
Note
FQDN = fully qualified domain name
2. Drill down on the name of the system from My Resources or from a group.
3. The links in Platform Lifecycle Management each launch additional functionality, giving you ex
panded capabilities for managing the resource.
Next Steps
After downloading components from the SAP Support Portal using the SAP HANA database lifecycle manager
(HDBLCM) Web user interface, prepare the software archive so that it is detected by the SAP HANA database
lifecycle manager during update. For more information about preparing the software archive, see Related
Information.
Related Information
After downloading the software components from SAP Support Portal, the software archive must be prepared
for the update.
Prerequisites
cd <sapmnt>/<SID>/hdblcm
./hdblcm --action=extract_components
3. Enter the location of the SAP HANA component archives which you want to prepare for the update.
4. Enter the target directory to extract the software component archives to. The target directory must be
empty.
5. Review the summary, and select y to finalize the configuration.
Next Steps
You can now update the SAP HANA system with the SAP HANA database lifecycle manager.
If the SAP HANA database lifecycle manager doesn't detect the installation kit, you should run it with the
parameter component_root specifying the root directory displayed at the end of the hdblcm_prepare.sh
script:
or
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.
Context
Note
If you extract more than one component SAR into a single directory, you need to move the
SIGNATURE.SMF file to the subfolder (SAP_HANA_DATABASE, SAP_HANA_CLIENT, etc.), before extracting
the next SAR in order to avoid overwriting the SIGNATURE.SMF file. For more information, see also SAP
Note 2178665 in Related Information.
Example: /hana/local/downloads
2. Download SAP HANA packages from the SAP Service Marketplace to the local directory.
The Debug Symbol Packages (*.TAR) that are also available for download are only needed for
troubleshooting purposes and not required for a system update. For more information, see SAP Note
2145573 in Related Information.
3. Create a directory, in to which the package contents can be unpacked.
Example: /hana/local/downloads/install
4. Unpack the SAP HANA database archive in to the local directory.
Run the SAP HANA platform LCM tool using the parameter extract_components as a call option.
Next Steps
You can now update the SAP HANA system with the SAP HANA database lifecycle manager.
Related Information
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.
● With system replication active, you have updated the secondary system before the primary system. The
version of the secondary system must be equal to or higher than the version of the primary system.
● You have performed a system backup. Also note that during the update there is a business downtime for
your SAP HANA
● You know the <sid>adm, and database administrator passwords.
● You have applied a valid license key for the SAP HANA system.
Context
After downloading the SAP HANA software, and preparing the downloaded archives for update execution, you
have the choice to update your SAP HANA system in one step, or to update it in a phased approach to minimize
system downtime.
When you start the SAP HANA database lifecycle manager with the prepare_update flag set, the SAP HANA
database lifecycle manager extracts the packages (like the SAP Host Agent, and delivery units) from the new
source, but does not actually perform the update. During the preparation phase the system is not modified by
the installer or restarted. The software switch occurs when the SAP HANA database lifecycle manager is run a
second time, resuming the system update.
Note
It is also possible to use system replication to achieve near zero downtime upgrades. For more information,
see Use System Replication for Near Zero Downtime Upgrades in the SAP HANA Administration Guide.
Procedure
Option Description
Note
If you downloaded the components to a different directory, change to the directory where you
unpacked the archive.
2. Perform the update preparation phase step with the SAP HANA database lifecycle manager using one of
the following commands.
Option Description
Provide the required system update information and credentials. See Related Information for more details
about SAP HANA system update.
Before triggering the update preparation phase, confirm that the following line is listed in the action
summary under Update Parameters:
If you are using the SAP HANA HDBLCM Web user interface, open the Advanced Parameters Configuration
dialog from the footer bar and select Prepare Update Only under General Parameters.
Related Information
As the most powerful database user, SYSTEM is not intended for day-to-day activities in production
environments. Create a lesser-privileged database user in the system database for updating an SAP HANA
system.
Context
For security reasons, the SYSTEM user is not intended for day-to-day activities in production environments. It
is, therefore, required to perform the SAP HANA system update as another user.
Note
A lesser-privileged database user cannot be used to update an XS advanced runtime installation. The
SYSTEM user is required and needs to be temporarily reactivated for the duration of the update.
A system database user should be created with the following granted roles and object privileges:
By calling one of the update LCM tools with the system_user option specified, the previously defined
database user is used in place of SYSTEM to authenticate the configuration task.
Procedure
1. Add the SAP HANA system database in the SAP HANA cockpit.
For more information, see Working with Resources and Resource Groups in the SAP HANA Administration
Guide.
For more information, see Provisioning Users in SAP HANA Cockpit in the SAP HANA Administration Guide.
4. Add the SAP HANA system database in the SAP HANA cockpit again as the new user.
5. Perform the SAP HANA system update as usual, specifying the new lesser-privileged user in place of the
SYSTEM user when prompted.
Related Information
Registered Databases
Provisioning Users in SAP HANA Cockpit
Deactivate the SYSTEM User
system_user [page 265]
During the update to SAP HANA 2.0 SPS 01 or greater, all single-container systems are converted to support
tenant databases.
As of SAP HANA 2.0 SPS 01, the multi-container database mode is the only database mode. A single-container
system will be automatically converted to a tenant database system during the update. The following sections
describe the changes made during the update.
The database of a single-container system is converted into a system database and a tenant database. A new
user (SYSTEM) is created in the system database (SYSTEMDB). During the update, a password has to be
specified for this user. The database superuser (SYSTEM) of the single-container system becomes the
SYSTEM user of the tenant database.
If you have additional questions about the automatic conversion of your single-container system, or wish to
discuss migration support, please contact your SAP support team representative.
In a single-host, single-container system the database is converted to a system database and a single tenant
database.
In a multiple-host, single-container system the database is converted to a system database on the first master
host and a single tenant database that is spread across the worker hosts.
Related Information
After update, you need to review and if necessary reconfigure certain settings.
Database configuration Parameters, which were changed are stored with the tenant database and be
come database-specific.
User administration Users of the single-container database are now present in the tenant database.
During the update, you are asked to provide a new password for the system user
of the system database.
The tenant database retains the port numbers of the original single-container
system: 3<instance>03 (internal communication), 3<instance>15 (SQL), and
3<instance>08 (HTTP via SAP HANA classic server).
The port number of the system database are fixed: 3<instance>01 (internal),
3<instance>13 (SQL), and 3<instance>14 (HTTP via XS classic server).
SAP HANA options If you were running SAP HANA options on your single-container system, no con
figuration changes are required after the update. SAP HANA options hosts or
host roles can be automatically provisioned to a system that is installed with a
single tenant. If the SAP HANA system contains multiple tenant databases or if
the single tenant was not running when you added the SAP HANA options host or
host role, it must be manually provisioned to the tenant. For more information,
see Important Disclaimer for Features in SAP HANA Platform, Options and Capa
bilities.
XS advanced runtime If you have XS advanced runtime installed, a separate xsengine process is cre
ated and the internal Web Dispatcher of the SAP HANA system routes by default
to the single tenant.
Related Information
After update, you need to review and if necessary reconfigure certain security-related settings.
User administration You need to set up new users for administration (at least for recovery) in the sys
tem database.
Network security The system database uses additional ports. These ports that might be firewalled
for security reasons in the system. If this the case, you need to open these ports
so that the system database can be accessed from the SAP HANA cockpit on
other hosts.
TLS/SSL configuration for external If TLS/SSL is enabled for both the system database and tenant database, the in-
communication database certificate collection containing the certificates used for trust validation
is available only in the tenant database. If you want to use the same certificates,
you will need import them into the certificate store of the system database and
add them to a certificate collection there.
Caution
If TLS/SSL is being enforced for client connections (that is, parame
ter[communication] sslEnforce in global.ini set to true), it will not
be possible to establish a connection to the system database. You have to set
sslEnforce to false first.
If the certificates used for trust validation are stored in a PSE in the file system,
both the tenant database and the system database will have access, so no recon
figuration is required.
However, you should validate that sharing the certificate stores for system data
base and tenant is actually intended.
Database isolation The default system isolation level is low. It is possible to change the isolation level
(from low to high or from high to low) at any time after the update. Once high iso
lation has been configured, a dedicated OS user and group must exist for every
tenant database. Otherwise, it's not possible to create or start a tenant database.
Auditing Existing audit policies are available in the tenant database database only. You
need to create new audit policies for administration tasks in the system database.
Related Information
After update, you need to review and if necessary reconfigure certain settings related to backup and recovery.
System database If you do not change your backup configuration, a backup of the tenant database
is created by default. It can be restored into any existing tenant database. The
system database has to be backed up separately.
Third-party tools If your backup strategy is based on data snapshots taken by a third-party tool, we
recommend that you get in touch with your snapshot tool vendor to check if the
tool supports snapshots of SAP HANA tenant database systems. If you use a
script that is based on the documented SQL statements, refer to the documenta
tion to adapt it for use with tenant databases.
Data snapshots As of SAP HANA 2.0 SPS 04, data snapshots are supported on single-tenant and
multiple-tenant systems.
Retention policy Without adjusting your backup retention policy, only the tenant database back
ups are maintained. As a consequence, the system database backup catalog
grows unchecked, consumes main memory, and prolongs backup times. Further
more, system database data and log backups will eat up your backup space.
Backup history The migration from single-container mode to tenant databases does not break
the backup history. Single database data and log backups can be used to recover
a tenant database system.
Disaster recovery In the event of a disaster, you first have to recover the system database in opera
tional mode offline and then the tenant database using the system database con
nectivity. The system database requires to be in operational state online while re
covering the tenant database.
Related Information
7.1.8.4 Landscape
After update, you need to review and if necessary reconfigure certain landscape-related settings.
Host addition and removal After the update, hosts can be added to or removed from a single-host or multi
ple-host SAP HANA system using the SAP HANA database lifecycle manager
(HDBLCM).
Scale-out To scale out a tenant database or distribute it across multiple hosts, you can add
further server components, for example, an additional index server or a separate
XS server. You add a service to a tenant database using the ALTER DATABASE
statement. The statement is executed on the system database for a specific ten
ant database.
Service addition and removal Add or remove service statements are executed on the system database for a
specific tenant database.
Related Information
You can perform an offline update of an SAP HANA system replication landscape. A single-container system
will be automatically converted to a tenant database system during the update. Converting an SAP HANA
system to a tenant database system is permanent and cannot be reversed.
Prerequisites
● The statistics server is not running as a separate server process (statisticsserver), but instead as an
embedded service in the master index server. If this is not the case, migrate the statistics server to the
embedded statistics service as described in SAP Note 1917938.
● The SAP HANA system has been installed with its server software on a shared file system (export options
rw, no_root_squash).
● The SAP HANA system has been installed with the SAP HANA database lifecycle manager (HDBLCM).
● You are logged on as the system administrator user <sid>adm.
Procedure
/usr/sap/<SID>/SYS/global/security/rsecssfs/data/SSFS_<SID>.DAT
/usr/sap/<SID>/SYS/global/security/rsecssfs/key/SSFS_<SID>.KEY
6. Repeat steps 2, 3, and 5 on all remaining secondary systems, following the replication chain.
Related Information
SAP Note 1917938 - Migration of the statistics server for Revision 74 or higher
SAP Note 2369981 - Required configuration steps for authentication with HANA System Replication
Configuring SAP HANA System Replication
You can perform a near-zero downtime update of an SAP HANA system replication landscape. A single-
container system will be automatically converted to a tenant database system during the update. Converting
an SAP HANA system to a tenant database system is permanent and cannot be reversed.
Prerequisites
● The statistics server is not running as a separate server process (statisticsserver), but instead as an
embedded service in the master index server. If this is not the case, migrate the statistics server to the
embedded statistics service as described in SAP Note 1917938.
● The SAP HANA system has been installed with its server software on a shared file system (export options
rw, no_root_squash).
● The SAP HANA system has been installed with the SAP HANA database lifecycle manager (HDBLCM).
● You are logged on as the system administrator user <sid>adm.
● Full data shipping has been successfully completed after setting up the system replication landscape. For
more information, see Initializing the Secondary in the SAP HANA Administration Guide.
Procedure
1. Update the secondary system using the SAP HANA database lifecycle manager. The migration to a tenant
database system is triggered automatically.
2. Wait until the update has finished and all systems are in sync again. The replication will be possible in this
situation although the primary is still a single-container system.
/usr/sap/<SID>/SYS/global/security/rsecssfs/data/SSFS_<SID>.DAT
/usr/sap/<SID>/SYS/global/security/rsecssfs/key/SSFS_<SID>.KEY
6. Register this former primary system as the new secondary to the new primary (former secondary) and
start it. The conversion to a tenant database system is performed automatically.
Related Information
SAP Note 1917938 - Migration of the statistics server for Revision 74 or higher
Configuring SAP HANA System Replication
Initializing the Secondary
7.2 Updating
The SAP HANA database lifecycle manager (HDBLCM) is the program used to update an SAP HANA system,
including server, client, studio, and additional components, in a graphical user interface, the command-line
interface, or the Web user interface.
Optimized Update
As of SPS 11, you can run an optimized update of an SAP HANA system to reduce the number of restarts and
system downtime. You can perform the update using either the SAP HANA database lifecycle manager
graphical user interface, command-line interface or Web user interface.
After downloading the SAP HANA software, and preparing the downloaded archives for update execution, you
have the choice to update your SAP HANA system in standard mode, or to update it using optimized mode to
minimize the number of restarts. The optimized update execution mode is enabled by default, if more than one
component that supports the phased update process is selected to be installed or updated. Usually there is no
need to specify this option explicitly.
The optimized execution mode is enabled when you install or update more than one of these components.
Components which do not support optimized update will be installed or updated in the most appropriate
moment.
When you start the SAP HANA database lifecycle manager with update_execution_mode set to optimized,
the SAP HANA database lifecycle manager:
1. Prepares the components for installation. In combination with the parameter prepare_update this step
can be executed before the actual update to reduce the system downtime during the maintenance window
and make sure that all checks pass.
2. Stops the system or individual instances.
3. Updates the software.
4. Starts the system or individual instances.
5. Resumes the update of the components.
Related Information
All SAP HANA platform components can be updated using the SAP HANA database lifecycle manager
(HDBLCM) graphical user interface.
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.
● With system replication active, you have updated the secondary system before the primary system. The
version of the secondary system must be equal to or higher than the version of the primary system.
● You have performed a system backup. Also note that during the update there is a business downtime for
your SAP HANA system.
● You know the <sid>adm, and database administrator passwords.
● The <sid>adm user has read and execute permissions for the directory that contains the installation
medium.
● You have applied a valid license key for the SAP HANA system.
● The <sid>adm user is able to execute graphical applications.
● You have uninstalled SAP HANA Remote Data Sync from your system. For more information, see SAP Note
2641466.
Context
The following procedure describes the update of an SAP HANA system in interactive mode and entering
parameters interactively. This procedure may also be performed in advanced interactive mode, with
parameters entered as call options or from a configuration file. For more information about interaction modes
and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.
Note
Not all parameters are requested interactively. Some parameters have default values, that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file using the graphical user or command-line interface and advanced interactive mode. For
more information about changeable default values, see Related Information.
Procedure
Note
If you downloaded the components to a different directory, change to the directory where you
unpacked the archive.
./hdblcmgui
The SAP HANA database lifecycle manager graphical user interface appears.
3. Select a detected software component or add a software component location by selecting Add Component
Location. Then select Next.
4. Select Update Existing System, and choose the SID from the drop-down menu. Then select Next.
5. Select the components you would like to update, then select Next.
6. Specify the SAP HANA authorization information.
When asked for database user, you have the opportunity to specify a lesser-privileged database user if you
have previously created one. For more information about creating a database user for update, see Related
Information.
7. Define additional properties, depending on which components are selected.
8. After specifying all system properties, review the summary, and select Update.
Next Steps
SAP HANA content that was installed as part of the SAP HANA database is updated automatically on tenant
databases. Restarting the tenant databases is not necessary to trigger the deployment of the updated content
on the tenant databases. You can monitor the progress of DU deployment by executing the following
statement:
Non-automated content and delivery units that were not installed together with the SAP HANA database and
are not part of the SAP HANA database need to be updated manually on the database where the content was
initially installed.
If your system is configured for system replication, you must perform the update on each host individually,
starting with the secondary host. The version of the secondary system must be the same or higher as the one
running on the primary system
All SAP HANA platform components can be updated using the SAP HANA database lifecycle manager
(HDBLCM) command-line interface.
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.
● With system replication active, you have updated the secondary system before the primary system. The
version of the secondary system must be equal to or higher than the version of the primary system.
● You have performed a system backup. Also note that during the update there is a business downtime for
your SAP HANA system.
● You know the <sid>adm, and database administrator passwords.
● The <sid>adm user has read and execute permissions for the directory that contains the installation
medium.
● You have applied a valid license key for the SAP HANA system.
● You have uninstalled SAP HANA Remote Data Sync from your system. For more information, see SAP Note
2641466.
Context
The following procedure describes the update of an SAP HANA system in interactive mode and entering
parameters interactively. This procedure may also be performed in advanced interactive mode or batch mode,
with parameters entered as call options or from a configuration file. For more information about interaction
modes and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.
Not all parameters are requested interactively. Some parameters have default values that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file. For more information about changeable default values, see Related Information.
Procedure
Option Description
Note
If you downloaded the components to a different directory, change to the directory where you
unpacked the archive.
2. Locate the SAP_HANA_DATABASE directory, and run the SAP HANA database lifecycle manager:
./hdblcm
Note
If your SAP HANA system has XS advanced runtime installed, you can specify XS advanced runtime
components to be updated using the xs_components parameter. MTA extension descriptors
(*.mtaext) can be specified using the xs_components_cfg parameter.
3. Select the index for the system to be updated, then select Enter .
4. Select the components you would like to update as a comma-separated list, then select Enter .
5. Specify the SAP HANA authorization information.
When asked for database user, you have the opportunity to specify a lesser-privileged database user if you
have previously created one. For more information about creating a database user for update, see Related
Information.
6. Define additional properties, depending on which components are selected.
7. After specifying all system properties, review the summary, and select y.
SAP HANA content that was installed as part of the SAP HANA database is updated automatically on tenant
databases. Restarting the tenant databases is not necessary to trigger the deployment of the updated content
on the tenant databases. You can monitor the progress of DU deployment by executing the following
statement:
Non-automated content and delivery units that were not installed together with the SAP HANA database and
are not part of the SAP HANA database need to be updated manually on the database where the content was
initially installed.
If your system is configured for system replication, you must perform the update on each host individually,
starting with the secondary host. The version of the secondary system must be the same or higher as the one
running on the primary system
Related Information
All SAP HANA platform components can be updated using the SAP HANA database lifecycle manager
(HDBLCM) Web user interface.
Prerequisites
You should verify that the following prerequisites are fulfilled before trying to access the SAP HANA database
lifecycle manager from a Web browser.
Note
For more information about supported Web browsers for the SAP HANA database lifecycle manager
Web interface, see the browser support for sap.m library in the SAPUI5 Developer Guide.
● The installation medium must be owned by the root user and should not have write permissions for the
group (except for when the group ID is 0) and others.
● You are updating to a new Support Package Stack (SPS) from an installation medium or you have prepared
for update, either in the SAP HANA studio or manually. For more information, see Prepare for Update
Manually in Related Information.
● With system replication active, you have updated the secondary system before the primary system. The
version of the secondary system must be equal to or higher than the version of the primary system.
● You have performed a system backup. Also note that during the update there is a business downtime for
your SAP HANA system.
● You have applied a valid license key for the SAP HANA system.
● You have uninstalled SAP HANA Remote Data Sync from your system. For more information, see SAP Note
2641466.
Context
SAP HANA content that was installed as part of the SAP HANA database is updated automatically on tenant
databases. Restarting the tenant databases is not necessary to trigger the deployment of the updated content
on the tenant databases. You can monitor the progress of DU deployment by executing the following
statement:
Non-automated content and delivery units that were not installed together with the SAP HANA database and
are not part of the SAP HANA database need to be updated manually on the database where the content was
initially installed.
Not all parameters are requested interactively. Some parameters have default values that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file. For more information about changeable default values, see Related Information.
Procedure
Option Description
Web browser Enter the SAP HANA database lifecycle manager (HDBLCM) URL in an HTML5-enabled browser:
https://<hostname>:1129/lmsl/HDBLCM/<SID>/index.html
Note
The URL is case sensitive. Make sure you enter upper and lower case letters correctly.
1. Enter the URL of the SAP HANA cockpit administration and monitoring console in your browser.
SAP HANA
https://<host_FQDN>:<port>
cockpit
Note
FQDN = fully qualified domain name
2. Drill down on the name of the system from My Resources or from a group.
3. The links in Platform Lifecycle Management each launch additional functionality, giving you ex
panded capabilities for managing the resource.
Option Description
If you downloaded the components to a different directory, enter the file path to the directory where you
unpacked the server archive.
When asked for database user, you have the opportunity to specify a lesser-privileged database user if you
have previously created one. For more information about creating a database user for update, see Related
Information.
7. Define additional properties, depending on which components are selected.
8. After specifying all system properties, review the summary, and select Update.
Next Steps
SAP HANA content that was installed as part of the SAP HANA database is updated automatically on tenant
databases. Restarting the tenant databases is not necessary to trigger the deployment of the updated content
on the tenant databases. You can monitor the progress of DU deployment by executing the following
statement:
Non-automated content and delivery units that were not installed together with the SAP HANA database and
are not part of the SAP HANA database need to be updated manually on the database where the content was
initially installed.
If your system is configured for system replication, you must perform the update on each host individually,
starting with the secondary host. The version of the secondary system must be the same or higher as the one
running on the primary system
Related Information
The SAP HANA database lifecycle manager (HDBLCM) uses the following default values during update unless
you change them.
Some default values are based on the predefined values on the current host.
client_path ${sapmnt}/${SID}/hdbclient
install_hostagent y
(on)
install_ssh_key y
(on)
remote_execution ssh
root_user root
scope system
studio_path ${sapmnt}/${SID}/hdbstudio
studio_repository 1
(on)
system_user SYSTEM
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.
Related Information
You can update your SAP HANA system with active system replication by updating the secondary and the
primary system one after the other.
Prerequisites
System replication is configured and active between two SAP HANA systems.
Context
You must update your SAP HANA system running in a system replication setup by updating the secondary
system first and then updating the primary system.
Remember
For system replication setups it is required that the secondary system has the same version as the primary
system or a higher version. As such, the secondary system must always be updated before the primary
system.
Note
Updating one system after the other results in some downtime. If you want to update your system with
reduced downtime, see Use SAP HANA System Replication for Near Zero Downtime Upgrades.
It is possible to reduce the time required to perform an update. For more information, see Prepare an
Update for Flexible System Downtime .
Procedure
1. Upgrade the SAP HANA server software and all installed components on the secondary system.
./hdblcm --action=update
2. With the secondary system online, use the SAP HANA lifecycle management tools to upgrade all the other
components to the same revision as the server software.
./hdblcm --action=update
5. With the primary system online, use the SAP HANA lifecycle management tools to upgrade all other
components to the same revision as the server software.
6. Verify that system replication is active and that all services are in sync.
Related Information
Use SAP HANA System Replication for Near Zero Downtime Upgrades [page 164]
Prepare an Update for Flexible System Downtime [page 142]
SAP Note 2407186 - How-To Guides & Whitepapers For SAP HANA High Availability
SAP Note 2599514 - Upgrade of Hana 1.0 to 2.0 in System Replication scenario without NZDU
You can use SAP HANA system replication to upgrade your SAP HANA systems as the secondary system can
run with a higher software version than the primary system.
Prerequisites
You configured a user in the local userstore under the SRTAKEOVER key. For more information, see Configure a
User Under the SRTAKEOVER Key.
System replication is configured and active between two identical SAP HANA systems:
Context
With system replication active, you can first upgrade the secondary system to a new revision and have it take
over in the role of primary system. The takeover is carried out in only a few minutes and committed
Note
It is possible to reduce the time required to perform an update. For more information, see Prepare an
Update for Flexible System Downtime in the SAP HANA Server Installation and Update Guide.
The secondary system can be initially installed with the new software version or upgraded to the new software
version when the replication has already been configured. After the secondary has been upgraded, all data has
to be replicated to the secondary system (already having the new software version). When the secondary
system is ACTIVE (all services have synced), a takeover has to be executed on the secondary system. This step
makes the secondary system the production system running with the new software version.
If the installed system version on the primary is HANA 2.0 SPS 04 or greater then you are recommended to use
the 'takeover with handshake' option to ensure a consistent handover. Using this option the primary continues
to run but the writing of transactions on the primary system is suspended. The takeover is only executed when
all redo log is available on the secondary system. See step 3 in the following procedure.
If you are upgrading from SAP HANA 1.0 to SAP HANA 2.0 note that system replication with SAP HANA 2.0
requires authentication for data and log shipping channels, this is done using the certificates in the system PKI
SSFS store. You must therefore copy the system PKI SSFS key and the data file from the current primary
system to the new to-be secondary system. Copy the files before registration when the secondary system is
offline; the files can be found here:
/usr/sap/<SID>/SYS/global/security/rsecssfs/data/SSFS_<SID>.DAT
/usr/sap/<SID>/SYS/global/security/rsecssfs/key/SSFS_<SID>.KEY
For more information, see SAP Note 2369981: Required configuration steps for authentication with HANA
System Replication.
In an Active/Active (read enabled) system replication setup, the version of the primary and the secondary
systems must be identical. For the near zero downtime upgrade to work, the operation mode on the secondary
system is automatically set to logreplay. Like this, the two systems can get back in sync before the takeover
step. To establish again the Active/Active (read enabled) landscape at the end, the logreplay_readaccess
operation mode must be explicitly specified during the former registration of the primary system as a new
secondary system.
For more information about near zero downtime upgrades when using a multitarget system replication setup,
see Use Multitarget System Replication for Near Zero Downtime Upgrades.
Procedure
1. Upgrade the secondary system's SAP HANA server software and all other components.
./hdblcm --action=update
2. Verify that system replication is active and that all services are in sync.
You can check that the column REPLICATION_STATUS in M_SERVICE_REPLICATION has the value ACTIVE
for all services.
○ If the installed system version on the primary is less than HANA 2.0 SPS 04, then:
○ Stop the primary system.
○ Execute the takeover as <sid>adm with the following (default) command:
hdbnsutil -sr_takeover
You can then switch virtual IP addresses to the secondary system, and start using it productively.
4. If XS Advanced is being updated as well, update the XS Advanced applications.
./hdblcm --action=update
5. If the primary has not been stopped (takeover with handshake option), you can now stop the primary
system.
6. Upgrade the original primary from the installation directory as root user using the 'nostart' option. This
option is required because otherwise the primary has to be stopped again before it can be registered as the
secondary:
Note
For a fast synchronization of the sites – after registering again the original primary system – perform
this failback within the time given by the datashipping_snapshot_max_retention_time
parameter (default 300 minutes), otherwise, a full data shipping will be done. Furthermore, the
optimized resync depends on the availability of the last snapshot.
For more information about near zero downtime upgrades in multitier system replication, see SAP Note
2386973.
Related Information
SAP Note 2386973 - Near Zero Downtime Upgrades for HANA database 3-tier System Replication
SAP Note 2494079 - Near-Zero-Downtime-Upgrade to HANA 2 SPS02 or above when internal communication
SSL is used
SAP Note 2407186 - How-To Guides & Whitepapers For SAP HANA High Availability
SAP Note 2300936 - Host Auto-Failover & System Replication Setup with SAP HANA extended application
services, advanced model
SAP HANA system components can be installed, updated, or uninstalled using the SAP HANA database
lifecycle manager (HDBLCM).
Note
As of SAP HANA Support Package Stack (SPS) 09, the SAP HANA studio repository is divided into core
and additional repositories.
Note
As of SAP HANA SPS 08, the Solution Manager Diagnostics Agent can no longer be installed or
uninstalled using the SAP HANA platform lifecycle management tools. To install or uninstall the
Solution Manager Diagnostics Agent, use Software Provisioning Manager (SWPM). For more
information about the setting up the Solution Manager Diagnostics Agent using SWPM, see SAP Note
1858920 in Related Information.
Note
As of SAP HANA SPS 09, SAP HANA platform lifecycle management no longer provides SAP LT
(Landscape Transformation) replication configuration. SAP LT replication configuration is a part of SL
Toolset 1.0. For more information about configuring SAP LT replication, see SAP Note 1891393 in
Related Information.
For information about the availability of the SAP HANA features, SAP HANA capabilities, SAP HANA
options on Intel-based hardware platforms or on IBM Power servers, see SAP HANA Hardware and
Software Requirements in the SAP HANA Master Guide.
For more information about installing, updating, and uninstalling the SAP HANA mandatory components and
SAP HANA additional components, see Related Information. For more information about installing, updating,
and uninstalling the SAP HANA options, see SAP HANA option documentation in Related Information.
Caution
Be aware that you need additional licenses for SAP HANA options. For more information, see Important
Disclaimer for Features in SAP HANA Platform, Options and Capabilities in Related Information.
Related Information
Related Information
Install or Update SAP HANA Components Using the Graphical User Interface [page 170]
You can install additional SAP HANA system components like the SAP HANA client, SAP HANA studio, and
additional system components like Application Function Libraries (AFL, EML and the product-specific AFLs
IBP, RTL, TRP, VCH, XRP), SAP liveCache applications (SAP LCA or LCAPPS plug-in), SAP HANA EPM-MDS
(EPMMDS plug-in), XS advanced runtime applications, SAP HANA smart data access (SDA), or SAP HANA XS
Advanced Runtime using the SAP HANA database lifecycle manager (HDBLCM) graphical user interface.
Prerequisites
The system component should have the same version as the SAP HANA database. Do one of the following:
● Patch the SAP HANA system component to a higher patch number within the same SP (revision).
● Update both the SAP HANA system component and the SAP HANA database to a higher SP (revision).
You cannot update the AFLs to a higher revision number unless you also update your SAP HANA database to
the same revision number. The installation and update of XS advanced runtime components requires the
installation/update of the XS advanced runtime.
Context
In order to install or update SAP HANA system components or additional components, you must start the SAP
HANA database lifecycle manager (HDBLCM) and run an update. The update component menu offers the
opportunity to update the components (if a more recent version is found) and to install additional components,
which were not installed during the initial server installation. If you select the action Install new system instead
of Update existing system, the SAP HANA database lifecycle manager (HDBLCM) also installs the SAP HANA
server, by default. Therefore, if you would like to add only one additional system component to an existing
system, it is necessary to select the action Update existing system, and select only that system component
from the available component list.
Some AFL components can be updated without the need for a database restart and system downtime. A
component supports this feature if its manifest file contains the entry
online-upgrade-plugin: 1
Before updating such a component, verify the version information contained in the required-
components entry inside the manifest file, for example:
If the installed SAP HANA database matches the version requirements of the component, the component is
updated and enabled without a database restart. In this example, any SAP HANA database including
version 1.00.110.00 and excluding version 1.00.110.1 supports this feature. If the versions do not
match, the component is updated, but the database must be updated to the required version and restarted
before the component is enabled.
Note
The product-specific AFLs are released individually and are no longer released as part of SAP HANA AFL.
Therefore, before updating AFL version SPS 07 to a current version, it is necessary to perform a migration.
For more information, see SAP Note 2014334 in Related Information. You can update AFL version SPS 08
to a current version as described.
Note
Adding SAP liveCache applications (SAP LCA or LCAPPS-Plugin) is only supported for the integrated SAP
liveCache, single-host scenario. The SAP LCA archive should be owned by the root user.
Procedure
Option Description
Note
If you downloaded the components to a different directory, change to the directory where you
unpacked the archive.
2. Start the SAP HANA database lifecycle manager interactively in the graphical user interface:
./hdblcmgui
The SAP HANA database lifecycle manager graphical user interface appears.
To activate the local secure (LSS) store during installation, run hdblcmgui with the parameter
secure_store=localsecurestore.
3. Select Update existing system from the activity options. Then select Next.
4. Select the components you would like to install or update as a comma-seperated list, then select Next.
5. Specify the SAP HANA system properties.
You have the opportunity to specify a lesser-privileged database user if you have previously created one.
For more information about creating a database user for update, see Related Information.
6. Review the summary, and select Run to finalize the configuration.
Related Information
You can install additional SAP HANA system components like the SAP HANA client, SAP HANA studio, and
additional system components like Application Function Libraries (AFL, EML and the product-specific AFLs
IBP, RTL, TRP, VCH, XRP), SAP liveCache applications (SAP LCA or LCAPPS plug-in), SAP HANA EPM-MDS
(EPMMDS plug-in), XS advanced runtime applications, SAP HANA smart data access (SDA), or SAP HANA XS
Advanced Runtime using the SAP HANA database lifecycle manager (HDBLCM) command-line interface.
Prerequisites
The system component should have the same version as the SAP HANA database. Do one of the following:
● Patch the SAP HANA system component to a higher patch number within the same SP (revision).
● Update both the SAP HANA system component and the SAP HANA database to a higher SP (revision).
You cannot update the AFLs to a higher revision number unless you also update your SAP HANA database to
the same revision number. The installation and update of XS advanced runtime components requires the
installation/update of the XS advanced runtime.
Context
In order to install or update SAP HANA system components or additional components, you must start the SAP
HANA database lifecycle manager (HDBLCM) and run an update. The update component menu offers the
Some AFL components can be updated without the need for a database restart and system downtime. A
component supports this feature if its manifest file contains the entry
online-upgrade-plugin: 1
Note
Before updating such a component, verify the version information contained in the required-
components entry inside the manifest file, for example:
If the installed SAP HANA database matches the version requirements of the component, the component is
updated and enabled without a database restart. In this example, any SAP HANA database including
version 1.00.110.00 and excluding version 1.00.110.1 supports this feature. If the versions do not
match, the component is updated, but the database must be updated to the required version and restarted
before the component is enabled.
Note
The product-specific AFLs are released individually and are no longer released as part of SAP HANA AFL.
Therefore, before updating AFL version SPS 07 to a current version, it is necessary to perform a migration.
For more information, see SAP Note 2014334 in Related Information. You can update AFL version SPS 08
to a current version as described.
Note
Adding SAP liveCache applications (SAP LCA or LCAPPS-Plugin) is only supported for the integrated SAP
liveCache, single-host scenario. The SAP LCA archive should be owned by the root user.
Procedure
Option Description
Note
If you downloaded the components to a different directory, change to the directory where you
unpacked the archive.
2. Start the SAP HANA database lifecycle manager interactively in the command line:
./hdblcm
3. Select the index for the system to be updated, then select Enter .
4. Select the components you would like to install or update as a comma-seperated list, then select Enter .
5. Specify the SAP HANA system properties.
You have the opportunity to specify a lesser-privileged database user if you have previously created one.
For more information about creating a database user for update, see Related Information.
6. After specifying all system properties, review the summary, and select y.
Related Information
SAP HANA system components like the SAP HANA client, SAP HANA studio, HLM, Application Function
Libraries (AFL), SAP liveCache applications (SAP LCA), XS advanced runtime, or SAP HANA smart data access
(SDA) can be added to an SAP HANA system after installation from a local host using the SAP HANA lifecycle
management tool hdblcm(gui).
Prerequisites
The system component should have the same version as the SAP HANA database. Do one of the following:
● Patch the SAP HANA system component to a higher patch number within the same SP (revision).
● Update both the SAP HANA system component and the SAP HANA database to a higher SP (revision).
You cannot update the AFLs to a higher revision number unless you also update your SAP HANA database to
the same revision number. The installation and update of XS advanced runtime components requires the
installation/update of the XS advanced runtime.
In order to add SAP HANA system components, you must start the hdblcm(gui) installer and select update.
The update component menu offers to update the server (if a more recent version is found) and also offers to
install additional components, which were not installed during the initial server installation. If you select the
action Install new system instead of Update existing system, hdblcm(gui) also installs the SAP HANA server, by
default. Therefore, if you would like to add only one additional system component, it is necessary to select the
action Update existing system, and select only that system component from the available component list.
Some AFL components can be updated without the need for a database restart and system downtime. A
component supports this feature if its manifest file contains the entry
online-upgrade-plugin: 1
Note
Before updating such a component, verify the version information contained in the required-
components entry inside the manifest file, for example:
If the installed SAP HANA database matches the version requirements of the component, the component is
updated and enabled without a database restart. In this example, any SAP HANA database including
version 1.00.110.00 and excluding version 1.00.110.1 supports this feature. If the versions do not
match, the component is updated, but the database must be updated to the required version and restarted
before the component is enabled.
To install and update software components in SAP HANA XS Advanced, the xs install command is available
in the XS Advanced command-line interface (CLI). For more information, see Installing and Updating Software
Components in SAP HANA XS Advanced Model in the SAP HANA Administration Guide.
Note
The product-specific AFLs are released individually and are no longer released as part of SAP HANA AFL.
Therefore, before updating AFL version SPS 07 to a current version, it is necessary to perform a migration.
For more information, see SAP Note 2014334 in Related Information. You can update AFL version SPS 08
to a current version as described.
Procedure
cd <sapmnt>/<SID>/hdblcm
Option Description
Results
A system component has been added to the SAP HANA system. The component list has been updated. A log
has been produced.
Installing and Updating Products and Software Components in SAP HANA XS Advanced Model
component_dirs [page 231]
component_medium [page 231]
component_root [page 231]
Create a Lesser-Privileged Database User for Update [page 144]
SAP Note 2327295 - Confirm Successful Installation of Smart Data Access
You can install additional SAP HANA system components like the SAP HANA client, SAP HANA studio, and
additional system components like Application Function Libraries (AFL, EML and the product-specific AFLs
IBP, RTL, TRP, VCH, XRP), SAP liveCache applications (SAP LCA or LCAPPS plug-in), SAP HANA EPM-MDS
(EPMMDS plug-in), XS advanced runtime applications, SAP HANA smart data access (SDA), or SAP HANA XS
Advanced Runtime using the SAP HANA database lifecycle manager (HDBLCM) Web user interface.
Prerequisites
You should verify that the following prerequisites are fulfilled before trying to access the SAP HANA database
lifecycle manager from a Web browser.
Note
For more information about supported Web browsers for the SAP HANA database lifecycle manager
Web interface, see the browser support for sap.m library in the SAPUI5 Developer Guide.
The system component should have the same version as the SAP HANA database. Do one of the following:
● Patch the SAP HANA system component to a higher patch number within the same SP (revision).
● Update both the SAP HANA system component and the SAP HANA database to a higher SP (revision).
You cannot update the AFLs to a higher revision number unless you also update your SAP HANA database to
the same revision number. The installation and update of XS advanced runtime components requires the
installation/update of the XS advanced runtime.
Context
Some AFL components can be updated without the need for a database restart and system downtime. A
component supports this feature if its manifest file contains the entry
online-upgrade-plugin: 1
Note
Before updating such a component, verify the version information contained in the required-
components entry inside the manifest file, for example:
If the installed SAP HANA database matches the version requirements of the component, the component is
updated and enabled without a database restart. In this example, any SAP HANA database including
version 1.00.110.00 and excluding version 1.00.110.1 supports this feature. If the versions do not
match, the component is updated, but the database must be updated to the required version and restarted
before the component is enabled.
Note
The product-specific AFLs are released individually and are no longer released as part of SAP HANA AFL.
Therefore, before updating AFL version SPS 07 to a current version, it is necessary to perform a migration.
For more information, see SAP Note 2014334 in Related Information. You can update AFL version SPS 08
to a current version as described.
Procedure
Web browser Enter the SAP HANA database lifecycle manager (HDBLCM) URL in an HTML5-enabled browser:
https://<hostname>:1129/lmsl/HDBLCM/<SID>/index.html
Note
The URL is case sensitive. Make sure you enter upper and lower case letters correctly.
1. Enter the URL of the SAP HANA cockpit administration and monitoring console in your browser.
SAP HANA
https://<host_FQDN>:<port>
cockpit
Note
FQDN = fully qualified domain name
2. Drill down on the name of the system from My Resources or from a group.
3. The links in Platform Lifecycle Management each launch additional functionality, giving you ex
panded capabilities for managing the resource.
Various parameters can be set in the Advanced Parameters Configuration dialog. To access the Advanced
Parameters Configuration dialog, click on the gear icon in the footer bar of the SAP HANA HDBLCM Web
user interface.
5. Specify additional hosts or roles to be added. Then select Next.
6. Specify the SAP HANA authorization information.
Depending on the component selection, if asked for database user, you have the opportunity to specify a
lesser-privileged database user if you have previously created one.
7. After specifying all system properties, review the summary, and select Update.
Related Information
You can upload and extract SAP HANA component archives that were downloaded from the SAP Service
Marketplace for installation or update using the SAP HANA database lifecycle manager (HDBLCM) Web user
interface.
Prerequisites
You should verify that the following prerequisites are fulfilled before trying to access the SAP HANA database
lifecycle manager from a Web browser.
Note
For more information about supported Web browsers for the SAP HANA database lifecycle manager
Web interface, see the browser support for sap.m library in the SAPUI5 Developer Guide.
The system component should have the same version as the SAP HANA database. Do one of the following:
● Patch the SAP HANA system component to a higher patch number within the same SP (revision).
● Update both the SAP HANA system component and the SAP HANA database to a higher SP (revision).
You cannot update the AFLs to a higher revision number unless you also update your SAP HANA database to
the same revision number. The installation and update of XS advanced runtime components requires the
installation/update of the XS advanced runtime.
Some AFL components can be updated without the need for a database restart and system downtime. A
component supports this feature if its manifest file contains the entry
online-upgrade-plugin: 1
Note
Before updating such a component, verify the version information contained in the required-
components entry inside the manifest file, for example:
If the installed SAP HANA database matches the version requirements of the component, the component is
updated and enabled without a database restart. In this example, any SAP HANA database including
version 1.00.110.00 and excluding version 1.00.110.1 supports this feature. If the versions do not
match, the component is updated, but the database must be updated to the required version and restarted
before the component is enabled.
Note
The product-specific AFLs are released individually and are no longer released as part of SAP HANA AFL.
Therefore, before updating AFL version SPS 07 to a current version, it is necessary to perform a migration.
For more information, see SAP Note 2014334 in Related Information. You can update AFL version SPS 08
to a current version as described.
Procedure
Option Description
Web browser Enter the SAP HANA database lifecycle manager (HDBLCM) URL in an HTML5-enabled browser:
https://<hostname>:1129/lmsl/HDBLCM/<SID>/index.html
Note
The URL is case sensitive. Make sure you enter upper and lower case letters correctly.
1. Enter the URL of the SAP HANA cockpit administration and monitoring console in your browser.
SAP HANA
https://<host_FQDN>:<port>
cockpit
Note
FQDN = fully qualified domain name
2. Drill down on the name of the system from My Resources or from a group.
3. The links in Platform Lifecycle Management each launch additional functionality, giving you ex
panded capabilities for managing the resource.
Option Description
The Archives are Ac Use this option if the archives are located on a file system accessible from the SAP HANA host.
cessible from the
SAP HANA Host Specify the directory which contains the component archives under Location of SAP HANA
Component Archives. Then select Next.
Upload Archives to Use this option if the archives are accessible only from your local machine.
the SAP HANA Host
Select one or more component archives that you want to upload to the SAP HANA host. Then
select Upload.
4. Specify an empty target directory to extract the software component archives to under Temporary Extract
Directory. Then select Next.
5. After specifying all system properties, review the summary, and select Extract.
If an XS Advanced component needs to be updated (for example, due to a security vulnerability), the patch
process depends on the category of the affected component.
The following list covers the update process for each category:
● XS Advanced Runtime
● UAA
● HANA Service Broker
● Instance Manager
● Audit-Log Service
● Product Installer
● Deploy Service
● File System Service
If one of these components needs to be updated, a new XS Advanced release has to be installed using the SAP
HANA lifecycle tool hdblcm. You can download the corresponding packages from the SAP Service
MarketPlace. For more information, see SAP Note 2347931 - SAP HANA extended application services,
advanced model components versioning.
Each new XS Advanced release includes the latest versions of the default build packs (for example, "Java Build
Pack" and "Node.js Build Pack"). Updating XS Advanced will also update the default build packs.
If you want to update any custom build packs, use the xs update-buildpack command, as illustrated in the
following example:
Tip
Updating a build pack does not imply an automatic change for any application droplets that have been built
using a previous version of the updated build pack. To update the application droplet, you must trigger the
restage and restart operations manually, for example using the xs restage and xs restart commands, as
illustrated in the following example:
xs restage <APP>
xs restart <APP>
XS Advanced comes with a set of default application run-time environments. Each new XS Advanced release
comes with the latest versions of the default application run-time environments. Updating XS Advanced will
also update the default application run-time environments.
To update a custom application run time environment, you must create and upload a new version of the
application run time by using the xs create-runtime command, as illustrated in the following example:
When you deploy new applications, the newly created run time environment is used. To enable any already
staged applications to use the new run-time environment, you must restage the affected applications. You can
then delete the old application run time using the xs delete-runtime command, as illustrated in the
following example:
Note
● The ID of the run time can be displayed with the command xs runtimes, which displays a list of all XS
advanced run-times.
● Application run time environments might be pinned to one or more specific applications. The xs
delete-runtime command removes all pinning settings for the deleted application run time. You can
use the command xs pinned-runtimes to display a list of all pinned run time environments.
Each new XS Advanced release includes the latest release of the system service brokers. Updating XS
Advanced also updates the system service brokers.
To update custom service brokers manually, deploy the updated service broker to your landscape and use the
command xs update-service-broker to register the changes for the updated service broker with the XS
Controller, as illustrated in the following example:
Note
Some service brokers are integrated in XS Advanced applications. If the service broker you update is
integrated in an application, you must deploy a new version of the application.
XS Advanced Applications
If you need to update an XS Advanced application (for example, due to a security vulnerability in one of the
application's components), deploy a new version of the application with the xs installcommand, as
illustrated in the following example:
xs install <installation-archive>
For more information about how to download new versions of additional SAP XS Advanced applications, see
SAP Note 2347931 - SAP HANA extended application services, advanced model components versioning.
For more information about the individual xs commands, see the SAP HANA Developer Guide for XS Advanced
(XS CLI) or the SAP HANA Administration Guide.
Related Information
SAP Note 2347931 - SAP HANA extended application services, advanced model components versioning
SAP HANA Administration Guide
SAP HANA Developer Guide for XS Advanced Model
After the installation of the local secure store has finished successfully, the local secure store must be enabled
from the command-line before it can be used.
Prerequisites
You are logged on with the required root user or system administrator user <sid>adm credentials.
Restriction
The local secure store (LSS) is not supported by SAP HANA Dynamic Tiering. For more information, see
SAP Note 2935272.
Context
The following procedure describes how to activate the local secure store after installing or updating an SAP
HANA system with the Local Secure Store component. It will also migrate the existing SSFS (secure store in the
file system) to LSS. To activate the local secure store during installation, run hdblcm with the parameter
secure_store=localsecurestore.
Procedure
Related Information
SAP HANA components - including system components and additional components - can be uninstalled the
following ways:
Related Information
Uninstall SAP HANA Components Using the Graphical User Interface [page 186]
Uninstall SAP HANA Components Using the Command-Line Interface [page 188]
Uninstall an SAP HANA Component on a System Missing the SAP HANA Resident Program [page 189]
Uninstall SAP HANA Components Using the Web User Interface [page 191]
SAP Note 1858920 - Diagnostics Agent installation with SWPM
SAP HANA system components and additional system components can be removed from an SAP HANA
system after installation using the SAP HANA database lifecycle manager (HDBLCM) graphical user interface.
Prerequisites
● The SAP HANA system has been installed with the SAP HANA database lifecycle manager (HDBLCM).
● The SAP HANA database server is up and running. Otherwise, inconsistencies in the configuration occur.
● The user is able to execute graphical applications.
Note
Using the SAP HANA database lifecycle manager, it is possible to remove the SAP HANA server, SAP HANA
client, SAP HANA studio, HLM, Application Function Libraries (AFL, EML and the product-specific AFLs IBP,
RTL, TRP, VCH, XRP), SAP liveCache applications (SAP LCA or LCAPPS plug-in), SAP HANA EPM-MDS
(EPMMDS plug-in), Local Secure Store (LSS), XS advanced runtime applications, or SAP HANA smart data
access (SDA), but it is not possible to remove the SAP host agent or the Solution Manager Diagnostics
(SMD) agent. If you need to uninstall the SMD agent, see SAP Note 1858920 in Related Information.
Note
If you want to uninstall a component that requires specific host roles, you must first remove all related host
roles or hosts which have these host roles assigned. For more information, see the removing hosts and
removing host roles sections in the SAP HANA Administration Guide.
During the uninstallation of the Local Secure Store (LSS) the secure store is automatically migrated to SSFS.
Procedure
cd <sapmnt>/<SID>/hdblcm
./hdblcmgui
The SAP HANA database lifecycle manager graphical user interface appears.
3. Select Uninstall SAP HANA Components from the activity options. Then select Next.
4. Select Uninstall separate components, and then choose the components to be uninstalled. Then select
Next.
5. Review the summary, and select Run to finalize the configuration.
Results
Related Information
SAP HANA system components and additional system components can be removed from an SAP HANA
system after installation using the SAP HANA database lifecycle manager (HDBLCM) command-line interface.
Prerequisites
● The SAP HANA system has been installed with the SAP HANA database lifecycle manager (HDBLCM).
● The SAP HANA database server is up and running. Otherwise, inconsistencies in the configuration occur.
Context
Note
Using the SAP HANA database lifecycle manager, it is possible to remove the SAP HANA server, SAP HANA
client, SAP HANA studio, HLM, Application Function Libraries (AFL, EML and the product-specific AFLs IBP,
RTL, TRP, VCH, XRP), SAP liveCache applications (SAP LCA or LCAPPS plug-in), SAP HANA EPM-MDS
(EPMMDS plug-in), Local Secure Store (LSS), XS advanced runtime applications, or SAP HANA smart data
access (SDA), but it is not possible to remove the SAP host agent or the Solution Manager Diagnostics
(SMD) agent. If you need to uninstall the SMD agent, see SAP Note 1858920 in Related Information.
Note
If you want to uninstall a component that requires specific host roles, you must first remove all related host
roles or hosts which have these host roles assigned. For more information, see the removing hosts and
removing host roles sections in the SAP HANA Administration Guide.
During the uninstallation of the Local Secure Store (LSS) the secure store is automatically migrated to SSFS.
Procedure
cd <sapmnt>/<SID>/hdblcm
./hdblcm
Results
Related Information
If you would like to uninstall SAP HANA components from a system, which has been installed with the SAP
HANA platform lifecycle management tool hdbinst, and has been updated with hdbupd, you cannot use the
typical uninstallation procedures with the SAP HANA database lifecycle manager (HDBLCM). The reason for
this is that the SAP HANA resident HDBLCM is missing from the system.
Prerequisites
● You are logged on to the host where the server software is installed.
● You are logged on as the root user.
Context
To uninstall an SAP HANA component on a system missing the SAP HANA resident HDBLCM:
Install the SAP HANA resident HDBLCM, then perform component uninstallation as usual using the newly
available SAP HANA resident HDBLCM.
Start the SAP HANA database lifecycle manager from an SAP HANA server installation kit, which has the same
version as the installed SAP HANA database, with the following command:
Then uninstall using one of the typical uninstallation procedures in Uninstalling SAP HANA Components.
During the uninstallation of the Local Secure Store (LSS) the secure store is automatically migrated to SSFS.
Procedure
Option Description
Note
If you downloaded the components to a different directory, change to the directory where you
unpacked the archive.
2. Start the SAP HANA database lifecycle manager interactively in the command line:
SAP HANA system components and additional system components can be removed from an SAP HANA
system after installation using the SAP HANA database lifecycle manager (HDBLCM) Web user interface.
Prerequisites
You should verify that the following prerequisites are fulfilled before trying to access the SAP HANA database
lifecycle manager from a Web browser.
Note
For more information about supported Web browsers for the SAP HANA database lifecycle manager
Web interface, see the browser support for sap.m library in the SAPUI5 Developer Guide.
The system component should have the same version as the SAP HANA database. Do one of the following:
● Patch the SAP HANA system component to a higher patch number within the same SP (revision).
● Update both the SAP HANA system component and the SAP HANA database to a higher SP (revision).
You cannot update the AFLs to a higher revision number unless you also update your SAP HANA database to
the same revision number. The installation and update of XS advanced runtime components requires the
installation/update of the XS advanced runtime.
Note
If you want to uninstall a component that requires specific host roles, you must first remove all related host
roles or hosts which have these host roles assigned. For more information, see the removing hosts and
removing host roles sections in the SAP HANA Administration Guide.
Note
The product-specific AFLs are released individually and are no longer released as part of SAP HANA AFL.
Therefore, before updating AFL version SPS 07 to a current version, it is necessary to perform a migration.
For more information, see SAP Note 2014334 in Related Information. You can update AFL version SPS 08
to a current version as described.
During the uninstallation of the Local Secure Store (LSS) the secure store is automatically migrated to SSFS.
Procedure
Option Description
Web browser Enter the SAP HANA database lifecycle manager (HDBLCM) URL in an HTML5-enabled browser:
https://<hostname>:1129/lmsl/HDBLCM/<SID>/index.html
Note
The URL is case sensitive. Make sure you enter upper and lower case letters correctly.
1. Enter the URL of the SAP HANA cockpit administration and monitoring console in your browser.
SAP HANA
https://<host_FQDN>:<port>
cockpit
Note
FQDN = fully qualified domain name
2. Drill down on the name of the system from My Resources or from a group.
3. The links in Platform Lifecycle Management each launch additional functionality, giving you ex
panded capabilities for managing the resource.
If required, you can uninstall the previously installed SAP HANA components by running the SAP HANA
database lifecycle manager (HDBLCM) from the SAP HANA resident HDBLCM directory in the graphical user
interface or command-line interface.
Related Information
Uninstall the SAP HANA System Using the Graphical User Interface [page 193]
Uninstall the SAP HANA System Using the Command-Line Interface [page 194]
Prerequisites
Context
Note
Using the SAP HANA database lifecycle manager, it is possible to remove the SAP HANA server, SAP HANA
client, SAP HANA studio, HLM, Application Function Libraries (AFL, EML and the product-specific AFLs IBP,
RTL, TRP, VCH, XRP), SAP liveCache applications (SAP LCA or LCAPPS plug-in), SAP HANA EPM-MDS
(EPMMDS plug-in), Local Secure Store (LSS), XS advanced runtime applications, or SAP HANA smart data
access (SDA), but it is not possible to remove the SAP host agent or the Solution Manager Diagnostics
(SMD) agent. If you need to uninstall the SMD agent, see SAP Note 1858920 in Related Information.
Caution
Uninstalling the SAP HANA system removes all data volumes and log volumes. It is a permanent action that
cannot be undone!
cd <sapmnt>/<SID>/hdblcm
./hdblcmgui
The SAP HANA database lifecycle manager graphical user interface appears.
3. Select Uninstall SAP HANA Database Components from the activity options. Then select Next.
4. Select Uninstall SAP HANA Database version <version number> and all other components. Then select
Next.
5. Review the summary, and select Uninstall to finalize the configuration.
Results
Related Information
You can uninstall an SAP HANA system using the SAP HANA database lifecycle manager (HDBLCM)
command-line interface.
Prerequisites
Note
Using the SAP HANA database lifecycle manager, it is possible to remove the SAP HANA server, SAP HANA
client, SAP HANA studio, HLM, Application Function Libraries (AFL, EML and the product-specific AFLs IBP,
RTL, TRP, VCH, XRP), SAP liveCache applications (SAP LCA or LCAPPS plug-in), SAP HANA EPM-MDS
(EPMMDS plug-in), Local Secure Store (LSS), XS advanced runtime applications, or SAP HANA smart data
access (SDA), but it is not possible to remove the SAP host agent or the Solution Manager Diagnostics
(SMD) agent. If you need to uninstall the SMD agent, see SAP Note 1858920 in Related Information.
Caution
Uninstalling the SAP HANA system removes all data volumes and log volumes. It is a permanent action that
cannot be undone!
Procedure
cd <sapmnt>/<SID>/hdblcm
./hdblcm
Results
Related Information
After the installation has finished, it is recommended to perform the following tasks:
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
Example:
/usr/sap/KB1/HDB26/HDB start
○ Stop the SAP HANA system by entering the following command:
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.
It is possible to display the SAP HANA system processes from the command line.
Prerequisites
You are logged on with the required root user or system administrator user <sid>adm credentials.
Procedure
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
09.07.2015 14:09:20
GetProcessList
OK
name, description, dispstatus, textstatus, starttime, elapsedtime, pid
hdbdaemon, HDB Daemon, GREEN, Running, 2015 07 06 13:38:00, 72:31:20, 1195
hdbnameserver, HDB Nameserver, GREEN, Running, 2015 07 06 13:38:03, 72:31:17,
1213
hdbpreprocessor, HDB Preprocessor, GREEN, Running, 2015 07 06 13:38:18,
72:31:02, 1279
The following tutorials are a sampling of general use cases, which illustrate the functionality and versatility of
the SAP HANA database lifecycle manager.
Installation automation is designed for those who are familiar with SAP HANA, and are installing it regularly, in
various production environments. In particular, installation automation refers to installing SAP HANA systems
using batch mode and a combination of a configuration file and call options passed on the command line.
With the SAP HANA database lifecycle manager (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.
The hardware partner automates the installation of nine SAP HANA systems (1 Extra Large, 5 Large, and 3
Small). Previously, he has created configuration files for each of the three system types. So, when several
orders come in at the same time, he fine tunes his installation script to include the number of systems and calls
the SAP HANA database lifecycle manager using the command-line interface with the configuration file
parameter in batch mode. When the installation script is run, SAP HANA is installed on both the single-host
and multiple-host systems, without any additional input. By reusing the same configuration files, the
installations are reliable, flexible, and efficient.
Automation is ideal for installations that run unattended. Before you start an automated installation, it is
recommended to consider the following.
Do you know where the data volumes and the log volumes For security reasons, the data device and log device should
will be located? not be the same. Refer to the SAP HANA System Types.
Where will the required file systems be located and is the Refer to the Recommended File System Layout.
storage sufficient?
Have you performed a hardware check? The installer performs a hardware check before installation,
for automated installation it is recommended to perform a
manual hardware check first. Refer to the Hardware and
Software Requirements.
Where will you specify passwords? SYSTEM, <sid>adm, and root passwords must be specified
in the configuration file or in an XML file. Refer to the Speci
fying Passwords information.
How many worker hosts and standby hosts will there be? System processes and data are distributed among worker
How will they be grouped? hosts, including the original host. Standby hosts do not per
form 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 Multiple-Host Sys
tem Concepts.
The root user name must be the same for all hosts in a multi If not, the root_user parameter must be specified during
ple-host system. Will the root user name for all hosts be installation. Refer to the root_user parameter information.
"root"?
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:
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:
Instance number 01 -n 01
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.
If you want to run the installation with a configuration file and you do not want be asked interactively for
specific parameters, you can either provide a fixed value in the configuration file or set the value to
USE_DEFAULT to use the paramater's default value. Example addhosts=USE_DEFAULT.
You can specify a new default value for a parameter to be used in interactive mode using the following
syntax:<parameter>::DEFAULT=<new_default_value>.
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.
./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:
Now, the partner starts the installer, this time with the addition of the batch mode parameter, -b (or --batch):
./hdblcm --configfile=/home/root/HANA_install.cfg -b
Related Information
During system installation, customized SAP HANA configuration (*.ini) files can be placed inside a dedicated
directory that is specified using the custom_cfg parameter.
Context
Custom configuration files can be placed inside a custom configuration folder. These files are used during
installation to override default settings. This reduces the number of restarts during installation and facilitates
configuration of the SAP HANA system.
Procedure
1. Create an empty directory that will contain your custom configuration files. The configuration files will be
copied to the following directory before system start and will override the default settings: <sapmnt>/
<SID>/global/hdb/custom/config
2. Create your own configuration files (*.ini) inside the custom configuration files directory. Alternatively, you
can copy existing files from another system to re-use a tested configuration. For more information on
configuration files, see Configuring SAP HANA System Properties (INI Files) in the SAP HANA
Administration Guide.
3. Now the installer can be called from the command line.
Related Information
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.
Procedure
1. The following are the relevant parameters for the SAP HANA server. They are specified in a combination of
command line options and configuration file:
2. The reusable installation parameter values are saved in the following configuration file:
[Server]
# Additional Hosts
addhosts=hananode1
# Root User Name (Default: root)
root_user=sysroot
# Root User Password
root_password=Root1234
# SAP HANA System ID
sid=ABC
# Instance Number (Default: <next available number>)
number=01
# SAP Host Agent (sapadm) Password
sapadm_password=Agent1234
# System Administrator Password
password=Adm1234
# System Administrator User ID (Default: <next available number>)
userid=55
# ID of User Group 'sapsys' (Default: 79)
groupid=110
# Directory containing a storage configuration
storage_cfg=/home/sysroot/storage
# Database User (SYSTEM) Password
system_user_password=Sys1234
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.
Procedure
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
# Root User Name (Default: root)
root_user=sysroot
# Root User Password
root_password=Root1234
# SAP HANA System ID
sid=ABC
# Instance Number (Default: <next available number>)
number=01
# SAP Host Agent (sapadm) Password
sapadm_password=Agent1234
# System Administrator Password
password=Adm1234
# System Administrator User ID (Default: <next available number>)
userid=55
# ID of User Group 'sapsys' (Default: 79)
groupid=110
# Directory containing a storage configuration
storage_cfg=/home/sysroot/storage
# Database User (SYSTEM) Password
system_user_password=Sys1234
If you want to run the installation with a configuration file and you do not want be asked interactively for
specific parameters, you can either provide a fixed value in the configuration file or set the value to
USE_DEFAULT to use the paramater's default value. Example addhosts=USE_DEFAULT.
You can specify a new default value for a parameter to be used in interactive mode using the following
syntax:<parameter>::DEFAULT=<new_default_value>.
Example
sid::DEFAULT=ABC
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.
Context
This tutorial describes how passwords are supplied to the SAP HANA database lifecycle manager in an XML file
in which passwords are stored as plain text. For security reasons, you may want to consider providing
encrypted passwords along with a tool that decrypts the passwords and passes them to the standard input
stream of the SAP HANA database lifecycle manager in XML format.
Procedure
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:
hdb_passwords.xml
<?xml version="1.0" encoding="UTF-8"?>
<Passwords>
<password><![CDATA[Adm1234]]></password>
<sapadm_password><![CDATA[Agent1234]]></sapadm_password>
<system_user_password><![CDATA[Sys1234]]></system_user_password>
<root_password><![CDATA[Root1234]]></root_password>
</Passwords>
3. Now the installer can be called from the command line, with the passwords read from a standard input
stream. The installation is run in batch mode, so no follow-up confirmation is required.
Related Information
Troubleshooting should be referred to if the installation fails for an unknown reason, or for workarounds in
special circumstances.
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.
To view the available underlying component parameters as extended help output, use the
pass_through_help parameter. The action parameter and --help or -h must be specified in combination
with pass_through_help.
Syntax
To view the help output for the installation or the update pass_through_help
parameters, use the following syntax:
--action=[install|update] --pass_through_help --help
or
--action=[install|update] --pass_through_help -h
--hdbinst_client_ignore=<check1>[]...
--hdbinst_client_sapmnt=<installation_path>
[default: --hdbinst_client_sapmnt=/hana/shared]
--hdbinst_plugin_ignore=<check1>[]...
--hdbinst_plugin_nostart
--hdbinst_plugin_system_user
--hdbinst_server_prepare_update
--hdbinst_server_remote_execution
Specifies the connectivity method for multiple host operations [default: ssh]
--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_features=all|<feat1>[,<feat2>]...
--hdbinst_studio_path=<hdbinst_studio_path>
--hdbupd_server_change_initial_ssfs_key[=off]
--hdbupd_server_ignore=<check1>[]...
--hdbupd_server_import_content[=off]
--hdbupd_server_nostart
--hdbupd_server_prepare_update
--hdbupd_server_remote_execution
Specifies the connectivity method for multiple host operations [default: ssh]
--hdbupd_server_xs_engine[=off]
--hdbupd_server_xs_engine_http_port=<port>
--hdbupd_server_xs_engine_https_port=<port>
In addition to the main components installed in the default file systems described in Recommended File
System Layout [page 18], it may also be necessary to locate the temporary files from the SAP HANA system.
They can be found in the following directories:
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.
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>_hdblcm_<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 Administration Guide.
The SAP HANA lifecycle management tool hdblcm can be added to an existing installation that was performed
using hdbinst by executing the following command:
Note
The version of hdblcm must be identical with the version of the installed SAP HANA system.
As of SPS 11, an optimized update of an SAP HANA system is performed to reduce the number of restarts and
system downtime. The optimized update execution mode is enabled by default, if more than one component
that supports the phased update process is selected to be installed. For troubleshooting purposes, the update
mode can be switched to standard. Perform a standard update with the SAP HANA database lifecycle manager
using one of the following commands.
Command-line interface
./hdblcm --action=update --
update_execution_mode=standard
If you are using the SAP HANA HDBLCM Web user interface, open the Advanced Parameters Configuration
dialog from the footer bar and select the standard update Update Execution Mode under General Parameters.
If the update stops without fully installing, uninstall the SAP HANA system using the SAP HANA database
lifecycle manager (HDBLCM) and recover the system from the last backup. Then reinstall the SAP HANA
system and run the update.
Related Information
If the import of delivery units fails during installation or update, you can import the delivery units manually. Use
the command-line tool hdbupdrep to import the delivery units into the database. hdbupdrep is located
in /usr/sap/<SID>/SYS/global/hdb/install/bin.
As of SAP HANA 2.0 Support Package Stack (SPS) 03, you can rerun the SAP HANA database lifecycle
manager to resume the update.
Related Information
General Troubleshooting for the SAP HANA Platform LCM Tools [page 66]
SAP Note 1795885 - HANA Upgrade: problems with "Importing delivery units"
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.
A host cannot be added using the SAP HANA lifecycle management tool hdblcm if the time difference between
the system time set on the installation host and the additional host is greater than 180 seconds. For
information about setting the system time, see the documentation of your Linux distribution.
The XS advanced runtime requires initial content to be imported during installation. However, this import can
be skipped by executing the SAP HANA installation with the following parameter:
--import_xs_content=off
If the import of the initial content was skipped during installation, the content can be imported at a later time
by executing the resident SAP HANA lifecycle management tool hdblcm with the following parameter:
--load_initial_xs_content
An SAP HANA system with XS advanced runtime installed that is using a proxy server requires the values of the
http_proxy, https_proxy and no_proxy environment variables to be set. To do so, execute the following
commands:
export http_proxy=http://<proxy_host>:<proxy_port>
export https_proxy=https://<proxy_host>:<proxy_port>
export no_proxy="<full qualified name of the XS Advanced server>"
Each parameter section includes some or all of the following information, depending on the complexity of the
parameter:
13.1 action
Syntax
Remarks
The default for this parameter is --action=exit.
13.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.
Syntax
--action=install --addhosts=<host>[,<host2>]
Options
The following options can be used to configure the parameter:
● role - Specifies the purpose of the SAP HANA host. Although multiple host roles
may be assigned, check the corresponding documentation for the SAP HANA
option for what configurations are supported in production environments.
○ worker - A worker host (default) is used for database processing.
○ standby - A standby host is idle and available for failover in a high-availability
environment.
○ compute - Database elastic compute server
○ extended_storage_worker - Worker host for SAP HANA dynamic tiering
○ extended_storage_standby - Standby host for SAP HANA dynamic tiering
○ ets_worker - Worker host for SAP HANA accelerator for SAP ASE
○ ets_standby - Standby host for SAP HANA accelerator for SAP ASE
○ streaming - Host for SAP HANA streaming analytics
○ xs_worker - Host for SAP HANA XS advanced runtime
○ xs_standby - Standby host for SAP HANA XS advanced runtime
● workergroup - Specifies the worker group of the host. If undefined, the worker
group is named "default". If you are using extension node for Business Warehouse,
you must name the worker group "worker_dt".
● 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 - Specifies the storage partition number, which is a logical
role number assigned to non-shared storage devices in a storage connector API.
Standby hosts do not have a storage partition.
Remarks
The following SAP HANA options are supported on Intel-based hardware platforms
only:
Be aware that you need additional licenses for SAP HANA options. For more information, see Important
Disclaimer for Features in SAP HANA Platform, Options and Capabilities in Related Information.
Related Information
13.3 add_local_roles
Specifies additional roles of the local host during SAP HANA system installation. Multiple host roles are not
supported in production environments. However, if XS advanced runtime is installed, hosts can share multiple
roles.
Syntax
--add_local_roles=<role1>[,<role2>]
Remarks
The following SAP HANA options are supported on Intel-based hardware platforms
only:
Caution
Be aware that you need additional licenses for SAP HANA options. For more information, see Important
Disclaimer for Features in SAP HANA Platform, Options and Capabilities in Related Information.
Related Information
13.4 add_roles
Specifies additional roles for exisiting SAP HANA hosts during SAP HANA option installation. Multiple host
roles are not supported in production environments. However, if XS advanced runtime is installed, hosts can
share multiple roles.
Syntax
Caution
Be aware that you need additional licenses for SAP HANA options. For more information, see Important
Disclaimer for Features in SAP HANA Platform, Options and Capabilities in Related Information.
Related Information
Syntax
--apply_system_size_dependent_parameters[=off]
Remarks
The parameter is available during installation and update to a newer version. If you want
to apply a resource limit without upgrading to a higher SAP HANA revision, specify --
ignore=check-version when starting the update.
Related Information
SAP Note 3014176 - Applying System Size Dependent Resource Limits During Installation or Upgrade
13.6 ase_datapath
Specifies the path to the directory of the SAP HANA accelerator for SAP ASE data. Required for installation of
SAP HANA accelerator for SAP ASE.
Syntax
Remarks
The default for this parameter is --ase_datapath=/hana/data_ase/<SID>.
Caution
Be aware that you need additional licenses for SAP HANA options. For more
information, see Important Disclaimer for Features in SAP HANA Platform, Options
and Capabilities in Related Information.
13.7 ase_logpath
Specifies the path to the directory of the SAP HANA accelerator for SAP ASE logs. Required for installation or
update of SAP HANA accelerator for SAP ASE.
Syntax
Remarks
The default for this parameter is --ase_logpath=/hana/log_ase/<SID>.
Caution
Be aware that you need additional licenses for SAP HANA options. For more
information, see Important Disclaimer for Features in SAP HANA Platform, Options
and Capabilities in Related Information.
Related Information
13.8 ase_user
Specifies the administrator user of SAP HANA accelerator for SAP ASE.
Syntax
Remarks
Caution
Be aware that you need additional licenses for SAP HANA options. For more
information, see Important Disclaimer for Features in SAP HANA Platform, Options
and Capabilities in Related Information.
Related Information
13.9 autoadd_xs_roles
Assigns XS_WORKER and XS_STANDBY host roles. The host role XS_WORKER will be assigned to all worker
hosts, the host role XS_STANDBY will be assigned to all standby hosts. To create a multiple-host system with
dedicated xs_worker and xs_standby hosts, assign host roles to each host individually during installation. Do
not choose the option to assign XS Advanced host roles automatically.
Syntax
--action=[install|update] --autoadd_xs_roles[=off]
Remarks
13.10 autostart
Syntax
--action=install --autostart=[0|1]
Note
To avoid the start of the SAP HANA system during the operating system upgrade,
set the autostart parameter in the profile to 0 (=off).
13.11 basepath_streaming
Syntax
Remarks
The default for this parameter is --basepath_streaming=/hana/
data_streaming/<SID>.
13.12 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
--action=[extract_components|install|update] --batch
-b
13.13 certificates_hostmap
Specifies the hostname used for generation of self-signed SSL certificates for the SAP Host Agent.
Requirements
The key-value pair action=install must be specified in combination with
certificates_hostmap.
Syntax
or
--action=install -C <host name>=<certificate host name>
Remarks
The default for this parameter is the current host.
Example
The following example generates certificates for two hosts in the long-form syntax:
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
Syntax
--change_lss_backup_password
Remarks
13.15 change_system_user_password
Syntax
--change_system_user_password
Remarks
13.16 check_installation
Syntax
--action=check_installation
Remarks
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
--action=install --checkmnt=<path>
13.18 check_only
Executes checks, but does not change the SAP HANA system.
Syntax
--action=update --check_only
13.19 client_path
Syntax
Remarks
The default for this parameter is --client_path=<sapmnt>/<SID>/hdbclient.
13.20 component_archives_dir
Syntax
--action=extract_components --
component_archives_dir=<component_archives_path>
Remarks
13.21 component_dirs
Syntax
--action=[install|update] --component_dirs=<component
directory>
Remarks
13.22 component_medium
Syntax
13.23 component_root
Syntax
Remarks
13.24 components
Specifies the components to be installed in combination with the SAP HANA server: SAP HANA client, SAP
HANA studio, and additional system components like Application Function Libraries (AFL, EML and the
product-specific AFLs IBP, RTL, TRP, VCH, XRP), SAP liveCache applications (SAP LCA or LCAPPS plug-in),
SAP HANA EPM-MDS (EPMMDS plug-in), or SAP HANA options. 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|uninstall] --components[=all|afl|
client|es|ets|lcapps|pos|sal|sca|server|smartda|sop|streaming|
studio|udf|xs]
Remarks
The default for this parameter is --components=client,server and is dependent
on the installer finding installation sources for the components.
Caution
Be aware that you need additional licenses for SAP HANA options. For more
information, see Important Disclaimer for Features in SAP HANA Platform, Options
and Capabilities in Related Information.
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.
13.25 configfile
Loads a configuration file of call option key-value pairs to be passed to the SAP HANA lifecycle management
program.
Syntax
--action=[extract_components|install|update] --
configfile=<file path>
Remarks
The configuration file makes installation and configuration tasks more efficient and
reliable. For more information, see Related Information.
Related Information
13.26 configure_python
Syntax
--configure_python=[python2|python3]
Remarks
The parameter is available during installation and update. If you want to change the
Python version without upgrading your SAP HANA revision, specify --ignore=check-
version when starting the update. During an upgrade the currently active Python
version is used as the default.
Caution
Before changing the Python version, make sure that all custom and third-party
Python scripts required by your system configuration (e.g. storage managers,
cluster managers) are compatible with the new Python version.
13.27 continue_update
Continues the pending update with the persisted parameters. For more details about update planning and
updating in a two-phase approach, see Related Information.
Syntax
--action=update --continue_update[=off]
Remarks
Related Information
13.28 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
Syntax
--action=install --create_initial_tenant[=off]
Remarks
13.30 custom_cfg
Specifies the path to the directory which contains custom configuration (*.ini) files.
Syntax
Remarks
Customized versions of SAP HANA configuration files for configuring the system as a
whole and individual tenant databases, hosts, and services can be placed inside the
directory. These configuration files will be copied to the following directory before
system start and will override the default settings:
<sapmnt>/<SID>/global/hdb/custom/config
Parameter values passed by the SAP HANA database lifecycle manager (HDBLCM)
take precedence over corresponding values that are specified in customized
configuration files.
Related Information
Syntax
--databackuppath=<path>
Remarks
The path must be specified if the new directory is located on a different physical
storage. The contents of the directory must be moved manually to the new location.
13.32 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>.
The path must be specified if the new directory is located on a different physical
storage. The contents of the directory must be moved manually to the new location.
13.33 db_isolation
Specifies the isolation of the tenant databases on operating system level for SAP HANA systems. By default, all
database processes run under the default OS user <sid>adm. If it's important to mitigate against cross-
database attacks through OS mechanisms, you can configure the system for high isolation. In this way, the
processes of individual tenant databases must run under dedicated OS users belonging to dedicated OS
groups. Database-specific data on the file system is subsequently protected using standard OS file and
directory permissions.
Syntax
--action=install --db_isolation=high|low
Remarks
In high isolation mode, /hana/shared/<SID> must not be mounted with the option
nosuid.
For more information about database isolation, see Database Isolation in the SAP HANA
Administration Guide or the SAP HANA Security Guide.
Related Information
13.34 dump_configfile_template
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
--action=[extract_components|install|update] --
dump_configfile_template=<file path>
Remarks
The configuration file makes installation and configuration tasks more efficient and
reliable. For more information, see Related Information.
13.35 es_datapath
Specifies the path to the directory of the SAP HANA dynamic tiering data. Required for installation of SAP
HANA dynamic tiering.
Syntax
Remarks
The default for this parameter is --es_datapath=/hana/data_es/<SID>.
Caution
Be aware that you need additional licenses for SAP HANA options. For more
information, see Important Disclaimer for Features in SAP HANA Platform, Options
and Capabilities in Related Information.
Related Information
13.36 es_logpath
Specifies the path to the directory of the SAP HANA data tiering logs. Required for installation or update of SAP
HANA dynamic tiering.
Syntax
Remarks
The default for this parameter is --es_logpath=/hana/log_es/<SID>.
Caution
Be aware that you need additional licenses for SAP HANA options. For more
information, see Important Disclaimer for Features in SAP HANA Platform, Options
and Capabilities in Related Information.
Related Information
Extracts content that was downloaded from the SAP Service Marketplace for installation or update. For more
details about preparing software archives for update, see Related Information.
Syntax
--extract_components
Options
The following options are available:
Remarks
The default for this parameter is --extract_components --
component_archives_dir --
extract_temp_dir=<component_archives_dir>/extracted --
sapcar_location=<install path>/<SID>/global/hdb/
saphostagent_setup/SAPCAR --tar_executable_location=</bin/tar>.
Related Information
13.38 extract_temp_dir
Syntax
--action=extract_components --
extract_temp_dir=<extract_temp_dir>
Remarks
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.
13.40 help
Syntax
--action=[extract_components|install|update] --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.
13.41 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
Remarks
The default for this parameter is --home=/usr/sap/<SID>/home.
13.42 hostmap
Specifies the host mapping to rename one host. The parameter has to be specified for each renamed host.
Syntax
Remarks
13.43 hostname
Syntax
Remarks
13.44 https
Syntax
--https
Remarks
13.45 ignore
Specifies failing prerequisite checks that the SAP HANA platform lifecycle management tools should ignore.
Syntax
--ignore=<check1>[,<check2>]...
Remarks
Check Description
13.46 import_content
Syntax
--import_content[=off]
Remarks
Related Information
13.47 import_xs_content
Syntax
--import_xs_content[=off]
Remarks
13.48 init_user
Uses the properties of an existing system administrator (<sid>adm) if the user ID does not match the user ID
that was used to set up the SAP HANA system.
Syntax
--init_user
13.49 init_user_home_dir
Creates a home directory for the system administrator on each host. This parameter is relevant only if the
home directory of the operating system administrator (<sid>adm) does not exist.
Syntax
--init_user_home_dir
13.50 install_execution_mode
Specifies the install execution workflow. In optimized installation mode, the number of restarts is reduced
during installation.
Syntax
Remarks
The default for this parameter is --install_execution_mode=standard.
13.51 install_hostagent
Syntax
--action=[install|update] --install_hostagent[=off]
Remarks
The default for this parameter is --install_hostagent (on).
13.52 install_ssh_key
Syntax
--action=[install|update] --install_ssh_key[=off]
Remarks
13.53 internal_network
Syntax
--action=install --internal_network=<address>|none
Example
--internal_network=192.168.1.0/24
13.54 isc_mode
Syntax
--action=[install|update] --isc_mode=standard|ssl
Remarks
If SAP HANA XS Advanced Runtime is installed, SSL is used for inter-service
communication by default. SSL can be disabled during the installation of the SAP
HANA XS Advanced Runtime by passing the parameter --isc_mode=standard to the
SAP HANA database lifecycle manager.
13.55 keep_user
Keeps the system administrator user (<sid>adm) from the source system to be used in the target system.
Syntax
--keep_user[=on]
-k[=on]
Remarks
13.56 keep_user_home_dir
Prevents the home directory of the source system administrator user (<sid>adm) from being removed.
Syntax
--keep_user_home_dir[=on]
Remarks
13.57 listen_interface
Syntax
--listen_interface=[local|global|internal]
Options
The following options are available:
global - Binds the processes to all interfaces. This option does not require an internal
network address entry.
internal - Binds the processes to this address only and to all local host interfaces.
This option requires an internal network address entry.
local - Opens the communication ports for internal usage on the local interfaces. This
configuration is only an option for single installations as the server is not reachable
from outside. This option does not require an internal network address entry.
Remarks
If you define a value other than local, the local interfaces will always be open.
When using listen_interface in batch mode, the global option must be specified
in combination with --internal_network=none to disable internal network binding.
13.58 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
--action=[extract_components|install] --list_systems
-L
13.59 load_initial_xs_content
Imports SAP HANA XS advanced runtime content if --import_xs_content=off was selected during installation
of the system.
Syntax
--load_initial_xs_content[=off]
Remarks
13.60 logbackuppath
Syntax
--logbackuppath=<path>
Remarks
The path must be specified if the new directory is located on a different physical
storage. The contents of the directory must be moved manually to the new location.
13.61 logpath
Specifies the path to the log directory of the SAP HANA system.
Syntax
The path must be specified if the new directory is located on a different physical
storage. The contents of the directory must be moved manually to the new location.
13.62 lss_groupid
Syntax
--action=install --lss_groupid=<lssgroupid>
Remarks
13.63 lss_inst_path
Syntax
--action=install --lss_inst_path=<lssinst_path>
Remarks
13.64 lss_trust_unsigned_server
Instructs the Local Secure Store (LSS) to trust an unsigned SAP HANA database.
Syntax
--lss_trust_unsigned_server
Remarks
During the installation or update of the local secure store (LSS), the installation will fail
if the system usage is set to production, test, or custom, and the SAP HANA server
is installed without a signature (SIGNATURE.SMF). Specify the
lss_trust_unsigned_server parameter to make local secure store trust the
unsigned server binaries.
Caution
Related Information
13.65 lss_user_home
Specifies the user home directory for the local secure store.
Syntax
--action=install --lss_user_home=<lssuser_home_dir>
Remarks
13.66 lss_user_shell
Specifies the user login shell for the local secure store.
Syntax
--action=install --lss_user_shell=<lssuser_shell>
13.67 lss_userid
Syntax
--action=install --lss_userid=<lssuserid>
Remarks
13.68 max_mem
Requirements
This parameter must be used in combination with restrict_max_mem. For more
information, see Related Information.
Syntax
--action=install --max_mem=<MB>
Remarks
Related Information
Syntax
--nostart
13.70 nostart_tenant_db
Syntax
--nostart_tenant_db
13.71 number
Requirements
The instance number must be a two-digit number between 00 and 97.
Syntax
-n <instance number>
Remarks
The default value for this parameter is the next successive un-used instance number.
Creates an SAP HANA XS advanced runtime admin user. An admin user can add and manage users, view
users, edit organization roles, view the organization quota, and perform other administrative tasks (default:
XSA_ADMIN).
Syntax
--org_manager_user=<admin user>
Remarks
13.73 org_name
Sets the name of the customer organization. Organizations enable developers to collaborate by sharing
resources, services, and applications. Access to the shared resources, services, and applications is controlled
by the organization manager (default: orgname).
Syntax
--org_name=<org_name>
Remarks
13.74 overwrite_extract_dir
Syntax
--action=extract_components --overwrite_extract_dir
Remarks
Syntax
--action=install --pmempath=<path>
Remarks
Related Information
13.76 pmem_mountpoints
Syntax
--action=install --pmem_mountpoints=<mountpoint>
Remarks
Related Information
13.77 prepare_update
Stops the SAP HANA update before software version switch. The update is resumable. For more details about
update planning and updating in a two-phase approach, see Related Information.
Syntax
--action=update --prepare_update
Related Information
13.78 prod_space_name
Sets the name of the customer space for the SAP HANA XS advanced runtime. In an organization, spaces
enable users to access shared resources that can be used to develop, deploy, and maintain applications
(default: PROD).
Syntax
--prod_space_name=<prod_space_name>
Remarks
13.79 read_password_from_stdin
Requirements
Syntax
--action=[install|update] --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
Related Information
13.80 remote_execution
Specifies the connectivity method for SAP HANA multiple-host system operations.
Syntax
--remote_execution=saphostagent|ssh
Remarks
The default for this parameter is --remote_execution=ssh.
Syntax
removehosts=<hostname1>[,<hostname2>]...
Remarks
13.82 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.
13.83 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
Related Information
13.84 root_user
Syntax
--root_user=<user name>
Remarks
The default for this parameter is --root_user=root.
13.85 sapcar_location
Syntax
--action=extract_components --sapcar_location=<sapcar_location>
13.86 sapmnt
Specifies the path to the SAP mount directory, which can be used as a shared directory between multiple
hosts.
Syntax
--sapmnt=<installation path>
13.87 scope
Performs task on the SAP HANA System (all hosts) or only on the local instance.
Syntax
--action=update --scope=instance|system
Remarks
The default for this parameter is --scope=system.
13.88 secure_store
Specifies whether the SAP HANA database should use the standard SSFS secure store or Local Secure Store
(LSS).
Syntax
--secure_store=localsecurestore|ssfs
Remarks
The default for this parameter is --secure_store=ssfs.
Related Information
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.
13.90 sid
Specifies a system ID. The SAP system ID (SID) is the identifier for the SAP HANA system.
Requirements
Syntax
--action=[install|update] --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.
Syntax
--action=[install|update] --simplified_ui
13.92 skip_hostagent_calls
Syntax
--action=[install|update] --skip_hostagent_calls
13.93 skip_modify_sudoers
Syntax
--action=[install|update] --skip_modify_sudoers
-M
13.94 sld_hostname
Specifies the name of the host where the SLD system is installed.
Syntax
--sld_hostname=<host name>
13.95 sld_password
Syntax
--sld_password=<password>
Remarks
13.96 sld_port
Syntax
--sld_port=<port number>
Remarks
13.97 sld_username
Specifies the user of the SLD system. It must be a user that already exists on the host where the SLD system is
running.
Syntax
--sld_username=<user name>
Remarks
Specifies the source system ID if the <sapmnt>/<SID> is mounted under the new <SID>.
Syntax
--source_sid=<SID>
-s <SID>
Remarks
13.99 sso_cert
Single sign-on (SSO) certificate file to authenticate sapcontrol and SAP Host Agent admin user.
Syntax
--action=update --sso_cert=<ssocertificate>
13.100 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
Remarks
Related Information
13.101 studio_path
Syntax
--studio_path=<installation path>
Remarks
The default for this parameter is --studio_path=<sapmnt>/<SID>/hdbstudio.
13.102 studio_repository
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
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
--action=install --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
13.104 system_user
Syntax
--action=user --system_user=<name>
Remarks
The default for this parameter is --system_user=SYSTEM.
13.105 systemdb_system_user_password
Syntax
--action=update --systemdb_system_user_password
13.106 systemdb_use_singledb_user_password
Use the single-container database user password for the system database user that is created during the
conversion to tenant databases.
Syntax
--action=update --systemdb_use_singledb_user_password
13.107 tar_executable_location
Syntax
--action=extract_components --
tar_executable_location=<tar_executable_location>
13.108 target_sid
Syntax
--target_sid=<new sid>
-S <new sid>
Remarks
Specifies the tenant mapping to rename a tenant. The parameter has to be specified for each renamed tenant.
It can only be used when changing the SID, instance number, or host names of a system.
Syntax
--tenantmap=<old_tenant_name>=<new_tenant_name> [--
tenantmap=<old_tenant_name2>=<new_tenant_name2>]
Example
The following command renames two tenants, tenant1 and tenant2, to tenant3 and
tenant4:
Related Information
Renaming a System
13.110 timeouts
Syntax
--action=[install|update] --
timeouts=<name1>:<sec>[,<name2>:<sec>]...
13.111 unrar_executable_location
Syntax
--action=extract_components --
unrar_executable_location=<unrar_executable_location>
Updates the list of components detected on the system. Updating the component list may be necessary, if your
technical system landscape is not reflected properly inside SAP Solution Manager landscape management
database (LMDB).
Syntax
--action=update_component_list
13.113 update_execution_mode
Specifies the update mode of hdblcm to be either standard or optimized. If the optimized update mode is
selected, the update process will be carried out in a phased approach to minimize system downtime. For more
details about the update process, see Related Information.
Syntax
Remarks
The default for this parameter is --update_execution_mode=standard.
Related Information
13.114 use_master_password
Specifies a single master password for all users, created during installation.
Syntax
Syntax
--action=install --use_pmem
Remarks
If you enable this option, you can specify the mount point of your persistent memory
volumes during installation.
Related Information
Persistent Memory
pmempath [page 254]
pmem_mountpoints [page 254]
SAP Note 2618154 - SAP HANA Persistent Memory (NVM) Release Information
13.116 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.
Syntax
-U <ID number>
Remarks
The default value for this parameter is the next successive un-used user ID number.
13.117 verify_signature
Syntax
--action=[install|update] --verify_signature
Related Information
SAP Note 2577617 - Verifying software authenticity and integrity during SAP HANA installation and update
13.118 version
Syntax
--version
-v
13.119 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.
13.120 volume_encryption
Syntax
--volume_encryption[=off]
Related Information
13.121 workergroup
Specifies the worker group of the host. If undefined, the worker group is named "default". If you are using
extension node for Business Warehouse, you must name the worker group "worker_dt".
Syntax
Remarks
Related Information
13.122 xs_app_working_path
Specifies the XS advanced runtime app working path for runtime data of application instances. For best
performance, specify a local directory, which is then created on all XS_WORKER hosts.
Syntax
--xs_app_working_path=<path>
Remarks
The default for this parameter is --xs_app_working_path=<sapmnt>/<SID>/xs/
app_working
13.123 xs_cert_key
Specifies the path to the key of the certificate to be used by XS advanced (*.key)
Syntax
--xs_cert_key=<path>
13.124 xs_cert_pem
Syntax
--xs_cert_pem=<path>
Syntax
--xs_components=<all>|<comp1>[,<comp2>]...
Remarks
The default for this parameter is --
xs_components=xsac_monitoring,xsac_services.
13.126 xs_components_cfg
Specifies the path to the directory containing MTA extension descriptors (*.mtaext)
Syntax
--xs_components_cfg=<path>
13.127 xs_components_nostart
Syntax
--xs_components_nostart=all|none|comp1[,comp2]...
Remarks
The default for this parameter is --xs_components=none.
Syntax
--xs_customer_space_isolation[=off]
Remarks
13.129 xs_customer_space_user_id
Syntax
--xs_customer_space_user_id=uid
Remarks
13.130 xs_domain_name
Specifies the domain name of an xs_worker host. The domain name has to resolve to the SAP HANA host
which is running the xscontroller and xsuaaserver service.
Syntax
--xs_domain_name=domain_name
Remarks
Alternatively, the domain name can resolve to a host which is not part of the SAP HANA
system. On this host a SAP Web Dispatcher must be installed and configured to act as a
reverse proxy, forwarding the requests to the xs_worker hosts.
SAP Note 2245631 - Enabling hostname routing in SAP HANA extended application services, advanced model
13.131 xs_routing_mode
Syntax
--xs_routing_mode=ports|hostnames
Remarks
The default for this parameter is --xs_routing_mode=ports.
Related Information
SAP Note 2245631 - Enabling hostname routing in SAP HANA extended application services, advanced model
13.132 xs_runtime_db_tenant
Syntax
--xs_runtime_db_tenant=tenant database
Remarks
The default for this parameter is --xs_runtime_db_tenant=SYSTEMDB.
Syntax
--xs_sap_space_isolation[=off]
Remarks
13.134 xs_sap_space_user_id
Syntax
--xs_sap_space_user_id=uid
Remarks
13.135 xs_trust_pem
Syntax
--xs_trust_pem=<path>
13.136 xs_use_default_tenant
Syntax
--xs_use_default_tenant
Remarks
SAP Notes contain important information that can help you to successfully install, update, administer, and
work with an SAP HANA system.
2372809 Guideline for Upgrading a SAP HANA 1.0 to SAP HANA 2.0
System
2714742 SAP Web IDE for SAP HANA 2.0 SPS 04 - Central Release
Note
2009879 SAP HANA Guidelines for Red Hat Enterprise Linux (RHEL)
Check the current SAP Notes for the various parts of SAP HANA by searching for any of the following
application areas:
Data Provisioning
● HAN-DP - Data Provisioning
● HAN-DP-BC - SAP HANA Blockchain Adapter
● HAN-DP-DS - Data Services
● HAN-DP-DXC - SAP HANA Direct Extractor Connector
● HAN-DP-ESS - SAP HANA Enterprise Semantic Services (ESS)
● HAN-DP-LTR - Landscape Transformation Replication Server
● HAN-DP-SDI - SAP HANA smart data integration
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 subcomponents.
Reporting Incidents
If you encounter any problems with the software, report an incident at http://support.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://support.sap.com/contactus ).
When reporting an incident, you can choose from the above list of components for the relevant software part.
For information about the capabilities available for your license and installation scenario, refer to the Feature
Scope Description for SAP HANA.
For information about the capabilities available for your license and installation scenario, refer to the Feature
Scope Description for SAP HANA.
Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:
● Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your
agreements with SAP) to this:
● The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
● SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.
● Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such
links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this
information.
Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax
and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of
example code unless damages have been caused by SAP's gross negligence or willful misconduct.
Gender-Related Language
We try not to use gender-specific word forms and formulations. As appropriate for context and readability, SAP may use masculine word forms to refer to all genders.
SAP and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP
SE (or an SAP affiliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.