PUBLIC
SAP HANA Platform 2.0 SPS 05
Document Version: 1.1 – 2021-09-24
SAP HANA Server Installation and Update Guide
© 2022 SAP SE or an SAP aliate company. All rights reserved.
THE BEST RUN
Content
1 SAP HANA Server Installation and Update Guide....................................9
2 SAP HANA Installation and Update Overview......................................10
2.1 SAP HANA Platform Software Components..........................................10
2.2 Software Download...........................................................11
2.3 Software Authenticity Verication.................................................13
3 Concepts and Requirements for an SAP HANA System...............................15
3.1 SAP HANA Hardware and Software Requirements.....................................15
3.2 Recommended File System Layout................................................18
3.3 SAP HANA System Concepts....................................................21
3.4 SAP HANA System Types...................................................... 22
3.5 SAP HANA Deployment Types...................................................25
3.6 SAP HANA and Virtualization....................................................27
3.7 Local Secure Store (LSS).......................................................28
4 Overview of SAP HANA Tenant Databases........................................30
4.1 Server Architecture of Tenant Databases............................................31
4.2 Scale-Out Architecture of Tenant Databases.........................................33
4.3 The System Database.........................................................35
4.4 Cross-Database Access........................................................36
4.5 Database Isolation........................................................... 37
4.6 Administration of Tenant Databases...............................................39
5 Using the SAP HANA Platform LCM Tools.........................................41
5.1 Choosing the Correct SAP HANA HDBLCM for Your Task................................42
5.2 Performing LCM Tasks by Program Interface.........................................42
Use the Graphical User Interface to Perform Platform LCM Tasks........................43
Use the Command-Line Interface to Perform Platform LCM Tasks.......................44
Using the Web User Interface.................................................45
5.3 Performing LCM Tasks by Program Interaction Mode...................................50
Use Interactive Mode to Perform Platform LCM Tasks................................50
Use Advanced Interactive Mode to Perform Platform LCM Tasks.........................51
Use Batch Mode to Perform Platform LCM Tasks................................... 53
5.4 Performing LCM Tasks by Parameter Entry Method....................................54
Entering Platform LCM Parameters Interactively....................................55
Use LCM Conguration Files to Enter Parameters...................................55
Entering Platform LCM Parameters as Call Options from the Command Line................57
2
PUBLIC
SAP HANA Server Installation and Update Guide
Content
5.5 Executing Platform LCM Tasks...................................................57
Centralized Execution of Platform LCM Tasks......................................58
Decentralized Execution of Platform LCM Tasks....................................63
5.6 Additional Information About Using the SAP HANA Platform LCM Tools......................64
Logging................................................................ 64
Linux Kernel Parameters.................................................... 65
General Troubleshooting for the SAP HANA Platform LCM Tools........................ 66
Managing SAP HANA System Components.......................................68
Check the Installation Using the Command-Line Interface.............................69
6 Installing an SAP HANA System................................................71
6.1 Getting Started with SAP HANA System Installation....................................71
Mandatory Installation Values.................................................71
Changeable Default Values for Installation........................................ 72
Users Created During Installation.............................................. 75
Specifying Passwords...................................................... 76
6.2 Installing a Single-Host System.................................................. 78
Install a Single-Host SAP HANA System Using the Graphical User Interface.................78
Install a Single-Host SAP HANA System Using the Command-Line Interface................81
6.3 Installing a Multiple-Host System.................................................83
Multiple-Host System Concepts...............................................84
Install a Multiple-Host SAP HANA System Using the Graphical User Interface...............88
Install a Multiple-Host SAP HANA System Using the Command-Line Interface...............92
6.4 Installing an SAP HANA System Including the XS Advanced Runtime........................96
System Concepts for XS Advanced Runtime Installations............................. 98
XS Advanced Database Setup Options..........................................102
Install an SAP HANA System Including XS Advanced Runtime Using the Graphical Interface
......................................................................111
Install an SAP HANA System Including XS Advanced Runtime Using the Command-Line
Interface............................................................... 117
Setting Up the XS Advanced Runtime Behind a Reverse Proxy......................... 122
6.5 System Properties...........................................................130
7 Updating the SAP HANA System...............................................133
7.1 Before Updating............................................................134
Congure the Connection to SAP Service Marketplace...............................135
Download Components from SAP Service Marketplace Using the SAP HANA Studio..........136
Download Components from SAP Support Portal Using the Web User Interface.............137
Prepare the Software Archive for the Update......................................139
Prepare for Update Manually.................................................140
Prepare an Update for Flexible System Downtime..................................142
Create a Lesser-Privileged Database User for Update................................144
SAP HANA Server Installation and Update Guide
Content
PUBLIC 3
Updating a Single-Container System...........................................145
7.2 Updating................................................................. 152
Update an SAP HANA System Using the Graphical User Interface.......................154
Update an SAP HANA System Using the Command-Line Interface......................156
Update an SAP HANA System Using the Web User Interface...........................158
Changeable Default Values for Update.......................................... 161
Update SAP HANA Systems Running in a System Replication Setup.....................163
Use SAP HANA System Replication for Near Zero Downtime Upgrades...................164
8 Managing SAP HANA System Components.......................................168
8.1 Installing or Updating SAP HANA Components...................................... 169
Install or Update SAP HANA Components Using the Graphical User Interface.............. 170
Install or Update SAP HANA Components Using the Command-Line Interface..............172
Install or Update SAP HANA Components Using the Resident Program...................174
Install or Update SAP HANA Components Using the Web User Interface.................. 177
Upload and Extract SAP HANA Components Using the Web User Interface................180
Update XS Advanced Components............................................ 182
Activate the Local Secure Store (LSS).......................................... 185
8.2 Uninstalling SAP HANA Components............................................. 186
Uninstall SAP HANA Components Using the Graphical User Interface....................186
Uninstall SAP HANA Components Using the Command-Line Interface................... 188
Uninstall an SAP HANA Component on a System Missing the SAP HANA Resident Program
..................................................................... 189
Uninstall SAP HANA Components Using the Web User Interface........................191
9 Uninstalling the SAP HANA System............................................ 193
9.1 Uninstall the SAP HANA System Using the Graphical User Interface........................193
9.2 Uninstall the SAP HANA System Using the Command-Line Interface.......................194
10 Managing the SAP HANA System After Installation................................ 196
10.1 Start and Stop the SAP HANA System.............................................197
10.2 Display the Process List.......................................................198
11 Tutorials.................................................................200
11.1 Tutorial: Automating Installation................................................ 200
11.2 Tutorial: Using Custom Conguration Files.........................................206
11.3 Tutorial: Installing a Multiple-Host System Using a Conguration File in Batch Mode............207
11.4 Tutorial: Overwriting Conguration 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
4
PUBLIC
SAP HANA Server Installation and Update Guide
Content
12.3 Enabling the Installer Trace.....................................................216
12.4 Checking the Log Files........................................................216
12.5 Adding hdblcm to an Existing SAP HANA Installation.................................. 217
12.6 Disabling the Optimized Update.................................................217
12.7 Dealing with a Failed Update....................................................217
12.8 Importing Delivery Units Manually................................................218
12.9 Removing a Partially Installed System.............................................218
12.10 Adjusting the System Time.....................................................218
12.11 Skipping the Import of Initial XS Advanced Runtime Content.............................219
12.12 Proxy Server Settings for SAP HANA Installations with XS Advanced Runtime.................219
13 Parameter Reference.......................................................220
13.1 action..................................................................220
13.2 addhosts................................................................220
13.3 add_local_roles......................................................... 222
13.4 add_roles...............................................................223
13.5 apply_system_size_dependent_parameters....................................224
13.6 ase_datapath............................................................ 224
13.7 ase_logpath............................................................. 225
13.8 ase_user................................................................225
13.9 autoadd_xs_roles.........................................................226
13.10 autostart...............................................................226
13.11 basepath_streaming.......................................................227
13.12 batch...................................................................227
13.13 certificates_hostmap.....................................................228
13.14 change_lss_backup_password...............................................229
13.15 change_system_user_password..............................................229
13.16 check_installation.......................................................229
13.17 checkmnt................................................................230
13.18 check_only..............................................................230
13.19 client_path.............................................................230
13.20 component_archives_dir...................................................230
13.21 component_dirs...........................................................231
13.22 component_medium.........................................................231
13.23 component_root...........................................................231
13.24 components..............................................................232
13.25 configfile..............................................................233
13.26 configure_python.........................................................233
13.27 continue_update......................................................... 234
13.28 copy_repository......................................................... 234
SAP HANA Server Installation and Update Guide
Content
PUBLIC 5
13.29 create_initial_tenant.........................................................235
13.30 custom_cfg..............................................................235
13.31 databackuppath.......................................................... 236
13.32 datapath................................................................236
13.33 db_isolation............................................................ 236
13.34 dump_configfile_template.................................................237
13.35 es_datapath............................................................. 237
13.36 es_logpath..............................................................238
13.37 extract_components.......................................................239
13.38 extract_temp_dir........................................................ 239
13.39 groupid.................................................................240
13.40 help....................................................................240
13.41 home....................................................................240
13.42 hostmap................................................................. 241
13.43 hostname................................................................ 241
13.44 https...................................................................242
13.45 ignore..................................................................242
13.46 import_content.......................................................... 243
13.47 import_xs_content........................................................243
13.48 init_user...............................................................244
13.49 init_user_home_dir.......................................................244
13.50 install_execution_mode...................................................244
13.51 install_hostagent........................................................245
13.52 install_ssh_key......................................................... 245
13.53 internal_network.........................................................245
13.54 isc_mode................................................................246
13.55 keep_user...............................................................246
13.56 keep_user_home_dir.......................................................246
13.57 listen_interface.........................................................247
13.58 list_systems............................................................ 247
13.59 load_initial_xs_content..................................................248
13.60 logbackuppath........................................................... 248
13.61 logpath.................................................................248
13.62 lss_groupid............................................................. 249
13.63 lss_inst_path........................................................... 249
13.64 lss_trust_unsigned_server................................................249
13.65 lss_user_home........................................................... 250
13.66 lss_user_shell.......................................................... 250
13.67 lss_userid...............................................................251
6
PUBLIC
SAP HANA Server Installation and Update Guide
Content
13.68 max_mem................................................................. 251
13.69 nostart.................................................................252
13.70 nostart_tenant_db........................................................252
13.71 number..................................................................252
13.72 org_manager_user.........................................................253
13.73 org_name................................................................253
13.74 overwrite_extract_dir....................................................253
13.75 pmempath................................................................254
13.76 pmem_mountpoints.........................................................254
13.77 prepare_update.......................................................... 255
13.78 prod_space_name..........................................................255
13.79 read_password_from_stdin.................................................255
13.80 remote_execution.........................................................256
13.81 removehosts............................................................. 257
13.82 repository.............................................................. 257
13.83 restrict_max_mem.........................................................257
13.84 root_user...............................................................258
13.85 sapcar_location......................................................... 258
13.86 sapmnt..................................................................259
13.87 scope...................................................................259
13.88 secure_store............................................................ 259
13.89 shell...................................................................260
13.90 sid.....................................................................260
13.91 simplified_ui............................................................261
13.92 skip_hostagent_calls.....................................................261
13.93 skip_modify_sudoers......................................................261
13.94 sld_hostname............................................................ 262
13.95 sld_password............................................................ 262
13.96 sld_port................................................................262
13.97 sld_username............................................................ 263
13.98 source_sid..............................................................263
13.99 sso_cert................................................................263
13.100 storage_cfg............................................................. 264
13.101 studio_path.............................................................264
13.102 studio_repository........................................................265
13.103 system_usage............................................................ 265
13.104 system_user.............................................................266
13.105 systemdb_system_user_password............................................266
13.106 systemdb_use_singledb_user_password...................................... 266
SAP HANA Server Installation and Update Guide
Content
PUBLIC 7
13.107 tar_executable_location..................................................266
13.108 target_sid.............................................................. 267
13.109 tenantmap............................................................... 267
13.110 timeouts................................................................268
13.111 unrar_executable_location................................................268
13.112 update_component_list....................................................268
13.113 update_execution_mode....................................................268
13.114 use_master_password......................................................269
13.115 use_pmem................................................................269
13.116 userid..................................................................270
13.117 verify_signature.........................................................270
13.118 version................................................................. 271
13.119 vm......................................................................271
13.120 volume_encryption........................................................271
13.121 workergroup............................................................. 272
13.122 xs_app_working_path......................................................272
13.123 xs_cert_key............................................................. 272
13.124 xs_cert_pem............................................................. 273
13.125 xs_components............................................................273
13.126 xs_components_cfg........................................................273
13.127 xs_components_nostart....................................................273
13.128 xs_customer_space_isolation..............................................274
13.129 xs_customer_space_user_id................................................274
13.130 xs_domain_name...........................................................274
13.131 xs_routing_mode..........................................................275
13.132 xs_runtime_db_tenant.....................................................276
13.133 xs_sap_space_isolation...................................................276
13.134 xs_sap_space_user_id.....................................................276
13.135 xs_trust_pem.............................................................277
13.136 xs_use_default_tenant....................................................277
14 Important SAP Notes.......................................................278
8
PUBLIC
SAP HANA Server Installation and Update Guide
Content
1 SAP HANA Server Installation and Update
Guide
This guide describes how to install and update an SAP HANA system with the SAP HANA lifecycle management
(LCM) tools.
SAP HANA Server Installation and Update Guide
SAP HANA Server Installation and Update Guide
PUBLIC 9
2 SAP HANA Installation and Update
Overview
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 ecient 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
congure the SAP HANA installation to be automated, using command line, the conguration le, and batch
mode.
It is possible to also perform post-installation congurations tasks, such as renaming the system, adding or
removing hosts, and reconguring the system, using the SAP HANA database lifecycle manager. For more
information, see the SAP HANA Administration Guide.
The SAP HANA database lifecycle manager oers 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 oered 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
SAP HANA Administration Guide
SAP HANA Master Guide
2.1 SAP HANA Platform Software Components
SAP HANA platform is composed of several components.
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:
● SAP HANA Database
● SAP HANA Client
10
PUBLIC
SAP HANA Server Installation and Update Guide
SAP HANA Installation and Update Overview
● SAP HANA Studio
● SAP HANA XS advanced runtime
● SAP HANA XS Engine
● SAP HANA Advanced Data Processing
● SAP HANA Spatial
● SAP HANA Graph
● SAP HANA Local Secure Store
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
SAP HANA Hardware and Software Requirements [page 15]
2.2 Software Download
In the SAP Software Downloads, you have access to the installation media and components for SAP HANA.
In the SAP Software Download Center, you nd media required to install a new SAP HANA system or to
upgrade an existing one. Please note that all SAP HANA media on SAP Software Download Center are self-
contained full installation media. This applies to the media available in the section Installations & Upgrades as
well as to the media available in section Support Packages & Patches. The section Installations & Upgrades
only contains media for the very rst revision of a Support Package Stack (SPS). The section Support
Packages & Patches only contains the latest revision of an SPS.
We strongly recommend using the most recent revision of an SPS to avoid running into issues, which are
already known and xed. Therefore, by default, download media for all components of SAP HANA for an
installation or upgrade from the section Support Packages & Patches.
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.
SAP HANA Server Installation and Update Guide
SAP HANA Installation and Update Overview
PUBLIC 11
Installation Media and Components for SAP HANA
Installation Media for an SAP HANA SPS
1. Open the SAP Software Downloads.
2. Go to INSTALLATIONS & UPGRADES, if not already chosen.
3. Open > By Alphabetical Index (A-Z).
4. Choose H.
5. Choose SAP HANA PLATFORM EDITION.
6. Go to DOWNLOADS, if not already opened.
7. Choose SAP HANA PLATFORM EDITION 2.0.
8. Open DOWNLOADS, if not already opened.
9. Choose INSTALLATION.
10. Download the items you need.
Note
The items you have downloaded must be available on the host where the SAP HANA system will be
installed or already is installed.
Support Packages and Patches for SAP HANA
1. Open the SAP Software Downloads.
2. Choose SUPPORT PACKAGES & PATCHES, if not already chosen.
3. Open > By Alphabetical Index (A-Z).
4. Choose H.
5. Choose SAP HANA PLATFORM EDITION.
6. Choose DOWNLOADS, if not already chosen.
7. Choose SAP HANA PLATFORM EDITION 2.0.
8. Choose DOWNLOADS, if not already chosen.
9. Open the required component and download the items you need.
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 certied administrator or ocial SAP HANA hardware
partner.
● If a customer chooses an SAP HANA appliance, then the components of SAP HANA can only be installed
by certied hardware partners on validated hardware running a specic operating system. Any other
system or content developed with systems of this type is not supported by SAP. For more information, see
12
PUBLIC
SAP HANA Server Installation and Update Guide
SAP HANA Installation and Update Overview
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 oer support for software that is the subject of the Developer Agreement.
Related Information
SAP Software Downloads
SAP Developer License Agreement
SAP Development Tools
2.3 Software Authenticity Verication
Before the installation and update of SAP HANA software components, the authenticity and integrity of the
software should be veried.
Installing an SAP HANA System
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 rst
make sure that the components are authentic, before starting the SAP HANA database lifecycle manager
(HDBLCM).
To verify the authenticity of a SAR archive, use the following command:
/usr/sap/hostctrl/exe/SAPCAR -dVf <archive name> /usr/sap/hostctrl/exe/
libsapcrypto.so
To verify the signature the additional components, run hdblcm with the parameter verify_signature. For
more information, see SAP Note 2577617.
Updating an SAP HANA System
An SAP HANA system can be updated using the SAP HANA resident HDBLCM.
SAP HANA Server Installation and Update Guide
SAP HANA Installation and Update Overview
PUBLIC 13
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 veried for authenticity by
default. In case you need to perform an update without verifying the authenticity, run hdblcm with the
parameter verify_signature=off.
Installing or Updating SAP HANA Components
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 verication is
only enabled by default if the SAP HANA database was installed or updated with an authentic signature. The
signature le 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
verify_signature [page 270]
SAP Note 2577617 - Verifying software authenticity and integrity during SAP HANA installation and update
SAP Note 2178665 - Signature validation of archives with SAPCAR
14
PUBLIC
SAP HANA Server Installation and Update Guide
SAP HANA Installation and Update Overview
3 Concepts and Requirements for an SAP
HANA System
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 reconguration.
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 congured 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 congured 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 oers 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. Dening installation and update parameters can be entered
interactively, in a conguration le, or in combination with the call to the program on the command line.
Note
The components of SAP HANA can only be installed by certied hardware partners, or any person holding
the required certication, on validated hardware running an approved operating system.
Related Information
Recent changes in the SAP HANA Technology certication program 2016
Updating a Single-Container System [page 145]
3.1 SAP HANA Hardware and Software Requirements
A number of hardware and software requirements apply to SAP HANA.
Note
You can nd 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.
SAP HANA Server Installation and Update Guide
Concepts and Requirements for an SAP HANA System
PUBLIC 15
Software Requirements
Note
Only software installed by certied hardware partners, or any person holding certication, 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 certied hardware partners, or any person holding
certication. Furthermore, it must be installed on validated hardware running an approved operating
system.
For more information, see the blogs SAP Certied Technology Associate: C_HANATEC_13 – by the SAP
HANA Academy and Recent changes in the SAP HANA Technology certication 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 .
Supported Hardware Platforms
SAP HANA is available for:
● Intel-based hardware platforms
● IBM Power Systems
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.
The following features are supported on Intel-based hardware platforms only:
● SAP HANA Accelerator for SAP ASE
For detailed information about the supported hardware, see Related Information in On-Premise in the SAP
HANA Master Guide.
16
PUBLIC
SAP HANA Server Installation and Update Guide
Concepts and Requirements for an SAP HANA System
Supported Operating Systems for SAP HANA
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.
Network Time Protocol (NTP)
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 les from distributed hosts cannot be
displayed in the correct chronological order.
Hardware Requirements for SAP HANA Network Connection
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
SUSE Linux Enterprise Server (SLES)
SAP Note 1944799 - SAP HANA Guidelines for SLES Operating System
SAP Note 2205917 - SAP HANA DB: Recommended OS settings for SLES 12 and SLES for SAP Applications 12
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 - Certied Appliances
SAP HANA Server Installation and Update Guide
Concepts and Requirements for an SAP HANA System
PUBLIC 17
On-Premise Deployment
SAP Note 2493172 - SAP HANA Hardware and Cloud Measurement Tools
SAP Note 2055470 - HANA on POWER Planning and Installation Specics - Central Note
SAP Note 2218464 - Supported products when running SAP HANA on IBM Power Systems
SAP Note 2188482 - SAP HANA on IBM Power Systems: Allowed Hardware
General Links
SAP HANA Tailored Data Center Integration (TDI) Overview
SAP Certied Technology Associate: C_HANATEC_13 – by the SAP HANA Academy
Recent changes in the SAP HANA Technology certication program 2016
SAP Note 52505 - Support after end of mainstream, extended maintenance
SAP Note 2235581 - SAP HANA: Supported Operating Systems
Product Availability Matrix
SAP HANA Network Requirements
SAP Note 1900823 - SAP HANA Storage Requirements and SAP HANA Storage Connector API
SAP Note 2618154 - SAP HANA Persistent Memory (NVM) Release Information
3.2 Recommended File System Layout
The SAP HANA database lifecycle manager (HDBLCM) requires certain le systems in order to successfully
install an SAP HANA system.
The le 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 le
systems listed below are available and have the recommended disk space before starting the SAP HANA
database lifecycle manager.
Default File Systems
File System
Default Path Recommendations
Root
/
18 PUBLIC
SAP HANA Server Installation and Update Guide
Concepts and Requirements for an SAP HANA System
File System Default Path Recommendations
Installation path
(sapmnt)
/hana/shared
The mount directory is used for shared les between all hosts in an SAP
HANA system. This directory needs to be accessible to each of the servers
in the SAP HANA cluster.
Subdirectories:
● /hana/shared/<SID> - Contains executable programs (exe),
globally shared data (global), instance proles (profile), and SAP
HANA conguration les.
● /hana/shared/<SID>/hdbclient - The SAP HANA client instal
lation path.
The following paths apply when the SAP HANA studio is installed:
● /hana/shared/<SID>/hdbstudio_update - The studio repo
sitory installation path. The studio repository is used to update the local
SAP HANA studio installation.
● /hana/shared/<SID>/hdbstudio - The SAP HANA studio in
stallation path.
System instance
/usr/sap
This is the path to the local SAP system instance directories.
Subdirectories:
● /usr/sap/hostctrl - The SAP host agent directory.
● /usr/sap/<SID> - Contains symbolic links to system executables
(SYS) and the home directory (home) of the <sid>adm user.
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>.
SAP HANA Server Installation and Update Guide
Concepts and Requirements for an SAP HANA System
PUBLIC 19
It is strongly recommended to use the SAP HANA le system layout shown in the gure below:
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 signicant 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
20
PUBLIC
SAP HANA Server Installation and Update Guide
Concepts and Requirements for an SAP HANA System
available for the production system and no longer shared. For more details, refer to the high availability
information in the SAP HANA Administration Guide.
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.
/hana/shared/<SID> must be mounted with the option suid.
The le systems /hana/data/<SID> and /hana/log/<SID> may use shared le systems like NFS, or block
storage using the
SAP HANA storage connector API with non-shared le 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 congured, and must belong to a shared le system.
For more details, refer to the backup information in the SAP HANA Administration Guide.
Related Information
Multiple-Host System Concepts [page 84]
SAP Note 405827 - Linux: Recommended le systems
SAP Note 1681092 - Multiple SAP HANA systems (SIDs) on the same underlying server(s)
db_isolation [page 236]
Database Isolation [page 37]
3.3 SAP HANA System Concepts
An SAP HANA system is composed of three main components: the host, the system, and the instance.
SAP HANA Server Installation and Update Guide
Concepts and Requirements for an SAP HANA System
PUBLIC 21
Host
A host is the operating environment in which the SAP HANA database runs. The host provides all the resources
and services (CPU, memory, network, and operating system) that the SAP HANA database requires. The
storage for an installation does not have to be on the host. For multiple-host systems, a shared storage or a
storage that is accessible on-demand from all hosts is required.
For more information about 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 identier. 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
SAP Note 611361 - Hostnames of SAP Servers
3.4 SAP HANA System Types
An SAP HANA system can be congured as a single-host or multiple-host system using the SAP HANA
database lifecycle manager.
The SAP HANA system type denitions are as follows:
● Single-host system - One SAP HANA instance on one host.
● Multiple-host (distributed) system - Multiple SAP HANA instances distributed over multiple hosts, with one
instance per host.
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
22
PUBLIC
SAP HANA Server Installation and Update Guide
Concepts and Requirements for an SAP HANA System
to install an SAP HANA single-host system in one of the program interfaces, and with a combination of
parameter specication methods.
The following graphic shows the le system for a single-host installation:
A multiple-host system is a system with more than one host, which can be congured 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 specication 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.
SAP HANA Server Installation and Update Guide
Concepts and Requirements for an SAP HANA System
PUBLIC 23
The following graphic shows the le system for a multiple-host system installed on a shared le system with
three hosts:
The server software is based on a exible architecture that enables a distributed installation. This means that
load can be balanced between dierent hosts. The server software has to be installed in a shared le system.
This le system has to be mounted by all hosts that are part of the system.
Related Information
Installing a Multiple-Host System [page 83]
24
PUBLIC
SAP HANA Server Installation and Update Guide
Concepts and Requirements for an SAP HANA System
3.5 SAP HANA Deployment Types
SAP HANA can be deployed in a number of congurations 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 signicant
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 congured 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.
Multiple Components on One Database (MCOD)
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
SAP HANA Server Installation and Update Guide
Concepts and Requirements for an SAP HANA System
PUBLIC 25
application or scenario is not on the "White List", then it is not supported to run together on the same SAP
HANA database with any other packaged application or scenario. For more information, see SAP Note 1661202
in Related Information.
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.
Multiple Components on One System (MCOS)
MCOS deployments are characterized by multiple SAP HANA systems on one host. This conguration 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 signicant 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 conguring 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
Converting an SAP HANA System to Support Tenant Databases
Database Isolation [page 37]
SAP Note 1661202 - Support for multiple applications on SAP HANA
SAP Note 1681092 - Multiple SAP HANA DBMSs (SIDs) on one SAP HANA system
SAP Note 1788665 - SAP HANA Support for virtualized and partitioned (multi-tenant) environments
SAP Note 2230704 - SAP HANA on IBM Power Systems with multiple - LPARs per physical host
SAP Note 2024433 - Multiple SAP HANA VMs on VMware vSphere in production
add_local_roles [page 222]
add_roles [page 223]
db_isolation [page 236]
26
PUBLIC
SAP HANA Server Installation and Update Guide
Concepts and Requirements for an SAP HANA System
3.6 SAP HANA and Virtualization
SAP HANA is supported on bare-metal and virtualized platforms.
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 Unied Compute Platform for the SAP HANA Platform with logical partitioning (LPAR) in a scale-up or
multi-VM conguration is a pre-congured 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 congurations with modications that are required for running
logical partitions (LPARs) in dedicated mode. For more information, see Hitachi Unied Compute Platform for
the SAP HANA Platform with Logical Partitioning in a Scale-Up Conguration 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.
Red Hat Enterprise Virtualization (RHV)
For information on supported congurations of SAP HANA in a virtualized environment using Red Hat
Enterprise Virtualization (RHV), see Best Practices / Deployment Guide SAP HANA on Red Hat Virtualization
and 2599726 - SAP HANA on Red Hat Virtualization.
SAP HANA Server Installation and Update Guide
Concepts and Requirements for an SAP HANA System
PUBLIC 27
SUSE Linux Enterprise Hypervisor
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 Unied Compute Platform for the SAP HANA Platform with Logical Partitioning in a Scale-Up
Conguration 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
Best Practices / Deployment Guide SAP HANA on Red Hat Virtualization
SAP Note 2599726 - SAP HANA on Red Hat Virtualization
SAP Note 2284516 - SAP HANA virtualized on SUSE Linux Enterprise hypervisors
IBM PowerVM Best Practices
SAP HANA with Virtualization
3.7 Local Secure Store (LSS)
The local secure store (LSS) is a separate, lightweight utility for storing and securely managing encryption
keys, encryption root keys, and other similarly sensitive data, such as security-relevant conguration settings.
It helps protect sensitive server-side data from illegitimate or fraudulent usage.
Note
The local secure store can optionally be used instead of the instance SSFS (secure store in the le system).
After the installation of the local secure store has nished successfully, the local secure store must be
activated before it can be used. For more information, see Activate the Local Secure Store (LSS).
28
PUBLIC
SAP HANA Server Installation and Update Guide
Concepts and Requirements for an SAP HANA System
To activate the local secure store during installation, run hdblcm with the parameter
secure_store=localsecurestore.
As of SAP HANA 2.0 Support Package Stack (SPS) 05, the local secure store is approved for use in production
environments.
Restriction
The local secure store (LSS) is not supported by SAP HANA Dynamic Tiering. For SAP HANA systems
congured with dynamic tiering (with LSS installed and activated), set the Secure Store type for them to
SSFS (secure store in the le system).
For details, see Local Secure Store (LSS) under Security Administration > Data Encryption in the SAP HANA
Dynamic Tiering: Administration Guide 2.0 SP04.
For more information, see the section on the local secure store in the SAP HANA Security Guide.
Related Information
Local Secure Store (LSS)
SAP HANA Security Guide
Managing SAP HANA System Components [page 168]
Activate the Local Secure Store (LSS) [page 185]
SAP HANA Server Installation and Update Guide
Concepts and Requirements for an SAP HANA System
PUBLIC 29
4 Overview of SAP HANA Tenant Databases
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 identied by a single system ID (SID). Databases
are identied 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 specic 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:
● Set of database users
● Database catalog
● Repository
● Persistence
● Backups
● Traces and logs
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.
30
PUBLIC
SAP HANA Server Installation and Update Guide
Overview of SAP HANA Tenant Databases
On-premise Deployment Using SAP HANA Tenant Databases
4.1 Server Architecture of Tenant Databases
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 dierent 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 gure shows a sample system with three databases (system database and three tenant
databases) on a single host.
SAP HANA Server Installation and Update Guide
Overview of SAP HANA Tenant Databases
PUBLIC 31
Single-Host SAP HANA System with Tenant Databases
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 conguration. 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
Server Components of the SAP HANA Database
Connections from Database Clients and Web Clients to SAP HANA
Port Assignment in Tenant Databases
Scale-Out Architecture of Tenant Databases [page 33]
Using SAP Web Dispatcher for Load Balancing with Tenant Databases
32
PUBLIC
SAP HANA Server Installation and Update Guide
Overview of SAP HANA Tenant Databases
4.2 Scale-Out Architecture of Tenant Databases
Tenant databases can be distributed across several hosts in a multiple-host system.
To ensure system availability, an instance of the system database runs on all hosts (worker and standby) in a
single master and multiple workers conguration. 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
congured 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 gure 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 dierent 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.
SAP HANA Server Installation and Update Guide
Overview of SAP HANA Tenant Databases
PUBLIC 33
Multiple-Host System with Tenant Databases
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 oers some performance advantages over scaling out, as memory access is local and
minor overhead associated with inter-node network communication is avoided.
Note the following with regard to scale-out:
● It is possible to distribute tenant databases across several hosts in a scale-out system.
● The primary reason to distribute tenant databases generally is when their size is larger than the capacity of
a single host. However, other reasons for distributing tenant database may exist, for example, a large SAP
Business Warehouse (BW) system requires a scale-out conguration in accordance with its sizing rules.
● If tenant databases are distributed in a scale-out conguration due to sizing requirements, caution is
advised when deploying additional tenant databases on the same host as a distributed tenant database
34
PUBLIC
SAP HANA Server Installation and Update Guide
Overview of SAP HANA Tenant Databases
shard. The rationale is this: Workload in distributed scenarios can be somewhat volatile and less
predictable. Therefore in many cases, it can be advantageous to dedicate maximum resources of the host
to the distributed tenant database shard in order to maintain expected performance.
● In certain cases, more than one distributed tenant database shard may share the same host. In these
cases, in order to dedicate maximum resources for a master node (for performance reasons), it is
advisable to avoid deploying other tenant databases on the master node. For example, the following
deployment should oer performance advantages:
○ Host 1: Master for tenant database 1
○ Host 2: Worker for tenant database 1 and worker for tenant database 2
○ Host 3: Master for tenant database 2
○ Host 4: Standby host for failover
Related Information
Scaling SAP HANA
4.3 The System Database
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 conguration settings), or can target specic tenant databases (for example,
backup of a tenant database). For more information, see Administration of Tenant Databases.
Things to Remember About the System Database
● 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.
SAP HANA Server Installation and Update Guide
Overview of SAP HANA Tenant Databases
PUBLIC 35
● Cross-database access between the system database and a tenant database is not possible. The system
database can show monitoring data from tenant databases (views in the schema SYS_DATABASES) but
can never show actual content from tenant databases.
● The system database cannot be copied or moved to another host.
● SAP HANA options can only run in tenant databases.
● Tenant-specic congurations cannot be set in the system database. Only global settings are allowed.
● Features can only be restricted or disabled at high level for tenant databases.
Related Information
Administration of Tenant Databases [page 39]
Memory and CPU Usage for Tenant Databases
Cross-Database Authorization in Tenant Databases
Restricted Features in Tenant Databases
4.4 Cross-Database Access
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 dierent tenant databases. For more information, see Modeling
Graphical Calculation Views With Tenant Databases in the SAP HANA Modeling Guide (For SAP HANA Studio).
36
PUBLIC
SAP HANA Server Installation and Update Guide
Overview of SAP HANA Tenant Databases
For more information about how to enable and congure cross-database access, see Enable and Congure
Cross-Database Access.
Related Information
Enable and Congure Cross-Database Access
Cross-Database Authorization in Tenant Databases (SAP HANA Security Guide)
Troubleshooting Error Situations Related to Cross-Database Access
Workload Management and Cross-Database Queries
Modeling Graphical Calculation Views With Tenant Databases (SAP HANA Modeling Guide)
Import/Export Catalog Objects with Dependencies for Multi-TenantDB (SAP Community Blog)
4.5 Database Isolation
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 congure 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-specic data on the le system
is then protected using standard OS le and directory permissions.
Note
<sid>adm is the OS user for the system database.
Authenticated Communication
In addition, once high isolation has been congured, internal database communication is secured using the
Transport Layer Security (TLS)/Secure Sockets Layer (SSL) protocol. Certicate-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 congure internal communication so that all data communication within databases is encrypted.
Note
If cross-database access is enabled, communication between congured tenant databases is allowed.
SAP HANA Server Installation and Update Guide
Overview of SAP HANA Tenant Databases
PUBLIC 37
High Database Isolation
Conguration
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 congured, 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 congured, authenticated communication
within databases is enabled without any change required to the default TLS/SSL conguration for internal
communication. However, encryption of data communication may need to be congured explicitly.
Related Information
File and Directory Permissions with High Isolation
Secure Internal Communication
Increase the System Isolation Level
SAP HANA Administration Guide
38
PUBLIC
SAP HANA Server Installation and Update Guide
Overview of SAP HANA Tenant Databases
4.6 Administration of Tenant Databases
In SAP HANA systems there is a distinction between administration tasks performed at system level and those
performed at database level.
System Versus Database Administration
Tenant database systems have two levels of administration.
Some administration tasks are performed in the system database and apply globally to the system and all its
databases. They include for example:
● Starting and stopping the whole system
● Monitoring the system
● Conguring parameters in conguration (*ini) les at system level
● Setting up and conguring tenant databases, for example:
○ Creating and dropping tenant databases
○ Disabling features on tenant databases
○ Conguring system- and database-specic parameters in conguration (*ini) les
○ Scaling out tenant databases by adding services
● Backing up tenant databases
● Recovering tenant databases
Some administration tasks are performed in the tenant database and apply only to that database. They include
for example:
● Monitoring the database
● Provisioning database users
● Creating and deleting schemas, tables, and indexes in the database
● Backing up the database
● Conguring database-specic parameters in conguration (*ini) les
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.
SAP HANA Server Installation and Update Guide
Overview of SAP HANA Tenant Databases
PUBLIC 39
5 Using the SAP HANA Platform LCM Tools
The SAP HANA database lifecycle manager (HDBLCM) is used to perform SAP HANA platform lifecycle
management (LCM) tasks, including installing, updating, and conguring an SAP HANA system. The SAP
HANA database lifecycle manager is designed to accommodate hardware partners and administrators, and so
it oers 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 modied
in a number of ways, for example, in the entry eld of a graphical interface, as a call option with the program
call, or in a conguration le. These options can be mixed and matched depending on the parameters you need
to use and the program interaction mode you choose.
Platform LCM Tools and Program Interaction Modes
Interactive Mode
Advanced Interactive Mode Batch Mode
Graphical User Interface
Command-Line Interface
Web User Interface
The rst 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 conguration
le. 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 conguration le. 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 conguration le. The syntax for the parameters as call
options can be found in the Parameter Reference. The conguration le is generated as a blank template, then
edited, and called as a call option.
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
PUBLIC 41
Related Information
Use Interactive Mode to Perform Platform LCM Tasks [page 50]
Use Advanced Interactive Mode to Perform Platform LCM Tasks [page 51]
Use Batch Mode to Perform Platform LCM Tasks [page 53]
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 conguration 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 conguration 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 conguration tasks performed with the SAP HANA database lifecycle manager will work as
expected because the installation or update tool and the conguration tool are of the same version and have
been tested together. The SAP HANA resident HDBLCM is located at <sapmnt>/<SID>/hdblcm.
5.2 Performing LCM Tasks by Program Interface
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]
42
PUBLIC
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
5.2.1 Use the Graphical User Interface to Perform Platform
LCM Tasks
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
Installation Medium (Intel-Based Hardware Plat
forms)
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64
Installation Medium (IBM Power Systems)
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64
SAP HANA
resident HDBLCM cd <sapmnt>/<SID>/hdblcm
In general, installation and update is carried out from the installation medium.
Conguration 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. Start the SAP HANA platform lifecycle management tool:
./hdblcmgui
3. Enter parameter values in the requested elds. In addition, you can specify parameter key-value pairs as
call options or in the conguration le template.
Note
If parameter key-value pairs are specied as command-line options, they override the corresponding
parameters in the conguration le. Parameters in the conguration le override default settings.
Order of parameter precedence:
Command Line > Conguration File > Default
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]
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
PUBLIC 43
5.2.2 Use the Command-Line Interface to Perform Platform
LCM Tasks
SAP HANA platform lifecycle management tasks can be performed from the command line.
Procedure
1. Change to the directory where the SAP HANA database lifecycle manager is located:
Option
Description
Installation Medium (Intel-Based Hardware Plat
forms)
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64
Installation Medium (IBM Power Systems)
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64
SAP HANA
resident HDBLCM cd <sapmnt>/<SID>/hdblcm
In general, installation and update is carried out from the installation medium.
Conguration 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. Start the SAP HANA platform lifecycle management tool:
./hdblcm
3. Enter parameter values in one of the following ways.
○ 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.
○ Conguration le parameter entry - If you enter parameter key-value pairs in the conguration le
template, and enter the conguration le 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 specied as command-line options, they override the corresponding
parameters in the conguration le. Parameters in the conguration le override default settings.
44
PUBLIC
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
Order of parameter precedence:
Command Line > Conguration File > Default
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]
5.2.3 Using the Web User Interface
SAP HANA platform lifecycle management tasks can be performed using the SAP HANA database lifecycle
manager (HDBLCM) Web user interface.
5.2.3.1 About the 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 conguration, 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) certicate (PSE) in its security directory. For
more information about SSL certicate 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.
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
PUBLIC 45
Note
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 rst 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 nishes. 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
Secure Sockets Layer (SSL) Certicate Handling [page 60]
46
PUBLIC
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
5.2.3.2 Use the Web User Interface to Perform Platform
LCM Tasks
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 fullled before trying to access the SAP HANA database
lifecycle manager from a Web browser.
● The communication port 1129 is open.
Port 1129 is required for the SSL communication with the SAP Host Agent in a standalone browser via
HTTPS.
● The following Web browser requirements are fullled:
○ Microsoft Windows
○ Internet Explorer - Version 9 or higher
If you are running Internet Explorer version 9, make sure that your browser is not running in
compatibility mode with your SAP HANA host. You can check this in your browser by choosing
Tools Compatibility View Settings .
○ Microsoft Edge
○ Mozilla Firefox - Latest version and Extended Support Release
○ Google Chrome - Latest version
○ SUSE Linux - Mozilla Firefox with XULRunner 10.0.4 ESR
○ Mac OS - Safari 5.1 or higher
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.
● You are logged on as the system administrator user <sid>adm.
● The <sid>adm user has read and execute permissions for the directory that contains the installation
medium.
Context
The Web user interface supports only the following SAP HANA platform lifecycle management tasks:
● View system information
● Update system and components
● Install or update additional components
● Congure System Landscape Directory (SLD) registration
● Congure inter-service communication
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
PUBLIC 47
When performing installation and update tasks, various parameters can be set in the Advanced Parameters
Conguration dialog. To access the Advanced Parameters Conguration dialog, click on the gear icon in the
footer bar of the SAP HANA HDBLCM Web user interface.
Procedure
Access the SAP HANA HDBLCM Web user interface.
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.
SAP HANA
cockpit
1.
Enter the URL of the SAP HANA cockpit administration and monitoring console in your browser.
https://<host_FQDN>:<port>
Note
FQDN = fully qualied 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
SAPUI5 Developer Guide
Add an SAP HANA System
48
PUBLIC
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
5.2.3.3 Log O From an SAP HANA System
In the SAP HANA database lifecycle manager (HDBLCM) Web user interface, you can log o 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
● To log o from a system click the Log out button.
All open connections to the system are closed.
Note
Currently, this feature is not available for browsers on mobile devices.
5.2.3.4 Troubleshooting the Web User Interface
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 Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
PUBLIC 49
5.3 Performing LCM Tasks by Program Interaction Mode
SAP HANA platform lifecycle management tasks can be performed in interactive mode, advanced interactive
mode and batch mode.
5.3.1 Use Interactive Mode to Perform Platform LCM Tasks
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. Conguration tasks are
performed using the SAP HANA resident HDBLCM. For more information about the dierent SAP HANA
database lifecycle manager types, see Related Information.
The SAP HANA platform LCM tools oer a wide variety of parameters which can modify the platform LCM task
you are performing. Some parameters can be modied 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
Installation Medium (Intel-Based Hardware Plat
forms)
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64
Installation Medium (IBM Power Systems)
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64
SAP HANA
resident HDBLCM cd <sapmnt>/<SID>/hdblcm
To access the SAP HANA database lifecycle manager Web user interface, see Related Information.
2. Start the SAP HANA platform lifecycle management tool:
50
PUBLIC
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
Option Description
Graphical Interface ./hdblcmgui
Command-line Interface ./hdblcm
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 conguration le. The program runs in interactive mode and requests any missing parameters
values, which must be veried 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]
5.3.2 Use Advanced Interactive Mode to Perform Platform
LCM Tasks
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 conguration le, 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. Conguration tasks are
performed using the SAP HANA resident HDBLCM. For more information about the dierent SAP HANA
database lifecycle manager types, see Related Information.
The SAP HANA platform LCM tools oer a wide variety of parameters which can modify the platform LCM task
you are performing. Some parameters can be modied 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 specied either as a call option with the call to the platform LCM tool, or from
within a conguration le.
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
PUBLIC 51
Procedure
1. Review which parameters are oered in interactive mode.
If the parameter you want to congure is not available in interactive mode, you have two options. You can
either enter the parameter key-value pair as a call option with the call to the platform LCM tool.
Alternatively, you can generate a conguration le template, and edit the parameters value in the
conguration le. Then call the conguration le as a call option with the call to the platform LCM tool.
Using the conguration le 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
Installation Medium (Intel-Based Hardware Plat
forms)
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64
Installation Medium (IBM Power Systems)
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64
SAP HANA
resident HDBLCM cd <sapmnt>/<SID>/hdblcm
3. If you plan to use a conguration le, prepare it with the following steps:
a. Generate the conguration le 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 le path for the template. A conguration le template and a password
le template are created.
./hdblcm --action=<LCM action> --dump_configfile_template=<file path>
b. Edit the conguration le parameters. Save the le.
c. Edit the password le. Save the le.
4. Start the SAP HANA platform lifecycle management tool:
Start the SAP HANA database lifecycle manager in either the graphical user interface or in the command-
line interface, with a call option:
./hdblcmgui --<parameter key>=<parameter value>
or
./hdblcm --<parameter key>=<parameter value>
If you are using a conguration le, you must use the call option --configfile=<file path>.
Related Information
Choosing the Correct SAP HANA HDBLCM for Your Task [page 42]
52
PUBLIC
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
5.3.3 Use Batch Mode to Perform Platform LCM Tasks
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 conguration le.
Prerequisites
● When using batch mode, passwords must either be dened in the conguration le, or passed to the
installer using an XML password le 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. Conguration tasks are
performed using the SAP HANA resident HDBLCM. For more information about the dierent 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
Installation Medium (Intel-Based Hardware Plat
forms)
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64
Installation Medium (IBM Power Systems)
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64
SAP HANA
resident HDBLCM cd <sapmnt>/<SID>/hdblcm
2. Start the SAP HANA platform lifecycle management tool:
./hdblcm --batch <additional parameters>
or
./hdblcm -b <additional parameters>
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
PUBLIC 53
It is mandatory to provide an SAP HANA system ID (SID) and user passwords during installation. In batch
mode, you are restricted to providing these parameter values as call options on the command line (for
passwords, by means of an XML le) or in a conguration le. If you don't provide parameter values for the
other required parameters, you implicitly accept the default values.
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 specied 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.
cat ~/hdb_passwords.xml | ./hdblcm --batch --action=install --
components=client,server --sid=DB1 --number=42 --read_password_from_stdin=xml
If a conguration le is used in combination with batch mode, an identical system can be installed with a
simplied call from the command line. In the following example, passwords are dened in the conguration le,
in addition to the action, components, SAP system ID, and instance number.
./hdblcm --batch --configfile=/var/tmp/H01_configfile
Related Information
Choosing the Correct SAP HANA HDBLCM for Your Task [page 42]
Specifying Passwords [page 76]
Use LCM Conguration Files to Enter Parameters [page 55]
Entering Platform LCM Parameters as Call Options from the Command Line [page 57]
5.4 Performing LCM Tasks by Parameter Entry Method
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 conguration le.
SAP HANA platform lifecycle management parameter values allow you to customize your SAP HANA
installation, update, or conguration. Parameter values can be entered by one or more of the following
methods:
Interactively
(Default)
Using either command line interface, the graphical interface or the Web user interface,
most parameters are requested interactively. Default parameter values are proposed in
brackets and can be changed or conrmed. Parameters that are not requested (or
specied via another method) accept the default value.
54 PUBLIC
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
Command Line
Options
Parameters are given in their accepted syntax as a space delimited list after the program
call (for example, hdblcm or hdblcmgui). The specied parameters replace the defaults.
If any mandatory parameters are excluded, they are requested interactively (unless batch
mode is specied). All parameters can be entered from the command line. For more details
about the accepted parameter syntax, see the inline help output (--help) for the
individual
SAP HANA lifecycle management tool.
Conguration
File
The conguration le is a plain text le, for which a template of parameter key-value pairs
can be generated, edited, and saved to be called in combination with the program call. If
any mandatory parameters are not specied, they are requested interactively (unless
batch mode is used). All parameters can be entered in the conguration le. For more
information about the conguration le, see Related Information.
Note
If parameters are specied in the command line, they override the corresponding parameters in the
conguration le. Parameters in the conguration le override default settings.
Order of parameter precedence:
Command Line > Conguration File > Default
5.4.1 Entering Platform LCM Parameters Interactively
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 congure a parameter not oered in
interactive mode, you must enter it as a call option with the call to the platform LCM program, or use
corresponding conguration le for the platform LCM task.
5.4.2 Use LCM Conguration Files to Enter Parameters
By dening a prepared conguration le during installation, specied parameter values are used by the SAP
HANA platform lifecycle management (LCM) tools to build a customized SAP HANA system.
Context
The conguration le is a plain text le of specied parameters, written in the same syntax as in the command
line (except without the leading two dashes --). A conguration le template can be generated, edited, and
saved to be called with the call to the SAP HANA database lifecycle manager (HDBLCM).
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
PUBLIC 55
The conguration le template provides a brief, commented-out summary of each parameter. Each parameter
is set to its default value.
Procedure
1. Change to the directory where the SAP HANA database lifecycle manager is located:
Option
Description
Installation Medium (Intel-Based Hardware Plat
forms)
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64
Installation Medium (IBM Power Systems)
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64
SAP HANA
resident HDBLCM cd <sapmnt>/<SID>/hdblcm
In general, installation and update is carried out from the installation medium. Conguration 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 conguration le 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 le path for the template. A conguration le template and a password le
template are created.
./hdblcm --action=<LCM action> --dump_configfile_template=<file path>
3. Edit the conguration le parameters. Save the le.
It is recommended that at least the SAP system ID (sid) and the instance number (number) are uniquely
dened. 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 le path parameters have automatic substitution values as part of the default le path, using the sid
(SAP HANA system ID) and sapmnt (installation path) parameters, so that the substituted values create
le paths that are unique and system-specic. For example, the default for the data le 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 le
path of the edited template.
./hdblcm --configfile=<file path>
You can specify the path to a directory in which custom conguration les are saved using the parameter
custom_cfg as a call option.
56
PUBLIC
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
Related Information
congle [page 233]
custom_cfg [page 235]
Choosing the Correct SAP HANA HDBLCM for Your Task [page 42]
5.4.3 Entering Platform LCM Parameters as Call Options
from the Command Line
Call options are available for every SAP HANA platform LCM program.
You can use call options for a number of reasons:
● 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 conguration le, but would like to override a parameter in the conguration le with a new
value.
● You are installing an SAP HANA multiple-host system from the command line.
A call option is entered with the following notation:
./<program call> --<parameter1 key>=<parameter1 value> --<parameter2
key>=<parameter2 value>
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
Parameter Reference [page 220]
5.5 Executing Platform LCM Tasks
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 rst 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 Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
PUBLIC 57
Related Information
Centralized Execution of Platform LCM Tasks [page 58]
Decentralized Execution of Platform LCM Tasks [page 63]
5.5.1 Centralized Execution of Platform LCM Tasks
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 certicate keys and the remote execution
conguration.
5.5.1.1 Using Secure Shell (SSH) to Execute Platform LCM
Tasks
An SAP HANA system must be installed with root user credentials. During installation a secure shell (SSH) key
is congured 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
58
PUBLIC
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
all system hosts to perform platform LCM tasks without root credentials. Once the SAP Host Agent is installed,
it is used to perform any platform LCM tasks executed from the Web user interface or as the system
administrator user <sid>adm.
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]
5.5.1.2 Using SAP Host Agent to Execute Platform LCM
Tasks
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:
● Execution as the system administrator user <sid>adm
● Connectivity to remote hosts via HTTPS (when no SSH or root user credentials are available)
● Execution from the SAP HANA database lifecycle manager Web user interface
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 congure 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 congured on all involved hosts in advance, which includes:
● Install SAP Host Agent
● Congure a Secure Sockets Layer (SSL) certicate for the SAP Host Agent, so that the HTTPS port 1129 is
accessible. If you don’t want to congure HTTPS, it is also possible to use the call option --use_http. It
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
PUBLIC 59
tells the SAP HANA database lifecycle manager to communicate with the SAP Host Agent via HTTP. During
the addition of new hosts to an SAP HANA system (also during the installation of a multiple-host system),
the HTTPS of the SAP Host Agent is automatically congured by the SAP HANA database lifecycle
manager.
Caution
Use the call option --use_http with caution, because passwords are also transferred in plain text via
HTTP.
Related Information
SAP Host Agent
Conguring SSL for SAP Host Agent on UNIX
5.5.1.2.1 Secure Sockets Layer (SSL) Certicate Handling
To enable secure communication with the SAP Host Agent over HTTPS, the SAP Host Agent needs a secure
sockets layer (SSL) certicate in its security directory. This certicate 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 certicate management during system installation,
update, or rename, as well as during the addition of new hosts as follows:
● If there is no certicate 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 certicate owner. The certicate
owner can be changed by using the call option --
certificates_hostmap=<fully_qualified_domain_name>.
● If there is an existing certicate, the following applies:
○ If the certicate host name is not passed to the SAP HANA database lifecycle manager, or if the
certicate host name is the same as the owner of the current certicate, the current certicate is
preserved.
○ If the certicate host name is passed via the call option --certificates_hostmap and it diers from
the owner of the current certicate, a new certicate is generated.
○ During update of an SAP HANA system, if the certicates on all hosts are in place, the call option --
certificates_hostmap is ignored and the current certicates are preserved.
If you want to use your own SSL certicates, see the SAP Host Agent documentation in Related Information.
Related Information
certicates_hostmap [page 228]
60
PUBLIC
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
SAP Note 1907566 - Accessing the Latest SAP Host Agent Documentation
SSL Conguration for the SAP Host Agent
5.5.1.2.2 Starting Platform LCM Tasks as the System
Administrator User <sid>adm
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:
● System update from the installation medium
● Installation or update of additional components from the SAP HANA resident HDBLCM
● Host addition and host removal
● System Landscape Directory (SLD) registration conguration
● Inter-service communication conguration
Make sure that SAP Host Agent is installed and congured (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).
5.5.1.2.3 Add Hosts Using SAP Host Agent
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 le 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>
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
PUBLIC 61
group is the same on all hosts. For information about installing or updating the SAP Host Agent individually,
see Installing SAP Host Agent Manually and Upgrading SAP Host Agent Manually.
● A Secure Sockets Layer (SSL) certicate is congured for the SAP Host Agent, so that the HTTPS port
1129 is accessible and the Personal Security Environment (PSE) for the server is prepared. For more
information about SSL conguration for the SAP Host Agent, see Conguring SSL for SAP Host Agent on
UNIX.
● The SAP HANA system has been installed with the SAP HANA database lifecycle manager (HDBLCM).
● The SAP HANA database server is up and running.
● You are logged on as root user or as the system administrator user <sid>adm.
● The dierence between the system time set on the installation host and the additional host is not greater
than 180 seconds.
● The operating system administrator (<sid>adm) user may exist on the additional host. Make sure that you
have the password of the existing
<sid>adm user, and that the user attributes and group assignments are
correct. The SAP HANA database lifecycle manager (HDBLCM) resident program will not modify the
properties of any existing user or group.
Procedure
1. Change to the SAP HANA resident HDBLCM directory:
cd <sapmnt>/<SID>/hdblcm
By default, <sapmnt> is /hana/shared.
2. Start the SAP HANA database lifecycle manager interactively in the command line:
./hdblcm --remote_execution=saphostagent
3. Select the index for the add_hosts action.
4. Enter the names of the hosts to be added.
5. Enter the SAP Host Agent administrator (sapadm) password.
6. Dene additional system properties.
7. Review the summary, and select y to nalize the conguration.
Results
You have added one or more new hosts to an SAP HANA system. The SAP HANA system you have congured 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 conguration task can also be performed in batch mode and using a conguration le. For more
information about the available conguration methods, see Using the SAP HANA Platform LCM Tools.
62
PUBLIC
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
Related Information
remote_execution [page 256]
Host Addition Concepts
Using the SAP HANA Platform LCM Tools [page 41]
Using SAP Host Agent to Execute Platform LCM Tasks [page 59]
SAP Host Agent Installation
SAP Host Agent Upgrade
SSL Conguration for the SAP Host Agent
5.5.2 Decentralized Execution of Platform LCM Tasks
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 conguration, 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]
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
PUBLIC 63
5.6 Additional Information About Using the SAP HANA
Platform LCM Tools
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 les, Linux kernel parameter settings,
or troubleshooting.
Related Information
Logging [page 64]
Linux Kernel Parameters [page 65]
General Troubleshooting for the SAP HANA Platform LCM Tools [page 66]
5.6.1 Logging
SAP HANA platform lifecycle management processes are logged by the system. The log les are stored in the
following path:
/var/tmp/hdb_<SID>_<action>_<time stamp>
where <action> :: = install | update | addhost | uninstall | and so on.
The following log les are written while performing the action:
● <hdbcommand>.log: can be read using a text editor
● <hdbcommand>.msg: XML format for display in the installation tool with the GUI
● <hostname>_tracediff.tgz: provides a delta analysis of the original trace les, makes a detailed
analysis easier
You can also view diagnostic les 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 nished, even if no LCM action trace is enabled,
HDBLCM writes a trace, which has the function of a preliminary (unformatted) log le. Upon program
completion, this preliminary logle is removed and replaced by the real, formatted log le.
The environment variable HDB_INSTALLER_TRACE_FILE=<file> enables the trace.
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 les are collected to a local
folder to make error analysis more convenient.
64
PUBLIC
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
To collect log les for multiple-host SAP HANA systems, an HDBLCM action ID is passed to each sub-program
(underlying LCM tool) working on a remote host. Each sub-program writes a copy of the log le in to the
following directory: <installation path>/<SID>/HDB<instance number>/<host name>/trace
Related Information
View Diagnostic Files in the SAP HANA Database Explorer
5.6.2 Linux Kernel Parameters
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 dier,
depending on your system conguration.
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 congure the SAP Host Agent, make sure that the /etc/sysctl.conf conguration does not contain any
of these two parameters. Afterwards, congure the SAP Host Agent prole parameters as described in SAP
Note 401162.
Parameter Description Value Location
nofile
Open le descriptors per user
1048576 /etc/security/
limits.conf
fs.file-max
Open le descriptors per host
20000000 /etc/
sysctl.conf
fs.aio-max-nr
Maximum number of asynchronous I/O re
quests
184467440737095
51615 (= 2^64-1
= ULONG_MAX)
/etc/
sysctl.conf
vm.memory_failu
re_early_kill
Method for killing processes when an uncor
rected memory error occurs
1 /etc/
sysctl.conf
kernel.shmmax
Maximum shared memory segment size (the
default minimum value is 1 GB)
1073741824 /etc/
sysctl.conf
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
PUBLIC 65
Parameter Description Value Location
kernel.shmmni
Maximum number of shared memory segments
32768 /etc/
sysctl.conf
kernel.shmall
System-wide limit of total shared memory, in 4k
pages
● RAM >= 35.5 TB:
(shmmax *
shmmni) /
65536
● RAM < 35.5 TB:
(0.9 * <RAM
in bytes>) /
4096
/etc/
sysctl.conf
net.ipv4.ip_loc
al_port_range
Lower limit of ephemeral port range
Note
No changes are applied if the SAP HANA
database lifecycle manager (HDBLCM) de
tects or installs SAP Host Agent version
7.20.162 or greater.
40000 /etc/
sysctl.conf
vm.max_map_coun
t
Maximum number of Virtual Memory Areas
(VMAs) that a process can own
2147483647 /etc/
sysctl.conf
Related Information
SAP Note 2382421 - Optimizing the Network Conguration on HANA- and OS-Level
SAP Note 401162 - Linux: Avoiding TCP IP port conicts and start problems
5.6.3 General Troubleshooting for the SAP HANA Platform
LCM Tools
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 aected underlying tools.
Caution
We only recommend the following underlying tools to be used for troubleshooting purposes.
66
PUBLIC
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
Program Name Description Location
hdbinst Command-line tool for installing the soft
ware
Installation media
hdbsetup Installation tool with a graphical interface
for installing or updating the software
Installation media
hdbuninst Command-line tool for uninstalling the soft
ware and removing a host
Installation media
and
<installation path>/
<SID>/global/hdb/
install/bin
hdbaddhost Command-line tool for adding a host to a
system
<installation path>/
<SID>/global/hdb/
install/bin
hdbupd Command-line tool for updating the soft
ware
Installation media
hdbrename Command-line tool for renaming a system
<installation path>/
<SID>/global/hdb/
install/bin
and
/usr/sap/<SID>/SYS/
global/hdb/
install/bin
hdbreg Command-line tool for registering an SAP
HANA system
<installation path>/
<SID>/global/hdb/
install/bin
and
/usr/sap/<SID>/SYS/
global/hdb/
install/bin
hdbremovehost Command-line tool for removing a host
<installation path>/
<SID>/global/hdb/
install/bin
and
/usr/sap/<SID>/SYS/
global/hdb/
install/bin
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
PUBLIC 67
Program Name Description Location
hdbmodify This command line tool removes and adds
remote hosts.
Furthermore, the listen interface can be
changed ('local', 'global', 'internal').
<installation path>/
<SID>/global/hdb/
install/bin
and
/usr/sap/<SID>/SYS/
global/hdb/
install/bin
hdbupdrep Command-line tool for upgrading a reposi
tory by loading delivery units into the data
base
<installation path>/
<SID>/global/hdb/
install/bin
and
/usr/sap/<SID>/SYS/
global/hdb/
install/bin
5.6.4 Managing SAP HANA System Components
SAP HANA system components can be installed, updated, or uninstalled using the SAP HANA database
lifecycle manager (HDBLCM).
The SAP HANA system is made up of the following components:
● SAP HANA mandatory components
○ SAP HANA server
○ SAP HANA client
● SAP HANA additional components
○ SAP HANA studio
○ Application Function Libraries (AFL and the product-specic AFLs IBP, RTL, TRP, VCH, XRP)
○ SAP liveCache applications (SAP LCA or LCAPPS-Plugin)
○ SAP HANA smart data access (SDA)
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 conguration is a part of SL Toolset 1.0. For more information about conguring SAP
LT replication, see SAP Note 1891393 in Related Information.
68
PUBLIC
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
● SAP HANA options
○ SAP HANA dynamic tiering
○ SAP HANA streaming analytics
○ SAP HANA accelerator for SAP ASE
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
SAP Note 1858920 - Diagnostics Agent installation with SWPM
SAP Note 1891393 - Automated Conguration scripts for HANA Landscape
Important Disclaimer for Features in SAP HANA [page 286]
Important Disclaimer for Features in SAP HANA
5.6.5 Check the Installation Using the Command-Line
Interface
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
● You are logged in as root user.
● Any user has read and execute permissions for the directory that contains the installation medium.
● Depending on the storage solution, set the export options rw,no_root_squash for the installation
directory.
● The operating system administrator (<sid>adm) user and other operating system users may exist prior to
installation. Make sure that you have the passwords of the existing users, and that the user attributes and
group assignments are correct. The SAP HANA database lifecycle manager (HDBLCM) will not modify the
properties of any existing user or group. The <sid>adm user passwords must be identical on all hosts.
● The SAP HANA system has been installed with its server software on a shared le system (export options
rw, no_root_squash).
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
PUBLIC 69
● The SAP HANA system has been installed with the SAP HANA database lifecycle manager (HDBLCM).
Procedure
1. Change to the SAP HANA resident HDBLCM directory:
cd <sapmnt>/<SID>/hdblcm
By default, <sapmnt> is /hana/shared.
2. Start the SAP HANA database lifecycle manager interactively in the command line:
./hdblcm --action=check_installation
3. Enter the required credentials.
4. Review the summary, and select y to nalize the conguration.
Results
The check tool outputs basic information about the conguration of the le system, system settings,
permission settings, and network conguration. The checks are based on the property le stored in the
following path:
<sapmnt>/<SID>/global/hdb/install/support/hdbcheck.xml
Use the generated log les as a reference in the case of troubleshooting. The log le is stored in the following
path:
/var/tmp/hdb_<SID>_hdblcm_check_installation_<time stamp>/hdblcm.log
Related Information
check_installation [page 229]
70
PUBLIC
SAP HANA Server Installation and Update Guide
Using the SAP HANA Platform LCM Tools
6 Installing an SAP HANA System
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 congured using the resident version of the SAP HANA database
lifecycle manager (HDBLCM).
Related Information
Getting Started with SAP HANA System Installation [page 71]
Installing a Single-Host System [page 78]
Installing a Multiple-Host System [page 83]
Installing an SAP HANA System Including the XS Advanced Runtime [page 96]
6.1 Getting Started with SAP HANA System Installation
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 specication - interactively, as command line
options, or with the conguration le. The following information is relevant for either installation mode
(interactive mode or batch mode).
6.1.1 Mandatory Installation Values
The only mandatory parameter without a default value is the SAP system ID (SID, sid), which must be
specied. However, it is also recommended to dene 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 (specied in XML syntax and streamed in, or specied in the conguration le). 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 specied, 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.
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 71
When building a multiple-host system, the action and addhosts parameters are mandatory command-line
specications for the SAP HANA database lifecycle manager.
6.1.2 Changeable Default Values for Installation
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 predened values on the current host. In a multiple-host system, it is
recommended to manually check the mandatory values on each hosts before installation.
Changeable Parameter Defaults
Parameter
System Default Value
Interactive
Mode Availa
bility
autoadd_xs_roles 1
(on)
autostart 0
(o)
certificates_hostmap
<current host>
client_path <sapmnt>/<SID>/hdbclient
components client,server,studio
(dependent on the installer nding installation sources for the com
ponents)
configure_python
python3
(as of SAP HANA 2.0 SPS 05 (Rev. 59.01))
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
hostname
<current host>
72 PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
Parameter System Default Value
Interactive
Mode Availa
bility
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
number
<next successive un-used instance number on the
host>
org_manager_user XSA_ADMIN
org_name
orgname
prod_space_name PROD
remote_execution ssh
repository y
(on)
restrict_max_mem
(o)
root_user root
sapmnt /hana/shared
shell /bin/sh
studio_path <sapmnt>/<SID>/hdbstudio
studio_repository 1
(on)
system_usage custom
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 73
Parameter System Default Value
Interactive
Mode Availa
bility
userid
<next successive un-used user ID on the host>
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
ion
1
(on)
xs_routing_mode
<ports>
xs_sap_space_isolation 1
(on)
Note
To substitute parameters in conguration les 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 specied once, and are then substituted in to the other
parameter values. This ensures that the system has unique le 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 conguration le, and when installing in batch mode.
Related Information
Parameter Reference [page 220]
74
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
6.1.3 Users Created During Installation
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 identier (UID) of the <sid>adm user is dened 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.
sapadm
The SAP Host Agent administrator.
● 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 modied by the
installer. The
sapadm user and password are also not modied.
● 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.
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 75
User Description
SYSTEM
The database superuser.
● 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
Predened Users
Operating System User sidadm
Predened XS Advanced Users
6.1.4 Specifying Passwords
Passwords are a mandatory parameter for installing an SAP HANA system. There are three methods for
conguring 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 specied 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
76
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
passes them to the standard input stream. Parameters specied in the command-line override parameters
specied in the conguration le. Since this method is the most powerful and exible method, it is often the
preferred method for installing multiple SAP HANA systems at one time.
Conguration File
It is possible to specify passwords in the conguration le. A conguration le template is created with all the
parameters set to their default values. The conguration le 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 specied in the conguration le, its
permission settings should limit access to the root user, for security reasons.
Example
The following is an example of the conguration le, with congured 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 conguration le (stored in the root user's home directory) is called from the command line using the
configfile parameter:
./hdblcm --sid=DB1 --configfile=~/configfile1.cfg
Related Information
congle [page 233]
read_password_from_stdin [page 255]
sid [page 260]
Tutorial: Installing a Single-Host System with Passwords Read from XML Standard Input Stream [page 211]
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 77
6.2 Installing a Single-Host System
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 specication 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 le system for a single-host installation:
6.2.1 Install a Single-Host SAP HANA System Using the
Graphical User Interface
A single-host SAP HANA system can be installed using the SAP HANA database lifecycle manager (HDBLCM)
graphical user interface.
Prerequisites
● You are logged in as root user.
● Any user has read and execute permissions for the directory that contains the installation medium.
78
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
● Depending on the storage solution, set the export options rw,no_root_squash for the installation
directory.
● The operating system administrator (<sid>adm) user and other operating system users may exist prior to
installation. Make sure that you have the passwords of the existing users, and that the user attributes and
group assignments are correct. The
SAP HANA database lifecycle manager (HDBLCM) will not modify the
properties of any existing user or group. The <sid>adm user passwords must be identical on all hosts.
● The root user is able to execute graphical applications.
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 conguration le. 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
conrmation in interactive mode. Those parameters must be specied as call options or from a
conguration le. For more information about changeable default values, see Related Information.
Procedure
1. Change to the following directory on the installation medium:
Option
Description
Intel-Based Hardware Platforms cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64
IBM Power Systems
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64
Note
If you downloaded the components to a dierent directory, change to the directory where you
unpacked the archive.
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 79
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 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
A single-host SAP HANA system is installed. A log le is available.
After installing the SAP HANA system, you may want to perform conguration 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
System Properties [page 130]
Using the SAP HANA Platform LCM Tools [page 41]
Changeable Default Values for Installation [page 72]
Managing the SAP HANA System After Installation [page 196]
SAP HANA Platform Lifecycle Management
SAP Note 2243156 - Secure user setup for SAP HANA extended application services, advanced model
Activate the Local Secure Store (LSS) [page 185]
80
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
6.2.2 Install a Single-Host SAP HANA System Using the
Command-Line Interface
A single-host SAP HANA system can be installed using the SAP HANA database lifecycle manager (HDBLCM)
command-line interface.
Prerequisites
● You are logged in as root user.
● Any user has read and execute permissions for the directory that contains the installation medium.
● Depending on the storage solution, set the export options rw,no_root_squash for the installation
directory.
● The operating system administrator (<sid>adm) user and other operating system users may exist prior to
installation. Make sure that you have the passwords of the existing users, and that the user attributes and
group assignments are correct. The SAP HANA database lifecycle manager (HDBLCM) will not modify the
properties of any existing user or group. The <sid>adm user passwords must be identical on all hosts.
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 conguration le. 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
conrmation in interactive mode. Those parameters must be specied as call options or from a
conguration le. For more information about changeable default values, see Related Information.
Procedure
1. Change to the following directory on the installation medium:
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 81
Option Description
Intel-Based Hardware Platforms cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64
IBM Power Systems
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64
Note
If you downloaded the components to a dierent 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
A single-host SAP HANA system is installed. A log le is available.
After installing the SAP HANA system, you may want to perform conguration 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
System Properties [page 130]
Using the SAP HANA Platform LCM Tools [page 41]
Changeable Default Values for Installation [page 72]
Managing the SAP HANA System After Installation [page 196]
SAP HANA Platform Lifecycle Management
SAP Note 2243156 - Secure user setup for SAP HANA extended application services, advanced model
82
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
Activate the Local Secure Store (LSS) [page 185]
6.3 Installing a Multiple-Host System
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 specication methods.
A multiple-host system is a system with more than one host, which can be congured as active worker hosts or
idle standby hosts. The server software is based on a exible architecture that enables a distributed
installation. This means that load can be balanced between dierent hosts. The server software has to be
installed in a shared le system. This le system has to be mounted by all hosts that are part of the system.
The following graphic shows the le system for a multiple-host installation using a shared le 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.
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 83
Related Information
Adding Hosts to an SAP HANA System
6.3.1 Multiple-Host System Concepts
It is important to review multiple-host system concepts like host grouping and storage options before installing
a multiple-host system.
Host Types
When conguring a multiple-host system, the additional hosts must be dened 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.
Auto-Failover for High Availability
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 congured
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 les 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 les (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 aect 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 specied, all hosts belong to one host group called "default". The more standby hosts in one host
group, the more failover security.
84
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
If the standby hosts are each in a dierent host group, the standby host in the same group as the failing worker
host is preferred. Only if no standby host is available in the same host group, the system will try to fail over to a
standby host, which is part of another host group. The advantage of this conguration is that in an SAP HANA
system with mixed machine resources, similar sized machines can be grouped together. If a small worker host
fails, and a small standby in the same group takes over, the processes are moved to a machine with similar
resources, which allows processing to continue as usual with optimal resource allocation.
Worker Host Grouping for Warm Data
If you use SAP Business Warehouse to apply a temperature-based data strategy you can signicantly 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 classied by access frequency as either hot, warm, or cold. Depending on this
classication and data usage, this data is stored in dierent memory areas.
A multi-temperature memory strategy may be required for dierent reasons, for example:
● Storage of historical data
● Clickstream logs for multiple years of Web data and detailed machine logs
● Guidelines for saving company data, such as the need to save all data for at least seven years due to legal
reasons.
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 sucient space for intermediate result sets. These
sizing guidelines can be signicantly 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
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 85
a separate Extension Node. Unlike the standard nodes (master and slave), the extension node is intended
exclusively for data that is not accessed as frequently (warm) as other data (hot).
For more information, see Data Temperature: Extension Node for Business Warehouse in the SAP HANA
Administration Guide and SAP Note 2453736.
Storage and File System Options
In single-host SAP HANA systems, it is possible to use local le 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 sucient. Either the chosen le system type or the
SAN Infrastructure along with a SAP HANA functionality capable of disc fencing must ensure the following:
● The standby host has le access to data and log volumes of the failed host.
● The failed worker host no longer has access to write to les - called fencing.
There are two fundamentally dierent storage congurations 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.
Shared File Systems
A shared storage subsystem, which is accessed using le systems such as NFS or IBM's GPFS, makes it easy to
ensure that the standby host has access to all active host les 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 specic for the le 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 congured as in the diagram below, however mounts may dier among
hardware partners and their congurations. For more information, see the SAP HANA Storage Whitepaper
available in SAP Note 1900823 in Related Information.
86
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
Non-shared Storage
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 oers 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 o the same volumes from the failed host.
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 87
In a non-shared environment, separate storage is used in combination with the storage connector API. For
more information about the storage connector API, see the SAP Fiber Channel Storage Connector Admin Guide
available in SAP Note 1900823 in Related Information.
Related Information
Recommended File System Layout [page 18]
SAP Note 405827 - Linux: Recommended le systems
Setting Up Host Auto-Failover
SAP Note 1900823 - SAP HANA Storage Connector API
Extension Node
SAP Note 2453736 - How-To: Conguring SAP HANA for SAP BW Extension Node in SAP HANA 2.0
More Details – HANA Extension Nodes for BW-on-HANA
workergroup [page 272]
ROUTE_TO Hint
6.3.2 Install a Multiple-Host SAP HANA System Using the
Graphical User Interface
A multiple-host SAP HANA system can be installed using the SAP HANA database lifecycle manager
(HDBLCM) graphical user interface.
Prerequisites
● You are logged in as root user.
● Any user has read and execute permissions for the directory that contains the installation medium.
● Depending on the storage solution, set the export options rw,no_root_squash for the installation
directory.
● The operating system administrator (<sid>adm) user and other operating system users may exist prior to
installation. Make sure that you have the passwords of the existing users, and that the user attributes and
group assignments are correct. The
SAP HANA database lifecycle manager (HDBLCM) will not modify the
properties of any existing user or group. The <sid>adm user passwords must be identical on all hosts.
● The root user is able to execute graphical applications.
● The SAP HANA system must be installed with its server software on a shared le 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/.
88
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
● Depending on the desired storage solution, shared storage devices or separate storage devices with
failover reassignment, dierent congurations apply:
○ In a shared le system, the data les and log les are congured 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 les and log
les.
The suggested locations for the le systems are as follows:
○ /hana/data/<SID>
○ /hana/log/<SID>
● (Optional) Additional storage is congured.
● 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 specied as a parameter during installation using the
parameter root_user.
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 conguration le. 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
conrmation in interactive mode. Those parameters must be specied as call options or from a
conguration le. For more information about changeable default values, see Related Information.
Procedure
1. Change to the following directory on the installation medium:
Option
Description
Intel-Based Hardware Platforms cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 89
Option Description
IBM Power Systems cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64
Note
If you downloaded the components to a dierent 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.
Field Name
Description
Installation Path Species the path to the SAP mount directory, which can be used as a shared
directory between multiple hosts.
Non-standard Shared File System Species a non-standard shared le system, which can be accessed by all
hosts during installation. This parameter is typically used when the SID is in
cluded in the mountpoint.
Host Name Species the host name of the machine.
90 PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
Field Name Description
Role Species 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 congurations 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
Species the host group ID for failover scenarios. If undened, the host group
is named "default".
Worker Group Species the worker group of the host. If undened, 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 Species 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.
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
A multiple-host SAP HANA system is installed. A log le is stored in the following path:
/var/tmp/hdb_<SID>_<action>_<time stamp>
After installing the SAP HANA system, you may want to perform conguration tasks. For more information, see
Managing the SAP HANA System After Installation or the platform lifecycle management section of the SAP
HANA Administration Guide.
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 91
Related Information
System Properties [page 130]
Using the SAP HANA Platform LCM Tools [page 41]
Changeable Default Values for Installation [page 72]
Managing the SAP HANA System After Installation [page 196]
SAP HANA Platform Lifecycle Management
SAP Note 2243156 - Secure user setup for SAP HANA extended application services, advanced model
Local Secure Store (LSS) [page 28]
lss_inst_path [page 249]
Activate the Local Secure Store (LSS) [page 185]
6.3.3 Install a Multiple-Host SAP HANA System Using the
Command-Line Interface
A multiple-host SAP HANA system can be installed using the SAP HANA database lifecycle manager
(HDBLCM) command-line interface.
Prerequisites
● You are logged in as root user.
● Any user has read and execute permissions for the directory that contains the installation medium.
● Depending on the storage solution, set the export options rw,no_root_squash for the installation
directory.
● The operating system administrator (<sid>adm) user and other operating system users may exist prior to
installation. Make sure that you have the passwords of the existing users, and that the user attributes and
group assignments are correct. The SAP HANA database lifecycle manager (HDBLCM) will not modify the
properties of any existing user or group. The <sid>adm user passwords must be identical on all hosts.
● The SAP HANA system must be installed with its server software on a shared le 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, dierent congurations apply:
○ In a shared le system, the data les and log les are congured 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 les and log
les.
92
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
The suggested locations for the le systems are as follows:
○ /hana/data/<SID>
○ /hana/log/<SID>
● (Optional) Additional storage is congured.
● 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 specied as a parameter during installation using the
parameter root_user.
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 conguration le. 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
conrmation in interactive mode. Those parameters must be specied as call options or from a
conguration le. For more information about changeable default values, see Related Information.
Procedure
1. Change to the following directory on the installation medium:
Option
Description
Intel-Based Hardware Platforms cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64
IBM Power Systems
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64
Note
If you downloaded the components to a dierent directory, change to the directory where you
unpacked the archive.
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 93
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.
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:
SAP HANA System Properties
Field Name
Description
Installation Path Species the path to the SAP mount directory, which can be used as a
shared directory between multiple hosts.
Local Host Name Species the host name of the machine.
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:
Field Name
Description
Host Name Species the host name of the machine.
94 PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
Field Name Description
Role Species 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 congurations 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
Species the host group ID for failover scenarios. If undened, the host group
is named "default".
Worker Group Species the worker group of the host. If undened, 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 Species 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.
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 y.
Results
A multiple-host SAP HANA system is installed. A log le is stored in the following path:
/var/tmp/hdb_<SID>_<action>_<time stamp>
After installing the SAP HANA system, you may want to perform conguration tasks. For more information, see
Managing the SAP HANA System After Installation or the platform lifecycle management section of the SAP
HANA Administration Guide.
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 95
Related Information
System Properties [page 130]
Using the SAP HANA Platform LCM Tools [page 41]
Changeable Default Values for Installation [page 72]
checkmnt [page 230]
Managing the SAP HANA System After Installation [page 196]
SAP HANA Platform Lifecycle Management
SAP Note 2243156 - Secure user setup for SAP HANA extended application services, advanced model
Local Secure Store (LSS) [page 28]
lss_inst_path [page 249]
Activate the Local Secure Store (LSS) [page 185]
6.4 Installing an SAP HANA System Including the XS
Advanced Runtime
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 rst 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, congurable 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
96
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
application-specic code that runs in the SAP HANA context . Also, you can use SAP HANA XS to build
dynamic HTML5 UI applications.
For more information about SAP HANA XS advanced, see the SAP HANA Developer Guide (For SAP HANA XS
Advanced Model).
Downloading XS Advanced from SAP Marketplace
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:
Service Marketplace Software Downloads [Downloads] SUPPORT PACKAGES & PATCHES By
Alphabetical Index (A-Z) H SAP HANA PLATFORM EDITION :
● 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
SAP Software Download Center (Logon required)
SAP Note 2542036 - XS Advanced SPS 03 Release Note
SAP Note 2596466 - FAQ: SAP HANA XS Advanced
SAP Note 2347931 - SAP HANA extended application services, advanced model components versioning
SAP HANA Developer Guide for XS Advanced Model
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 97
6.4.1 System Concepts for XS Advanced Runtime
Installations
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 conguring a multiple-host system with XS advanced runtime, the additional hosts must be dened 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.
Automatic Role Assignment
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.
98
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
Multi-Host Setup
A multiple-host system is a system with more than one host, which can be congured as active worker hosts or
idle standby hosts. The server software is based on a exible architecture that enables a distributed
installation. This means that load can be balanced between dierent hosts. The server software has to be
installed in a shared le system. This le 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.
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 99
Multi-Host System with Standby Host
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.
Dedicated XS advanced runtime Host
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 dierent hosts. To create a multiple-host system with a dedicated XS worker host,
hosts must be assigned manually during installation.
Tenant Database 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
specic tenant database.
100
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
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 setup helps to overcome
restrictions of backup and recovery and when moving XS Advanced related data to other SAP HANA systems.
Please note, that when the tenant database containing the XS Advanced platform data is deleted, XS Advanced
services will not continue to work and must be stopped. For more information, see Installing XS Advanced in a
Tenant Database.
Default Domain Conguration
The XS advanced default domain is congured during XS advanced installation and denes 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 conguration le 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 Mode Conguration
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 conguration after installation.
For more information about domains and routing conguration, see 2245631 in Related Information.
Related Information
Installing a Single-Host System [page 78]
Installing a Multiple-Host System [page 83]
Setting Up Host Auto-Failover
Install an SAP HANA System Including XS Advanced Runtime Using the Graphical Interface [page 111]
Install an SAP HANA System Including XS Advanced Runtime Using the Command-Line Interface [page 117]
SAP Note 2245631 - Enabling hostname routing in SAP HANA extended application services, advanced model
Maintaining the SAP HANA XS Advanced Model Run Time
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 101
Installing XS Advanced in a Tenant Database [page 103]
Public Endpoints
6.4.2 XS Advanced Database Setup Options
Congure the location of XS-advanced-related data.
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 nd 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:
XS Advanced Data Types
XS Advanced Data Type
Description
Users SAP HANA users who access the XS advanced platform, for example, with the
following tools:
● The xs command-line-interface (CLI) client
● The XS Advanced Cockpit
● XS advanced business-application users
Platform data Data uploaded to the XS advanced platform, for example: applications, build
packs, application run time environments, application droplets
Metadata, for example, describing the current state of applications
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
conguration choices available.
102
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
Related Information
Installing XS Advanced in the System Database [page 108]
Installing XS Advanced in a Tenant Database [page 103]
SAP Note 2542036 - XS Advanced SPS 03 Release Note
SAP Software Download Center (Logon required)
Installing an SAP HANA System Including the XS Advanced Runtime [page 96]
6.4.2.1 Installing XS Advanced in a Tenant Database
Install XS Advanced in a tenant database.
As of SAP HANA SPS05, XS advanced is installed in the default tenant database by default. During rst-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
hdblcm installation prompt for XS advanced data location
Install XS Advanced in the default tenant database? (y/n) [y]: y
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
Selecting the Target Tenant Database for XS Advanced Data
Enter System Database User Name [SYSTEM]:
Enter System Database User (SYSTEM) Password:
Index | XS Advanced Tenant Database
-----------------------------------
1 | SYSTEMDB
2 | MY_TENANT1
3 | MY_TENANT2
[...]
Select XS Advanced Tenant Database / Enter Index [1]:
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) conguration to a Multiple Database Container (MDC) conguration, where XS advanced
is already installed.
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 103
XS Advanced Installed in a Single Tenant Database
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 dierent XS advanced applications in dierent tenant
databases. For more information, see Maintaining Tenant Databases in XS Advanced in Related Information
below.
104
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
XS Advanced Installed in a Tenant Database with Additional Tenants
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.
Implications for Backup and Recovery
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
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 105
to be stopped during the backup operation, whereas these services and applications would need to be
stopped if XS advanced is installed in the System database, to ensure the consistency of the backup.
● In this tenant-database setup, the restrictions regarding the recovering of the system database described
in the system-database scenario do not apply.
Note
If you congure 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.
Implications for Moving Tenant Databases
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 nd 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.
Displaying the XS Advanced Database Setup
To nd 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
106
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
information indicating if the tenant database contains XS advanced platform data, as illustrated in the
following excerpt of the command output:
Output Code
XSA list-tenants Command Output
...
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.
Selecting the XS Advanced Database After Backup and Recovery
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 nd 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:
XSA select-xsa-runtime-db -n <tenant_database_name>
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:
● All XS advanced services are restarted
● After restarting, the XS advanced services use the XS advanced platform data that was recovered
● XS advanced platform data residing in a dierent database than the one selected in this step is ignored but
not deleted.
Related Information
XS Advanced Database Setup Options [page 102]
Installing XS Advanced in the System Database [page 108]
Maintaining Tenant Databases in XS Advanced
SAP Note 2542036 - XS Advanced SPS 03 Release Note
Backup and Recovery in XS Advanced (SAP HANA Admin Guide)
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 107
6.4.2.2 Installing XS Advanced in the System Database
Install XS advanced in the system database.
The XS advanced installation provides the option to keep XS advanced platform data in the system database,
while custom applications are congured to use a tenant database as storage, as illustrated by the following
diagram:
XS Advanced Data in the System Database (Default)
108
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
After installation, XS advanced allows you to register additional tenant databases in the SAP HANA system, as
illustrated in the following diagram, which enables you to ensure that data belonging to dierent XS advanced
applications can be stored in separate tenant databases:
XS Advanced Applications using Additional Tenant Databases
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 aected
applications is deleted, too, and the corresponding applications need to be re-deployed.
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 109
Location of Platform and Business Users
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.
Implications for Backup and Recovery
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.
Please note the following:
● Complete system backup
In order to backup and recover XS advanced related data, the system database must be backed up as well
in this case. Therefore, a complete system backup must be created.
● System recovery
When recovering XS advanced related data, the complete system backup including the system database
must be restored; it is not recommended to restore only particular individual tenant databases. The reason
for this recommendation is that recovering the system database might have implications on the state of
the entire SAP HANA system, which also aects tenant databases not related to XS advanced. For
example, the system database contains information about SAP HANA topology, etc. Restoring the system
database re-establishes the state of the SAP HANA system as it existed at the time of the backup.
● Data Consistency
In this default setup, XS advanced related data is distributed across several databases, and since no cross-
database snapshot is supported at the moment, each database must be backed up separately. To ensure
the consistency of the data contained in the backup across databases, it is recommend to stop the XS
advanced services during the backup operation.
Implications for Tenant Database Move
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 dierent SAP HANA system is only possible by creating a
complete system copy of the source SAP HANA system.
110
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
Related Information
Maintaining Tenant Databases in XS Advanced
Installing XS Advanced in a Tenant Database [page 103]
XS Advanced Database Setup Options [page 102]
Backup and Recovery in XS Advanced (SAP HANA Admin Guide)
6.4.3 Install an SAP HANA System Including XS Advanced
Runtime Using the Graphical Interface
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.
● You are logged in as root user.
● Any user has read and execute permissions for the directory that contains the installation medium.
● Depending on the storage solution, set the export options rw,no_root_squash for the installation
directory.
● The operating system administrator (<sid>adm) user and other operating system users may exist prior to
installation. Make sure that you have the passwords of the existing users, and that the user attributes and
group assignments are correct. The SAP HANA database lifecycle manager (HDBLCM) will not modify the
properties of any existing user or group. The <sid>adm user passwords must be identical on all hosts.
● The root user is able to execute graphical applications.
● The SAP HANA system must be installed with its server software on a shared le 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, dierent congurations apply:
○ In a shared le system, the data les and log les are congured 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 les and log
les.
The suggested locations for the le systems are as follows:
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 111
○ /hana/data/<SID>
○ /hana/log/<SID>
● (Optional) Additional storage is congured.
● 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 specied as a parameter during installation using the
parameter root_user.
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 conguration le. 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
conrmation in interactive mode. Those parameters must be specied as call options or from a
conguration le. For more information about changeable default values, see Related Information.
Procedure
1. Change to the following directory on the installation medium:
Option
Description
Intel-Based Hardware Platforms cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64
IBM Power Systems
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64
2. Start the SAP HANA database lifecycle manager interactively in the graphical user interface:
./hdblcmgui
112
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
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. 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.
Field Name
Description
Installation Path Species the path to the SAP mount directory, which can be used as a shared
directory between multiple hosts.
Non-standard Shared File System Species a non-standard shared le system, which can be accessed by all
hosts during installation. This parameter is typically used when the SID is in
cluded in the mountpoint.
Host Name Species the host name of the machine.
Note
For XS advanced runtime installations, the fully-qualied host name must
be specied.
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 113
Field Name Description
Role Species 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 congurations 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
Species the host group ID for failover scenarios. If undened, the host group
is named "default".
Worker Group Species the worker group of the host. If undened, 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 Species 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.
7. Specify the SAP HANA system properties.
For a list of all system properties, see System Properties in Related Information.
8. Select the XS Advanced components you would like to install, then select Next .
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.
114 PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
Component Description
SAP File Processing SAP File Processing provides structured information from unstructured les.
The rich set of HTTP APIs enables application programmers to integrate File
Processing features in client applications.
SAP Enterprise Architecture Designer
for SAP HANA
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.
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.
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 115
Results
A SAP HANA system with XS advanced runtime is installed. A log le is available.
Next Steps
After installing the SAP HANA system, you may want to perform conguration 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 congure 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-specic certicates.
These can be either self-signed or issued by the global certicate authority (CA). The certicates 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 certicates 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 certicate with one trusted in your organization.
Related Information
System Properties [page 130]
Using the SAP HANA Platform LCM Tools [page 41]
Changeable Default Values for Installation [page 72]
Managing the SAP HANA System After Installation [page 196]
Maintaining the SAP HANA XS Advanced Model Run Time
SAP Note 2243156 - Secure user setup for SAP HANA extended application services, advanced model
Network and Communication Security with SAP HANA XS Advanced
Installing or Updating SAP HANA Components [page 169]
116
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
6.4.4 Install an SAP HANA System Including XS Advanced
Runtime Using the Command-Line Interface
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.
● You are logged in as root user.
● Any user has read and execute permissions for the directory that contains the installation medium.
● Depending on the storage solution, set the export options rw,no_root_squash for the installation
directory.
● The operating system administrator (<sid>adm) user and other operating system users may exist prior to
installation. Make sure that you have the passwords of the existing users, and that the user attributes and
group assignments are correct. The SAP HANA database lifecycle manager (HDBLCM) will not modify the
properties of any existing user or group. The <sid>adm user passwords must be identical on all hosts.
● The SAP HANA system must be installed with its server software on a shared le 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, dierent congurations apply:
○ In a shared le system, the data les and log les are congured 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 les and log
les.
The suggested locations for the le systems are as follows:
○ /hana/data/<SID>
○ /hana/log/<SID>
● (Optional) Additional storage is congured.
● 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 specied as a parameter during installation using the
parameter root_user.
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 117
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 conguration le. 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
conrmation in interactive mode. Those parameters must be specied as call options or from a
conguration le. For more information about changeable default values, see Related Information.
Procedure
1. Change to the following directory on the installation medium:
Option
Description
Intel-Based Hardware Platforms cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64
IBM Power Systems
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64
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 .
5. Specify the installation path, and the local host name:
118
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
SAP HANA System Properties
Field Name Description
Installation Path Species the path to the SAP mount directory, which can be used as a
shared directory between multiple hosts.
Local Host Name Species the host name of the machine.
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:
Field Name
Description
Host Name Species the host name of the machine.
Note
For XS advanced runtime installations, the fully-qualied host name must
be specied.
Role
Species 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 congurations 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
Species the host group ID for failover scenarios. If undened, the host group
is named "default".
Worker Group Species the worker group of the host. If undened, 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 Species 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.
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 119
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.
7. Specify the SAP HANA system properties.
For a list of all system properties, see System Properties in Related Information.
8. Select the XS Advanced components you would like to install as a comma-separated list, then select
Enter .
Component
Description
xsac_alm_pi_ui 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.
xsac_le_proc SAP File Processing provides structured information from unstructured les.
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) specication. 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.
120 PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
Component Description
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 le is available.
Next Steps
After installing the SAP HANA system, you may want to perform conguration 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 congure 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-specic certicates.
These can be either self-signed or issued by the global certicate authority (CA). The certicates 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 certicates 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.
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 121
Note
In production XSA installations, replace the self-signed certicate with one trusted in your organization.
Related Information
System Properties [page 130]
Using the SAP HANA Platform LCM Tools [page 41]
Changeable Default Values for Installation [page 72]
Managing the SAP HANA System After Installation [page 196]
Maintaining the SAP HANA XS Advanced Model Run Time
SAP Note 2243156 - Secure user setup for SAP HANA extended application services, advanced model
Network and Communication Security with SAP HANA XS Advanced
Installing or Updating SAP HANA Components [page 169]
6.4.5 Setting Up the XS Advanced Runtime Behind a Reverse
Proxy
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.
Default Domain and Routing Modes
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.
122
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
Port-based Routing
If you select port-based routing mode during installation, applications are exposed using the XS advanced
default domain. Dierent applications are distinguished by dierent TCP ports.
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 prexed 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.
Changing the Default Domain
After installation, you can change the default domain with the property default_domain in the
xscontroller.ini conguration le. After changing this property, you must restart the XS advanced
runtime, for example, using the XSA restart command.
Note
Changing the default domain requires some downtime of your applications because all applications are re-
staged during XS Controller startup. Changing the routing mode after installation is not supported.
Request Flows
Basic Landscape (No Reverse Proxy)
In a basic landscape with no reverse proxy in place, requests from the end user’s browser are sent directly to
the Platform Router, or the XS advanced Web Dispatcher, which dispatches the requests to the appropriate
application.
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 123
Basic Request Flow
This means that the XS advanced default domain must be mapped in your DNS to the SAP HANA host on
which the XS advanced 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.
Landscape with Reverse Proxy
If a reverse proxy (for example, a load balancer) is in place between the end user's browser and the XS
advanced Web Dispatcher, the reverse proxy is responsible for routing all requests on all domains registered
with XS advanced to the SAP HANA host on which the XS advanced Web Dispatcher is running. Internal
requests from an application to its back end are also dispatched via the reverse proxy. However, it is possible to
congure internal requests to be routed directly to the XS advanced Web Dispatcher. For more information, see
Routing Internal Requests to Backend Applications.
Note
In a high-availability setup (SAP HANA System Replication or Host Auto-Failover) or in a multi-host system
where several hosts have been assigned the role of xs_worker, the reverse proxy must forward requests to
the currently active host or system. For more information, see the section on high availability in the SAP
HANA Administration Guide.
124
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
Request Flow with Reverse Proxy
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 XS advanced 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 XS
advanced Web Dispatcher.
Related Information
xs_routing_mode [page 275]
xs_domain_name [page 274]
XS CLI: Application Management
The XSA Command Reference
Routing Internal Requests to Backend Applications [page 126]
Host Auto-Failover Setup with XS Advanced Run Time
SAP HANA System Replication Setup for XS Advanced Runtime
SAP Note 2245631 - Domains and routing conguration for SAP HANA extended application services,
advanced model
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 125
6.4.5.1 Routing Internal Requests to Backend Applications
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 certicate 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.
Request Flow with Direct Routing of Internal Requests
You can route internal requests directly to the XS advanced Web Dispatcher using a local DNS proxy or altering
the /etc/hosts le.
126
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
Using a Local DNS Proxy
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. Congure 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 le 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
Establishing Trust with a Reverse Proxy [page 127]
6.4.5.2 Establishing Trust with a Reverse Proxy
How you set up the trust relationship depends on the layer at which routing is performed. This in turn aects
the installation process.
Certicate Setup Without SSL Termination at Reverse Proxy
If the reverse proxy does not terminate SSL (for example, by routing on network layer 4), no 3rd party
components are involved in the certicate 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 certicates for XS advanced domains after installation, use the xs set-certificate and xs
trust-certificate commands. For more information, see SAP Note 2243019.
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 127
Certicate Setup with SSL Termination at Reverse Proxy
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 certicate
already trusted by the reverse proxy in the XS advanced Web Dispatcher (see also SAP Note 2243019).
If the XS controller is running, use the xs client command as follows:
xs set-certificate <domain_name> -k <path_to_key_file> -c
<path_to_certificate_chain_file>
If the XS controller is stopped, log on to your SAP HANA system as <sid>adm and use the XS advanced
service command:
XSA set-certificate --cert <path_to_certificate_file> --key <path_to_key_file>
The change becomes eective when the XS controller is started.
Alternatively, extract the XS advanced Web Dispatcher's public certicate (a self-signed certicate available
right after installation) and install it on the reverse proxy. To nd the certicate le, log on the system as
<sid>adm and save the le: /hana/shared/<SID>/xs/controller/controller_data/ssl-pub/
router/default.root.crt.pem
Establishing Trust Between XS Advanced Applications and the Reverse Proxy
It is recommended to use a publicly signed server certicate for the reverse proxy; with a publicly signed
certicate, it is not necessary to congure anything in XS advanced.
If you are not using a publicly signed server certicate, the following steps are required to ensure that the XS
advanced platform router trusts the public certicate 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:
xs trust-certificate --alias <alias> --cert <path_to_certificate_file>
The <path_to_certificate_file> must point to an X.509 certicate in PEM format.
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 certicate locally:
XSA trust-certificate --alias <alias> --cert <path_to_certificate_file>
Note
Applications need to be re-staged and restarted for these changes to become eective.
128
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
To restage and restart individual XS advanced applications, use the XS CLI, as shown in the following
examples:
xs restage <application name>
xs restart <application name>
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.
Impact on XS Advanced Installation
During installation, requests are made to the XS advanced default domain. Therefore, if the default domain
points to a reverse proxy, certicate 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:
Specify appropriate certicates during installation.
Specify paths to certicate les as non-interactive parameters to HDBLCM. The relevant parameters are:
● xs_cert_pem: The path to the default domain certicate le in PEM format that the reverse proxy trusts.
● xs_cert_key: The path to the default domain certicate key le in PKCS8 format that the reverse proxy
trusts
● xs_trust_pem: The path to an additional trust certicate (to trust the reverse proxy)
Temporarily map the default domain to the XS advanced Web Dispatcher
Alternatively, re-map the default domain to the SAP HANA host that runs the XS advanced Web Dispatcher.
This is either done by modifying the corresponding DNS entry or using the methods described in section on
routing internal requests to backend applications.
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 le, it is sucient to map the following domains
temporarily during installation. After successful installation and certicate 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>
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 129
● product-installer.<xsa-default-domain>
● auditlog-odata.<xsa-default-domain>
● auditlog-ui.<xsa-default-domain>
● xsa-admin.<xsa-default-domain>
● xsa-admin-backend.<xsa-default-domain>
● subdomaintest.<xsa-default-domain>
● uaa-server.<xsa-default-domain>
● api.<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 certicates for domains dened in SAP HANA extended application
services, advanced model
XS CLI: Domains
Routing Internal Requests to Backend Applications [page 126]
6.5 System Properties
SAP HANA system properties and XS advanced runtime properties.
System Properties
SAP HANA System Properties
Property
Description
Local Host Name Species the host name of the machine.
SAP HANA System ID Species a system ID. The SAP system ID (SID) is the identier for the
SAP HANA system.
Instance Number Species the instance number of the SAP HANA system.
Local Host Worker Group Species the worker group of the host. If undened, 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 Species the usage type of the system to be installed. This setting is
stored in the
global.ini le, and can be used to identify the intended
usage of the system.
130 PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
Property Description
Restrict maximum memory allocation? Species whether maximum memory allocation is restricted for a new
system.
Species the maximum memory allocation for a new system in MB.
Restart system after machine reboot? Restarts system after machine reboot.
Location of Data Volumes Species the path to the data directory of the SAP HANA system.
Location of Log Volumes Species the path to the log directory of the SAP HANA system.
Location of Persistent Memory Volume Species the location of persistent memory volumes. This setting is
stored in the
global.ini le.
Edit Certicate Host... Species the hostname used for generation of self-signed SSL certi-
cates for the SAP Host Agent.
System Administrator User ID Species 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) Species 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
Species 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 Species 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.
XS Advanced Runtime Properties
XS Advanced Runtime Properties
Property
Description
Automatically assign XS Advanced Runtime roles
to the hosts with database 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 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).
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
PUBLIC 131
Property Description
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
Separate OS User
Run applications in customer space with a separate OS user
Routing Mode Species the routing mode to be used for XS advanced runtime installa
tions. For more information on routing congurations, 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
Species 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 Species 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
Local Secure Store Properties
Local Secure Store Properties
Property
Description
Installation Path for Local Secure Store Species the installation path for local secure store.
Local Secure Store User ID Species the user ID for the local secure store.
Local Secure Store User Group ID Species the group ID for the local secure store.
Local Secure Store User Home Directory Species the user home directory for the local secure store.
Local Secure Store User Login Shell Species the user login shell for the local secure store.
Related Information
Parameter Reference [page 220]
132
PUBLIC
SAP HANA Server Installation and Update Guide
Installing an SAP HANA System
7 Updating the SAP HANA System
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-specic 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 rst 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
fullled. For more information, see Prerequisites in the SAP HANA Master Guide.
If you need to upgrade the operating system rst, 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
Before Updating [page 134]
Updating [page 152]
Create a Lesser-Privileged Database User for Update [page 144]
autostart [page 226]
Updating an SAP HANA System Landscape
SAP Note 2115815
SAP Note 2422421
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
PUBLIC 133
7.1 Before Updating
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:
● Download from Service Marketplace (SMP)
○ Download the installation medium - This method is only applicable when updating to a new SPS
○ Download individual components
● Use the Check for Updates functionality in the SAP HANA studio
See Related Information, for more information about using the SAP HANA studio to check for available
software component updates and download them from SAP Service Marketplace.
● Use the Maintenance Planner in the SAP Solution Manager
If you have SAP Solution Manager, you can use it to update your SAP HANA system like other SAP systems
in your landscape. In this case, you have to register your SAP HANA system using the System Landscape
Directory (SLD). Once this conguration is performed, the SAP HANA database server regularly updates
the SLD with data about your SAP HANA system. Afterward, SAP Solution Manager can access this data to
calculate updates for this system. You can then use the Maintenance Planner in SAP Solution Manager to
generate an SPS and download the necessary archives to a specied location. For more information about
updating with the Maintenance Planner, see Related Information. You can then provide the SPS location to
the SAP HANA database lifecycle manager during system update.
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
Congure the Connection to SAP Service Marketplace [page 135]
Download Components from SAP Service Marketplace Using the SAP HANA Studio [page 136]
Download Components from SAP Support Portal Using the Web User Interface [page 137]
Prepare the Software Archive for the Update [page 139]
Prepare for Update Manually [page 140]
Prepare an Update for Flexible System Downtime [page 142]
Create a Lesser-Privileged Database User for Update [page 144]
Upload and Extract SAP HANA Components Using the Web User Interface [page 180]
134
PUBLIC
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
Maintenance Planner
7.1.1 Congure the Connection to SAP Service Marketplace
Before downloading software components using the SAP HANA studio, congure the connection to SAP
Service Marketplace (SMP). As of SPS 12, conguring the connection is only required if you want to connect to
and update an SAP HANA system version SPS 11 or lower.
Procedure
1. Start the SAP HANA studio.
2. Select Window Preferences SAP HANA Lifecycle Management Service Marketplace .
3. Select Use SMP conguration.
The Host Name is set to service.sap.com. This is the URL of SMP, where the les that are used for the
update are located. Enter your SMP S-User credentials in User Name/Password.
Note
You can obtain an S-User on SMP at https://service.sap.com under Registration.
4. Select Apply, then OK to complete the conguration.
Note
To reset your entries, choose Restore Defaults.
Next Steps
After conguring 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]
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
PUBLIC 135
7.1.2 Download Components from SAP Service Marketplace
Using the SAP HANA Studio
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 congured 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 rst 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 le 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.
136
PUBLIC
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
3. Review the selected components and choose a download directory.
4. To start the download process, choose Finish.
5. You can run the download process in background by pressing the Run In Background button. To get the
current progress of the download, open the Progress View ( Window Show View Other…
Progress ).
Next Steps
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]
7.1.3 Download Components from SAP Support Portal Using
the Web User Interface
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
● The SAP HANA database server is up and running.
● The SAP HANA system has access to the Internet.
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 fullled before trying to access the SAP HANA database
lifecycle manager from a Web browser.
● The communication port 1129 is open.
Port 1129 is required for the SSL communication with the SAP Host Agent in a standalone browser via
HTTPS.
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
PUBLIC 137
● The following Web browser requirements are fullled:
○ Microsoft Windows
○ Internet Explorer - Version 9 or higher
If you are running Internet Explorer version 9, make sure that your browser is not running in
compatibility mode with your SAP HANA host. You can check this in your browser by choosing
Tools Compatibility View Settings .
○ Microsoft Edge
○ Mozilla Firefox - Latest version and Extended Support Release
○ Google Chrome - Latest version
○ SUSE Linux - Mozilla Firefox with XULRunner 10.0.4 ESR
○ Mac OS - Safari 5.1 or higher
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.
● You are logged on as the system administrator user <sid>adm.
● The <sid>adm user has read and execute permissions for the directory that contains the installation
medium.
Procedure
1. Access the SAP HANA HDBLCM Web user interface.
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.
SAP HANA
cockpit
1.
Enter the URL of the SAP HANA cockpit administration and monitoring console in your browser.
https://<host_FQDN>:<port>
Note
FQDN = fully qualied 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.
2. Select the Download Components tile.
3. Specify the download mode. Then select Next.
You can choose between downloading the software archives to the SAP HANA host or via the Web browser
to your local computer. If you choose to download the archives to your local computer, you will have to copy
them to the host manually.
138
PUBLIC
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
4. Specify the HTTPS proxy properties. Then select Next.
5. Provide the SAP Support Portal credentials, then select Next.
6. Select the components for download. Then select Next.
Note that you can also select and download SAP HANA core components which are not currently, but can
be installed on the system. To display all components available for download, select Show Components
(Only Updates) and then select All.
7. Specify the download properties. Then select Next.
8. Select Download to download the components.
9. Once the downloads have nished, select Close to return to the main screen.
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
Prepare the Software Archive for the Update [page 139]
Upload and Extract SAP HANA Components Using the Web User Interface [page 180]
7.1.4 Prepare the Software Archive for the Update
After downloading the software components from SAP Support Portal, the software archive must be prepared
for the update.
Prerequisites
● You are logged in as root user.
● You have downloaded the software components from SAP Support Portal (SAP Service Marketplace) using
the SAP HANA studio or the SAP HANA database lifecycle manager (HDBLCM) Web user interface.
● You have copied the download directory to the SAP HANA host or in case it is a shared le system, make
sure it is accessible from the SAP HANA host.
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
PUBLIC 139
Procedure
1. Change to the SAP HANA resident HDBLCM directory:
cd <sapmnt>/<SID>/hdblcm
By default, <sapmnt> is /hana/shared.
2. Start the SAP HANA database lifecycle manager interactively in the command line:
./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 nalize the conguration.
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:
./hdblcmgui --component_root=<component root directory>
or
./hdblcm --component_root=<component root directory>
7.1.5 Prepare for Update Manually
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 le to the subfolder (SAP_HANA_DATABASE, SAP_HANA_CLIENT, etc.), before extracting
the next SAR in order to avoid overwriting the
SIGNATURE.SMF le. For more information, see also SAP
Note 2178665 in Related Information.
140
PUBLIC
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
Procedure
1. Create a local directory for the downloaded packages.
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.
Example:/usr/sap/hostctrl/exe/SAPCAR -manifest SIGNATURE.SMF -xvf
IMDB_SERVER<version number>.SAR
5. Unpack the component archives to a 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
SAP Note 2178665 - Signature validation of archives with SAPCAR
SAP Note 2577617 - Verifying software authenticity and integrity during SAP HANA installation and update
SAP Note 2145573 - SAP HANA DB: Installing the Debug Symbol Package for SAP HANA
extract_components [page 239]
Update an SAP HANA System Using the Graphical User Interface [page 154]
Update an SAP HANA System Using the Command-Line Interface [page 156]
Update an SAP HANA System Using the Web User Interface [page 158]
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
PUBLIC 141
7.1.6 Prepare an Update for Flexible System Downtime
You can run an SAP HANA system update in two phases - an update preparation phase and a resume update
phase. You can perform the prepare update phase and the update resume phase using either the SAP HANA
database lifecycle manager graphical user interface, command-line interface or Web 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
● 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 ag 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 modied 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.
The phased update aims to:
● Lower the system downtime
● Reduce the chances of a failed system update due to preliminary steps like archive preparation or
dependency conicts
142
PUBLIC
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
● Before Updating [page 134]
● Prepare an Update for Flexible System Downtime [page 142]
● Update an SAP HANA System Using the Graphical User Interface [page 154]
● Update an SAP HANA System Using the Graphical User Interface [page 154]
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
1. Change to the following directory on the installation medium:
Option
Description
Intel-Based Hardware Platforms cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64
IBM Power Systems
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64
Note
If you downloaded the components to a dierent 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
Graphical user interface ./hdblcmgui --action=update --prepare_update
Command-line interface ./hdblcm --action=update --prepare_update
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, conrm that the following line is listed in the action
summary under Update Parameters:
Stop update before software version switch, resumable: Yes
If you are using the SAP HANA HDBLCM Web user interface, open the Advanced Parameters Conguration
dialog from the footer bar and select Prepare Update Only under General Parameters.
3. Resume the update.
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
PUBLIC 143
During the planned maintenance window, you can resume the prepared update using any of the standard
update procedures. For standard SAP HANA system update procedures, see Related Information.
Related Information
Before Updating [page 134]
Update an SAP HANA System Using the Graphical User Interface [page 154]
Update an SAP HANA System Using the Command-Line Interface [page 156]
Update an SAP HANA System Using the Web User Interface [page 158]
prepare_update [page 255]
SAP Note 2407186 - How-To Guides & Whitepapers For SAP HANA High Availability
7.1.7 Create a Lesser-Privileged Database User for Update
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:
● Granted Roles: CONTENT_ADMIN
● Object Privileges: _SYS_REPO (SELECT)
By calling one of the update LCM tools with the system_user option specied, the previously dened
database user is used in place of SYSTEM to authenticate the conguration 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.
144
PUBLIC
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
2. Create a role in the SAP HANA cockpit with the CONTENT_ADMIN role and the object privilege SELECT on
the catalog object _SYS_REPO.
3. Create a user in the SAP HANA cockpit and grant the new user the role you created in step 2.
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 266]
7.1.8 Updating a Single-Container System
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
specied 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.
Updating a Single-Host, Single-Container system to Support Tenant
Databases
In a single-host, single-container system the database is converted to a system database and a single tenant
database.
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
PUBLIC 145
Updating a Multiple-Host, Single-Container system to Support Tenant
Databases
In a multiple-host, single-container system the database is converted to a system database on the rst master
host and a single tenant database that is spread across the worker hosts.
Related Information
SAP Note 2423367
Converting an SAP HANA System to Support Tenant Databases
Create a Tenant Database
146
PUBLIC
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
7.1.8.1 Conguration
After update, you need to review and if necessary recongure certain settings.
Conguration Area
After Update
Database conguration Parameters, which were changed are stored with the tenant database and be
come database-specic.
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.
Network
Ports and URLs do not change after the update.
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 xed: 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
guration 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
Important Disclaimer for Features in SAP HANA
SAP HANA Server Installation and Update Guide [page 9]
Port Assignment in Tenant Databases
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
PUBLIC 147
7.1.8.2 Security
After update, you need to review and if necessary recongure certain security-related settings.
Conguration Area
After Update
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 rewalled
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.
The system database is accessible via SQL port 3<instance_no>13.
TLS/SSL conguration for external
communication
If TLS/SSL is enabled for both the system database and tenant database, the in-
database certicate collection containing the certicates used for trust validation
is available only in the tenant database. If you want to use the same certicates,
you will need import them into the certicate store of the system database and
add them to a certicate 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 rst.
If the certicates used for trust validation are stored in a PSE in the le system,
both the tenant database and the system database will have access, so no recon
guration is required.
However, you should validate that sharing the certicate 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 congured, 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
User Administration Tools
TLS/SSL Conguration on the SAP HANA Server
Increase the System Isolation Level
Decrease the System Isolation Level
148
PUBLIC
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
7.1.8.3 Backup and Recovery
After update, you need to review and if necessary recongure certain settings related to backup and recovery.
Conguration Area
After Update
System database If you do not change your backup conguration, 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 rst have to recover the system database in opera
tional mode oine 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
SAP HANA SQL Reference Guide for SAP HANA Platform
Recover a Database
7.1.8.4 Landscape
After update, you need to review and if necessary recongure certain landscape-related settings.
Conguration
Area After Update
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)
.
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
PUBLIC 149
Conguration Area After Update
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 specic ten
ant database.
Service addition and removal
Add or remove service statements are executed on the system database for a
specic tenant database.
Related Information
Adding and Removing Hosts
Add or Remove Services in a Tenant Database
7.1.8.5 Perform an Oine Update
You can perform an oine 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 le 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
1. Stop all SAP HANA systems on all sites.
2. Update the primary system using the SAP HANA database lifecycle manager. The migration to a tenant
database system is done automatically.
3. Wait until the update has nished and the system is active again.
4. Create a data backup of the system database.
150
PUBLIC
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
5. Prepare the secondary system for authentication by copying the system PKI SSFS .key and the .dat le
from the primary system to the secondary system. For more information, see SAP Note 2369981 .
The .key and .dat les can be found in the following location:
/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 conguration steps for authentication with HANA System Replication
Conguring SAP HANA System Replication
7.1.8.6 Perform a Near-Zero Downtime Update
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 le 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 nished and all systems are in sync again. The replication will be possible in this
situation although the primary is still a single-container system.
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
PUBLIC 151
3. Perform a takeover to the updated secondary system. Only now the migration to a tenant database system
is nalized for the secondary.
4. Update the primary system using the SAP HANA database lifecycle manager. Set the no_restart option
to prevent a restart of the primary system after the update. The migration to a tenant database system is
done automatically.
5. Prepare the secondary system for authentication by copying the system PKI SSFS .key and the .dat le
from the primary system to the secondary system. For more information, see SAP Note 2369981 .
The .key and .dat les can be found in the following location:
/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
Conguring 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 following components support the optimized update:
● SAP HANA server
● SAP HANA Accelerator for SAP ASE
152
PUBLIC
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
● SAP HANA Dynamic Tiering
● SAP HANA Streaming Analytics
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.
The optimized update aims to:
● Reduce the number of system restarts
● Lower the system downtime
● Reduce the chances of a failed system update due to dependency conicts or errors in preliminary steps,
such as archive preparation
● Ensure consistency of component binaries during system start
Related Information
Before Updating [page 134]
Update an SAP HANA System Using the Graphical User Interface [page 154]
Update an SAP HANA System Using the Command-Line Interface [page 156]
Update an SAP HANA System Using the Web User Interface [page 158]
Changeable Default Values for Update [page 161]
Use SAP HANA System Replication for Near Zero Downtime Upgrades [page 164]
update_execution_mode [page 268]
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
PUBLIC 153
7.2.1 Update an SAP HANA System Using the Graphical User
Interface
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 conguration le. 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
conrmation in interactive mode. Those parameters must be specied as call options or from a
conguration le using the graphical user or command-line interface and advanced interactive mode. For
more information about changeable default values, see Related Information.
Procedure
1. Change to the following directory on the installation medium:
154
PUBLIC
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
Option Description
Intel-Based Hardware Platforms cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64
IBM Power Systems
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64
Note
If you downloaded the components to a dierent directory, change to the directory where you
unpacked the archive.
2. Run the SAP HANA database lifecycle manager:
./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. Dene 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:
SELECT * FROM "PUBLIC"."M_SERVICE_THREADS" WHERE THREAD_TYPE = 'ImportOrUpdate
Content';
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 congured 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
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
PUBLIC 155
Related Information
Using the SAP HANA Platform LCM Tools [page 41]
Changeable Default Values for Update [page 161]
Use Advanced Interactive Mode to Perform Platform LCM Tasks [page 51]
Create a Lesser-Privileged Database User for Update [page 144]
SAP HANA Content
SAP Note 2641466 - Upgrading an SAP HANA Install that Includes Remote Data Sync
7.2.2 Update an SAP HANA System Using the Command-Line
Interface
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 conguration le. For more information about interaction
modes and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.
156
PUBLIC
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
Note
Not all parameters are requested interactively. Some parameters have default values that do not require
conrmation in interactive mode. Those parameters must be specied as call options or from a
conguration le. For more information about changeable default values, see Related Information.
Procedure
1. Change to the following directory on the installation medium:
Option
Description
Intel-Based Hardware Platforms cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64
IBM Power Systems
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64
Note
If you downloaded the components to a dierent 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 specied 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. Dene additional properties, depending on which components are selected.
7. After specifying all system properties, review the summary, and select y.
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
PUBLIC 157
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:
SELECT * FROM "PUBLIC"."M_SERVICE_THREADS" WHERE THREAD_TYPE = 'ImportOrUpdate
Content';
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 congured 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
Using the SAP HANA Platform LCM Tools [page 41]
Changeable Default Values for Update [page 161]
Create a Lesser-Privileged Database User for Update [page 144]
SAP HANA Content
SAP Note 2641466 - Upgrading an SAP HANA Install that Includes Remote Data Sync
7.2.3 Update an SAP HANA System Using the Web User
Interface
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 fullled before trying to access the SAP HANA database
lifecycle manager from a Web browser.
● The communication port 1129 is open.
Port 1129 is required for the SSL communication with the SAP Host Agent in a standalone browser via
HTTPS.
● The following Web browser requirements are fullled:
○ Microsoft Windows
158
PUBLIC
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
○ Internet Explorer - Version 9 or higher
If you are running Internet Explorer version 9, make sure that your browser is not running in
compatibility mode with your SAP HANA host. You can check this in your browser by choosing
Tools Compatibility View Settings .
○ Microsoft Edge
○ Mozilla Firefox - Latest version and Extended Support Release
○ Google Chrome - Latest version
○ SUSE Linux - Mozilla Firefox with XULRunner 10.0.4 ESR
○ Mac OS - Safari 5.1 or higher
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.
● You are logged on as the system administrator user <sid>adm.
● The <sid>adm user has read and execute permissions for the directory that contains the installation
medium.
● 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:
SELECT * FROM "PUBLIC"."M_SERVICE_THREADS" WHERE THREAD_TYPE = 'ImportOrUpdate
Content';
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.
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
PUBLIC 159
Note
Not all parameters are requested interactively. Some parameters have default values that do not require
conrmation in interactive mode. Those parameters must be specied as call options or from a
conguration le. For more information about changeable default values, see Related Information.
Procedure
1. Access the SAP HANA HDBLCM Web user interface.
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.
SAP HANA
cockpit
1.
Enter the URL of the SAP HANA cockpit administration and monitoring console in your browser.
https://<host_FQDN>:<port>
Note
FQDN = fully qualied 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.
2. Select the Update System and Components tile.
3. Enter the le path of the installation medium in the location eld:
Option
Description
Intel-Based Hardware Platforms <installation medium>/DATA_UNITS/
HDB_SERVER_LINUX_X86_64
IBM Power Systems
<installation medium>/DATA_UNITS/
HDB_SERVER_LINUX_PPC64
If you downloaded the components to a dierent directory, enter the le path to the directory where you
unpacked the server archive.
4. Select Proceed with Update.
The SAP HANA database lifecycle manager (HDBLCM) detects all available components for the given le
path.
If you would like to add more than one software location, select Add Software Location.
5. Select the components you would like to update, or install if they are not already available on your system.
160
PUBLIC
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
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. Dene 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:
SELECT * FROM "PUBLIC"."M_SERVICE_THREADS" WHERE THREAD_TYPE = 'ImportOrUpdate
Content';
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 congured 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
SAPUI5 Developer Guide
Add an SAP HANA System
Before Updating [page 134]
Prepare for Update Manually [page 140]
Changeable Default Values for Update [page 161]
Create a Lesser-Privileged Database User for Update [page 144]
SAP HANA Content
SAP Note 2641466 - Upgrading an SAP HANA Install that Includes Remote Data Sync
7.2.4 Changeable Default Values for Update
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 predened values on the current host.
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
PUBLIC 161
Changeable Parameter Defaults
Parameter System Default Value
Interactive
Mode
Availability
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 conguration le 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 specied once, and are then substituted in
to the other parameter values. This ensures that the system has unique le 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 conguration le, and when installing in batch
mode.
Related Information
client_path [page 230]
install_hostagent [page 245]
install_ssh_key [page 245]
remote_execution [page 256]
root_user [page 258]
scope [page 259]
studio_path [page 264]
studio_repository [page 265]
162
PUBLIC
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
system_user [page 266]
7.2.5 Update SAP HANA Systems Running in a System
Replication Setup
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 congured 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 rst 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.
From your installation directory execute as root or as <sid>adm:
./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.
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
PUBLIC 163
3. Verify that system replication is active and that all services are in sync.
You can check that the REPLICATION_STATUS column in M_SERVICE_REPLICATION has the value ACTIVE
for all services.
4. Upgrade the SAP HANA server software and all installed components on the primary system.
From your installation directory, execute as root or as <sid>adm:
./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
7.2.6 Use SAP HANA System Replication for Near Zero
Downtime Upgrades
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 congured a user in the local userstore under the SRTAKEOVER key. For more information, see Congure a
User Under the SRTAKEOVER Key.
System replication is congured and active between two identical SAP HANA systems:
● The primary system is the production system.
● The secondary system will become the production system after the upgrade.
Context
With system replication active, you can rst 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
164
PUBLIC
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
transactions or data are not lost. You can then do an upgrade on the primary system, which is now in the role of
secondary.
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 congured. 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 certicates in the system PKI
SSFS store. You must therefore copy the system PKI SSFS key and the data le from the current primary
system to the new to-be secondary system. Copy the les before registration when the secondary system is
oine; the les 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 conguration 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 specied 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.
From your installation directory execute as root:
./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.
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
PUBLIC 165
3. Depending on the version installed on the primary, perform a takeover by doing one of the following:
○ If the installed system version on the primary is HANA 2.0 SPS 04 or greater then you have the option
to use the --suspendPrimary parameter for a 'takeover with handshake' which ensures that all redo
logs are written to disk. In this case, execute the takeover as <sid>adm with the following command:
hdbnsutil -sr_takeover --suspendPrimary
○ 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:
./hdblcm --action=update --hdbupd_server_nostart
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.
7. Register the original primary as secondary as <sid>adm.
hdbnsutil -sr_register --name=<secondary_alias>
--remoteHost=<primary_host> --remoteInstance=<primary_systemnr>
--replicationMode=[sync|syncmem|async] --operationMode=[delta_datashipping|
logreplay|logreplay_readaccess]
8. Start the original primary.
Related Information
Congure a User Under the SRTAKEOVER Key
Prepare an Update for Flexible System Downtime [page 142]
Updating the SAP HANA System [page 133]
Perform a Near-Zero Downtime Update [page 151]
166
PUBLIC
SAP HANA Server Installation and Update Guide
Updating the SAP HANA System
Use Multitarget System Replication for Near Zero Downtime Upgrades
Deploy a Multi-Target Application with Zero-Downtime Maintenance
Takeover with Handshake
SAP Note 2369981 - Required conguration steps for authentication with HANA System Replication
SAP Note 1984882 - Using HANA System Replication for Hardware Exchange with minimum to zero Downtime
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 Server Installation and Update Guide
Updating the SAP HANA System
PUBLIC 167
8 Managing SAP HANA System
Components
SAP HANA system components can be installed, updated, or uninstalled using the SAP HANA database
lifecycle manager (HDBLCM).
The SAP HANA system is made up of the following components:
● SAP HANA mandatory components
○ SAP HANA server
○ SAP HANA client
● SAP HANA additional components
○ SAP HANA studio
○ Application Function Libraries (AFL, EML and the product-specic AFLs RME, RTL POS, SAL, SCA,
SOP, TRP, VCH)
○ SAP liveCache applications (SAP LCA or LCAPPS-Plugin)
○ SAP HANA EPM-MDS (EPMMDS plug-in)
○ SAP HANA smart data access (SDA)
○ SAP HANA XS Advanced Runtime (For more information about installating XS advanced runtime, see
Installing XS Advanced Runtime in Related Information.)
○ Local Secure Store (LSS)
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 conguration. SAP LT replication conguration is a part of SL
Toolset 1.0. For more information about conguring SAP LT replication, see SAP Note 1891393 in
Related Information.
● SAP HANA options
○ SAP HANA dynamic tiering
○ SAP HANA streaming analytics
○ SAP HANA accelerator for SAP ASE
168
PUBLIC
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
Note
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
SAP Note 1858920 - Diagnostics Agent installation with SWPM
SAP Note 1891393 - Automated Conguration scripts for HANA Landscape
Installing or Updating SAP HANA Components [page 169]
SAP HANA Options in SAP Help Portal
Important Disclaimer for Features in SAP HANA [page 286]
Installing an SAP HANA System Including the XS Advanced Runtime [page 96]
Local Secure Store (LSS) [page 28]
8.1 Installing or Updating SAP HANA Components
SAP HANA components can be installed or updated the following ways:
● From the installation medium, using
○ the graphical user interface,
○ the command-line interface.
● From the resident program, using
○ the graphical user interface,
○ the command-line interface.
● Using the Web user interface.
Related Information
Install or Update SAP HANA Components Using the Graphical User Interface [page 170]
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
PUBLIC 169
Install or Update SAP HANA Components Using the Command-Line Interface [page 172]
Install or Update SAP HANA Components Using the Resident Program [page 174]
Install or Update SAP HANA Components Using the Web User Interface [page 177]
SAP Note 1858920 - Diagnostics Agent installation with SWPM
SAP Note 2293092 - SAP HANA Database upgrade fails due to missing plugin
SAP Note 2014334 - Migration from SAP HANA AFL (SPS 07 or earlier) to Product-Specic AFLs (SPS 08)
8.1.1 Install or Update SAP HANA Components Using the
Graphical User Interface
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-specic 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.
● The root user is able to execute graphical applications.
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 oers 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 le contains the entry
online-upgrade-plugin: 1
170
PUBLIC
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
Note
Before updating such a component, verify the version information contained in the required-
components entry inside the manifest le, for example:
required-components: name="HDB"; vendor="sap.com";
version="[1.00.110.00,1.00.110.1)"
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-specic 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
1. Change to the following directory on the installation medium:
Option
Description
Intel-Based Hardware Platforms cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64
IBM Power Systems
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64
Note
If you downloaded the components to a dierent 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.
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
PUBLIC 171
Note
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 nalize the conguration.
Related Information
SAP Note 2327295 - Conrm Successful Installation of Smart Data Access
8.1.2 Install or Update SAP HANA Components Using the
Command-Line Interface
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-specic 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 oers the
172
PUBLIC
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
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 le 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 le, for example:
required-components: name="HDB"; vendor="sap.com";
version="[1.00.110.00,1.00.110.1)"
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-specic 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
1. Change to the following directory on the installation medium:
Option
Description
Intel-Based Hardware Platforms cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
PUBLIC 173
Option Description
IBM Power Systems cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64
Note
If you downloaded the components to a dierent 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 Note 2327295 - Conrm Successful Installation of Smart Data Access
8.1.3 Install or Update SAP HANA Components Using the
Resident Program
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.
174
PUBLIC
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
Context
In order to add SAP HANA system components, you must start the hdblcm(gui) installer and select update.
The update component menu oers to update the server (if a more recent version is found) and also oers 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 le 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 le, for example:
required-components: name="HDB"; vendor="sap.com";
version="[1.00.110.00,1.00.110.1)"
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-specic 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
1. Prepare the component location.
The SAP HANA database lifecycle manager detects software components in nearby standard directories,
but not in unique or distant directories. Therefore, you should make note of where the software
components for installation or update are located, so that you can add the component location in the
graphical user interface eld, or specify the component location as a call option in the command-line
interface using one of the following parameters:
○ component_dirs
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
PUBLIC 175
○ component_medium
○ component_root
For more information about these parameters, see Related Information.
2. Change to the SAP HANA resident HDBLCM directory:
cd <sapmnt>/<SID>/hdblcm
By default, <sapmnt> is /hana/shared.
3. Start the SAP HANA database lifecycle manager using the graphical user interface or the command-line
interface.
Option
Description
Graphical
User In
terface
1.
Start the SAP HANA HDBLCM graphical user interface:
./hdblcmgui
2. Select the Install or Update Additional Components from the activity list. Then select Next.
3. Select a detected software component or add a software component location by selecting Add
Component Location.... Then select Next.
4. Select the components you would like to install or update, 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. If you are installing or updating XS advanced runtime components, you can select which of the de
tected components are installed.
7. Review the summary and select Upgrade.
Com
mand-
Line In
terface
1.
Start the SAP HANA HDBLCM command-line interface:
./hdblcm
If the component location is not detected by the SAP HANA HDBLCM, rerun the program with one of
the following call options specied --component[_dirs|_medium|_root]=<component
location>
2. Select the index for the update_components, then select Enter .
3. Select the components you would like to install or update as a comma-seperated list of indexes, then
select
Enter .
4. 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.
5. If you are installing or updating XS advanced runtime components, you can select which of the de
tected components are installed.
6. Review the summary and select y.
Results
A system component has been added to the SAP HANA system. The component list has been updated. A log
has been produced.
176
PUBLIC
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
Related Information
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 - Conrm Successful Installation of Smart Data Access
8.1.4 Install or Update SAP HANA Components Using the
Web User Interface
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-specic 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 fullled before trying to access the SAP HANA database
lifecycle manager from a Web browser.
● The communication port 1129 is open.
Port 1129 is required for the SSL communication with the SAP Host Agent in a standalone browser via
HTTPS.
● The following Web browser requirements are fullled:
○ Microsoft Windows
○ Internet Explorer - Version 9 or higher
If you are running Internet Explorer version 9, make sure that your browser is not running in
compatibility mode with your SAP HANA host. You can check this in your browser by choosing
Tools Compatibility View Settings .
○ Microsoft Edge
○ Mozilla Firefox - Latest version and Extended Support Release
○ Google Chrome - Latest version
○ SUSE Linux - Mozilla Firefox with XULRunner 10.0.4 ESR
○ Mac OS - Safari 5.1 or higher
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.
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
PUBLIC 177
● You are logged on as the system administrator user <sid>adm.
● The <sid>adm user has read and execute permissions for the directory that contains the installation
medium.
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 le 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 le, for example:
required-components: name="HDB"; vendor="sap.com";
version="[1.00.110.00,1.00.110.1)"
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-specic 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
1. Access the SAP HANA HDBLCM Web user interface.
178
PUBLIC
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
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.
SAP HANA
cockpit
1.
Enter the URL of the SAP HANA cockpit administration and monitoring console in your browser.
https://<host_FQDN>:<port>
Note
FQDN = fully qualied 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.
2. Select the Install or Update Additional Components tile.
3. Select Add Software Locations... to add SAP HANA components for installation or update. Then select
Next.
4. Select the components for installation or update. Then select Next.
Various parameters can be set in the Advanced Parameters Conguration dialog. To access the Advanced
Parameters Conguration 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
SAP Note 2327295 - Conrm Successful Installation of Smart Data Access
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
PUBLIC 179
8.1.5 Upload and Extract SAP HANA Components Using the
Web User Interface
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
● The SAP HANA database server is up and running.
You should verify that the following prerequisites are fullled before trying to access the SAP HANA database
lifecycle manager from a Web browser.
● The communication port 1129 is open.
Port 1129 is required for the SSL communication with the SAP Host Agent in a standalone browser via
HTTPS.
● The following Web browser requirements are fullled:
○ Microsoft Windows
○ Internet Explorer - Version 9 or higher
If you are running Internet Explorer version 9, make sure that your browser is not running in
compatibility mode with your SAP HANA host. You can check this in your browser by choosing
Tools Compatibility View Settings .
○ Microsoft Edge
○ Mozilla Firefox - Latest version and Extended Support Release
○ Google Chrome - Latest version
○ SUSE Linux - Mozilla Firefox with XULRunner 10.0.4 ESR
○ Mac OS - Safari 5.1 or higher
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.
● You are logged on as the system administrator user <sid>adm.
● The <sid>adm user has read and execute permissions for the directory that contains the installation
medium.
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.
180
PUBLIC
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
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 le 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 le, for example:
required-components: name="HDB"; vendor="sap.com";
version="[1.00.110.00,1.00.110.1)"
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-specic 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
1. Access the SAP HANA HDBLCM Web user interface.
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.
SAP HANA
cockpit
1.
Enter the URL of the SAP HANA cockpit administration and monitoring console in your browser.
https://<host_FQDN>:<port>
Note
FQDN = fully qualied domain name
2. Drill down on the name of the system from My Resources or from a group.
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
PUBLIC 181
Option Description
3. The links in Platform Lifecycle Management each launch additional functionality, giving you ex
panded capabilities for managing the resource.
2. Select the Upload/Extract Components tile.
3. Select the upload method.
Option
Description
The Archives are Ac
cessible from the
SAP HANA Host
Use this option if the archives are located on a le system accessible 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
the SAP HANA Host
Use this option if the archives are accessible only from your local machine.
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.
8.1.6 Update XS Advanced Components
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 aected component.
The following list covers the update process for each category:
XS Advanced System Components
The XS Advanced core installation includes the following system components:
● 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.
182
PUBLIC
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
Build Packs
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:
xs update-buildpack <BUILDPACK> [-p <PATH>] [-i <POSITION>] [--enable|--disable]
[--lock|--unlock]
Tip
<PATH> is the location of the updated package.
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>
Application Run Times
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:
xs create-runtime -p <PATH> [--inactive] [<DESCRIPTION>]
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 aected applications. You can
then delete the old application run time using the xs delete-runtime command, as illustrated in the
following example:
xs delete-runtime -i <ID> [-f]
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 specic 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.
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
PUBLIC 183
Service Brokers
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:
xs update-service-broker <SERVICE_BROKER> <USERNAME> <PASSWORD> <URL>
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
184
PUBLIC
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
8.1.7 Activate the Local Secure Store (LSS)
After the installation of the local secure store has nished 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 SAP HANA systems
congured with dynamic tiering (with LSS installed and activated), set the Secure Store type for them to
SSFS (secure store in the le system).
For details, see Local Secure Store (LSS) under Security Administration > Data Encryption in the SAP HANA
Dynamic Tiering: Administration Guide 2.0 SP04.
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
le system) to LSS. To activate the local secure store during installation, run hdblcm with the parameter
secure_store=localsecurestore.
Procedure
1. Stop the SAP HANA system:
/usr/sap/hostctrl/exe/sapcontrol -nr <instance number> -function Stop
2. Activate the local secure store:
hdbnsutil -migrateSecureStore –-target=LSS
3. Start the SAP HANA system:
/usr/sap/hostctrl/exe/sapcontrol -nr <instance number> -function Start
Related Information
Local Secure Store (LSS) [page 28]
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
PUBLIC 185
Start and Stop the SAP HANA System [page 197]
secure_store [page 259]
8.2 Uninstalling SAP HANA Components
SAP HANA components - including system components and additional components - can be uninstalled the
following ways:
● From the resident program, using
○ the graphical user interface,
○ the command-line interface.
● Using the Web user interface.
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
8.2.1 Uninstall SAP HANA Components Using the Graphical
User Interface
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 conguration occur.
● The user is able to execute graphical applications.
186
PUBLIC
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
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-specic 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 specic host roles, you must rst 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
1. Change to the SAP HANA resident HDBLCM directory:
cd <sapmnt>/<SID>/hdblcm
By default, <sapmnt> is /hana/shared.
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.
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 nalize the conguration.
Results
The selected components are uninstalled. A log le is available.
Related Information
SAP Note 1858920 - Diagnostics Agent installation with SWPM
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
PUBLIC 187
Removing Hosts from an SAP HANA System
Removing Host Roles
8.2.2 Uninstall SAP HANA Components Using the Command-
Line Interface
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 conguration 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-specic 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 specic host roles, you must rst 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
1. Change to the SAP HANA resident HDBLCM directory:
cd <sapmnt>/<SID>/hdblcm
By default, <sapmnt> is /hana/shared.
188
PUBLIC
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
2. Start the SAP HANA database lifecycle manager interactively in the command line:
./hdblcm
3. Select the index for uninstall, then select Enter .
4. Select the components to be uninstalled as a comma-separated list of indexes. Then select Enter.
5. Review the summary, and select y to nalize the conguration.
Results
The selected components are uninstalled. A log le is available.
Related Information
SAP Note 1858920 - Diagnostics Agent installation with SWPM
Removing Hosts from an SAP HANA System
Removing Host Roles
8.2.3 Uninstall an SAP HANA Component on a System
Missing the SAP HANA Resident Program
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.
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
PUBLIC 189
To install the SAP HANA resident HDBLCM, follow the procedure below.
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:
./hdblcm --action=update --components=hdblcm
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
1. Change to the following directory on the installation medium:
Option
Description
Intel-Based Hardware Platforms cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64
IBM Power Systems
cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64
Note
If you downloaded the components to a dierent directory, change to the directory where you
unpacked the archive.
2. Start the SAP HANA database lifecycle manager interactively in the command line:
./hdblcm --action=update --components=hdblcm
3. Optionally, specify additional components locations.
4. Select the index for the system you want to update, then select Enter .
5. Review the summary, and select y to nalize the conguration.
190
PUBLIC
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
8.2.4 Uninstall SAP HANA Components Using the Web User
Interface
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 fullled before trying to access the SAP HANA database
lifecycle manager from a Web browser.
● The communication port 1129 is open.
Port 1129 is required for the SSL communication with the SAP Host Agent in a standalone browser via
HTTPS.
● The following Web browser requirements are fullled:
○ Microsoft Windows
○ Internet Explorer - Version 9 or higher
If you are running Internet Explorer version 9, make sure that your browser is not running in
compatibility mode with your SAP HANA host. You can check this in your browser by choosing
Tools Compatibility View Settings .
○ Microsoft Edge
○ Mozilla Firefox - Latest version and Extended Support Release
○ Google Chrome - Latest version
○ SUSE Linux - Mozilla Firefox with XULRunner 10.0.4 ESR
○ Mac OS - Safari 5.1 or higher
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.
● You are logged on as the system administrator user <sid>adm.
● The <sid>adm user has read and execute permissions for the directory that contains the installation
medium.
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 specic host roles, you must rst 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.
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
PUBLIC 191
Context
Note
The product-specic 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
1. Access the SAP HANA HDBLCM Web user interface.
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.
SAP HANA
cockpit
1.
Enter the URL of the SAP HANA cockpit administration and monitoring console in your browser.
https://<host_FQDN>:<port>
Note
FQDN = fully qualied 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.
2. Select the Uninstall Components tile.
3. Select the components for uninstallation. Then select Next.
4. Specify the SAP HANA authorization information.
5. Select Uninstall.
192
PUBLIC
SAP HANA Server Installation and Update Guide
Managing SAP HANA System Components
9 Uninstalling the SAP HANA System
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]
9.1 Uninstall the SAP HANA System Using the Graphical
User Interface
You can uninstall an SAP HANA system using the SAP HANA database lifecycle manager (HDBLCM) graphical
user interface.
Prerequisites
You are logged in as root user.
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-specic 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!
SAP HANA Server Installation and Update Guide
Uninstalling the SAP HANA System
PUBLIC 193
Procedure
1. Change to the SAP HANA resident HDBLCM directory:
cd <sapmnt>/<SID>/hdblcm
By default, <sapmnt> is /hana/shared.
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.
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 nalize the conguration.
Results
The selected components are uninstalled. A log le is available.
Related Information
SAP Note 1858920 - Diagnostics Agent installation with SWPM
9.2 Uninstall the SAP HANA System Using the Command-
Line Interface
You can uninstall an SAP HANA system using the SAP HANA database lifecycle manager (HDBLCM)
command-line interface.
Prerequisites
You are logged in as root user.
194
PUBLIC
SAP HANA Server Installation and Update Guide
Uninstalling the SAP HANA System
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-specic 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
1. Change to the SAP HANA resident HDBLCM directory:
cd <sapmnt>/<SID>/hdblcm
By default, <sapmnt> is /hana/shared.
2. Start the SAP HANA database lifecycle manager interactively in the command line:
./hdblcm
3. Select the index for uninstall, then select Enter .
4. Select the index for all. Then select Enter .
5. Review the summary, and select y to nalize the conguration.
Results
The selected components are uninstalled. A log le is available.
Related Information
SAP Note 1858920 - Diagnostics Agent installation with SWPM
SAP HANA Server Installation and Update Guide
Uninstalling the SAP HANA System
PUBLIC 195
10 Managing the SAP HANA System After
Installation
After the installation has nished, it is recommended to perform the following tasks:
● Perform a system backup
We strongly recommend that you perform an initial backup of your system once you have nished the
installation. For more details, see the system backup information in the SAP HANA Administration Guide.
● Change the passwords
If you are receiving an newly installed SAP HANA platform from a hardware provider, it is recommended to
update the passwords so they comply with your security guidelines. For more information, see the SAP
HANA Security Guide.
● Congure encryption on the SAP HANA server:
○ Change the SSFS master keys
SAP HANA secures content in two secure stores in the le system (SSFS): the instance SSFS and the
system PKI SSFS. Unique master keys are generated for the instance SSFS, if used, and the system
PKI SSFS during installation or update. However, if you received your system pre-installed from a
hardware or hosting partner, we recommend that you change them immediately after handover to
ensure that they are not known outside of your organization. You can also change the master keys any
time later.
○ Change and back up the encryption root keys used for SAP HANA data-at-rest encryption and
application data encryption services.
○ Enable data-at-rest encryption if required.
For more information about sever-side data encryption services, as well as and how to congure and
manage them, see the SAP HANA Security Guide and the SAP HANA Administration Guide.
● Finalize your customization
Use the SAP HANA lifecycle management tools to adapt the existing conguration, if necessary. For more
information, see the SAP HANA Administration Guide.
The following sections in this chapter are optional tasks that can be performed as part of installation
management.
Related Information
Server-Side Data Encryption Services
Encryption Conguration
SAP Note 2600030 - Parameter Recommendations in SAP HANA Environments
SAP Note 2400024 - How-To SAP HANA Administration and Monitoring
196
PUBLIC
SAP HANA Server Installation and Update Guide
Managing the SAP HANA System After Installation
10.1 Start and Stop the SAP HANA System
After the installation has nished 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
● By using the sapcontrol program:
a. Log on to the SAP HANA system host as a user with root authorization.
b. Execute one of the following commands:
○ Start the SAP HANA system by entering the following command:
/usr/sap/hostctrl/exe/sapcontrol -nr <instance number> -function Start
○ Stop the SAP HANA system by entering the following command:
/usr/sap/hostctrl/exe/sapcontrol -nr <instance number> -function Stop
● By using the HDB program:
a. Log on to the SAP HANA system host as user <sid>adm.
b. Execute one of the following commands:
○ Start the SAP HANA system by entering the following command:
/usr/sap/<SID>/HDB<instance number>/HDB start
Example:
/usr/sap/KB1/HDB26/HDB start
○ Stop the SAP HANA system by entering the following command:
/usr/sap/<SID>/HDB<instance number>/HDB stop
Example:
/usr/sap/KB1/HDB26/HDB stop
Note
The SAP HANA database does not start automatically by default when the SAP HANA system
is started. But you can enable an automated start of this kind. For more information, see
Related Information.
SAP HANA Server Installation and Update Guide
Managing the SAP HANA System After Installation
PUBLIC 197
Related Information
Starting and Stopping SAP HANA Systems
autostart [page 226]
10.2 Display the Process List
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:
/usr/sap/hostctrl/exe/sapcontrol -nr <instance number> -function GetProcessList
You can also display the SAP HANA system processes using the SAP Microsoft Management Console (SAP
MMC) from a Microsoft Windows PC.
Results
Example: Displaying the Process List
/usr/sap/hostctrl/exe/sapcontrol -nr 00 -function GetProcessList
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
198
PUBLIC
SAP HANA Server Installation and Update Guide
Managing the SAP HANA System After Installation
hdbindexserver, HDB Indexserver, GREEN, Running, 2015 07 06 13:38:26, 72:30:54,
1317
hdbxsengine, HDB XSEngine, GREEN, Running, 2015 07 06 13:38:26, 72:30:54, 1320
hdbcompileserver, HDB Compileserver, GREEN, Running, 2015 07 06 13:38:18,
72:31:02, 1282
hdbwebdispatcher, HDB Web Dispatcher, GREEN, Running, 2015 07 06 13:39:10,
72:30:10, 1540
SAP HANA Server Installation and Update Guide
Managing the SAP HANA System After Installation
PUBLIC 199
11 Tutorials
The following tutorials are a sampling of general use cases, which illustrate the functionality and versatility of
the SAP HANA database lifecycle manager.
11.1 Tutorial: Automating Installation
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 conguration le and call options passed on the command line.
Introduction to Installation Automation
With the SAP HANA database lifecycle manager (HDBLCM), it is now possible to automate installation by using
a combination of the conguration le, 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 oers SAP
HANA platforms (SAP HANA system installed on SAP veried hardware) in three sizes: Small, Large, and Extra
Large.
200
PUBLIC
SAP HANA Server Installation and Update Guide
Tutorials
Since the hardware partner prepares the SAP HANA platform on-demand, he needs to be able to react quickly
to orders as they are placed. During slow sales periods, manual installation is feasible, however during busy
sales periods, manual installation could create too much overhead. In this case, installation automation would
allow the hardware partner to start as many installation copies as required, without any further interaction with
the installer. It would even be possible for the partner to start the installation near the end of the business day,
leave the installation, and ship out the order the next morning.
The hardware partner automates the installation of nine SAP HANA systems (1 Extra Large, 5 Large, and 3
Small). Previously, he has created conguration les for each of the three system types. So, when several
orders come in at the same time, he ne 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 conguration le
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 conguration les, the
installations are reliable, exible, and ecient.
Step 1: Prepare for automation with the automation checklist.
Automation is ideal for installations that run unattended. Before you start an automated installation, it is
recommended to consider the following.
For All System Types
SAP HANA Server Installation and Update Guide
Tutorials
PUBLIC 201
Do the operating system and additional software compo
nents meet the requirements?
Refer to the SAP HANA Hardware and Software Require
ments.
Do you know where the data volumes and the log volumes
will be located?
For security reasons, the data device and log device should
not be the same. Refer to the SAP HANA System Types.
Where will the required le systems be located and is the
storage sucient?
Refer to the Recommended File System Layout.
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 rst. Refer to the Hardware and
Software Requirements.
Where will you specify passwords? SYSTEM, <sid>adm, and root passwords must be specied
in the conguration le or in an XML le. Refer to the
Speci
fying Passwords information.
For the Multiple-Host System Type Only
How many worker hosts and standby hosts will there be?
How will they be grouped?
System processes and data are distributed among worker
hosts, including the original host. Standby hosts do not per
form tasks. Refer to the Multiple-Host System Concepts.
How will storage devices be congured? External storage can be congured 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
ple-host system. Will the root user name for all hosts be
"root"?
If not, the root_user parameter must be specied during
installation. Refer to the
root_user parameter information.
Step 2: Review the installation scenario.
In order to provide exibility, it is possible to install the same SAP HANA system in several ways. The
dierences 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 specications:
● System name: P01
● Instance number: 01
● Installation path: /hana/shared
● Data path: /hana/data/P01
● Log path: /hana/log/P01
● User group ID: 110
202
PUBLIC
SAP HANA Server Installation and Update Guide
Tutorials
He has several customers who have pre-ordered the single-host SAP HANA P01 system and he is expecting
more P01 orders. His goal is to iteratively improve his installation method to the point that he can automate his
ideally congured system installation on several hosts at the same time, come back later, and the installed SAP
HANA platforms will be nished and ready to ship. To reach his goal, he installs the same system (P01) three
times, using:
● Command line options
● Conguration le
● Conguration le in batch mode
Step 3: Create a test installation by installing the system using command
line options.
Since the hardware partner is still new to installing SAP HANA, he tries out the installation rst from the
command line. He reviews the installation parameters and nds the corresponding parameter key-value pairs
for his desired P01 single-host system.
System Detail
Specication Command Line Parameter
System name P01
--sid=P01
Instance number 01
--number=01
Installation path /hana/shared
--sapmnt=/hana/shared
Data path /hana/data/P01
--datapath=/hana/data/P01
Log path /hana/log/P01
--logpath=/hana/log/P01
User group ID 110
--groupid=110
The hardware partner takes the parameter key-value pairs, and builds the command line input as follows:
./hdblcm --sid=P01 --number=01 --groupid=110 --sapmnt=/hana/shared --datapath=/
hana/data/P01 --logpath=/hana/log/P01
SAP HANA Server Installation and Update Guide
Tutorials
PUBLIC 203
Upon review of the parameter syntax, he realizes he did not need to specify sapmnt, datapath, or logpath
parameters because he chose the default values. The rest of the parameters could also have been given the
short-form syntax. Therefore, the same P01 system installation could be simplied to the following syntax:
./hdblcm –s P01 –n 01 –G 110
System Detail
Specication Simplied Command Line Parameter
System name P01
-s P01
Instance number 01
-n 01
Installation path /hana/shared
<default>
Data path /hana/data/P01
<default>
Log path /hana/log/P01
<default>
User group ID 110
-G 110
Step 4: Create a test installation by installing the system using the
conguration le.
Now that the hardware partner successfully installed from the command line, he wants to make use of the
conguration le, since his end goal is to automate the installation.
He generates a template of the conguration le:
./hdblcm --action=install --dump_configfile_template=/home/root/HANA_install.cfg
He opens the blank conguration le template and lls it in as follows:
HANA_install.cfg# SAP HANA System ID
sid=P01
# Instance Number (Default: 00)
number=01
…
# ID of User Group 'sapsys'
Groupid=110
If you want to run the installation with a conguration le and you do not want be asked interactively for
specic parameters, you can either provide a xed value in the conguration le 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 dier from the default values,
only they are specied in the conguration le. The hardware partner also realizes that there is automatic
substitution of the SID (sid) and installation path (sapmnt) throughout the conguration le 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.
204
PUBLIC
SAP HANA Server Installation and Update Guide
Tutorials
Now, he can start the installer from the command line with the following simple command:
./hdblcm --configfile=/home/root/HANA_install.cfg
Step 5: Automate the system installation using the conguration le in
batch mode
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 conrming other default parameters as part of interactive mode. Batch mode runs the
installer without asking for any conrmation 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 le and
passed to the installer as a stream by standard input, or they can be specied in the conguration le. Since
the hardware partner is already making use of the conguration le, 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 unspecied parameters.
With the addition of passwords to the conguration le, it now looks like this:
HANA_install.cfg# Root User Password
root_password=Root1234
...
# SAP HANA System ID
sid=P01
# Instance Number (Default: 00)
number=01
...
# ID of User Group 'sapsys'
Groupid=110
...
# SAP Host Agent (sapadm) Password
sapadm_password=Agent1234
...
# System Administrator Password
password=Adm1234
....
# Database User (SYSTEM) Password
system_user_password=Sys1234
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
Getting Started with SAP HANA System Installation [page 71]
SAP HANA Hardware and Software Requirements [page 15]
SAP HANA Server Installation and Update Guide
Tutorials
PUBLIC 205
SAP HANA System Types [page 22]
Recommended File System Layout [page 18]
Specifying Passwords [page 76]
root_user [page 258]
Multiple-Host System Concepts [page 84]
11.2 Tutorial: Using Custom Conguration Files
During system installation, customized SAP HANA conguration (*.ini) les can be placed inside a dedicated
directory that is specied using the custom_cfg parameter.
Context
Custom conguration les can be placed inside a custom conguration folder. These les are used during
installation to override default settings. This reduces the number of restarts during installation and facilitates
conguration of the SAP HANA system.
Procedure
1. Create an empty directory that will contain your custom conguration les. The conguration les 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 conguration les (*.ini) inside the custom conguration les directory. Alternatively, you
can copy existing les from another system to re-use a tested conguration. For more information on
conguration les, see Conguring SAP HANA System Properties (INI Files) in the SAP HANA
Administration Guide.
3. Now the installer can be called from the command line.
./hdblcm --action=install --custom_cfg=<path to directory containing custom
configuration files>
Related Information
custom_cfg [page 235]
Conguring SAP HANA System Properties (INI Files)
206
PUBLIC
SAP HANA Server Installation and Update Guide
Tutorials
11.3 Tutorial: Installing a Multiple-Host System Using a
Conguration File in Batch Mode
The following use case installs a multiple-host system, with two hosts (both worker). The installer reads the
parameters from a conguration le. The installation is run in batch mode, so that once the installation is
started, both host installations are congured without any further input required.
Procedure
1. The following are the relevant parameters for the SAP HANA server. They are specied in a combination of
command line options and conguration le:
Parameter
Input Location Specied
Passwords
# 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
Conguration le
action --action=install
Call option
sid sid=ABC
Conguration le
number number=01
Conguration le
root_user root_user=sysroot
Conguration le
addhosts addhosts=hananode1
Conguration le
configfile --configfile=/home/sysroot/hdblcm.cfg
Call option
batch -b
Call option
userid userid=55
Conguration le
SAP HANA Server Installation and Update Guide
Tutorials
PUBLIC 207
Parameter Input Location Specied
groupid groupid=110
Conguration le
storage_cfg storage_cfg=/home/sysroot/storage
Conguration le
2. The reusable installation parameter values are saved in the following conguration le:
[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
conguration le. The installation is run in batch mode, so no follow-up conrmation is required.
./hdblcm --action=install --configfile=/home/sysroot/hdblcm.cfg -b
11.4 Tutorial: Overwriting Conguration File Parameters
with Command Line Parameters
The following use case uses the same conguration le as above. However, this time, the desired system
deviates slightly from the one dened the conguration le. By specifying parameters in the command line
which are already specied in the conguration le, the conguration le settings are eectively overwritten.
The command line parameters take precedence over the conguration le parameters.
Procedure
1. The following are the desired parameters for the SAP HANA server. They are specied in a combination of
command-line and conguration le:
208
PUBLIC
SAP HANA Server Installation and Update Guide
Tutorials
Parameter Input Location Specied Used for Installation
Passwords
# 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
Conguration le
yes
action --action=install
CLI yes
sid sid=ABC
Conguration le no
sid --sid=DB1
CLI yes
number number=01
Conguration le no
number -n 01
CLI yes
root_user root_user=sysroot
Conguration le yes
addhosts addhosts=hananode1
Conguration le no
addhosts --
addhosts=hananode1,hananode2
:role=standby
CLI yes
configfile --configfile=/home/sysroot/
hdblcm_SPS7.cfg
CLI yes
batch -b
CLI yes
userid userid=55
Conguration le yes
groupid groupid=110
Conguration le yes
storage_cfg storage_cfg=/home/sysroot/
storage
Conguration le no
SAP HANA Server Installation and Update Guide
Tutorials
PUBLIC 209
Parameter Input Location Specied Used for Installation
storage_cfg --storage_cfg=/home/sysroot/
storage_new
CLI yes
2. The reusable installation parameter values are saved in the following conguration le:
[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 conguration le and you do not want be asked interactively for
specic parameters, you can either provide a xed value in the conguration le 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
conguration le. The installation is run in batch mode, so no follow-up conrmation is required.
./hdblcm --action=install -n 01 --sid=DB1 --
addhosts=hananode1,hananode2:role=standby --storage_cfg=/home/sysroot/
storage_new --configfile=/home/sysroot/hdblcm_SPS7.cfg -b
210
PUBLIC
SAP HANA Server Installation and Update Guide
Tutorials
11.5 Tutorial: Installing a Single-Host System with
Passwords Read from XML Standard Input Stream
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 congured without any further input required.
Context
This tutorial describes how passwords are supplied to the SAP HANA database lifecycle manager in an XML le
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.
Parameter
Input Location Specied
Passwords
--read_password_from_stdin=xml
Call Option
sid --sid=P02
Call Option
number --number=01
Call Option
root_user --root_user=sysroot
Call Option
batch --batch
Call Option
2. The following password le 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>
SAP HANA Server Installation and Update Guide
Tutorials
PUBLIC 211
Note
Make sure to set the appropriate le permissions.
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 conrmation is required.
cat ~/hdb_passwords.xml | ./hdblcm --sid=P02 --number 01 --root_user=sysroot
--read_password_from_stdin=xml --batch
Related Information
read_password_from_stdin [page 255]
212
PUBLIC
SAP HANA Server Installation and Update Guide
Tutorials
12 Troubleshooting
Troubleshooting should be referred to if the installation fails for an unknown reason, or for workarounds in
special circumstances.
12.1 Accessing the Underlying Installer Components
(pass_through_help)
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 specied 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
Available Parameters for pass_through_help
Parameter
Install Update
--hdbinst_client_ignore=<check1>[]...
Ignores failing prerequisite checks (check_version)
--hdbinst_client_sapmnt=<installation_path>
Mount point for shared client installations
[default: --hdbinst_client_sapmnt=/hana/shared]
--hdbinst_plugin_ignore=<check1>[]...
Ignores failing prerequisite checks (check_busy_files, check_version)
--hdbinst_plugin_nostart
Does not start the instance after installation
SAP HANA Server Installation and Update Guide
Troubleshooting
PUBLIC 213
Parameter Install Update
--hdbinst_plugin_system_user
Species the system user of the database [default: --
hdbinst_plugin_system_user=SYSTEM
--hdbinst_server_prepare_update
Stops the update before software version switch
--hdbinst_server_remote_execution
Species the connectivity method for multiple host operations [default: ssh]
--hdbinst_server_ignore=<check1>[]...
Ignores failing prerequisite checks (check_busy_files,
check_diskspace, check_hosts, check_license, check_min_mem,
check_pending_upgrade, check_plugin_dependencies,
check_secondary_system, check_version)
--hdbinst_server_import_content[=off]
Imports delivery units [default: --hdbinst_server_import_content]
--hdbinst_server_xs_engine[=off]
Enables the XS engine [default: --hdbinst_server_xs_engine]
--hdbinst_server_xs_engine_http_port=<port>
Species the HTTP port of the XS engine
--hdbinst_server_xs_engine_https_port=<port>
Species the HTTPS port of the XS engine
--hdbinst_studio_features=all|<feat1>[,<feat2>]...
Species the features to be installed [default: --
hdbinst_studio_features=all]
--hdbinst_studio_path=<hdbinst_studio_path>
Installation path [default: --hdbinst_studio_path=/usr/sap/
hdbstudio]
--hdbupd_server_change_initial_ssfs_key[=off]
Changes the initial SSFS key [default: off]
214 PUBLIC
SAP HANA Server Installation and Update Guide
Troubleshooting
Parameter Install Update
--hdbupd_server_ignore=<check1>[]...
Ignores failing prerequisite checks (check_busy_files,
check_diskspace, check_hosts, check_license, check_min_mem,
check_pending_upgrade, check_plugin_dependencies,
check_secondary_system, check_version)
--hdbupd_server_import_content[=off]
Imports delivery units [default: --hdbupd_server_import_content]
--hdbupd_server_nostart
Does not start the instance after upgrade
--hdbupd_server_prepare_update
Stops the update before software version switch
--hdbupd_server_remote_execution
Species the connectivity method for multiple host operations [default: ssh]
--hdbupd_server_xs_engine[=off]
Enables the XS engine [default: --hdbupd_server_xs_engine]
--hdbupd_server_xs_engine_http_port=<port>
Species the HTTP port of the XS engine
--hdbupd_server_xs_engine_https_port=<port>
Species the HTTPS port of the XS engine
XML password tag: <hdbinst_plugin_password>
System administrator password
12.2 Locating all SAP HANA File System Components
In addition to the main components installed in the default le systems described in Recommended File
System Layout [page 18], it may also be necessary to locate the temporary les from the SAP HANA system.
They can be found in the following directories:
● SAP HANA DB les:
○ /var/lib/hdb - IPC data (volatile)
○ /var/tmp - Installer log les, HDB_alive_*
SAP HANA Server Installation and Update Guide
Troubleshooting
PUBLIC 215
○ /tmp - .hdb_*_lock (volatile)
● sapstartsrv les:
○ /etc/init.d/sapinit* - Boot script
○ /tmp/.sap* - Sockets, lock les (volatile)
12.3 Enabling the Installer Trace
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 le 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 le must already exist.
12.4 Checking the Log Files
The SAP HANA lifecycle management tools hdblcm and hdblcmgui write log les during installation. The
most recent log le is always available under /var/tmp/hdblcm.log or /var/tmp/hdblcmgui.log.
Additionally, a copy of the log les 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 rst. Once the source of the problem
is narrowed down to a specic component, then the component logs can be further analyzed.
The component log les are stored in the following path:
/var/tmp/hdb_<SID>_hdblcm_<action>_<time_stamp>
where <action> :: = install | update | addhost | uninstall | and so on
The following log les are written during performing the action:
● <hdbcommand>.log: can be read using a text editor
● <hdbcommand>.msg: XML format for the display in the installation tool with the GUI
● <hostname>_tracediff.tgz: provides a delta analysis of the original trace les, makes a detailed
analysis more easy
You can also view the last three log les in the SAP HANA studio using the administration function Diagnosis
Files. For more information, see the SAP HANA Administration Guide.
216
PUBLIC
SAP HANA Server Installation and Update Guide
Troubleshooting
12.5 Adding hdblcm to an Existing SAP HANA Installation
The SAP HANA lifecycle management tool hdblcm can be added to an existing installation that was performed
using hdbinst by executing the following command:
./hdblcm --action=update --sid=<SID> --components=hdblcm
Note
The version of hdblcm must be identical with the version of the installed SAP HANA system.
12.6 Disabling the Optimized Update
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.
Graphical user interface
./hdblcmgui --action=update --
update_execution_mode=standard
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 Conguration
dialog from the footer bar and select the standard update Update Execution Mode under General Parameters.
12.7 Dealing with a Failed Update
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
Recovering an SAP HANA Database
SAP HANA Server Installation and Update Guide
Troubleshooting
PUBLIC 217
Updating the SAP HANA System [page 133]
12.8 Importing Delivery Units Manually
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"
12.9 Removing a Partially Installed System
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.
12.10 Adjusting the System Time
A host cannot be added using the SAP HANA lifecycle management tool hdblcm if the time dierence 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.
218
PUBLIC
SAP HANA Server Installation and Update Guide
Troubleshooting
12.11 Skipping the Import of Initial XS Advanced Runtime
Content
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
12.12 Proxy Server Settings for SAP HANA Installations with
XS Advanced Runtime
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>"
SAP HANA Server Installation and Update Guide
Troubleshooting
PUBLIC 219
13 Parameter Reference
Reference information is provided for each installation parameter.
Each parameter section includes some or all of the following information, depending on the complexity of the
parameter:
● Description - The function of the parameter.
● Syntax - The command line option format and conguration le format for the parameter. Interactive
mode (for both the GUI and CLI) do not require the use of parameter syntax.
● Options - The sub-specications for the highly congurable parameters.
● Remarks - Important information about the parameters, including default values and whether the
parameter is oered in interactive mode. If it is not available in interactive mode, and the default value is
not wanted, the parameter must be specied as a command line option or in the conguration le in
combination with the call to the installation tool in interactive mode.
● Examples - The syntax in its common usage with acceptable parameter specications.
● Related Information - Links to relevant sections in the current document or to other documents which
contain more detailed information.
13.1 action
Species the action of hdblcm to be either installation, update, or extract components.
Syntax
In the command line, the following syntax is used:
--action=[extract_components|install|update]
Remarks
The default for this parameter is --action=exit.
This parameter is available in interactive mode.
13.2 addhosts
Species additional hosts for the SAP HANA system as a comma-separated list. Individual host options are
specied by a colon-separated list. This parameter is used when conguring 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 specied in combination with
addhosts.
220
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
When used with command-line batch mode, the action parameter must be specied
in combination with addhosts.
Syntax
In the command line, the following syntax is used:
--action=install --addhosts=<host>[,<host2>]
where the <host> syntax is as follows:
<host_name>[:role=worker|standby|extended_storage_worker|
extended_storage_standby| ets_worker|ets_standby|streaming|rdsync|
xs_worker|xs_standby][:group=<name>][:storage_partition=<number>]
Options
The following options can be used to congure the parameter:
● role - Species 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 congurations 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 - Species the worker group of the host. If undened, the worker
group is named "default". If you are using extension node for Business Warehouse,
you must name the worker group "worker_dt".
● group - Species the host group ID for failover scenarios. If undened, the host
group is named "default".
(The host group ID is NOT the same as the sapsys group ID, which is specied by
the parameter groupid).
● storage_partition - Species 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
This parameter is available in interactive mode.
The following SAP HANA options are supported on Intel-based hardware platforms
only:
● SAP HANA Accelerator for SAP ASE
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 221
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
Multiple-Host System Concepts [page 84]
Install a Multiple-Host SAP HANA System Using the Graphical User Interface [page 88]
root_user [page 258]
action [page 220]
Important Disclaimer for Features in SAP HANA [page 286]
13.3 add_local_roles
Species 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
In the command line, the following syntax is used:
--add_local_roles=<role1>[,<role2>]
where the following roles can be specied:
● 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
Remarks
The following SAP HANA options are supported on Intel-based hardware platforms
only:
● SAP HANA Accelerator for SAP ASE
222
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
This parameter is only available for the resident HDBLCM program.
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
Important Disclaimer for Features in SAP HANA [page 286]
13.4 add_roles
Species 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
In the command line, the following syntax is used:
--add_roles=<host name>=<role> -R <host name>=<role>
where the following roles can be specied:
● 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
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
Important Disclaimer for Features in SAP HANA [page 286]
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 223
13.5 apply_system_size_dependent_parameters
Applies a resource limit depending on the system size..
Syntax
In the command line, the following syntax is used:
--apply_system_size_dependent_parameters[=off]
Remarks
The default for this parameter is --apply_system_size_dependent_parameters
(on).
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
Species 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
In the command line, the following syntax is used:
--ase_datapath=<path to SAP HANA accelerator for SAP ASE data
directory>
Remarks
The default for this parameter is --ase_datapath=/hana/data_ase/<SID>.
This parameter is available in interactive mode.
This parameter is not supported by SAP HANA on IBM Power Systems.
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.
224
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
Related Information
Important Disclaimer for Features in SAP HANA [page 286]
13.7 ase_logpath
Species 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
In the command line, the following syntax is used:
--ase_logpath=<path to SAP HANA accelerator for SAP ASE log
directory>
Remarks
The default for this parameter is --ase_logpath=/hana/log_ase/<SID>.
This parameter is available in interactive mode.
This parameter is not supported by SAP HANA on IBM Power Systems.
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
Important Disclaimer for Features in SAP HANA [page 286]
13.8 ase_user
Species the administrator user of SAP HANA accelerator for SAP ASE.
Syntax
In the command line, the following syntax is used:
--ase_user=<administrator user name>
Remarks
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 225
The default for this parameter is --ase_user=sa.
This parameter is available in interactive mode.
This parameter is not supported by SAP HANA on IBM Power Systems.
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
Important Disclaimer for Features in SAP HANA [page 286]
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
In the command line, the following syntax is used:
--action=[install|update] --autoadd_xs_roles[=off]
Remarks
The default for this parameter is --autoadd_xs_roles (on).
This parameter is available in interactive mode.
13.10 autostart
Restarts system after machine reboot.
Syntax
In the command line, the following syntax is used:
--action=install --autostart=[0|1]
where 0 = o, and 1 = on
226
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
Remarks
The default for this parameter is --autostart=0 (o).
Note
To avoid the start of the SAP HANA system during the operating system upgrade,
set the autostart parameter in the prole to 0 (=o).
The prole can be found here: <sapmnt>/<SID>/profile/
<SID>_HDB<instance_number>_<hostname>
13.11 basepath_streaming
Species the location of streaming logstores and runtime information.
Syntax
In the command line, the following syntax is used:
--basepath_streaming=<location of streaming logstores and
runtime information>
Remarks
The default for this parameter is --basepath_streaming=/hana/
data_streaming/<SID>.
This parameter is available in interactive mode.
13.12 batch
Runs the SAP HANA lifecycle management tool from the command line in batch mode using default values for
unspecied parameters. If mandatory values are omitted or if invalid values are specied, the program issues
an error message.
Syntax
In the command line, the following syntax is used:
--action=[extract_components|install|update] --batch
or, in short form:
-b
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 227
Related Information
Specifying Passwords [page 76]
13.13 certificates_hostmap
Species the hostname used for generation of self-signed SSL certicates for the SAP Host Agent.
Requirements
The key-value pair action=install must be specied in combination with
certificates_hostmap.
Syntax
In the command line, the following syntax is used:
--action=install --certificates_hostmap=<host name>=<certificate
host name>
or
--action=install -C <host name>=<certificate host name>
Remarks
The default for this parameter is the current host.
This parameter is available in interactive mode.
Example
The following example generates certicates for two hosts in the long-form syntax:
./hdblcm --action=install --certificates_hostmap=hananode01=server1.company.com
--certificates_hostmap=hananode02=server2.company.com
The following example generates certicates for two hosts in the short-form syntax:
./hdblcm --action=install -C hananode01=server1.company.com -C
hananode02=server2.company.com
In this example, not all required installation parameters are specied in the command line. If this is the case,
the remaining mandatory parameters are requested interactively.
Related Information
action [page 220]
components [page 232]
228
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
13.14 change_lss_backup_password
Changes the password of the Local Secure Store (LSS) backup.
Syntax
In the command line, the following syntax is used:
--change_lss_backup_password
Remarks
This parameter is available in interactive mode.
13.15 change_system_user_password
Changes the password of the database user (SYSTEM).
Syntax
In the command line, the following syntax is used:
--change_system_user_password
Remarks
This parameter is available in interactive mode.
13.16 check_installation
Checks the SAP HANA installation
Syntax
In the command line, the following syntax is used:
--action=check_installation
Remarks
This parameter is only available for the resident HDBLCM program.
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 229
13.17 checkmnt
Species a non-standard shared le system, which can be accessed by all hosts during installation. This
parameter is typically used when the SID is included in the mountpoint.
Syntax
In the command line, the following syntax is used:
--action=install --checkmnt=<path>
13.18 check_only
Executes checks, but does not change the SAP HANA system.
Syntax
In the command line, the following syntax is used:
--action=update --check_only
13.19 client_path
Species the installation path for the client.
Syntax
In the command line, the following syntax is used:
--client_path=<path for client installation>
Remarks
The default for this parameter is --client_path=<sapmnt>/<SID>/hdbclient.
13.20 component_archives_dir
Species the directory of the SAP HANA database component archives.
Syntax
230
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
In the command line, the following syntax is used:
--action=extract_components --
component_archives_dir=
<component_archives_path>
Remarks
This parameter is available in interactive mode.
13.21 component_dirs
Species the installer component directories as a comma-separated list.
Syntax
In the command line, the following syntax is used:
--action=[install|update] --component_dirs=<component
directory>
Remarks
This parameter supports relative paths.
13.22 component_medium
Species the location of the SAP HANA installation medium.
Syntax
In the command line, the following syntax is used:
--action=[install|update] --component_medium=<directory of the
installation medium>
13.23 component_root
Species the directory root to search for components.
Syntax
In the command line, the following syntax is used:
--action=[install|update] --component_root=<component root
directory>
Remarks
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 231
This parameter supports relative paths.
13.24 components
Species 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-specic 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 specied.
Requirements
The parameter action must be specied in combination with components.
Syntax
In the command line, the following syntax is used:
--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 nding 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.
This parameter is available in interactive mode.
Example
The following example installs the SAP HANA client, the SAP HANA studio, and the SAP HANA database
(always installed, despite the specication):
./hdblcm --action=install --components=client,studio
In this example, not all required installation parameters are specied in the command line. If this is the case,
the remaining mandatory parameters are requested interactively.
232
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
Related Information
action [page 220]
Important Disclaimer for Features in SAP HANA [page 286]
13.25 configfile
Loads a conguration le of call option key-value pairs to be passed to the SAP HANA lifecycle management
program.
Syntax
In the command line, the following syntax is used:
--action=[extract_components|install|update] --
configfile=<file path>
Remarks
The conguration le makes installation and conguration tasks more ecient and
reliable. For more information, see Related Information.
This complement to this call option is the call option dump_configfile_template.
Related Information
dump_congle_template [page 237]
13.26 configure_python
Species the Python version to be used.
Syntax
In the command line, the following syntax is used:
--configure_python=[python2|python3]
Remarks
The default for this parameter is --configure_python=python2. Starting from SAP
HANA 2.0 SPS 05 (Rev. 59.01), the default for this parameter is
--
configure_python=python3.
The parameter is available during installation and update. If you want to change the
Python version without upgrading your SAP HANA revision, specify --
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 233
ignore=check_version when starting the update. During an upgrade the currently
active Python version is used as the default. Starting from SAP HANA 2.0 SPS 05 (Rev.
59.01), Python 3 is the default version during an upgrade.
Caution
Before changing the Python version, make sure that all custom and third-party
Python scripts required by your system conguration (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
In the command line, the following syntax is used:
--action=update --continue_update[=off]
Remarks
The default for this parameter is --continue_update (on).
This parameter is available in interactive mode.
Related Information
Prepare an Update for Flexible System Downtime [page 142]
13.28 copy_repository
Species the target path to which the SAP HANA studio repository should be copied.
Syntax
In the command line, the following syntax is used:
--copy_repository=<target path>
Remarks
The default for this parameter is --copy_repository=/<sapmnt>/<SID>/
hdbstudio_update
234
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
13.29 create_initial_tenant
Creates the initial tenant database.
Syntax
In the command line, the following syntax is used:
--action=install --create_initial_tenant[=off]
Remarks
The default for this parameter is --create_initial_tenant (on).
13.30 custom_cfg
Species the path to the directory which contains custom conguration (*.ini) les.
Syntax
In the command line, the following syntax is used:
--action=install --custom_cfg=<path to directory containing
custom configuration files>
Remarks
Customized versions of SAP HANA conguration les for conguring the system as a
whole and individual tenant databases, hosts, and services can be placed inside the
directory. These conguration les 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 specied in customized
conguration les.
Related Information
Conguring SAP HANA System Properties (INI Files)
Tutorial: Using Custom Conguration Files [page 206]
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 235
13.31 databackuppath
Species the location of the data backups.
Syntax
In the command line, the following syntax is used:
--databackuppath=<path>
Remarks
This parameter is available in interactive mode.
The path must be specied if the new directory is located on a dierent physical
storage. The contents of the directory must be moved manually to the new location.
13.32 datapath
Species the path to the data directory of the SAP HANA system.
Syntax
In the command line, the following syntax is used:
--action=install --datapath=<path to data directory>
Remarks
The default for this parameter is --datapath=/hana/data/<SID>.
This parameter is available in interactive mode.
The path must be specied if the new directory is located on a dierent physical
storage. The contents of the directory must be moved manually to the new location.
13.33 db_isolation
Species 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 congure 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-specic data on the le system is subsequently protected using standard OS le and
directory permissions.
Syntax
236
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
In the command line, the following syntax is used:
--action=install --db_isolation=high|low
Remarks
The default for this parameter is --db_isolation=low.
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
Database Isolation [page 37]
Recommended File System Layout [page 18]
13.34 dump_configfile_template
Species a le path to which a template conguration le is exported. The call options in the template
conguration le are set to their default values, and can be edited.
Syntax
In the command line, the following syntax is used:
--action=[extract_components|install|update] --
dump_configfile_template=<file path>
Remarks
The conguration le makes installation and conguration tasks more ecient and
reliable. For more information, see Related Information.
This complement to this call option is the call option configfile.
13.35 es_datapath
Species the path to the directory of the SAP HANA dynamic tiering data. Required for installation of SAP
HANA dynamic tiering.
Syntax
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 237
In the command line, the following syntax is used:
--es_datapath=<path to SAP HANA dynamic tiering data directory>
Remarks
The default for this parameter is --es_datapath=/hana/data_es/<SID>.
This parameter is available in interactive mode.
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
Important Disclaimer for Features in SAP HANA [page 286]
13.36 es_logpath
Species the path to the directory of the SAP HANA data tiering logs. Required for installation or update of SAP
HANA dynamic tiering.
Syntax
In the command line, the following syntax is used:
--es_logpath=<path to SAP HANA dynamic tiering log directory>
Remarks
The default for this parameter is --es_logpath=/hana/log_es/<SID>.
This parameter is available in interactive mode.
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
Important Disclaimer for Features in SAP HANA [page 286]
238
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
13.37 extract_components
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
In the command line, the following syntax is used:
--extract_components
Options
The following options are available:
component_archives_dir - Location of the SAP HANA component archives.
extract_temp_dir - The target directory to extract the software component archives
to.
sapcar_location - Location to the SAPCAR executable.
tar_executable_location - Location of the tar executable.
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>.
This parameter is available in interactive mode.
Related Information
Prepare the Software Archive for the Update [page 139]
13.38 extract_temp_dir
Species the temporary extraction directory.
Syntax
In the command line, the following syntax is used:
--action=extract_components --
extract_temp_dir=<extract_temp_dir>
Remarks
This parameter is available in interactive mode.
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 239
13.39 groupid
Species 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
In the command line, the following syntax is used:
--action=install --groupid=<sapsys group ID>
or, in short form:
-G <sapsys group ID>
Remarks
The default for this parameter is --groupid=79.
This parameter is available in interactive mode.
13.40 help
Displays the inline help information.
Syntax
In the command line, the following syntax is used:
--action=[extract_components|install|update] --help
or, in short form:
-h
Remarks
A general help output is available for all SAP HANA lifecycle management programs.
Task-specic help output is available for some programs. Refer to the task
documentation for more details.
13.41 home
Species 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
240
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
In the command line, the following syntax is used:
--action=install --home=<home directory>
Remarks
The default for this parameter is --home=/usr/sap/<SID>/home.
This parameter is available in interactive mode.
The home directory must not be located inside a directory that is used by the SAP
HANA installation. The home directory must be a local directory on each system host,
i.e. not shared between the hosts.
13.42 hostmap
Species the host mapping to rename one host. The parameter has to be specied for each renamed host.
Syntax
In the command line, the following syntax is used:
--hostmap=<old host name>=<new host name>
or, in short form:
-H <old host name>=<new host name>
Remarks
This parameter is available in interactive mode.
Example
The following command renames two hosts, host1 and host2, to host3 and host4:
./hdblcm --action=rename_system -H host1=host3 -H host2=host4
13.43 hostname
Species the virtual host name of the system host.
Syntax
In the command line, the following syntax is used:
--hostname=<name of the host machine>
or, in short form:
-H <name of the host machine>
Remarks
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 241
Restrictions apply to host names in SAP HANA systems. Alphanumerical string of
lowercase alpha characters [a-z] and digits [0-9] and the hyphen (or minus) character
"-" are permitted. Although the newer RFCs permit hostnames beginning with digits we
recommend hostnames to begin with an alpha character. The period character "." is
only allowed to delimit components of domain names like (sapc11.sap.com). Host
names with up to 64 characters are supported.
The default for this parameter is the host name of the current machine.
This parameter is available in interactive mode.
13.44 https
Species whether or not to use HTTPS.
Syntax
In the command line, the following syntax is used:
--https
Remarks
This parameter is available in interactive mode.
13.45 ignore
Species failing prerequisite checks that the SAP HANA platform lifecycle management tools should ignore.
Syntax
In the command line, the following syntax is used:
--ignore=<check1>[,<check2>]...
Remarks
Ignores the following prerequisite checks:
Check
Description
check_busy_les Verify that the les to be modied are not
locked by a process.
check_component_dependencies Verify that all component dependencies are
resolved.
check_diskspace Verify that enough free disk space of the le
system is available.
242 PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
Check Description
check_min_mem Verify that enough physical memory on the
host is available.
check_pending_upgrade Verify if an upgrade is pending and can be
resumed.
check_platform Verify that the required gcc runtime and other
libraries are present.
check_resume_hostname Verify that the operation is resumed from the
correct host.
check_signature_le Verify that the signature le exists and has a
correct format.
check_version Verify that the version to be installed is newer
than the current one.
verify_signature Verify that the software packages are
authentic.
13.46 import_content
Imports delivery units.
Syntax
In the command line, the following syntax is used:
--import_content[=off]
Remarks
The default for this parameter is --import_content.
Related Information
SAP HANA Content
13.47 import_xs_content
Imports SAP HANA XS advanced runtime content.
Syntax
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 243
In the command line, the following syntax is used:
--import_xs_content[=off]
Remarks
The default for this parameter is --import_xs_content.
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
In the command line, the following syntax is used:
--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
In the command line, the following syntax is used:
--init_user_home_dir
13.50 install_execution_mode
Species the install execution workow. In optimized installation mode, the number of restarts is reduced
during installation.
Syntax
In the command line, the following syntax is used:
--install_execution_mode=[optimized|standard]
Remarks
The default for this parameter is --install_execution_mode=standard.
244
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
The default value changes to --install_execution_mode=optimized if a server
plug-in is being installed or if more than one component selected for installtion
supports a phased installation.
The local secure store component (LSS) can only be installed in optimized installation
mode.
13.51 install_hostagent
Enables the installation or update of the SAP host agent.
Syntax
In the command line, the following syntax is used:
--action=[install|update] --install_hostagent[=off]
Remarks
The default for this parameter is --install_hostagent (on).
13.52 install_ssh_key
Installs SSH key to access remote hosts.
Syntax
In the command line, the following syntax is used:
--action=[install|update] --install_ssh_key[=off]
Remarks
The default for this parameter is --install_ssh_key (on).
13.53 internal_network
Species the internal subset address in CIDR notation.
Syntax
In the command line, the following syntax is used:
--action=install --internal_network=<address>|none
Example
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 245
The following example species the internal network address in CIDR notation.
--internal_network=192.168.1.0/24
13.54 isc_mode
Species the inter-service communication mode.
Syntax
In the command line, the following syntax is used:
--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
In the command line, the following syntax is used:
--keep_user[=on]
or, in short form:
-k[=on]
Remarks
The default for this parameter is --keep_user (o).
This parameter is available in interactive mode.
13.56 keep_user_home_dir
Prevents the home directory of the source system administrator user (<sid>adm) from being removed.
Syntax
246
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
In the command line, the following syntax is used:
--keep_user_home_dir[=on]
Remarks
The default for this parameter is --keep_user_home_dir (o).
This parameter is available in interactive mode.
13.57 listen_interface
Species the listen interface for the internal network communication.
Syntax
In the command line, the following syntax is used:
--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
conguration 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 dene a value other than local, the local interfaces will always be open.
When using listen_interface in batch mode, the global option must be specied
in combination with --internal_network=none to disable internal network binding.
This parameter is available in interactive mode.
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
In the command line, the following syntax is used:
--action=[extract_components|install] --list_systems
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 247
or, in short form:
-L
13.59
load_initial_xs_content
Imports SAP HANA XS advanced runtime content if --import_xs_content=o was selected during installation
of the system.
Syntax
In the command line, the following syntax is used:
--load_initial_xs_content[=off]
Remarks
The default for this parameter is --load_initial_xs_content.
13.60 logbackuppath
Species the location of the log backups.
Syntax
In the command line, the following syntax is used:
--logbackuppath=<path>
Remarks
This parameter is available in interactive mode.
The path must be specied if the new directory is located on a dierent physical
storage. The contents of the directory must be moved manually to the new location.
13.61 logpath
Species the path to the log directory of the SAP HANA system.
Syntax
In the command line, the following syntax is used:
--action=install --logpath=<path to log directory>
248
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
Remarks
The default for this parameter is --logpath=/hana/log/<SID>.
This parameter is available in interactive mode.
The path must be specied if the new directory is located on a dierent physical
storage. The contents of the directory must be moved manually to the new location.
13.62 lss_groupid
Species the group ID for the local secure store.
Syntax
In the command line, the following syntax is used:
--action=install --lss_groupid=<lssgroupid>
Remarks
This parameter is available in interactive mode.
13.63 lss_inst_path
Species the installation path for local secure store.
Syntax
In the command line, the following syntax is used:
--action=install --lss_inst_path=<lssinst_path>
Remarks
The default for this parameter is --lss_inst_path=/lss/shared.
On a single-host system, the installation directory will be created automatically. On a
multiple-host system, the installation path must be created manually before the
installation of local secure store and mounted on all hosts.
This parameter is available in interactive mode.
13.64 lss_trust_unsigned_server
Instructs the Local Secure Store (LSS) to trust an unsigned SAP HANA database.
Syntax
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 249
In the command line, the following syntax is used:
--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
By specifying the lss_trust_unsigned_server parameter data and log volume
encryption keys may be leaked if the server binaries have been tampered with.
Related Information
system_usage [page 265]
13.65 lss_user_home
Species the user home directory for the local secure store.
Syntax
In the command line, the following syntax is used:
--action=install --lss_user_home=<lssuser_home_dir>
Remarks
The default for this parameter is --lss_user_home=/usr/sap/<SID>/lss/home.
This parameter is available in interactive mode.
13.66 lss_user_shell
Species the user login shell for the local secure store.
Syntax
In the command line, the following syntax is used:
--action=install --lss_user_shell=<lssuser_shell>
250
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
Remarks
The default for this parameter is --lss_user_shell=/bin/sh.
This parameter is available in interactive mode.
13.67 lss_userid
Species the user ID for the local secure store.
Syntax
In the command line, the following syntax is used:
--action=install --lss_userid=<lssuserid>
Remarks
The default for this parameter is --lss_userid=<SID>crypt.
This parameter is available in interactive mode.
13.68 max_mem
Species the maximum memory allocation for a new system in MB.
Requirements
This parameter must be used in combination with restrict_max_mem. For more
information, see Related Information.
Syntax
In the command line, the following syntax is used:
--action=install --max_mem=<MB>
Remarks
The default for this parameter is --max_mem=0.
This parameter is available in interactive mode.
Related Information
restrict_max_mem [page 257]
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 251
13.69 nostart
Prevents the SAP HANA system from being started.
Syntax
In the command line, the following syntax is used:
--nostart
13.70 nostart_tenant_db
Prevents the SAP HANA tenant databases from being started.
Syntax
In the command line, the following syntax is used:
--nostart_tenant_db
13.71 number
Species the instance number of the SAP HANA system.
Requirements
The instance number must be a two-digit number between 00 and 97.
Syntax
In the command line, the following syntax is used:
--action=install --number=<instance number>
or, in short form:
-n <instance number>
Remarks
The default value for this parameter is the next successive un-used instance number.
This parameter is available in interactive mode.
252
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
13.72 org_manager_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).
Syntax
In the command line, the following syntax is used:
--org_manager_user=<admin user>
Remarks
The default for this parameter is --org_manager_user=XSA_ADMIN.
This parameter is available in interactive mode.
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
In the command line, the following syntax is used:
--org_name=<org_name>
Remarks
The default for this parameter is --org_name=orgname.
This parameter is available in interactive mode.
13.74 overwrite_extract_dir
Overwrite the existing les in the temporary extraction directory.
Syntax
In the command line, the following syntax is used:
--action=extract_components --overwrite_extract_dir
Remarks
This parameter is available in interactive mode.
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 253
13.75 pmempath
Species the path to persistent memory volumes.
Syntax
In the command line, the following syntax is used:
--action=install --pmempath=<path>
Remarks
The default for this parameter is --pmempath=/hana/pmem/<SID>.
The parameter cannot be used in combination with the parameter
pmem_mountpoints.
This parameter is available in interactive mode.
Related Information
use_pmem [page 269]
pmem_mountpoints [page 254]
Persistent Memory
SAP Note 2618154 - SAP HANA Persistent Memory (NVM) Release Information
13.76 pmem_mountpoints
Species the mountpoints of the persistent memory volumes.
Syntax
In the command line, the following syntax is used:
--action=install --pmem_mountpoints=<mountpoint>
Remarks
The parameter cannot be used in combination with the parameter pmempath.
This parameter is available in interactive mode.
Related Information
use_pmem [page 269]
254
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
pmempath [page 254]
Persistent Memory
SAP Note 2618154 - SAP HANA Persistent Memory (NVM) Release 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
In the command line, the following syntax is used:
--action=update --prepare_update
Related Information
Prepare an Update for Flexible System Downtime [page 142]
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
In the command line, the following syntax is used:
--prod_space_name=<prod_space_name>
Remarks
The default for this parameter is --prod_space_name=PROD.
This parameter is available in interactive mode.
13.79 read_password_from_stdin
Reads passwords in XML syntax via input stream in batch mode.
Requirements
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 255
When using read_password_from_stdin in batch mode, the program looks for the
necessary passwords from the standard input stream. Therefore, the following two
requirements apply:
● Passwords must be provided in XML syntax.
● Batch mode is specied from the command line.
Syntax
In the command line, the following syntax is used:
--action=[install|update] --read_password_from_stdin=xml
Remarks
Passwords can be specied in several ways depending on your installation method of
choice. For more details, refer to the information about passwords specication.
Example
The following example shows XML data containing the passwords:
<?xml version="1.0" encoding="UTF-8"?>
<!-- Replace the 3 asterisks with the password -->
<Passwords>
<root_password><![CDATA[***]]></root_password>
<sapadm_password><![CDATA[***]]></sapadm_password>
<master_password><![CDATA[***]]></master_password>
<password><![CDATA[***]]></password>
<system_user_password><![CDATA[Abcd1234]]></system_user_password>
<lss_user_password><![CDATA[***]]></lss_user_password>
<lss_backup_password><![CDATA[***]]></lss_backup_password>
<streaming_cluster_manager_password><![CDATA[***]]></
streaming_cluster_manager_password>
<ase_user_password><![CDATA[***]]></ase_user_password>
<org_manager_password><![CDATA[***]]></org_manager_password>
</Passwords>
Related Information
Specifying Passwords [page 76]
Tutorial: Installing a Single-Host System with Passwords Read from XML Standard Input Stream [page 211]
13.80 remote_execution
Species the connectivity method for SAP HANA multiple-host system operations.
Syntax
256
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
In the command line, the following syntax is used:
--remote_execution=saphostagent|ssh
Remarks
The default for this parameter is --remote_execution=ssh.
13.81 removehosts
Species remote hosts to be removed from the SAP HANA system.
Syntax
In the command line, the following syntax is used:
removehosts=<hostname1>[,<hostname2>]...
Remarks
This parameter is available in interactive mode.
13.82 repository
Denes the source path from which the SAP HANA studio repository should be copied.
Syntax
In the command line, the following syntax is used:
--repository=<source path>
or, in short form:
-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
Species whether maximum memory allocation is restricted for a new system.
Requirements
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 257
This parameter must be used in combination with max_mem. For more information, see
Related Information.
Syntax
In the command line, the following syntax is used:
--restrict_max_mem
Remarks
This parameter is available in interactive mode.
Related Information
max_mem [page 251]
13.84 root_user
Species the root user name.
Syntax
In the command line, the following syntax is used:
--root_user=<user name>
Remarks
The default for this parameter is --root_user=root.
This parameter is available in interactive mode.
13.85 sapcar_location
Location of the SAPCAR executable.
Syntax
In the command line, the following syntax is used:
--action=extract_components --sapcar_location=<sapcar_location>
258
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
13.86 sapmnt
Species the path to the SAP mount directory, which can be used as a shared directory between multiple
hosts.
Syntax
In the command line, the following syntax is used:
--sapmnt=<installation path>
Remarks
The default for this parameter is --sapmnt=/hana/shared.
This parameter is available in interactive mode.
This parameter can be specied once and automatically subsituted throughout all
parameter defaults, which use sapmnt as part of their default value.
13.87 scope
Performs task on the SAP HANA System (all hosts) or only on the local instance.
Syntax
In the command line, the following syntax is used:
--action=update --scope=instance|system
Remarks
The default for this parameter is --scope=system.
13.88 secure_store
Species whether the SAP HANA database should use the standard SSFS secure store or Local Secure Store
(LSS).
Syntax
In the command line, the following syntax is used:
--secure_store=localsecurestore|ssfs
Remarks
The default for this parameter is --secure_store=ssfs.
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 259
Related Information
Activate the Local Secure Store (LSS) [page 185]
13.89 shell
Species a system administrator login shell. This parameter is relevant only if the operating system
administrator (<sid>adm) does not exist prior to installation.
Syntax
In the command line, the following syntax is used:
--action=install --shell=<admin login shell>
Remarks
The default for this parameter is --shell=/bin/sh.
This parameter is available in interactive mode.
13.90 sid
Species a system ID. The SAP system ID (SID) is the identier for the SAP HANA system.
Requirements
● The ID must be unique throughout your organization and consistent throughout
your SAP system installation landscape.
● If you want to install an additional application server instance, make sure that no
gateway instance with the same SAP SID exists in your SAP system landscape.
● The ID must consist of exactly three alphanumeric characters. Only uppercase
letters are allowed. The rst character must be a letter (not a digit).
● The following IDs are reserved and cannot be used: ADD ALL AMD AND ANY ARE
ASC AUX AVG BIT CDC COM CON DBA END EPS FOR GET GID IBM INT KEY LOG
LPT MAP MAX MIN MON NIX NOT NUL OFF OLD OMS OUT PAD PRN RAW REF
ROW SAP SET SGA SHG SID SQL SUM SYS TMP TOP UID USE USR VAR.
Syntax
In the command line, the following syntax is used:
--action=[install|update] --sid=<SID>
or, in short form:
-s <SID>
260
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
Remarks
This parameter is available in interactive mode.
This parameter can be specied once and automatically substituted throughout all
parameter defaults, which use sid as part of their default value.
13.91 simplified_ui
Enables simplied installation user interface.
Syntax
In the command line, the following syntax is used:
--action=[install|update] --simplified_ui
13.92 skip_hostagent_calls
Skips all SAP Host Agent calls.
Syntax
In the command line, the following syntax is used:
--action=[install|update] --skip_hostagent_calls
13.93 skip_modify_sudoers
Prevents the le /etc/sudoers from being modied.
Syntax
In the command line, the following syntax is used:
--action=[install|update] --skip_modify_sudoers
or, in short form:
-M
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 261
13.94 sld_hostname
Species the name of the host where the SLD system is installed.
Syntax
In the command line, the following syntax is used:
--sld_hostname=<host name>
Remarks
This parameter is available in interactive mode.
13.95 sld_password
Species the password for the SLD system.
Syntax
In the command line, the following syntax is used:
--sld_password=<password>
Remarks
This parameter is available in interactive mode.
13.96 sld_port
Species the standard HTTP access port of the SLD.
Syntax
In the command line, the following syntax is used:
--sld_port=<port number>
Remarks
This parameter is available in interactive mode.
262
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
13.97 sld_username
Species the user of the SLD system. It must be a user that already exists on the host where the SLD system is
running.
Syntax
In the command line, the following syntax is used:
--sld_username=<user name>
Remarks
This parameter is available in interactive mode.
13.98 source_sid
Species the source system ID if the <sapmnt>/<SID> is mounted under the new <SID>.
Syntax
In the command line, the following syntax is used:
--source_sid=<SID>
or, in short form:
-s <SID>
Remarks
This parameter is available in interactive mode.
13.99 sso_cert
Single sign-on (SSO) certicate le to authenticate sapcontrol and SAP Host Agent admin user.
Syntax
In the command line, the following syntax is used:
--action=update --sso_cert=<ssocertificate>
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 263
13.100 storage_cfg
Species a location where a global.ini is dened. It is possible to set up a storage connector, allowing SAP
HANA to use hardware vendor-specic 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
In the command line, the following syntax is used:
--action=install --storage_cfg=<directory of the storage
configuration>
Remarks
Parameter values passed by the SAP HANA database lifecycle manager (HDBLCM)
take precedence over corresponding values that are specied in a storage conguration
le.
Related Information
Multiple-Host System Concepts [page 84]
13.101 studio_path
Species the installation path for the SAP HANA studio.
Syntax
In the command line, the following syntax is used:
--studio_path=<installation path>
Remarks
The default for this parameter is --studio_path=<sapmnt>/<SID>/hdbstudio.
264
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
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 dened by copy_repository from the location dened by repository.
Syntax
In the command line, the following syntax is used:
--studio_repository[=off]
Remarks
The default for this parameter is --studio_repository (on).
Related Information
copy_repository [page 234]
repository [page 257]
13.103 system_usage
Species the usage type of the system to be installed. This setting is stored in the global.ini le, and can be
used to identify the intended usage of the system.
Syntax
In the command line, the following syntax is used:
--action=install --system_usage=[production|test|development|
custom]
Remarks
The default for this parameter is --system_usage=custom.
This parameter is available in interactive mode.
For information about implementing the next steps of the system usage type, see the
SAP HANA Administration Guide.
Related Information
Congure System Usage Type
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 265
13.104 system_user
Species the system user of the database.
Syntax
In the command line, the following syntax is used:
--action=user --system_user=<name>
Remarks
The default for this parameter is --system_user=SYSTEM.
13.105 systemdb_system_user_password
Enable the interactive input of system database user (SYSTEM) password.
Syntax
In the command line, the following syntax is used:
--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
In the command line, the following syntax is used:
--action=update --systemdb_use_singledb_user_password
13.107 tar_executable_location
Location of the TAR executable.
Syntax
266
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
In the command line, the following syntax is used:
--action=extract_components --
tar_executable_location=
<tar_executable_location>
13.108 target_sid
Species the SID for the target system.
Syntax
In the command line, the following syntax is used:
--target_sid=<new sid>
or, in short form:
-S <new sid>
Remarks
This parameter is available in interactive mode.
13.109 tenantmap
Species the tenant mapping to rename a tenant. The parameter has to be specied for each renamed tenant.
It can only be used when changing the SID, instance number, or host names of a system.
Syntax
In the command line, the following syntax is used:
--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:
./hdblcm --action=rename_system --target_sid=DEF --tenantmap
tenant1=tenant3 --tenantmap tenant2=tenant4
Related Information
Renaming a System
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 267
13.110 timeouts
Sets customized timeouts (start_instance, start_service, stop_instance, stop_service).
Syntax
In the command line, the following syntax is used:
--action=[install|update] --
timeouts=<name1>:<sec>[,<name2>:<sec>]...
13.111 unrar_executable_location
Location of the UNRAR executable.
Syntax
In the command line, the following syntax is used:
--action=extract_components --
unrar_executable_location=<unrar_executable_location>
13.112 update_component_list
Updates the list of components detected on the system. Updating the component list may be necessary, if your
technical system landscape is not reected properly inside SAP Solution Manager landscape management
database (LMDB).
Syntax
In the command line, the following syntax is used:
--action=update_component_list
13.113 update_execution_mode
Species 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
268
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
In the command line, the following syntax is used:
--action=update --update_execution_mode=[standard|optimized]
Remarks
The default for this parameter is --update_execution_mode=standard.
Related Information
Updating [page 152]
13.114 use_master_password
Species a single master password for all users, created during installation.
Syntax
In the command line, the following syntax is used:
--action=install --use_master_password=<master password>
13.115 use_pmem
Enables the use of persistent memory.
Syntax
In the command line, the following syntax is used:
--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
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 269
13.116 userid
Species 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
In the command line, the following syntax is used:
--action=install --userid=<ID number>
or, in short form:
-U <ID number>
Remarks
The default value for this parameter is the next successive un-used user ID number.
This parameter is available in interactive mode.
Related Information
Users Created During Installation [page 75]
13.117 verify_signature
Veries the signature of SAP HANA components.
Syntax
In the command line, the following syntax is used:
--action=[install|update] --verify_signature
Related Information
SAP Note 2577617 - Verifying software authenticity and integrity during SAP HANA installation and update
270
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
13.118 version
Displays the version of the SAP HANA lifecycle management program.
Syntax
In the command line, the following syntax is used:
--version
or, in short form:
-v
13.119 vm
Species the path of the Java runtime le. This parameter is only relevant if the SAP HANA studio is selected
for installation or update.
Syntax
In the command line, the following syntax is used:
--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 specied with the environment variable
JAVA_HOME.
13.120 volume_encryption
Enables data and log encryption.
Syntax
In the command line, the following syntax is used:
--volume_encryption[=off]
Related Information
Data and Log Volume Encryption
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 271
13.121 workergroup
Species the worker group of the host. If undened, the worker group is named "default". If you are using
extension node for Business Warehouse, you must name the worker group "worker_dt".
Syntax
In the command line, the following syntax is used:
--action=install --workergroup=<worker group>
Remarks
This parameter is available in interactive mode.
Related Information
Multiple-Host System Concepts [page 84]
SAP Note 2453736 - How-To: Conguring SAP HANA for SAP BW Extension Node in SAP HANA 2.0
13.122 xs_app_working_path
Species 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
In the command line, the following syntax is used:
--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
Species the path to the key of the certicate to be used by XS advanced (*.key)
Syntax
In the command line, the following syntax is used:
--xs_cert_key=<path>
272
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
13.124 xs_cert_pem
Species the path to the certicate to be used by XS advanced (*.pem)
Syntax
In the command line, the following syntax is used:
--xs_cert_pem=<path>
13.125 xs_components
Species the XS advanced runtime components to be installed or updated.
Syntax
In the command line, the following syntax is used:
--xs_components=<all>|<comp1>[,<comp2>]...
Remarks
The default for this parameter is --
xs_components=xsac_monitoring,xsac_services.
This parameter is available in interactive mode.
13.126 xs_components_cfg
Species the path to the directory containing MTA extension descriptors (*.mtaext)
Syntax
In the command line, the following syntax is used:
--xs_components_cfg=<path>
13.127 xs_components_nostart
Do not start the selected xs advanced components after installation
Syntax
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 273
In the command line, the following syntax is used:
--xs_components_nostart=all|none|comp1[,comp2]...
Remarks
The default for this parameter is --xs_components=none.
13.128 xs_customer_space_isolation
Run applications in customer space with a separate OS user
Syntax
In the command line, the following syntax is used:
--xs_customer_space_isolation[=off]
Remarks
The default for this parameter is --xs_customer_space_isolation (on).
This parameter is available in interactive mode.
13.129 xs_customer_space_user_id
OS user ID used for running XS Advanced applications in customer space
Syntax
In the command line, the following syntax is used:
--xs_customer_space_user_id=uid
Remarks
This parameter is available in interactive mode.
13.130 xs_domain_name
Species 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
274
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
In the command line, the following syntax is used:
--xs_domain_name=domain_name
Remarks
This parameter is available in interactive mode.
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 congured to act as a
reverse proxy, forwarding the requests to the xs_worker hosts.
Related Information
SAP Note 2245631 - Enabling hostname routing in SAP HANA extended application services, advanced model
xs_routing_mode [page 275]
13.131 xs_routing_mode
Species the routing mode to be used for XS advanced runtime installations.
Syntax
In the command line, the following syntax is used:
--xs_routing_mode=ports|hostnames
Remarks
The default for this parameter is --xs_routing_mode=ports.
This parameter is available in interactive mode.
Related Information
SAP Note 2245631 - Enabling hostname routing in SAP HANA extended application services, advanced model
xs_domain_name [page 274]
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 275
13.132 xs_runtime_db_tenant
The tenant database in which the XS advanced runtime is installed.
Syntax
In the command line, the following syntax is used:
--xs_runtime_db_tenant=tenant database
Remarks
The default for this parameter is --xs_runtime_db_tenant=SYSTEMDB.
This parameter is available in interactive mode.
13.133 xs_sap_space_isolation
Run applications in SAP space with a separate OS user
Syntax
In the command line, the following syntax is used:
--xs_sap_space_isolation[=off]
Remarks
The default for this parameter is --xs_sap_space_isolation (on).
13.134 xs_sap_space_user_id
OS user ID used for running XS advanced runtime applications in SAP space
Syntax
In the command line, the following syntax is used:
--xs_sap_space_user_id=uid
Remarks
This parameter is available in interactive mode.
276
PUBLIC
SAP HANA Server Installation and Update Guide
Parameter Reference
13.135 xs_trust_pem
Species the path to the trust certicate to be used by XS advanced (*.pem)
Syntax
In the command line, the following syntax is used:
--xs_trust_pem=<path>
13.136 xs_use_default_tenant
Install XS advanced in the default tenant database.
Syntax
In the command line, the following syntax is used:
--xs_use_default_tenant
Remarks
This parameter is available in interactive mode.
SAP HANA Server Installation and Update Guide
Parameter Reference
PUBLIC 277
14 Important SAP Notes
SAP Notes contain important information that can help you to successfully install, update, administer, and
work with an SAP HANA system.
SAP Note Number Title
1514967
SAP HANA: Central Note
2380229
SAP HANA Platform 2.0 - Central Note
2844322
SAP HANA Platform 2.0 SPS 05 Release Note
2932865
SAP HANA 2.0 SPS 05 Database Revision 050
2372809
Guideline for Upgrading a SAP HANA 1.0 to SAP HANA 2.0
System
1948334
SAP HANA Database Update Paths for Maintenance
Revisions
2503043
Global temporary ROW table could not be dropped
2378962
SAP HANA 2.0 Revision and Maintenance Strategy
2380291
SAP HANA 2.0 Cockpit Central Release Note
2373065
SAP HANA Runtime Tools 2.0 Release Notes
2714742
SAP Web IDE for SAP HANA 2.0 SPS 04 - Central Release
Note
2078425
Troubleshooting note for SAP HANA platform lifecycle
management tool hdblcm
2000003
FAQ: SAP HANA
2235581
SAP HANA: Supported Operating Systems
1944799
SAP HANA Guidelines for SLES Operating System
2009879
SAP HANA Guidelines for Red Hat Enterprise Linux (RHEL)
2055470
HANA on POWER Planning and Installation Specics -
Central Note
2218464
Supported products when running SAP HANA on IBM
Power Systems
278 PUBLIC
SAP HANA Server Installation and Update Guide
Important SAP Notes
SAP Note Number Title
52505
Support after end of mainstream/extended maintenance
1681092
Support for multiple SAP HANA databases on a single SAP
HANA appliance
1976729
Application Component Hierarchy for SAP HANA
1661202
Support for multiple applications on SAP HANA
1927949
Standard Behavior for SAP Logon Tickets
1906576
HANA client and server cross-version compatibility
1637145
SAP BW on HANA: Sizing SAP HANA Database
1793345
Sizing for Suite on HANA
2428875
Full-text index creation runs endlessly in Preprocessor
service.
2435642
Deprecation of legacy text mining implementation.
2560918
Broken transport of changes in HALM after source system
SID renaming
Check the current SAP Notes for the various parts of SAP HANA by searching for any of the following
application areas:
SAP HANA Native Applications
● HAN-APP - SAP HANA Native Applications
● HAN-APP-DCI - Please use HAN-APP-IOA
● HAN-APP-DWS - SAP HANA Data Warehouse Services
● HAN-APP-DWS-DDO - SAP HANA Data Distribution Optimizer
● HAN-APP-DWS-DLM - SAP HANA Data Lifecycle Manager
● HAN-APP-DWS-DSO - DataStore Object
● HAN-APP-DWS-DWS - Data Warehousing Scheduler
SAP HANA Application Services
● HAN-AS - SAP HANA Application Services
● HAN-AS-INA - SAP HANA InA Tools and Infrastructure
● HAN-AS-INA-FL - SAP HANA InA File Loader
● HAN-AS-INA-UI - SAP HANA InA Toolkit, Fiori Search UI
● HAN-AS-RPO - SAP HANA Repository
● HAN-AS-RST - SAP HANA Development Environment REST API
● HAN-AS-RUL - SAP HANA Rules Framework
● HAN-AS-XS - SAP HANA Extended Application Services
● HAN-AS-XSA - SAP HANA XS Basis Applications
SAP HANA Server Installation and Update Guide
Important SAP Notes
PUBLIC 279
● HAN-AS-XS-ADM - SAP HANA XS Administration
● HAN-AS-XSA-LIB - Please use HAN-AS-XS
● HAN-AS-XSA-SHN - SAP HANA Interactive Education (SHINE Model)
● HAN-AS-XSA-TM - SAP HANA Task management
● HAN-AS-XSA-WF - HWF (Deprecated)
● HAN-AS-XS-JOB - SAP HANA XS Scheduled Jobs
SAP HANA Accelerator for SAP ASE
● HAN-ASE - SAP HANA Accelerator for SAP ASE
HANA adaptive transaction processing
● HAN-ATP - HANA adaptive transaction processing
HANA Cloud Services
● HAN-CLS - HANA Cloud Services
● HAN-CLS-CPT - HANA Cockpit as a Service (Cloud Service)
● HAN-CLS-DB - HANA Database as a Service
● HAN-CLS-DB-ALI - HANA Service for Alicloud
● HAN-CLS-HC - HANA Cloud Services HANA Cloud
● HAN-CLS-HC-HDL - HANA Cloud HANA Data Lake
● HAN-CLS-SRC - Enterprise Search as a Service
SAP HANA Cockpit
● HAN-CPT - SAP HANA Cockpit
● HAN-CPT-ADM - SAP HANA Administration Core
● HAN-CPT-ASE - SAP HANA Accelerator for SAP ASE Administration
● HAN-CPT-BAC - SAP HANA Backup and Recovery
● HAN-CPT-CNR - SAP HANA Workload Capture and Replay
● HAN-CPT-CPT2 - SAP HANA Cockpit version 2
● HAN-CPT-CPT2-ADM - SAP HANA Cockpit 2 (Administration Core)
● HAN-CPT-CPT2-ASE - SAP HANA Cockpit 2 (Accelerator for SAP ASE Administration)
● HAN-CPT-CPT2-BAC - SAP HANA Cockpit 2 Backup and Recovery
● HAN-CPT-CPT2-CNR - SAP HANA Cockpit 2 (Capture and Replay)
● HAN-CPT-CPT2-DBX - SAP HANA Cockpit 2 Database Explorer
● HAN-CPT-CPT2-DYT - SAP HANA Cockpit 2 (Dynamic Tiering Administration)
● HAN-CPT-CPT2-EWA - SAP HANA Cockpit Early Watch Alert Support
● HAN-CPT-CPT2-LA - SAP HANA Cockpit Landscape Administration
● HAN-CPT-CPT2-MDC - SAP HANA Cockpit 2 (MDC Tenant Handling)
● HAN-CPT-CPT2-MGC - SAP HANA Cockpit Manager
● HAN-CPT-CPT2-PM - SAP HANA Cockpit 2 (Performance Monitoring)
● HAN-CPT-CPT2-REC - SAP HANA Cockpit 2 (Recommendation Application)
● HAN-CPT-CPT2-SA - SAP HANA Cockpit 2 SQL Analyzer
● HAN-CPT-CPT2-SDA - SAP HANA Cockpit 2 (Smart Data Access )
● HAN-CPT-CPT2-SDI - SAP HANA Cockpit 2 (Smart Data Integration)
● HAN-CPT-CPT2-SDS - SAP HANA Cockpit 2 (Smart Data Streaming Administration)
280
PUBLIC
SAP HANA Server Installation and Update Guide
Important SAP Notes
● HAN-CPT-CPT2-SEC - SAP HANA Cockpit 2 (Security)
● HAN-CPT-CPT2-SR - SAP HANA Cockpit 2 (System Replication)
● HAN-CPT-CPT2-SYN - SAP HANA Cockpit 2 (remote data sync)
● HAN-CPT-CPT2-TEL - HANA Express Telemetry
● HAN-CPT-CPT2-WA - SAP HANA Cockpit 2 (Workload Analyzer)
● HAN-CPT-DCC - SAP DB Control Center
● HAN-CPT-DP - Please use HAN-DP-SDI
● HAN-CPT-DYT - SAP HANA Dynamic Tiering Administration
● HAN-CPT-SDS - SAP HANA Smart Data Streaming Administration
● HAN-CPT-SEC - SAP HANA Cockpit Security
● HAN-CPT-WA - HANA Workload Analyzer
● HAN-CPT-XS - Please use HAN-AS-XS-ADM
SAP HANA Database
● HAN-DB - SAP HANA Database
● HAN-DB-AFL - Appl. Function Library - SAP Note 2198403 for subcomponents
● HAN-DB-AFL-DQ - SAP HANA Data Quality Library
● HAN-DB-AFL-EML - SAP HANA External Machine Learning Library
● HAN-DB-AFL-GEN - SAP HANA AFL Shipment and general AFL topics
● HAN-DB-AFL-HIE - SAP HANA AFL Hierarchies
● HAN-DB-AFL-PAL - SAP HANA Predictive Analysis Library
● HAN-DB-AFL-POS - SAP HANA On-Shelf Availability
● HAN-DB-AFL-SAL - SAP HANA Self Service Analytics Library
● HAN-DB-AFL-SCA - SAP HANA Supply Chain Algorithm Library
● HAN-DB-AFL-SOP - SAP HANA Sales and Operations Planning
● HAN-DB-AFL-TEC - SAP HANA AFL Technology and SDK
● HAN-DB-AFL-UDF - SAP HANA Unied Demand Forecast
● HAN-DB-AFL-VCH - Variant Conguration Library (VCH AFL)
● HAN-DB-ANO - SAP HANA Data Anonymization
● HAN-DB-BAC - SAP HANA Backup and Recovery
● HAN-DB-CDS - SAP HANA Activation of HDBDD-les (CDS Denitions)
● HAN-DB-CLI - SAP HANA Clients (JDBC, ODBC)
● HAN-DB-CLI-CVAPI - JS API to generate SAP HANA calculation models
● HAN-DB-CLI-MLAPI - HANA machine learning API
● HAN-DB-DI - SAP HANA DI (HDI): diserver, HDI pluginsand client libs
● HAN-DB-ENG - SAP HANA DB Engines
● HAN-DB-ENG-BW - SAP HANA BW Engine
● HAN-DB-ENG-ESH - SAP HANA Enterprise Search Engine
● HAN-DB-ENG-GPH - SAP HANA Graph Engine
● HAN-DB-ENG-IM - Please use HAN-DB-SDQ
● HAN-DB-ENG-MDS - SAP HANA Multidimensional Services MDS / InA
● HAN-DB-ENG-PLE - SAP HANA Planning Engine
● HAN-DB-ENG-SPA - SAP HANA Spatial Engine
● HAN-DB-ENG-SPA-ESRI - SAP HANA Spatial - Esri Geodatabase
● HAN-DB-ENG-TRX - TREX API for SAP HANA Database
SAP HANA Server Installation and Update Guide
Important SAP Notes
PUBLIC 281
● HAN-DB-ENG-TXT - SAP HANA Text Engine
● HAN-DB-EPM - SAP HANA Enterprise Performance Management Platform
● HAN-DB-EPM-PLT - SAP HANA EPM Platform
● HAN-DB-EPM-XSL - SAP HANA EPM XSJS library
● HAN-DB-HA - SAP HANA High Availability (System Replication, DR, etc.)
● HAN-DB-MDX - SAP HANA MDX Engine/Excel Client
● HAN-DB-MON - SAP HANA Monitoring
● HAN-DB-NSE - SAP HANA Native Storage Extension
● HAN-DB-PER - SAP HANA Database Persistence
● HAN-DB-PERF - SAP HANA Database Performance
● HAN-DB-R - SAP HANA Integration with R
● HAN-DB-SCR - SAP HANA SQL Script
● HAN-DB-SDA - SAP HANA Smart Data Access
● HAN-DB-SDQ - Information Mgmt Platform - smart data quality
● HAN-DB-SEC - SAP HANA Security and User Management
Dynamic Edge Processing
● HAN-DEP - Dynamic Edge Processing
● HAN-DEP-CTE - Core to Edge Processing
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
SAP HANA Dynamic Tiering
● HAN-DYT - SAP HANA Dynamic Tiering
HANA Hardware and Cloud Optimization Tool
● HAN-HCO - HANA Hardware and Cloud Optimization Tool
SAP HANA Lifecycle Management
● HAN-LM - SAP HANA Lifecycle Management
● HAN-LM-APP - SAP HANA Application Lifecycle Management
● HAN-LM-INS - SAP HANA Installation
● HAN-LM-INS-DB - Installation of HANA Database
● HAN-LM-INS-SAP - Installation of SAP Systems on HANA
● HAN-LM-PLT - SAP HANA Platform Lifecycle Management
● HAN-LM-UPG - SAP HANA Upgrade
● HAN-LM-UPG-DB - Upgrade of HANA Database
● HAN-LM-UPG-SAP - Upgrade of SAP Systems on HANA
282
PUBLIC
SAP HANA Server Installation and Update Guide
Important SAP Notes
SAP HANA Smart Data Streaming
● HAN-SDS - SAP HANA Smart Data Streaming
SAP HANA Studio (Eclipse)
● HAN-STD - SAP HANA Studio (Eclipse)
● HAN-STD-ADM - SAP HANA Studio (Eclipse) Tooling
● HAN-STD-ADM-BAC - SAP HANA Studio Backup and Recovery
● HAN-STD-ADM-DBA - SAP HANA Studio (Eclipse) Admin Tooling
● HAN-STD-ADM-PVZ - SAP HANA Plan Visualizer
● HAN-STD-ADM-SEC - SAP HANA Security and User Management (Studio)
● HAN-STD-DEV - SAP HANA Development Tools
● HAN-STD-DEV-CDS - SAP HANA Core Data Services Tools
● HAN-STD-DEV-CDS-GRA - Please use HAN-STD-DEV-CDS
● HAN-STD-DEV-DP - SAP HANA Data Provisioning Modeler
● HAN-STD-DEV-EPM - SAP HANA EPM Modeler
● HAN-STD-DEV-MOD - SAP HANA Analytical Modeling
● HAN-STD-DEV-MOD-CLT - SAP HANA Analytical Modeling Client
● HAN-STD-DEV-MOD-SRV - SAP HANA Analytical Modeling - Server Component
● HAN-STD-DEV-REF - SAP HANA Tools for Where-used, Refactoring and Mass Copy
● HAN-STD-DEV-RUL - SAP HANA Rules Editor
● HAN-STD-DEV-SCR - SAP HANA SQL Script Editor/Debugger
● HAN-STD-DEV-TP - SAP HANA Team Provider
● HAN-STD-DEV-TP-CM - SAP HANA Development Change Management
● HAN-STD-DEV-UIS - SAP HANA UI Integration Services
● HAN-STD-DEV-UIS-FLP - SAP HANA UI Integration Services
● HAN-STD-DEV-XS - SAP HANA XS Editors and Wizards
SAP Web IDE for Hana
● HAN-WDE - SAP Web IDE for Hana
● HAN-WDE-BLD - SAP Web IDE for Hana building applications
● HAN-WDE-BLD-HDB - SAP Web IDE for Hana HDB Build
● HAN-WDE-CPS - SAP Web IDE for Hana user and project settings
● HAN-WDE-DBG - SAP Web IDE for Hana debugging applications
● HAN-WDE-DBX - Database Explorer in Web IDE for SAP HANA
● HAN-WDE-DOC - SAP Web IDE for Hana documentation
● HAN-WDE-EDT - SAP Web IDE for Hana text editors
● HAN-WDE-EDT-CDS - SAP Web IDE for Hana editor for Core Data Services
● HAN-WDE-EDT-GCDS - Graphical Editor for HANA CDS
● HAN-WDE-EDT-JAVA - Java Support
● HAN-WDE-EDT-MOD - SAP Web IDE editor for HANA Analytical Modeling
● HAN-WDE-EDT-NJS - Node.js Tools
● HAN-WDE-EIM - Flowgraph, RepTasks and other SDA Tools
● HAN-WDE-FPM - SAP Web IDE for Hana feature management
● HAN-WDE-GIT - SAP Web IDE for Hana GIT
● HAN-WDE-INS - SAP Web IDE for Hana Installation
SAP HANA Server Installation and Update Guide
Important SAP Notes
PUBLIC 283
● HAN-WDE-MTA - SAP Web IDE for HANA Multi Targeted Application
● HAN-WDE-PLF - SAP Web IDE for Hana platform
● HAN-WDE-RTT - SAP Web IDE for Hana Runtime and SQL Tools
● HAN-WDE-RUN - SAP Web IDE for Hana running applications
● HAN-WDE-RUN-UI - SAP Web IDE for Hana - Run web and SAP Fiori applications
● HAN-WDE-SA - SAP HANA SQL Analyzer
● HAN-WDE-SDS - Smart Data Streaming Tools
● HAN-WDE-TPL - SAP Web IDE for Hana Project creation, template and wizards
● HAN-WDE-TXT - Text Analysis Web IDE extensions
● HAN-WDE-XSC - Old SAP HANA Web IDE
● HAN-WDE-XSC-EIM - Flowgraph, RepTasks and other SDA Tools
● HAN-WDE-XSC-MOD - Modeling
● HAN-WDE-XSC-PVZ - Performance Visualization Plugin
SAP HANA XS Advanced
● BC-XS - HANA XS Advanced
● BC-XS-CDX - SAP Cloud application programming model
● BC-XS-CDX-JAV - SAP CAP – Java runtime
● BC-XS-CDX-JAV-V1 - Java Runtime Version 1
● BC-XS-CDX-JAV-V2 - Java Runtime Version 2
● BC-XS-CDX-COR - SAP CAP– Compiler and CDS language
● BC-XS-CDX-NJS - SAP CAP – node.js runtime
● BC-XS-CDX-TLS - SAP CAP – tools, IDEs, build, deployment
● BC-XS-SRV - Services
● BC-XS-SRV-ODT - OData Service
● BC-XS-SRV-ODT-JS - OData Node.js (XSOData XS Classic use HAN-AS-XS)
● BC-XS-SRV-ODT-JAV - JAVA Runtime for Cloud Application Programming Model
● BC-XS-SRV-HSB - HANA Service Broker
● BC-XS-SRV-GIT - Git/Gerrit
● BC-XS-SRV-PTL - Hana XS Advanced Portal Services (for Fiori Launchpad)
● BC-XS-SRV-JBS - Job Scheduler
● BC-XS-SRV-ADT - Audit Log Service for XS advanced
● BC-XS-SL - Software Logistics
● BC-XS-SL-PI - XSA App Installation and Update via xs install/HALM
● BC-XS-SL-DS - MTA Lifecycle Management Operations
● BC-XS-TLS - Tools
● BC-XS-TLS-MIG - XSC to XSA Migration Assistant tooling
● BC-XS-PY - Python Runtime
● BC-XS-APR - HANA XSA / Cloud Foundry Application Router
● BC-XS-JAV - Java Runtime
● BC-XS-RT - OP Runtime / XS Controller
● BC-XS-ADM - Admin Tools
● BC-XS-SEC - UAA and Security for XS engine
● BC-XS-JS - Javascript runtime
284
PUBLIC
SAP HANA Server Installation and Update Guide
Important SAP Notes
SAP HANA Database (CCMS, Porting and DB Interface)
● BC-DB-HDB Use HAN-DB*. Here CCMS, Porting, DB Interface issues only
● BC-DB-HDB-PFW Parallelization Framework
● BC-DB-HDB-SYS Database Interface/DBMS for SAP HANA
● BC-DB-HDB-CCM CCMS / Database Monitors for SAP HANA
● BC-DB-HDB-POR DB Porting for SAP HANA
End User Clients
● BI-BIP Business intelligence platform (formerly known as BOE)
● BI-BIP-CMC Central Management Console (CMC)
● BI-BIP-CRS SAP Crystal Reports Server
● BI-BIP-IDT Information design tool
● BI-RA-AO-XLA MS Excel Add-In
● BI-RA-CR SAP Crystal Reports
● BI-RA-EXP SAP BusinessObjects Explorer
● BI-RA-WBI Web Intelligence
● BI-RA-XL Dashboard Designer
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 ).
The CIC requires a valid S-user number.
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.
SAP HANA Server Installation and Update Guide
Important SAP Notes
PUBLIC 285
Important Disclaimers and Legal Information
Hyperlinks
Some links are classied 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.
Videos Hosted on External Platforms
Some videos may point to third-party video hosting platforms. SAP cannot guarantee the future availability of videos stored on these platforms. Furthermore, any
advertisements or other content hosted on these platforms (for example, suggested videos or by navigating to other videos hosted on the same site), are not within
the control or responsibility of SAP.
Beta and Other Experimental Features
Experimental features are not part of the ocially delivered scope that SAP guarantees for future releases. This means that experimental features may be changed by
SAP at any time for any reason without notice. Experimental features are not for productive use. You may not demonstrate, test, examine, evaluate or otherwise use
the experimental features in a live operating environment or with data that has not been suciently backed up.
The purpose of experimental features is to get feedback early on, allowing customers and partners to inuence the future product accordingly. By providing your
feedback (e.g. in the SAP Community), you accept that intellectual property rights of the contributions or derivative works shall remain the exclusive property of SAP.
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.
Bias-Free Language
SAP supports a culture of diversity and inclusion. Whenever possible, we use unbiased language in our documentation to refer to people of all cultures, ethnicities,
genders, and abilities.
SAP HANA Server Installation and Update Guide
Important Disclaimers and Legal Information
PUBLIC 287
www.sap.com/contactsap
© 2022 SAP SE or an SAP aliate company. All rights reserved.
No part of this publication may be reproduced or transmitted in any form
or for any purpose without the express permission of SAP SE or an SAP
aliate company. The information contained herein may be changed
without prior notice.
Some software products marketed by SAP SE and its distributors
contain proprietary software components of other software vendors.
National product specications may vary.
These materials are provided by SAP SE or an SAP aliate company for
informational purposes only, without representation or warranty of any
kind, and SAP or its aliated companies shall not be liable for errors or
omissions with respect to the materials. The only warranties for SAP or
SAP aliate company products and services are those that are set forth
in the express warranty statements accompanying such products and
services, if any. Nothing herein should be construed as constituting an
additional warranty.
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 aliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.
Please see https://www.sap.com/about/legal/trademark.html for
additional trademark information and notices.
THE BEST RUN
