SAP HANA Server Installation Guide en

Download as pdf or txt
Download as pdf or txt
You are on page 1of 202

PUBLIC

SAP HANA Platform SPS 11


Document Version: 1.1 2016-03-29

SAP HANA Server Installation and Update Guide

Content

SAP HANA Installation and Update Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

1.1

SAP HANA Platform Software Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

1.2

Software Download. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Concepts and Requirements for an SAP HANA System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

2.1

SAP HANA System Concepts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

2.2

SAP HANA System Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

2.3

SAP HANA Deployment Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

2.4

SAP HANA Hardware and Software Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16


Recommended File System Layout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

2.5

SAP HANA and Virtualization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Using the SAP HANA Platform LCM Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

3.1

Choosing the Correct SAP HANA HDBLCM for Your Task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

3.2

Performing LCM Tasks by Program Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25


Use the Graphical User Interface to Perform Platform LCM Tasks. . . . . . . . . . . . . . . . . . . . . . . 26
Use the Command-Line Interface to Perform Platform LCM Tasks. . . . . . . . . . . . . . . . . . . . . . . 27
Using the Web User Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

3.3

Performing LCM Tasks by Program Interaction Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33


Use Interactive Mode to Perform Platform LCM Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Use Advanced Interactive Mode to Perform Platform LCM Tasks. . . . . . . . . . . . . . . . . . . . . . . . 34
Use Batch Mode to Perform Platform LCM Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

3.4

Performing LCM Tasks by Parameter Entry Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38


Entering Platform LCM Parameters Interactively. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Use LCM Configuration Files to Enter Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Entering Platform LCM Parameters as Call Options from the Command Line. . . . . . . . . . . . . . . 40

3.5

Executing Platform LCM Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41


Centralized Execution of Platform LCM Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
Decentralized Execution of Platform LCM Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45

3.6

Additional Information About Using the SAP HANA Platform LCM Tools. . . . . . . . . . . . . . . . . . . . . 46
Logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Linux Kernel Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
General Troubleshooting for the SAP HANA Platform LCM Tools. . . . . . . . . . . . . . . . . . . . . . . . 48

Installing an SAP HANA System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50

4.1

Getting Started with SAP HANA System Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50


Mandatory Installation Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
Changeable Default Values for Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Content

Users Created During Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53


Specifying Passwords. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
4.2

Installing a Single-Host System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55


Install a Single-Host SAP HANA System Using the Graphical User Interface. . . . . . . . . . . . . . . . 56
Install a Single-Host SAP HANA System Using the Command-Line Interface. . . . . . . . . . . . . . . . 58

4.3

Installing a Multiple-Host System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60


Multiple-Host System Concepts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Install a Multiple-Host SAP HANA System Using the Graphical User Interface. . . . . . . . . . . . . . . 64
Install a Multiple-Host SAP HANA System Using the Command-Line Interface. . . . . . . . . . . . . . 67

4.4

Installing a Multitenant Database Container SAP HANA System. . . . . . . . . . . . . . . . . . . . . . . . . . . 70


Install a Multitenant Database Container System Using the Graphical User Interface. . . . . . . . . . 71
Install a Multitenant Database Container System Using the Command-Line Interface. . . . . . . . . 74

4.5

Installing XS Advanced Runtime. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76


System Concepts for XS Advanced Runtime Installations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Install the XS Advanced Runtime Using the Graphical Interface. . . . . . . . . . . . . . . . . . . . . . . . . 79
Install the XS Advanced Runtime Using the Command-Line Interface. . . . . . . . . . . . . . . . . . . . . 82

4.6

System Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Updating the SAP HANA System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

5.1

Changeable Default Values for Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

5.2

Preparing for Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90


Preparing for Update in the SAP HANA Studio. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Prepare for Update Manually. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

5.3

Prepare an Update for Reduced SAP HANA System Downtime. . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

5.4

Perform an Optimized Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

5.5

Update an SAP HANA System Using the Graphical User Interface. . . . . . . . . . . . . . . . . . . . . . . . . 101

5.6

Update an SAP HANA System Using the Command-Line Interface. . . . . . . . . . . . . . . . . . . . . . . . 103

5.7

Update an SAP HANA System Using the Web User Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Managing SAP HANA System Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

6.1

Installing or Updating SAP HANA Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110


Add SAP HANA System Components from a Local Host. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Install or Update SAP HANA Components Using the Command-Line Interface. . . . . . . . . . . . . . 113
Install or Update SAP HANA Components Using the Web User Interface. . . . . . . . . . . . . . . . . . 115
Install or Update SAP HANA Components Using the Resident Program. . . . . . . . . . . . . . . . . . . 117

6.2

Remove SAP HANA System Components from a Local System Host. . . . . . . . . . . . . . . . . . . . . . . 120
Uninstall SAP HANA Components Using the Graphical User Interface. . . . . . . . . . . . . . . . . . . . 121
Uninstall SAP HANA Components Using the Command-Line Interface. . . . . . . . . . . . . . . . . . . 123
Uninstall an SAP HANA Component on a System Missing the SAP HANA Resident Program
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Uninstalling the SAP HANA System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

7.1

Uninstall the SAP HANA System Using the Graphical User Interface. . . . . . . . . . . . . . . . . . . . . . . 126

SAP HANA Server Installation and Update Guide


Content

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

7.2

Uninstall the SAP HANA System Using the Command-Line Interface. . . . . . . . . . . . . . . . . . . . . . . 127

Managing the SAP HANA System After Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

8.1

Start and Stop the SAP HANA System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

8.2

Display the Process List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

8.3

Create a Lesser-Privileged Database User for Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

8.4

Enable Data Volume Encryption. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133


Enable Data Volume Encryption with System Reinstallation. . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Enable Data Volume Encryption Without System Reinstallation. . . . . . . . . . . . . . . . . . . . . . . . 136

8.5

Change the Root Key of the Internal Data Encryption Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Tutorials. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

9.1

Tutorial: Using Custom Configuration Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

9.2

Tutorial: Installing a Multiple-Host System Using a Configuration File in Batch Mode. . . . . . . . . . . . 143

9.3

Tutorial: Overwriting Configuration File Parameters with Command Line Parameters. . . . . . . . . . . 144

9.4

Tutorial: Installing a Single-Host System with Passwords Read from XML Standard Input Stream
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

9.5

Tutorial: Automating Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147

10

Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

11

Parameter Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

11.1

action. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161

11.2

addhosts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161

11.3

add_local_roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

11.4

add_roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

11.5

ase_datapath. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .164

11.6

ase_logpath. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165

11.7

ase_user. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

11.8

autoadd_xs_roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

11.9

autostart. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

11.10

basepath_streaming. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

11.11

batch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

11.12

certificates_hostmap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

11.13

checkmnt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

11.14

check_only. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

11.15

client_path. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

11.16

component_dirs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .169

11.17

component_medium. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

11.18

component_root. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .170

11.19

components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

11.20

configfile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Content

11.21

continue_update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

11.22

copy_repository. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

11.23

custom_cfg. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172

11.24

datapath. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

11.25

db_isolation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .173

11.26

db_mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

11.27

dump_configfile_template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

11.28

es_datapath. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175

11.29

es_logpath. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175

11.30

extract_components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

11.31

groupid. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

11.32

help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

11.33

home. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

11.34

hostname. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

11.35

ignore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

11.36

import_xs_content. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

11.37

install_hostagent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

11.38

install_ssh_key. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

11.39

internal_network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

11.40

listen_interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .180

11.41

list_systems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

11.42

load_initial_xs_content. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

11.43

logpath. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .181

11.44

isc_mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .181

11.45

max_mem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

11.46

number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

11.47

org_manager_user. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

11.48

org_name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

11.49

prepare_update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .183

11.50

prod_space_name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

11.51

rdsync_downloadpath. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

11.52

rdsync_uploadpath. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

11.53

read_password_from_stdin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

11.54

remote_execution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

11.55

repository. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

11.56

restrict_max_mem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

11.57

root_user. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

11.58

sapmnt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

11.59

scope. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

SAP HANA Server Installation and Update Guide


Content

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

11.60

shell. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

11.61

sid. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

11.62

storage_cfg. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

11.63

studio_path. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

11.64

studio_repository. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

11.65

system_usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

11.66

system_user. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

11.67

timeouts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .191

11.68

update_execution_mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

11.69

userid. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

11.70

version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

11.71

vm. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

11.72

xs_components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .193

12

Important SAP Notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Content

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 efficient and optimized installation path, allowing you to customize
your SAP HANA installation by selecting which components should be installed and updated. It is also now
possible to perform installation in interactive graphical or interactive command-line interfaces, as well as
configure the SAP HANA installation to be automated, using command line, the configuration file, and batch
mode.
It is worth noting, that the SAP HANA component installation concept has changed significantly with the fastpaced development of SAP HANA itself. In the early SAP HANA Support Package Stack (SPS) releases, the
SAP HANA components had to be installed individually, which proved to be a time-consuming task. Then, the
SAP HANA unified installer was developed to streamline the installation process by installing all required
components from one call to the installer. As of SPS 08, the unified installer is no longer shipped with SAP
HANA.
With SAP HANA SPS 07, the SAP HANA database lifecycle manager was introduced to offer the efficiency of
installing all components at one time, while providing further flexibility to customize and automate the
installation. The components can now be installed, upgraded, or uninstalled from one tool, in both commandline or graphical user interface.
As of SAP HANA SPS 08, it is possible to also perform post-installation configurations tasks, such as renaming
the system, adding or removing hosts, and reconfiguring the system, using the SAP HANA database lifecycle
manager. For more information, see the SAP HANA Administration Guide.
With the SAP HANA SPS 09 release, the SAP HANA database lifecycle manager offers a third user interface the Web user interface - in addition to graphical user and command-line interfaces. 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, as of SPS 09, the SAP HANA database lifecycle manager is capable of performing all actions
offered in the SAP HANA platform lifecycle management portfolio and is the only recommended tool for these
actions. As of SPS 09, SAP HANA supports IBM Power systems.
Before starting the installation of SAP HANA, make sure that you have reviewed the SAP HANA Master Guide.

Related Information
SAP HANA Master Guide
SAP HANA Administration Guide

SAP HANA Server Installation and Update Guide


SAP HANA Installation and Update Overview

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

1.1

SAP HANA Platform Software Components

SAP HANA platform is composed of several components.


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
SAP HANA Studio
SAP HANA XS advanced runtime
SAP HANA XS Engine
SAP HANA Advanced Data Processing
SAP HANA Spatial
SAP HANA features, SAP HANA capabilities, SAP HANA options provide additional functions. To use the
SAP HANA options and SAP HANA capabilities you need a dedicated license for the options or capabilities you
want to use (see disclaimer below). SAP HANA options and SAP HANA capabilities are among others:
SAP HANA Accelerator for SAP ASE
SAP HANA Dynamic Tiering
SAP HANA Remote Data Sync
SAP Landscape Transformation Replication Server
SAP HANA Smart Data Streaming

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.

Caution
SAP HANA server software and tools can be used for several SAP HANA platform and options scenarios as
well as the respective capabilities used in these scenarios. The availability of these is based on the available
SAP HANA licenses and the SAP HANA landscape, including the type and version of the back-end systems
the SAP HANA administration and development tools are connected to. There are several types of licenses
available for SAP HANA. Depending on your SAP HANA installation license type, some of the features and
tools described in the SAP HANA platform documentation may only be available in the SAP HANA options
and capabilities, which may be released independently of an SAP HANA Platform Support Package Stack
(SPS). Although various features included in SAP HANA options and capabilities are cited in the SAP HANA
platform documentation, each SAP HANA edition governs the options and capabilities available. Based on
this, customers do not necessarily have the right to use features included in SAP HANA options and
capabilities. For customers to whom these license restrictions apply, the use of features included in SAP
HANA options and capabilities in a production system requires purchasing the corresponding software
license(s) from SAP. The documentation for the SAP HANA optional components is available in SAP Help
Portal at http://help.sap.com/hana_options. If you have additional questions about what your particular
license provides, or wish to discuss licensing features available in SAP HANA options, please contact your
SAP account team representative.

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


SAP HANA Installation and Update Overview

Note
SAP HANA information composer is a Web-based environment that allows business users to upload data to
the SAP HANA database and to manipulate that data by creating information views. The SAP HANA
information composer is installed separately from the SAP HANA system.

Related Information
SAP HANA Hardware and Software Requirements [page 16]

1.2

Software Download

In the SAP Software Download Center, you have access to the installation media and components for SAP
HANA.
You can find the installation media and components for SAP HANA in the following locations:
Installation media for an SAP HANA SPS:
SAP Software Download Center
H

SAP In-Memory (SAP HANA)

HANA PLATFORM EDIT. 1.0

Installations and Upgrades


HANA Platform Edition

A-Z Index

Installations and Upgrades -

SAP HANA PLATFORM EDITION

SAP

Installation

Support Packages and Patches for SAP HANA:


SAP Software Download Center
Patches - H

Support Packages and Patches

SAP HANA PLATFORM EDITION

A-Z Index

Support Packages and

SAP HANA PLATFORM EDIT. 1.0

The responsibility for acquiring and installing SAP HANA depends on the chosen deployment model:
If a customer chooses the SAP HANA tailored data center integration, the components of SAP HANA
have to be installed on validated hardware by a certified administrator or official SAP HANA hardware
partner.
If a customer chooses an SAP HANA appliance, the components of SAP HANA can only be installed by
certified hardware partners on validated hardware running a specific operating system. Any other system
or content developed with systems of this type is not supported by SAP. For more information, see the
information page of the product version. Support Package Stacks (SPS) can be downloaded and applied
to appliances in accordance with agreements with the respective hardware partner.

Related Information
SAP Software Download Center

SAP HANA Server Installation and Update Guide


SAP HANA Installation and Update Overview

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

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 reconfiguration.
An SAP HANA system is made up of the SAP HANA server and its components. The system can be installed on
one or multiple system hosts, which are configured to operate as worker or standby hosts. As of SAP HANA
Support Package Stack (SPS) 09, the SAP HANA system can be installed or configured to be a multitenant
database container enabled system. Where a single tenant database container system contains exactly one
database, a multitenant database container enabled system contains one system database and can contain
multiple tenant databases.
The SAP HANA database lifecycle manager offers three user interfaces: graphical, command-line, and Web.
System installation can be performed using the graphical user or command-line interface. System update, or
component installation or update can be perform using any of the three user interfaces.
The SAP HANA database lifecycle manager can be run interactively, requiring step-by-step input, or they can
be run in batch mode, requiring no subsequent input. Defining installation and update parameters can be
entered interactively, in a configuration file, or in combination with the call to the program on the command
line.

Note
The components of SAP HANA can only be installed by certified hardware partners, or any person holding
E_HANAINS certification, on validated hardware running an approved operating system.

2.1

SAP HANA System Concepts

An SAP HANA system is composed of three main components: the host, the system, and the instance.

Host

10

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Concepts and Requirements for an SAP HANA System

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.
Instance (HDB)
An SAP HANA instance (HDB) is the smallest operational unit on a host. It is the set of SAP HANA system
components that are installed on one host. A single-host system contains one instance on the one host. A
multiple-host system contains several instances distributed across the multiple hosts (one per host). Every
system has an instance number, which is a two-digit identifier. Each instance in a multiple-host system must
have the same instance number.
System
A system is one or more instances with the same number. The term "system" is interchangeable with the term
"SAP HANA database". 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).

Related Information
SAP Note 611361 - Hostnames of SAP Servers

2.2

SAP HANA System Types

An SAP HANA system can be configured as a single-host or multiple-host system using the SAP HANA
database lifecycle manager.
The SAP HANA system type definitions 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 to install an SAP HANA single-host system in one of the program interfaces, and with a combination of
parameter specification methods.
The following graphic shows the file system for a single-host installation:

SAP HANA Server Installation and Update Guide


Concepts and Requirements for an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

11

A multiple-host system is a system with more than one host, which can be configured as active worker hosts
or idle standby hosts. The SAP HANA database lifecycle manager can be used to install an SAP HANA
multiple-host system in one of the program interfaces, and with a combination of parameter specification
methods. To add hosts to an existing system, use the SAP HANA resident HDBLCM. For more information
about installing a multiple-host system, see the Related Information.

12

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Concepts and Requirements for an SAP HANA System

The following graphic shows the file system for a multiple-host system installed on a shared file system with
three hosts:

The server software is based on a flexible architecture that enables a distributed installation. This means that
load can be balanced between different hosts. The server software has to be installed in a shared file system.
This file system has to be mounted by all hosts that are part of the system.

Related Information
Installing a Multiple-Host System [page 60]

SAP HANA Server Installation and Update Guide


Concepts and Requirements for an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

13

2.3

SAP HANA Deployment Types

SAP HANA can be deployed in a number of configurations that are approved in varying degrees for production
environments (or not approved for production at all).

The server installation documentation is mainly written for SAP HANA deployment types which are completely
approved for production environments, that is to say, an SAP HANA system running on dedicated hardware,
or multitenant database container systems (also known as MDC systems).
Multitenant Database Containers (MDC)
The multitenant database container deployment type was introduced with SAP HANA Support Package Stack
(SPS) 09, and 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 not approved for
production environments.
It is possible to install an SAP HANA as a multitenant database container system using the SAP HANA
database lifecycle manager (HDBLCM). As of SPS 10, you can specify a database isolation type during
installation of a multitenant database container system. High isolation can be configured to protect against
unauthorized access at the operating-system level by separating system administrator users and providing
authenticated communication within databases. For more information, see Database Isolation in the SAP
HANA Administration Guide or the SAP HANA Security Guide and db_isolation in Related Information.
If you have an SAP HANA system which you would like to update to support multitenancy, you must first
update the SAP HANA system to revision 90 or later, and then convert the SAP HANA system to support
multitenant database containers. For more information, see Convert an SAP HANA System to Support
Multitenant Database Containers in the SAP HANA Administration Guide.
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

14

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Concepts and Requirements for an SAP HANA System

applications and scenarios listed on the "White List" included in SAP Note 1661202. If a particular packaged
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 and 2230704 in
Related Information.
Multiple Components on One System (MCOS)
MCOS deployments are characterized by multiple SAP HANA systems on one host. This configuration is
approved for production environments as of SAP HANA Support Package Stack (SPS) 09. This is restricted to
single host / scale-up scenarios only. Please keep in mind that multi-SID requires significant attention to
various detailed tasks related to system administration and performance management. For more information
about running SAP HANA virtualized, see SAP Note 1681092 in Related Information.
It is approved for production environments for SAP HANA systems to share hardware between the SAP HANA
server and SAP HANA options. As of SPS 10, you have the option to install SAP HANA systems with multiple
host roles - including database server roles and SAP HANA option host roles - on one host, or give an existing
SAP HANA host additional roles during system update. For more information about configuring additional host
roles, see add_local_roles and add_roles in Related Information.

Caution
SAP HANA server software and tools can be used for several SAP HANA platform and options scenarios as
well as the respective capabilities used in these scenarios. The availability of these is based on the available
SAP HANA licenses and the SAP HANA landscape, including the type and version of the back-end systems
the SAP HANA administration and development tools are connected to. There are several types of licenses
available for SAP HANA. Depending on your SAP HANA installation license type, some of the features and
tools described in the SAP HANA platform documentation may only be available in the SAP HANA options
and capabilities, which may be released independently of an SAP HANA Platform Support Package Stack
(SPS). Although various features included in SAP HANA options and capabilities are cited in the SAP HANA
platform documentation, each SAP HANA edition governs the options and capabilities available. Based on
this, customers do not necessarily have the right to use features included in SAP HANA options and
capabilities. For customers to whom these license restrictions apply, the use of features included in SAP
HANA options and capabilities in a production system requires purchasing the corresponding software
license(s) from SAP. The documentation for the SAP HANA optional components is available in SAP Help
Portal at http://help.sap.com/hana_options. If you have additional questions about what your particular
license provides, or wish to discuss licensing features available in SAP HANA options, please contact your
SAP account team representative.

Related Information
Install a Multitenant Database Container System Using the Graphical User Interface [page 71]
Install a Multitenant Database Container System Using the Command-Line Interface [page 74]
SAP HANA Administration Guide
SAP Note 1661202 - Support for multiple applications on SAP HANA

SAP HANA Server Installation and Update Guide


Concepts and Requirements for an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

15

SAP Note 1681092 - Multiple SAP HANA DBMSs (SIDs) on one SAP HANA system
SAP Note 1788665 - SAP HANA Support for virtualized / partitioned (multi-tenant) environments
SAP Note 2230704 - SAP HANA on IBM Power Systems with multiple - LPARs per physical host
add_local_roles [page 163]
add_roles [page 164]
db_isolation [page 173]

2.4

SAP HANA Hardware and Software Requirements

For SAP HANA, a number of hardware and software requirements apply.

Note
You can find a complete list of all SAP HANA components and the corresponding SAP HANA hardware and
software requirements in the Product Availability Matrix (PAM) on the SAP Service Marketplace, in the SAP
HANA Hardware Directory and in the SAP Community Network.

Software Requirements
Note
Only software installed by certified hardware partners, or any person holding certification, is recommended
for use on the SAP HANA system. Do not install any other software on the SAP HANA system. The
components of SAP HANA can only be installed by certified hardware partners, or any person holding
certification. Furthermore, it must be installed on validated hardware running an approved operating
system. Check the SAP Education resources for information about the SAP HANA certification exams.

Supported Hardware Platforms


SAP HANA is available for:
Intel-Based Hardware Platforms
IBM Power Systems
The following SAP HANA features, SAP HANA capabilities, and SAP HANA options are supported on Intelbased hardware platforms only:
SAP HANA Accelerator for SAP ASE
SAP HANA Ambari Cockpit
SAP HANA Hadoop Controller

16

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Concepts and Requirements for an SAP HANA System

SAP HANA Remote Data Sync


SAP HANA Smart Data Streaming
SAP HANA SPARK Controller
SAP HANA Data Provisioning Agent
SAP HANA Information Composer
For detailed information about the supported hardware, see Related Information in On-Premise in the SAP
HANA Master Guide.

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 files 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.

SAP HANA Server Installation and Update Guide


Concepts and Requirements for an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

17

Related Information
SUSE Linux Enterprise Server (SLES)
SAP Note 1944799 - SAP HANA Guidelines for SLES Operating System
SAP Note 1855805 - Recommended SLES 11 packages for HANA support on OS level
SAP Note 1824819 - SAP HANA DB: Recommended OS settings for SLES 11 / SLES for SAP Applications 11
SP2
SAP Note 1954788 - SAP HANA DB: Recommended OS settings for SLES 11 / SLES for SAP Applications 11
SP3
SAP Note 2240716 - SAP HANA DB: Recommended OS settings for SLES 11 / SLES for SAP Applications 11
SP4
Red Hat Enterprise Linux (RHEL)
SAP Note 2009879 - SAP HANA Guidelines for Red Hat Enterprise Linux (RHEL) Operating System
SAP Note 2013638 - SAP HANA DB: Recommended OS settings for RHEL 6.5
SAP Note 2136965 - SAP HANA DB: Recommended OS settings for RHEL 6.6
SLES and RHEL
SAP Note 2001528 - Linux: SAP HANA Database SPS 08 revision 80 (or higher) on RHEL 6 or SLES 11
SAP Note 2228351 Linux: SAP HANA Database SPS 11 revision 110 (or higher) on RHEL 6 or SLES 11
SAP HANA Network Requirements
Supported Hardware Platforms
SAP Certified Appliance Hardware for SAP HANA
SAP Note 1943937 - Hardware Configuration Check Tool - Central Note
SAP Note 2055470 - HANA on POWER Planning and Installation Specifics - Central Note
SAP Note 2218464 - Supported products when running SAP HANA on IBM Power Systems
General Links
SAP Training & Education
SAP Note 52505 - Support after end of mainstream/extended maintenance
SAP Note 2235581 - SAP HANA: Supported Operating Systems
Product Availability Matrix

2.4.1 Recommended File System Layout


The SAP HANA database lifecycle manager (HDBLCM) requires certain file systems in order to successfully
install an SAP HANA system.
The file systems can be defined manually before installation and then specified during installation, or the
default file systems can be used. It is important that the file systems listed below are available and have the
recommended disk space before starting the SAP HANA database lifecycle manager.
Table 1: Default File Systems
File System

Default Path

Root

18

Recommendations

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Concepts and Requirements for an SAP HANA System

File System

Default Path

Recommendations

Installation path

/hana/shared/

The mount directory is used for shared files between all hosts in an SAP
HANA system. This directory needs to be accessible to each of the servers

(sapmnt)

in the SAP HANA cluster.


Subdirectories:

/hana/shared/<SID> - Contains executable programs (exe),


globally shared data (global), instance profiles (profile), and SAP
HANA configuration files.

/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 lo
cal 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. It is possible to
join this location with the Linux installation.
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.

Data volume

Log volume

/hana/data/
<SID>

The default path to the data directory depends on the system ID of the SAP

/hana/log/
<SID>

The default path to the log directory depends on the system ID of the SAP

SAP HANA Server Installation and Update Guide


Concepts and Requirements for an SAP HANA System

HANA host.

HANA host.

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

19

It is strongly recommended to use the SAP HANA file system layout shown in the figure below:

Note
An SAP HANA system in a production environment must not share any infrastructure with another SAP
HANA system.
Hosts running more than one SAP HANA system (sometimes referred to as multiple-SID installations) can
only be used for non-production purposes such as development, quality assurance, or testing.
As of SAP HANA Support Package Stack (SPS) 11, 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
available for the production system and no longer shared. For more details, refer to the high availability
information in the SAP HANA Administration Guide.

20

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Concepts and Requirements for an SAP HANA System

The file systems /hana/data/<SID> and /hana/log/<SID> may use shared file systems like NFS, or block
storage using the SAP HANA storage connector API with non-shared file systems. For more details, see
Related Information.
The installation path (/hana/shared) is visible on all hosts. By default, the installation path is also used for
backup. However, backup directories should be manually configured, and must belong to a shared file system.
For more details, refer to the backup information in the SAP HANA Administration Guide.

Related Information
SAP HANA Administration Guide
Multiple-Host System Concepts [page 61]

2.5

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 in Related Information.

VMware vSphere
SAP HANA is supported on VMware vSphere for scale-up, multi-VM and scale-out production environments,
including SAP Tailored Center 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 in Related Information.

Hitachi LPAR
Hitachi Unified Compute Platform for the SAP HANA Platform with logical partitioning (LPAR) in a scale-up or
multi-VM configuration is a pre-configured virtual appliance ready to plug into a network to provide real-time
access to operational data for use in analytic models. SAP HANA on Hitachi solutions with logical partitioning
are based on a number of bare metal appliance configurations with modifications that are required for running
logical partitions (LPARs) in dedicated mode. For more information, see Hitachi Unified Compute Platform for
the SAP HANA Platform with Logical Partitioning in a Scale-up Configuration using Hitachi Compute Blade 500
and Hitachi Unified Storage VM in Related Information.

SAP HANA Server Installation and Update Guide


Concepts and Requirements for an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

21

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 in Related
Information.

Red Hat Enterprise Linux KVM Hypervisor


SAP HANA is supported on the KVM (Kernel-based Virtual Machine) hypervisor in a non-production
environment. For more information, see SAP HANA on KVM: Best Practices Resource Guide in Related
Information.

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 in Related Information.

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 in Related Information.

Related Information
SAP Note 1788665 - SAP HANA Support for virtualized / partitioned (multi-tenant) environments
Best Practices and Recommendations for Scale-up Deployments of SAP HANA on VMware vSphere
Best Practices and Recommendations for Scale-Out Deployments of SAP HANA on VMware vSphere
Hitachi Unified Compute Platform for the SAP HANA Platform with Logical Partitioning in a Scale-up
Configuration using Hitachi Compute Blade 500 and Hitachi Unified Storage VM
Best Practices for Deploying SAP HANA on Huawei FusionSphere Virtualization Platform
Guide for Deploying SAP HANA on Huawei FusionSphere Virtualization
SAP HANA on KVM: Best Practices Resource Guide
SAP Note 2284516 - SAP HANA virtualized on SUSE Linux Enterprise hypervisors
IBM PowerVM Best Practices

22

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Concepts and Requirements for an SAP HANA System

SAP HANA Master Guide

SAP HANA Server Installation and Update Guide


Concepts and Requirements for an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

23

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 configuring an SAP HANA system. The SAP
HANA database lifecycle manager is designed to accommodate hardware partners and administrators, and so
it offers a variety of usage techniques.
The SAP HANA database lifecycle manager is used by means of program interface type, program interaction
mode, and parameter entry mode. Before using the SAP HANA database lifecycle manager, you should
choose which user interface you prefer to use and how you want to modify the platform LCM task to achieve
your desired result. You modify the actions of the platform LCM tools using parameters. Parameters can be
modified in a number of ways, for example, in the entry field of a graphical interface, as a call option with the
program call, or in a configuration file. These options can be mixed and matched depending on the parameters
you need to use and the program interaction mode you choose.

Performing LCM Tasks by Program Interface [page 25]


Use the Web User Interface to Perform Platform LCM Tasks [page 30]
Use the Graphical User Interface to Perform Platform LCM Tasks [page 26]
Use the Command-Line Interface to Perform Platform LCM Tasks [page 27]
Performing LCM Tasks by Program Interaction Mode [page 33]
Use Interactive Mode to Perform Platform LCM Tasks [page 33]
Use Advanced Interactive Mode to Perform Platform LCM Tasks [page 34]
Use Batch Mode to Perform Platform LCM Tasks [page 36]
Performing LCM Tasks by Parameter Entry Method [page 38]
Entering Platform LCM Parameters Interactively [page 38]
Entering Platform LCM Parameters as Call Options from the Command Line [page 40]
Use LCM Configuration Files to Enter Parameters [page 39]
The first choice to make is which SAP HANA database lifecycle manager (HDBLCM) interface type you prefer
to use. The SAP HANA HDBLCM program can be run as a graphical user interface, a command-line interface,
or as Web user interface in a Web browser or from the SAP HANA studio (the Web user interface is not
available for all platform LCM tasks).

24

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

Once you've chosen the graphical user, command-line, or Web user interface, you can decide if you prefer to
interactively enter parameter values, or give all required parameters with the call to the platform LCM tool, and
let it run unattended to completion. Interactive mode is available for all user interfaces, and is the default mode
for program interaction. To use interactive mode, you simply call the SAP HANA HDBLCM user interface, and
enter parameter values as they are requested by the program. Advanced interactive mode involves entering
some parameter values interactively and providing some parameter values as call options or in a configuration
file. This is the recommended interaction mode if you'd like to modify parameter default values which are not
requested in interactive mode. Batch mode is an advanced platform LCM interaction method because all
required parameters must be provided with the call to the LCM program on the command line. Batch mode is
designed for large-scale platform LCM tasks, which would be time consuming to perform interactively.
Platform LCM parameters can be entered interactively (only available for interactive mode or advanced
interactive mode), as a call option on the command line, or via a configuration file. If you are performing
platform LCM tasks in advanced interactive mode, you can choose any of the three parameter entry methods
(or use more than one). If you are using batch mode, you must enter parameter values either as call options to
the SAP HANA database lifecycle manager or from a configuration file. The syntax for the parameters as call
options can be found in the Parameter Reference. The configuration file is generated as a blank template, then
edited, and called as a call option.

3.1

Choosing the Correct SAP HANA HDBLCM for Your


Task

It is important to distinguish between the version of the SAP HANA database lifecycle manager (HDBLCM)
that is available on the installation medium and the version that is unpacked during installation, and
subsequently used to perform administration and configuration tasks after the SAP HANA system has been
installed.
The SAP HANA database lifecycle manager is available in two varieties - an installation medium version to
perform installation and update, and a resident version for update and configuration that is unpacked on the
SAP HANA host during installation or update. The SAP HANA resident HDBLCM has been designed to be
version-compatible. That means, every time you install or update an SAP HANA system, you can be sure that
any subsequent configuration tasks performed with the SAP HANA database lifecycle manager will work as
expected because the installation or update tool and the configuration tool are of the same version and have
been tested together. The SAP HANA resident HDBLCM is available with SAP HANA Support Package Stack
(SPS) 08 and later. If you have a pre-resident version of SAP HANA installed (anything SPS 07 or earlier), you
would need to first update the system with a more recent version in order to perform the configuration tasks.
The SAP HANA resident HDBLCM is located at <sapmnt>/<SID>/hdblcm.

3.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.

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

25

3.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. Configuration tasks are
performed using the SAP HANA resident HDBLCM. For more information about the two SAP HANA
database lifecycle manager types, see Related Information.
2. Start the SAP HANA platform lifecycle management tool:
./hdblcmgui
3. Enter parameter values in the requested fields.

Related Information
Choosing the Correct SAP HANA HDBLCM for Your Task [page 25]

26

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

3.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. Configuration tasks are
performed using the SAP HANA resident HDBLCM. For more information about the two SAP HANA
database lifecycle manager types, see Related Information.
2. 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 interactive mode and
requests values for any parameter values which you didn't specify in the original input. If you entered
the batch mode call option, the program runs to completion without any further requests, unless a
mandatory parameter was left out of the original input, in which case, the program fails to perform the
platform LCM task.
Configuration file parameter entry - If you enter parameter key-value pairs in the configuration file
template, and enter the configuration file path as a call option with the call to the SAP HANA platform
LCM tool, the program runs in 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.

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

27

Note
If parameter key-value pairs are specified as command-line options, they override the corresponding
parameters in the configuration file. Parameters in the configuration file override default settings.
Order of parameter precedence:
Command Line > Configuration 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 25]
Performing LCM Tasks by Parameter Entry Method [page 38]
Performing LCM Tasks by Program Interaction Mode [page 33]

3.2.3 Using the Web User Interface

3.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 configuration, the SAP HANA system deploys its artifacts on the SAP Host
Agent, thus enabling the Web user interface.
All Web user interface actions are always performed in the context of an already installed and registered SAP
HANA system. In order to access the SAP HANA database lifecycle manager Web user interface you need to
log on as the system administrator user <sid>adm.
The communication between the Web browser and the SAP Host Agent is always done over HTTPS, which
requires that the SAP Host Agent has a secure sockets layer (SSL) certificate (PSE) in its security directory.
For more information about SSL certificate handling, see Related Information.
The backend is provided by the special executable hdblcmweb, which is started automatically by the SAP Host
Agent as soon as an action is triggered from the Web user interface and terminates after the action completes.

Note
You should never start hdblcmweb manually. For security reasons, hdblcmweb is always started with
system administrator user <sid>adm privileges. If you require logging with individual users (to ensure
personalized logging), use the SAP HANA database lifecycle manager graphical user or command-line
interface.

28

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

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 first step before even starting the update process, you are
required to enter a location of an SAP HANA database installation kit. After detecting the kit, the update Web
user interface is loaded from the installation kit and the installation kit SAP HANA database lifecycle manager
starts serving as backend until the update process finishes. It is as if you start the SAP HANA database
lifecycle manager directly from the installation kit in graphical user or command-line interface.

Related Information
Secure Sockets Layer (SSL) Certificate Handling [page 43]

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

29

3.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 Platform Lifecycle Management view within the SAP HANA studio.

Prerequisites
You should verify that the following prerequisites are fulfilled 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 fulfilled:
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 .

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 in Related
Information.
You are logged on with the required root user or system administrator user <sid>adm credentials.
You should verify that the following additional prerequisites are fulfilled before trying to access the SAP HANA
database lifecycle manager from the SAP HANA studio.
The SAP HANA studio revision is 90 or higher.
For Linux:
The system property org.eclipse.swt.browser.XULRunnerPath should be set in
hdbstudio.ini to point to the path of XULRunner, for example:
-Dorg.eclipse.swt.browser.XULRunnerPath=<path to xulrunner>.
This hdbstudio.ini file is located in the same folder as the executable that is used to start the SAP
HANA studio. For Linux, the default location is hana/shared/<SID>/hdbstudio..

30

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

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
Configure System Landscape Directory (SLD) registration
Configure inter-service communication
When performing installation and update tasks, various parameters can be set in the Advanced Parameters
Configuration dialog. To access the Advanced Parameters Configuration dialog, click on the gear icon in the
footer bar of the SAP HANA HDBLCM Web user interface.

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
Studio

1. Start the SAP HANA studio.


2. In the SAP HANA studio, add the SAP HANA system.
3. Open the context menu (right-mouse click) in the Systems view, and select Add System.
For more information about adding a system, see Add an SAP HANA System in the SAP HANA Adminis
tration Guide in Related Information.
4. In the SAP HANA studio, log on to the system.
5. From the context menu of the selected system, select
Management

SAP HANA
Cockpit

1.

Lifecycle Management

SAP HANA Platform Lifecycle Management

Platform Lifecycle

Enter the SAP HANA cockpit URL in your browser.


The URL depends on whether you are connecting to a single-container system or to a database in a
multiple-container system.
A single-container system is accessed through the URL: http://<host_FQDN>:

80<instance>/sap/hana/admin/cockpit
For more information about the URLs in multiple-container systems, see Configure HTTP Access to
Multitenant Database Containers.

Note
FQDN = fully qualified domain name

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

31

Option

Description
2. The SAP HANA Platform Lifecycle Management tiles are visible on the homepage of the SAP HANA
cockpit. If they are not, you can add them from the SAP HANA Platform Lifecycle Management tile cata
log. For more information, see Customizing the Homepage of SAP HANA Cockpit.

Results
The SAP HANA database lifecycle manager is displayed as a Web user interface in either a standalone browser
or in the SAP HANA studio.

Related Information
SAPUI5 Developer Guide
SAP HANA Administration Guide

3.2.3.3

Log Off From an SAP HANA System

In the SAP HANA database lifecycle manager (HDBLCM) Web user interface, you can log off from an SAP
HANA system and close all connections to the system. To be able to connect to system again, you must log on.

Procedure
To log off 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.

32

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

3.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

3.3

Performing LCM Tasks by Program Interaction Mode

3.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
To access the SAP HANA database lifecycle manager Web user interface, see Related Information.

Procedure
1. Change to the directory where the SAP HANA database lifecycle manager is located:

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

33

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. Configuration tasks are
performed using the SAP HANA resident HDBLCM. For more information about the two SAP HANA
database lifecycle manager types, see Related Information.
2. Start the SAP HANA platform lifecycle management tool:
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 configuration file. The program runs in interactive mode and requests any missing parameters
values, which must be verified or changed. You are provided with a summary of parameter values, which
you can accept to run the program to completion, or reject to exit the program.

Related Information
Choosing the Correct SAP HANA HDBLCM for Your Task [page 25]
Use the Web User Interface to Perform Platform LCM Tasks [page 30]

3.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 perfom platform LCM tasks in interactive mode, but would like to enter call options not available in
interactive mode, or make use of the configuration file, you can use a combination of interactive mode and
advanced parameter entry methods.

34

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

Context
The SAP HANA platform LCM tools offer a wide variety of parameters which can modify the platform LCM task
you are performing. Some parameters can be modified in interactive mode when the graphical user,
command-line, or Web user interface requests a value for a given parameter. However, some parameters are
not available in interactive mode, and must be specified either as a call option with the call to the platform LCM
tool, or from within a configuration file.

Procedure
1. Review which parameters are offered in interactive mode.
If the parameter you want to configure 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 configuration file template, and edit the parameters value in the
configuration file. Then call the configuration file as a call option with the call to the platform LCM tool.
Using the configuration file for interactive mode is recommended if you plan to perform the exact same
platform LCM task multiple times.
2. Change to the directory where the SAP HANA database lifecycle manager is located:
Option

Description

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. Configuration tasks are
performed using the SAP HANA resident HDBLCM. For more information about the two SAP HANA
database lifecycle manager types, see Related Information.
3. If you plan to use a configuration file, prepare it with the following steps:
a. Generate the configuration file template using the SAP HANA platform lifecycle management tool:
Run the SAP HANA platform LCM tool using the parameter dump_configfile_template as a call
option. Specify an action and a file path for the template. A configuration file template and a password
file template are created.
./hdblcm --action=<LCM action> --dump_configfile_template=<file path>
b. Edit the configuration file parameters. Save the file.
c. Edit the password file. Save the file.
4. Start the SAP HANA platform lifecycle management tool:

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

35

Start the SAP HANA database lifecycle manager in either the graphical user interface or in the commandline interface, with a call option:
./hdblcmgui --<parameter key>=<parameter value>
or
./hdblcm --<parameter key>=<parameter value>
If you are using a configuration file, you must you the call option --configfile=<file path>.

Related Information
Choosing the Correct SAP HANA HDBLCM for Your Task [page 25]

3.3.3 Use Batch Mode to Perform Platform LCM Tasks


Batch mode is a method for running SAP HANA platform lifecycle management (LCM) tools which starts the
program and runs it to completion without requiring you to interacte with it any further. Batch mode must be
run with the SAP HANA platform LCM command-line tools. All required parameter values must be passed as
call options or from a configuration file.

Prerequisites
When using batch mode, passwords must either be defined in the configuration file, or passed to the
installer using an XML password file and streamed in via standard input. In both cases, it is necessary to
prepare the passwords. For more information, see Specifying Passwords.

Context
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:

36

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

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. Configuration tasks are
performed using the SAP HANA resident HDBLCM. For more information about the two SAP HANA
database lifecycle manager types, see Related Information.
2. Start the SAP HANA platform lifecycle management tool:
./hdblcm --batch <additional parameters>
or
./hdblcm -b <additional parameters>
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 file) or in a configuration file. 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 specified from the command line. The system passwords are read from a
standard input stream by the installer. All other parameter defaults are automatically accepted and no
other input is requested in order to complete the installation.
cat ~/hdb_passwords.xml | ./hdblcm --batch --action=install -components=client,server --sid=DB1 --number=42 --read_password_from_stdin=xml
If a configuration file is used in combination with batch mode, an identical system can be installed with a
simplified call from the command line. In the following example, passwords are defined in the configuration
file, in addition to the action, components, SAP system ID, and instance number.
./hdblcm --batch --configfile=/var/tmp/H01_configfile

Related Information
Specifying Passwords [page 54]
read_password_from_stdin [page 185]
sid [page 189]

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

37

Use LCM Configuration Files to Enter Parameters [page 39]


Entering Platform LCM Parameters as Call Options from the Command Line [page 40]

3.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 of command prompt, as commandline options with the call to the platform LCM tool, or in a configuration file.
SAP HANA platform lifecycle management parameter values allow you to customize your SAP HANA
installation, update, or configuration. Parameter values can be entered by one or more of the following
methods:
Interactively
(Default)

Using either command line interface or graphical interface, most parameters are
requested interactively. Default parameter values are proposed in brackets and can be
changed or confirmed. Parameters that are not requested (or specified via another
method) accept the default value.

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 specified parameters replace the defaults.
If any mandatory parameters are excluded, they are requested interactively (unless batch
mode is specified). All parameters can be entered from the command line. For more
details about the accepted parameter syntax, see the inline help output (--help) for the
individual SAP HANA lifecycle management tool.

Configuration
File

The configuration file is a plain text file, 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 specified, they are requested interactively (unless
batch mode is used). All parameters can be entered in the configuration file. For more
information about the configuration file, see Related Information.

Note
If parameters are specified in the command line, they override the corresponding parameters in the
configuration file. Parameters in the configuration file override default settings.
Order of parameter precedence:
Command Line > Configuration File > Default

3.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 .

38

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

Not all parameters are requested in interactive mode. If you would like to configure a parameter not offered in
interactive mode, you must enter it as a call option with the call to the platform LCM program, or use
corresponding configuration file for the platform LCM task.

3.4.2 Use LCM Configuration Files to Enter Parameters


By defining a prepared configuration file during installation, specified parameter values are used by the SAP
HANA platform lifecycle management (LCM) tools to build a customized SAP HANA system.

Context
The configuration file is a plain text file of specified parameters, written in the same syntax as in the command
line (except without the leading two dashes --). A configuration file template can be generated, edited, and
saved to be called with the call to the SAP HANA database lifecycle manager (HDBLCM).
The configuration file 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. Configuration tasks are
performed using the SAP HANA resident HDBLCM. For more information about the two SAP HANA
database lifecycle manager types, see Related Information.
2. Generate the configuration file template using the SAP HANA platform lifecycle management tool:
Run the SAP HANA platform LCM tool using the parameter dump_configfile_template as a call
option. Specify an action and a file path for the template. A configuration file template and a password file
template are created.
./hdblcm --action=<LCM action> --dump_configfile_template=<file path>

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

39

3. Edit the configuration file parameters. Save the file.


It is recommended that at least the SAP system ID (sid) and the instance number (number) are uniquely
defined. There are several required parameters, that are provided default values in case they are not
customized. For more information, refer to the default values.
Some file path parameters have automatic substitution values as part of the default file path, using the
sid (SAP HANA system ID) and sapmnt (installation path) parameters, so that the substituted values
create file paths that are unique and system-specific. For example, the default for the data file path is:
datapath=/hana/data/${sid}, where sid is automatically replaced by the unique SAP HANA system
ID.
4. Start the SAP HANA platform lifecycle management tool:
Run the SAP HANA platform LCM tool using the parameter configfile as a call option. Specify the file
path of the edited template.
./hdblcm --configfile=<file path>
You can specify the path to a directory in which custom configuration files are saved using the parameter
custom_cfg as a call option.

Related Information
configfile [page 171]
custom_cfg [page 172]
Choosing the Correct SAP HANA HDBLCM for Your Task [page 25]

3.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 configuration file, but would like to override a parameter in the configuration file with a new
value.
You are installing an SAP HANA multiple-host system from the command line.
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.

40

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

3.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 first on a worker host, and then re-executed manually on each remaining host. This method is
considered decentralized execution.
The following is an example of an SAP HANA system update performed centrally and decentrally.

3.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 certificate keys and the remote execution
configuration.
In previous SAP HANA releases, it was only possible to execute centralized multiple-host system tasks on
remote hosts via secure shell (SSH) by providing root credentials. As of SAP HANA Support Package Stack
(SPS) 09, it is possible to perform all platform LCM tasks via HTTPS by using the SAP Host Agent.

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

41

3.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 configured so that future platform LCM tasks can be performed remotely on multiple-host SAP HANA
systems without requiring the root user password.
By default, the SAP HANA database lifecycle manager (HDBLCM) uses SSH during SAP HANA system
installation or update install the SAP Host Agent on all system hosts. In order to use SSH, the SFTP subsystem
must be active. 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.

Related Information
1944799 - SAP HANA Guidelines for SLES Operating System Installation
2009879 - SAP HANA Guidelines for Red Hat Enterprise Linux (RHEL) Operating System

3.5.1.2

Using SAP Host Agent to Execute Platform LCM


Tasks

In previous SAP HANA releases, it was only possible to perform multiple-host system tasks by providing root
credentials and executing platform on remote hosts via secure shell (SSH). Since SAP HANA Support Package
Stack (SPS) 09, it has been possible to perform platform LCM tasks without root credentials by using the SAP
Host Agent.
Even though the SAP Host Agent is not required to be installed on the SAP HANA system, the SAP HANA
database lifecycle manager (HDBLCM) heavily relies on it 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 for offline administration also 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. For more information, see SAP HANA Cockpit for Offline
Administration.
The SAP Host Agent is installed and updated by default during SAP HANA system installation and update,
unless the call option --install_hostagent=off is used. We recommend installing and updating the SAP

42

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

Host Agent with the SAP HANA server to ensure version compatibility, however in some cases you may need
to install or update only the SAP Host Agent. For information about installing or updating the SAP Host Agent
individually, see Installing SAP Host Agent Manually and Upgrading SAP Host Agent Manually in Related
Information.
If execution on the remote hosts is done via SSH (default, --remote_execution=ssh), the SAP HANA
database lifecycle manager is able to connect to a remote host via SSH and install and configure the SAP Host
Agent. In contrast, the remote execution via SAP Host Agent (--remote_execution=saphostagent)
requires that the SAP Host Agent is installed and configured on all involved hosts in advance, which includes:
Install SAP Host Agent
Configure a Secure Sockets Layer (SSL) certificate for the SAP Host Agent, so that the HTTPS port 1129 is
accessible. For more information about SSL configuration for the SAP Host Agent, see Related
Information. If you dont want to configure HTTPS, it is also possible to use the call option --use_http. It
tells the SAP HANA database lifecycle manager to communicate with the SAP Host Agent via HTTP.
During addition of new host to an SAP HANA system (also during installation of a multiple-host system),
the HTTPS of the SAP Host Agent is automatically configured 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
Installing SAP Host Agent Manually
Updating SAP Host Agent Manually
SSL Configuration for the SAP Host Agent

3.5.1.2.1

Secure Sockets Layer (SSL) Certificate Handling

To enable secure communication with the SAP Host Agent over HTTPS, the SAP Host Agent needs a secure
sockets layer (SSL) certificate in its security directory. This certificate is also used by the SAP HANA database
lifecycle manager (HDBLCM) Web-based user interface and the SAP HANA cockpit for offline administration
because the Web pages are served by the SAP Host Agent.
The SAP HANA database lifecycle manager handles certificate management during system installation,
update, or rename, as well as during the addition of new hosts as follows:
If there is no certificate in the SAP Host Agent security directory, the SAP HANA database lifecycle
manager generates one. The SAP HANA host name is used as the default certificate owner. The certificate
owner can be changed by using the call option --certificates_hostmap.
If there is an existing certificate, the following applies:
If the certificate host name is not passed to the SAP HANA database lifecycle manager, or if the
certificate host name is the same as the owner of the current certificate, the current certificate is
preserved.

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

43

If the certificate host name is passed via the call option --certificates_hostmap and it differs
from the owner of the current certificate, a new certificate is generated.
During update of an SAP HANA system, if the certificates on all hosts are in place, the call option -certificates_hostmap is ignored and the current certificates are preserved.
If you want to use your own SSL certificates, see the SAP Host Agent documentation in Related Information.

Related Information
certificates_hostmap [page 167]
SAP HANA Server Installation and Update Guide
SSL Configuration for the SAP Host Agent

3.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 configuration
Inter-service communication configuration

Note
The SAP HANA cockpit for offline administration also 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. For more information, see SAP HANA Cockpit for Offline
Administration.
Make sure that SAP Host Agent is installed and configured (HTTPS-enabled) on all hosts of the SAP HANA
system.

Note
Platform LCM tasks cannot be executed remotely via SSH as the system administrator user <sid>adm.

44

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

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).

3.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 configuration, can be performed on a multiple-host system from one host. This is referred to
as centralized execution and requires SSH or root credentials. For more information, see Centralized
Execution of Platform LCM Tasks in Related Information.
In some circumstances, a secure shell (SSH) key may not be installed or root credentials are not available. In
this case, the platform LCM actions must be executed on each individual host of the multiple-host system,
which is also known as decentralized execution. For more information about decentralized execution, see
SAP Note 2048681 in Related Information.

Related Information
SAP Note 2048681 - Performing SAP HANA platform lifecycle management administration tasks on multiplehost systems without SSH or root credentials
Executing Platform LCM Tasks [page 41]
Centralized Execution of Platform LCM Tasks [page 41]
SAP HANA Administration Guide

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

45

3.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 where log files and traces are stores, Linux kernel
parameter settings, or using the underlying LCM tools for troubleshooting purposes.

3.6.1 Logging
SAP HANA platform lifecycle management processes are logged by the system. The log files are stored in the
following path:
/var/tmp/hdb_<SID>_<action>_<time stamp>
where <action> :: = install | update | addhost | uninstall | and so on.
The following log files 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 files, makes a detailed
analysis more easy
You can also view the last three log files in the SAP HANA studio using the administration function Diagnosis
Files. For more information, see the SAP HANA Administration Guide.
Instant Logging
If an LCM action crashes or hangs before the execution is finished, even if no LCM action trace is enabled,
HDBLCM writes a trace, which has the function of a preliminary (unformatted) log file. Upon program
completion, this preliminary logfile is removed and replaced by the real, formatted log file.
The environment variable 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 files are collected to a local
folder to make error analysis more convenient.
To collect log files 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 file in to the
following directory: <installation path>/<SID>/HDB<instance number>/<host name>/trace

Related Information
SAP HANA Administration Guide

46

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

3.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.
Table 2:
Parameter

Description

Value

Location

nofile

Open file descriptors per user

1048576

/etc/security/
limits.conf

fs.file-max

Open file descriptors per host

20000000

/etc/
sysctl.conf

fs.aio-max-nr

Maximum number of asynchronous I/O re

0x20000 +
<number of
existing
databases> *
0x10000

/etc/
sysctl.conf

/etc/
sysctl.conf

0x40000000 (1
GB)

/etc/
sysctl.conf

quests

vm.memory_failu
re_early_kill

Method for killing processes when an uncor

kernel.shmmax

Maximum shared memory segment size

kernel.shmmni

Maximum number of shared memory segments

kernel.shmall

rected memory error occurs

RAM
256GB
=> 524288

RAM
64 GB
=> 65536

RAM
4096

/etc/
sysctl.conf

64GB =>

pages

shmmax / 4096 *
(shmmni / 16)

/etc/
sysctl.conf

net.ipv4.ip_loc
al_port_range

Lower limit of ephemeral port range

40000

/etc/
sysctl.conf

vm.max_map_coun
t

Maximum number of Virtual Memory Areas

1000000 + (RAM
in TB) *
100000000

/etc/
sysctl.conf

System-wide limit of total shared memory, in

(VMAs) that a process can own

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

47

3.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 affected underlying tools.

Caution
We only recommend the following underlying tools to be used for troubleshooting purposes.
Table 3:
Program Name

Description

Location

hdbinst

Command-line tool for installing the software

Installation media

hdbsetup

Installation tool with a graphical interface for instal

Installation media

ling or updating the software


hdbuninst

Command-line tool for uninstalling the software 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 software

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 sys

<installation path>/<SID>/

tem

global/hdb/install/bin
and

/usr/sap/<SID>/SYS/
global/hdb/install/bin

48

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Using the SAP HANA Platform LCM Tools

Program Name

Description

Location

hdbremovehost

Command-line tool for removing a host

<installation path>/<SID>/
global/hdb/install/bin
and

/usr/sap/<SID>/SYS/
global/hdb/install/bin
hdbmodify

This command line tool removes and adds remote

<installation path>/<SID>/

hosts.

global/hdb/install/bin

Furthermore, the listen interface can be changed ('lo and


cal', 'global', 'internal').

/usr/sap/<SID>/SYS/
global/hdb/install/bin

hdbupdrep

Command-line tool for upgrading a repository by

<installation path>/<SID>/

loading delivery units into the database

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
2016 SAP SE or an SAP affiliate company. All rights reserved.

49

Installing an SAP HANA System

The SAP HANA database lifecycle manager (HDBLCM) is the program used to install an SAP HANA system,
including server, client, studio, and additional components, in a graphical user interface or the command-line
interface. The SAP HANA system can be uninstalled or configured using the resident version of the SAP HANA
database lifecycle manager (HDBLCM).

4.1

Getting Started with SAP HANA System Installation

Installation parameters are a fundamental aspect of the SAP HANA database lifecycle manager (HDBLCM),
and provide the opportunity to optimize and customize the system during installation.
Installation parameters are used for all methods of parameter specification - interactively, as command line
options, or with the configuration file. The following information is relevant for either installation mode
(interactive mode or batch mode).

4.1.1 Mandatory Installation Values


The only mandatory parameter without a default value is the SAP system ID (SID, sid), which must be
specified. However, it is also recommended to define an instance number (number), since these two
parameters are meaningful to the identity of the system.
If the installation is run in batch mode from the installation medium, the minimum required parameters are the
SID and the passwords (specified in XML syntax and streamed in, or specified in the configuration file). In the
case that only the SID and passwords are entered as parameters, the other parameters automatically take
their default value.
In batch mode, if one of the mandatory parameters, without a default, is not specified, the installation fails with
an error. If an installation is not run in batch mode, but in interactive mode (default) instead, the missing
mandatory parameters are requested in the console.
When building a multiple-host system, the action and addhosts parameters are mandatory command-line
specifications for the SAP HANA database lifecycle manager.

4.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 predefined values on the current host. In a multiple-host system, it is
recommended to manually check the mandatory values on each hosts before installation.

50

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

Table 4: Changeable Parameter Defaults


Parameter

System Default Value

autoadd_xs_roles

Interactive
Mode Availa
bility

(on)

autostart

0
(off)

certificates_hostmap

<current host>

client_path

<sapmnt>/<SID>/hdbclient

components

client,server,studio
(dependent on the installer finding installation sources for the com
ponents)

copy_repository

/hana/shared/<SID>/hdbstudio_update

datapath

/hana/data/<SID>

db_isolation

low

db_mode

single_container

groupid

79

home

/usr/sap/<SID>/home

hostname

<current host>

install_hostagent

y
(on)

install_ssh_key

y
(on)

logpath

/hana/log/<SID>

max_mem

number

<next successive un-used instance number on the


host>

remote_execution

ssh

restrict_max_mem

(off)

root_user

root

sapmnt

/hana/shared

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

51

Parameter

System Default Value

shell

/bin/sh

studio_path

<sapmnt>/<SID>/hdbstudio

studio_repository

Interactive
Mode Availa
bility

(on)

system_usage

custom

userid

<next successive un-used user ID on the host>

Note
To substitute parameters in configuration files and batch mode, they must be written in the form $
{<parameter>}. Substitution also occurs in interactive mode in order to create a suggested path. The
advantage of substitution is that the SAP system ID (SID) and the installation path (sapmnt, which is /
hana/shared, by default) only need to be specified once, and are then substituted in to the other
parameter values. This ensures that the system has unique file system paths if multiple systems are
installed on the same host. However, if it is preferred to deviate from the default paths, it is necessary to pay
attention to the settings, especially in the configuration file, and when installing in batch mode.

Related Information
action [page 161]
autostart [page 166]
certificates_hostmap [page 167]
client_path [page 169]
components [page 170]
copy_repository [page 172]
datapath [page 173]
db_mode [page 174]
groupid [page 176]
home [page 177]
hostname [page 178]
install_hostagent [page 179]
logpath [page 181]
number [page 182]
root_user [page 187]
sapmnt [page 187]
shell [page 188]
studio_path [page 190]

52

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

studio_repository [page 190]


userid [page 192]
vm [page 193]

4.1.3 Users Created During Installation


A number of standard users are required for installing, upgrading, and operating SAP HANA.
The following users are created during installation. For more information about users in a SAP HANA system,
see Standard Users in the SAP HANA Administration Guide.
Table 5:
User

Description

<sid>adm

The operating system administrator.

The user <sid>adm is the operating system user required for administrative tasks such

The user ID of the <sid>adm user is defined during the system installation. The user ID

as starting and stopping the system.


and group ID of this operating system user must be unique and identical on each host of a
multiple-host system.

The password of the <sid>adm user is set during installation with the password param
eter.

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 modified by the
installer. The sapadm user and password are also not modified.

The password of the sapadm user is set during installation with the sapadm_password
parameter.

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.

The password of the SYSTEM user is set during installation with the

system_user_password parameter.

Related Information
SAP HANA Security Guide
SAP HANA Administration Guide

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

53

4.1.4 Specifying Passwords


Passwords are a mandatory parameter for installing an SAP HANA system. There are three methods for
configuring passwords.

Interactive Mode
Interactive installation is available for the SAP HANA database lifecycle manager in both graphical user and
command-line 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
Configuring passwords in the command line is a two-step process. First, a simple text file with passwords in
XML syntax should be created and saved in the home directory of the root user. A password file template can
be created with the SAP HANA platform LCM tool using the parameter dump_configfile_template as a
call option. Then the file can be called using standard input and the read_password_from_stdin parameter
in the command line with batch mode. Parameters specified in the command line override parameters
specified in the configuration file. Since this method is the most powerful and flexible method, it is often the
preferred method for installing multiple SAP HANA systems at one time.

Example
The following is an example of the password file in XML syntax:
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>
Now, the password file (stored in the root user's home directory) is called from the command line using
standard input, the read_password_from_stdin=xml parameter, and batch mode:
cat ~/hdb_passwords.xml | ./hdblcm --sid=DB1 --number=42 -read_password_from_stdin=xml -b

Configuration File
It is possible to specify passwords in the configuration file. A configuration file template is created with all the
parameters set to their default values. The configuration file is edited to the preferred parameter values, then
it is saved, and the values are read by the installer during installation. This method is preferred for a one-step

54

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

installation that can be re-created several times. If passwords are specified in the configuration file, its
permission settings should limit access to the root user, for security reasons.

Example
The following is an example of the configuration file, with configured password parameters:
configfile1.cfg
# Root User Password
root_password=Root1234
...
# SAP Host Agent (sapadm) Password
sapadm_password=Agent1234
...
# System Administrator Password
password=Adm1234
....
# Database User (SYSTEM) Password
system_user_password=Sys1234
Now, the configuration file (stored in the root user's home directory) is called from the command line using
the configfile parameter:
./hdblcm --sid=DB1 --configfile=~/configfile1.cfg

4.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 specification methods.
A single-host system is the simplest system installation type. It is possible to run an SAP HANA system
entirely on one host and then scale the system up as needed.
The following graphic shows the file system for a single-host installation:

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

55

4.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.

Context
The following procedure describes the installation of an SAP HANA system in interactive mode by entering
parameters interactively. This procedure may also be performed in advanced interactive mode, with
parameters entered as call options or from a configuration file. For more information about interaction modes
and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.

56

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

Note
Not all parameters are requested interactively. Some parameters have default values that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file. For more information about changeable default values, see Related Information.

Procedure
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 different directory, change to the directory where you
unpacked the archive.
2. Start the SAP HANA database lifecycle manager interactively in the graphical user interface:
./hdblcmgui
The SAP HANA database lifecycle manager graphical user interface appears.
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 file is available.
After installing the SAP HANA system, you may want to perform configuration tasks. For more information,
see Managing the SAP HANA System After Installation or the platform lifecycle management section of the
SAP HANA Administration Guide.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

57

Related Information
System Properties [page 85]
Using the SAP HANA Platform LCM Tools [page 24]
Changeable Default Values for Installation [page 50]
Managing the SAP HANA System After Installation [page 129]
SAP HANA Administration Guide

4.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.

Context
The following procedure describes the installation of an SAP HANA system in interactive mode and entering
parameters interactively. This procedure may also be performed in advanced interactive mode or batch mode,
with parameters entered as call options or from a configuration file. For more information about interaction
modes and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.

Note
Not all parameters are requested interactively. Some parameters have default values that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file. For more information about changeable default values, see Related Information.

Procedure
1. Change to the following directory on the installation medium:

58

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Installing an 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 different directory, change to the directory where you
unpacked the archive.
2. Start the SAP HANA database lifecycle manager interactively in the command line:
./hdblcm
3. Select the index for 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 file is available.
After installing the SAP HANA system, you may want to perform configuration tasks. For more information,
see Managing the SAP HANA System After Installation or the platform lifecycle management section of the
SAP HANA Administration Guide.

Related Information
System Properties [page 85]
Using the SAP HANA Platform LCM Tools [page 24]
Changeable Default Values for Installation [page 50]
Managing the SAP HANA System After Installation [page 129]
SAP HANA Administration Guide

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

59

4.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 specification methods.
A multiple-host system is a system with more than one host, which can be configured as active worker hosts
or idle standby hosts. The server software is based on a flexible architecture that enables a distributed
installation. This means that load can be balanced between different hosts. The server software has to be
installed in a shared file system. This file system has to be mounted by all hosts that are part of the system.
The following graphic shows the file system for a multiple-host installation using a shared file system:

To create a multiple-host system after installing a single-host system, hosts must be added to the SAP HANA
system. To add hosts to an existing system, use the SAP HANA resident HDBLCM. For more information about
host addition, see Related Information or the SAP HANA Administration Guide.
The following information only covers building a multiple-host system during installation.

60

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

Related Information
SAP HANA Administration Guide

4.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 configuring a multiple-host system, the additional hosts must be defined as worker hosts or standby
hosts (worker is default). Worker machines process data; standby machines do not handle any processing and
instead just wait to take over processes in the case of worker machine failure.

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 configured to work in standby mode.
Before installing a multiple-host system, it is important to consider whether high availability is necessary and
how hosts should be grouped to ensure preferred host auto-failover. For host auto-failover to be successful, if
the active (worker) host fails, the standby host takes over its role by starting its database instance using the
persisted data and log files of the failed host. The name server of one of the SAP HANA instances acts as the
cluster manager that pings all hosts regularly. If a failing host is detected, the cluster manager ensures that the
standby host takes over the role and the failing host is no longer allowed write access to the files (called
fencing) so that they do not become corrupted. The crash of a single service does not trigger failover since
services are normally restarted by hdbdaemon. For more information, see Setting Up Host Auto-Failover in the
SAP HANA Administration Guide.

Host Grouping
Host grouping does not affect the load distribution among worker hosts - the load is distributed among all
workers in an SAP HANA system. If there are multiple standby hosts in a system, host grouping should be
considered, because host grouping decides the allocation of standby resources if a worker machine fails. If no
host group is specified, all hosts belong to one host group called "default". The more standby hosts in one host
group, the more failover security.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

61

If the standby hosts are each in a different 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 configuration 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.

Storage and File System Options


In single-host SAP HANA systems, it is possible to use local file systems residing on direct-attached internal or
external storage devices, such as SCSI hard drives, SSDs, SAN storage, or NAS. However, in order to build a
multiple-host system with failover capabilities this is not sufficient. Either the chosen file system type or the
SAN Infrastructure along with a SAP HANA functionality capable of disc fencing must ensure the following:
The standby host has file access to data and log volumes of the failed host.
The failed worker host no longer has access to write to files - called fencing.
There are two fundamentally different storage configurations which meet the two conditions above: shared
storage devices or separate storage devices with failover reassignment. Do not confuse "shared storage"
with the installation directory /hana/shared that must be shared across all hosts.

Shared File Systems


A shared storage subsystem, which is accessed using file systems such as NFS or IBM's GPFS, makes it easy
to ensure that the standby host has access to all active host files in the system. In a shared storage solution,
the externally attached storage subsystem devices are capable of providing dynamic mount points for hosts.
Since shared storage subsystems vary in their handling of fencing, it is the responsibility of the hardware
partner and their storage partners to develop a corruption-safe failover solution which is specific for the file
system used to access that storage subsystem. An NFSv3 storage solution must be used in combination with

62

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

the storage connector supplied by the hardware partner. NFSv4 and GPFS storage solutions can optionally be
used with a storage connector.
A shared storage system could be configured as in the diagram below, however mounts may differ among
hardware partners and their configurations.

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 offers storage technology vendors. During failover, SAP HANA uses the storage connector
API to tell the storage device driver to re-mount the required data and logs volumes to the standby host and
fence off the same volumes from the failed host.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

63

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
1900823 - SAP HANA Storage Connector API
405827 - Linux: Recommended file systems
SAP HANA Administration Guide

4.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.
The SAP HANA system must be installed with its server software on a shared file system:
Create an installation directory, e.g. /hana/shared/
Set the export options rw,no_root_squash for the installation directory.
Mount the installation directory on all hosts.

64

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

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, different configurations apply:
In a shared file system, the data files and log files are configured so that they are present and mounted
on all hosts, including the primary host.
In a system that uses separate storage devices, each host only has access to its own data files and log
files.
The suggested locations for the file systems are as follows:
/hana/data/<SID>
/hana/log/<SID>
(Optional) Additional storage is configured.
Root user name must be the same for all hosts in a multiple-host system.
If the root user name is not root, it must be specified 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 configuration file. For more information about interaction modes
and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.

Note
Not all parameters are requested interactively. Some parameters have default values that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file. 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 different directory, change to the directory where you
unpacked the archive.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

65

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 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.
Table 6:
Field Name

Description

Installation Path

Specifies the path to the SAP mount directory, which can be used as a shared
directory between multiple hosts.

Non-standard Shared File System

Specifies a non-standard shared file system, which can be accessed by all


hosts during installation. This parameter is typically used when the SID is in
cluded in the mountpoint.

Host Name

Specifies the host name of the machine.

Role

Specifies the purpose of the SAP HANA host. SAP HANA hosts in production
environments must only have one host role. However, if XS advanced runtime
is installed, hosts can share multiple roles.

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.

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

Remote Data Sync (rdsync) - Host for SAP HANA remote data sync

Smart Data Streaming (streaming) - Host for SAP HANA smart data
streaming

XS advanced runtime worker - Host for SAP HANA XS advanced runtime

XS advanced runtime standby - Standby host for SAP HANA XS ad


vanced runtime

High-Availability Group

Specifies the host group ID for failover scenarios. If undefined, the host group
is named "default".

Storage Partition

Specifies the storage partition number, which is a logical role number as


signed to non-shared storage devices in a storage connector API. Standby
hosts do not have a storage partition. By default, the storage partition number
is assigned automatically.

7. Specify the SAP HANA system properties.


For a list of all system properties, see System Properties in Related Information.

66

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

8. After specifying all system properties, review the summary, and select Install.

Results
A multiple-host SAP HANA system is installed. A log file is stored in the following path:
/var/tmp/hdb_<SID>_<action>_<time stamp>
After installing the SAP HANA system, you may want to perform configuration tasks. For more information,
see Managing the SAP HANA System After Installation or the platform lifecycle management section of the
SAP HANA Administration Guide.

Related Information
System Properties [page 85]
Using the SAP HANA Platform LCM Tools [page 24]
Changeable Default Values for Installation [page 50]
Managing the SAP HANA System After Installation [page 129]
SAP HANA Administration Guide

4.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.
The SAP HANA system must be installed with its server software on a shared file system:
Create an installation directory, e.g. /hana/shared/
Set the export options rw,no_root_squash for the installation directory.
Mount the installation directory on all hosts.
Depending on the desired storage solution, shared storage devices or separate storage devices with
failover reassignment, different configurations apply:
In a shared file system, the data files and log files are configured so that they are present and mounted
on all hosts, including the primary host.
In a system that uses separate storage devices, each host only has access to its own data files and log
files.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

67

The suggested locations for the file systems are as follows:


/hana/data/<SID>
/hana/log/<SID>
(Optional) Additional storage is configured.
Root user name must be the same for all hosts in a multiple-host system.
If the root user name is not root, it must be specified 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 configuration file. For more information about interaction
modes and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.

Note
Not all parameters are requested interactively. Some parameters have default values that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file. 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 different directory, change to the directory where you
unpacked the archive.
2. Start the SAP HANA database lifecycle manager interactively in the command line:
./hdblcm

68

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

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:
Table 7: SAP HANA System Properties
Field Name

Description

Installation Path

Specifies the path to the SAP mount directory, which can be used as a
shared directory between multiple hosts.

Local Host Name

Specifies 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:
Table 8:
Field Name

Description

Host Name

Specifies the host name of the machine.

Role

Specifies the purpose of the SAP HANA host. SAP HANA hosts in production
environments must only have one host role. However, if XS advanced runtime
is installed, hosts can share multiple roles.

Host Failover Group

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

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.

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

Remote Data Sync (rdsync) - Host for SAP HANA remote data sync

Smart Data Streaming (streaming) - Host for SAP HANA smart data
streaming

XS advanced runtime worker - Host for SAP HANA XS advanced runtime

XS advanced runtime standby - Standby host for SAP HANA XS ad


vanced runtime

Specifies the host group ID for failover scenarios. If undefined, the host group
is named "default".

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

69

Field Name

Description

Storage Partition

Specifies the storage partition number, which is a logical role number as


signed to non-shared storage devices in a storage connector API. Standby
hosts do not have a storage partition. By default, the storage partition number
is assigned automatically.

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 file is stored in the following path:
/var/tmp/hdb_<SID>_<action>_<time stamp>
After installing the SAP HANA system, you may want to perform configuration tasks. For more information,
see Managing the SAP HANA System After Installation or the platform lifecycle management section of the
SAP HANA Administration Guide.

Related Information
System Properties [page 85]
Using the SAP HANA Platform LCM Tools [page 24]
Changeable Default Values for Installation [page 50]
checkmnt [page 168]
Managing the SAP HANA System After Installation [page 129]
SAP HANA Administration Guide

4.4

Installing a Multitenant Database Container SAP HANA


System

A multitenant database container SAP HANA system is a system that contains one system database and
multiple tenant databases.
For more information about creating and configuring multitenant database containers, see the SAP HANA
Administration Guide.

70

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

Related Information
SAP HANA Administration Guide

4.4.1 Install a Multitenant Database Container System Using


the Graphical User Interface
An SAP HANA system can be installed as an SAP HANA multitenant database container system using the SAP
HANA database lifecycle manager graphical user interface. This is a prerequisite step for configuring SAP
HANA multitenant database containers from the SAP HANA studio.

Prerequisites
You are logged in as 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 configuration file. For more information about interaction modes
and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.

Note
Not all parameters are requested interactively. Some parameters have default values that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file. For more information about changeable default values, see Related Information.

Caution
Configuring an SAP HANA system to be an SAP HANA multitenant database container system is permanent
and cannot be reversed.

Procedure
1. Change to the following directory on the installation medium:

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

71

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 different directory, change to the directory where you
unpacked the archive.
2. Start the SAP HANA database lifecycle manager interactively in the graphical user interface:
./hdblcmgui
The SAP HANA database lifecycle manager graphical user interface appears.
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 or Multiple-Host System as the System Type, and select Add Host to specify
host parameters for the additional hosts.
Table 9:

72

Field Name

Description

Installation Path

Specifies the path to the SAP mount directory, which can be used as a shared
directory between multiple hosts.

Non-standard Shared File System

Specifies a non-standard shared file system, which can be accessed by all


hosts during installation. This parameter is typically used when the SID is in
cluded in the mountpoint.

Host Name

Specifies the host name of the machine.

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

Field Name

Description

Role

Specifies the purpose of the SAP HANA host. SAP HANA hosts in production
environments must only have one host role. However, if XS advanced runtime
is installed, hosts can share multiple roles.

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.

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

Remote Data Sync (rdsync) - Host for SAP HANA remote data sync

Smart Data Streaming (streaming) - Host for SAP HANA smart data
streaming

XS advanced runtime worker - Host for SAP HANA XS advanced runtime

XS advanced runtime standby - Standby host for SAP HANA XS ad


vanced runtime

High-Availability Group

Specifies the host group ID for failover scenarios. If undefined, the host group
is named "default".

Storage Partition

Specifies the storage partition number, which is a logical role number as


signed to non-shared storage devices in a storage connector API. Standby
hosts do not have a storage partition. By default, the storage partition number
is assigned automatically.

7. Specify the SAP HANA system properties. Select the multiple_containers value for the Database Mode
property to configure the system to support multitenant database containers.
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
The SAP HANA system is now installed as an SAP HANA multitenant database container system. For more
information about configuring the multitenant database container system in the SAP HANA studio, see
Related Information or the SAP HANA Administration Guide.

Related Information
System Properties [page 85]
Using the SAP HANA Platform LCM Tools [page 24]
Changeable Default Values for Installation [page 50]

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

73

Managing the SAP HANA System After Installation [page 129]


SAP HANA Security Guide
SAP HANA Administration Guide

4.4.2 Install a Multitenant Database Container System Using


the Command-Line Interface
An SAP HANA system can be installed as an SAP HANA multitenant database container system using the SAP
HANA database lifecycle manager command-line interface. This is a prerequisite step for configuring SAP
HANA multitenant database containers from the SAP HANA studio.

Prerequisites
You are logged in as 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 configuration file. For more information about interaction
modes and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.

Note
Not all parameters are requested interactively. Some parameters have default values that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file. For more information about changeable default values, see Related Information.

Caution
Configuring an SAP HANA system to be an SAP HANA multitenant database container system is permanent
and cannot be reversed.

Procedure
1. Change to the following directory on the installation medium:

74

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Installing an 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 different directory, change to the directory where you
unpacked the archive.
2. Start the SAP HANA database lifecycle manager interactively in the command line:
./hdblcm
3. Select the index for 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. Select the multiple_containers value for the Database Mode
property to configure the system to support multitenant database containers.
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
The SAP HANA system is now installed as an SAP HANA multitenant database container system. For more
information about configuring the multitenant database container system in the SAP HANA studio, see
Related Information or the SAP HANA Administration Guide.

Related Information
System Properties [page 85]
Using the SAP HANA Platform LCM Tools [page 24]
Changeable Default Values for Installation [page 50]
Managing the SAP HANA System After Installation [page 129]
SAP HANA Security Guide
SAP HANA Administration Guide

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

75

4.5

Installing XS Advanced Runtime

The SAP HANA database lifecycle manager can be used to install the XS Advanced Runtime.

Note
SAP HANA SPS 11 includes an additional, new run-time environment for application development: SAP
HANA extended application services (XS), advanced model. SAP HANA extended application services,
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, classic model.
SAP recommends that customers and partners begin to evaluate the new capabilities of SAP HANA
extended application services, advanced model with this release (SPS 11). However, please note that it is
not recommended to immediately start migrating existing applications to the new capabilities.
SAP HANA extended application services, advanced model provides a comprehensive platform for the
development and execution of native data-intensive applications. It requires the installation of the XS
advanced runtime.
In support of this data-integrated application paradigm, SAP HANA Extended Application Services provide a
comprehensive set of embedded services that provide end-to-end support for Web-based applications. This
includes a lightweight web server, configurable OData support, JavaScript execution and, of course, full access
to SQL and SQLScript.
These SAP HANA Extended Application Services are provided by the SAP HANA XS server, which provides
lightweight application services that are fully integrated into SAP HANA. It allows clients to access the SAP
HANA system via HTTP. Controller applications can run completely natively on SAP HANA, without the need
for an additional external application server.
The application services can be used to expose the database data model, with its tables, views and database
procedures, to clients. This can be done in a declarative way using OData services or by writing native
application-specific 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).

Related Information
2244998 - Known issues of SAP HANA extended application services, advanced model

76

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

4.5.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 configuring a multiple-host system with XS advanced runtime, the additional hosts must be defined as
xs_worker hosts or xs_standby hosts. Worker machines run XS applications; standby machines do not handle
any processing and instead just wait to take over processes in the case of worker machine failure.

Automatic Role Assignment


XS advanced runtime host roles can be assigned automatically during installation. The installer will assign the
role xs_worker to every worker host and xs_standby to every standby host.

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.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

77

Multi-Host Setup
A multiple-host system is a system with more than one host, which can be configured as active worker hosts
or idle standby hosts. The server software is based on a flexible architecture that enables a distributed
installation. This means that load can be balanced between different hosts. The server software has to be
installed in a shared file system. This file system has to be mounted by all hosts that are part of the system.
In a basic multi-host system all worker hosts also act as XS worker hosts.

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

78

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

therefore be assigned to different hosts. To create a multiple-host system with a dedicated XS worker host,
hosts must be assigned manually during installation.

Related Information
Installing a Single-Host System [page 55]
Installing a Multiple-Host System [page 60]
SAP HANA Administration Guide

4.5.2 Install the XS Advanced Runtime Using the Graphical


Interface
The SAP HANA 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.
The SAP HANA system must be installed with its server software on a shared file system:
Create an installation directory, e.g. /hana/shared/
Set the export options rw,no_root_squash for the installation directory.
Mount the installation directory on all hosts.
Depending on the desired storage solution, shared storage devices or separate storage devices with
failover reassignment, different configurations apply:
In a shared file system, the data files and log files are configured so that they are present and mounted
on all hosts, including the primary host.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

79

In a system that uses separate storage devices, each host only has access to its own data files and log
files.
The suggested locations for the file systems are as follows:
/hana/data/<SID>
/hana/log/<SID>
(Optional) Additional storage is configured.
Root user name must be the same for all hosts in a multiple-host system.
If the root user name is not root, it must be specified 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 configuration file. For more information about interaction modes
and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.

Note
Not all parameters are requested interactively. Some parameters have default values that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file. 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
The SAP HANA database lifecycle manager graphical user interface appears.
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.

80

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

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.
Table 10:
Field Name

Description

Installation Path

Specifies the path to the SAP mount directory, which can be used as a shared
directory between multiple hosts.

Non-standard Shared File System

Specifies a non-standard shared file system, which can be accessed by all


hosts during installation. This parameter is typically used when the SID is in
cluded in the mountpoint.

Host Name

Specifies the host name of the machine.

Note
For XS advanced runtime installations, the fully-qualified host name must
be specified.
Role

Specifies the purpose of the SAP HANA host. SAP HANA hosts in production
environments must only have one host role. However, if XS advanced runtime
is installed, hosts can share multiple roles.

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.

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

Remote Data Sync (rdsync) - Host for SAP HANA remote data sync

Smart Data Streaming (streaming) - Host for SAP HANA smart data
streaming

XS advanced runtime worker - Host for SAP HANA XS advanced runtime

XS advanced runtime standby - Standby host for SAP HANA XS ad


vanced runtime

High-Availability Group

Specifies the host group ID for failover scenarios. If undefined, the host group
is named "default".

Storage Partition

Specifies the storage partition number, which is a logical role number as


signed to non-shared storage devices in a storage connector API. Standby
hosts do not have a storage partition. By default, the storage partition number
is assigned automatically.

XS advanced runtime host roles can be assigned automatically during installation. The installer will assign
the role xs_worker to every worker host and xs_standby to every standby host. To create a multiple-host
system with a dedicated XS worker host, hosts must be assigned manually during installation.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

81

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 SAP HANA system with XS advanced runtime is installed. A log file is available.
After installing the SAP HANA system, you may want to perform configuration tasks. For more information,
see Managing the SAP HANA System After Installation or the platform lifecycle management section of the
SAP HANA Administration Guide.

Related Information
System Properties [page 85]
Using the SAP HANA Platform LCM Tools [page 24]
Changeable Default Values for Installation [page 50]
Managing the SAP HANA System After Installation [page 129]
SAP HANA Administration Guide

4.5.3 Install the XS Advanced Runtime Using the CommandLine Interface


The SAP HANA XS advanced runtime can be installed in a single-host or multi-host environment using the SAP
HANA database lifecycle manager (HDBLCM) command-line interface.

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.
The SAP HANA system must be installed with its server software on a shared file system:
Create an installation directory, e.g. /hana/shared/
Set the export options rw,no_root_squash for the installation directory.
Mount the installation directory on all hosts.
Depending on the desired storage solution, shared storage devices or separate storage devices with
failover reassignment, different configurations apply:

82

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

In a shared file system, the data files and log files are configured so that they are present and mounted
on all hosts, including the primary host.
In a system that uses separate storage devices, each host only has access to its own data files and log
files.
The suggested locations for the file systems are as follows:
/hana/data/<SID>
/hana/log/<SID>
(Optional) Additional storage is configured.
Root user name must be the same for all hosts in a multiple-host system.
If the root user name is not root, it must be specified 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 configuration file. For more information about interaction
modes and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.

Note
Not all parameters are requested interactively. Some parameters have default values that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file. 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 .

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

83

5. Specify the installation path, and the local host name:


Table 11: SAP HANA System Properties
Field Name

Description

Installation Path

Specifies the path to the SAP mount directory, which can be used as a
shared directory between multiple hosts.

Local Host Name

Specifies 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 additional hosts to
the system?. If you want to install a multi-host system, select y and enter the following details for each
additional host:
Table 12:
Field Name

Description

Host Name

Specifies the host name of the machine.

Note
For XS advanced runtime installations, the fully-qualified host name must
be specified.
Role

84

Specifies the purpose of the SAP HANA host. SAP HANA hosts in production
environments must only have one host role. However, if XS advanced runtime
is installed, hosts can share multiple roles.

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.

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

Remote Data Sync (rdsync) - Host for SAP HANA remote data sync

Smart Data Streaming (streaming) - Host for SAP HANA smart data
streaming

XS advanced runtime worker - Host for SAP HANA XS advanced runtime

XS advanced runtime standby - Standby host for SAP HANA XS ad


vanced runtime

Host Failover Group

Specifies the host group ID for failover scenarios. If undefined, the host group
is named "default".

Storage Partition

Specifies the storage partition number, which is a logical role number as


signed to non-shared storage devices in a storage connector API. Standby
hosts do not have a storage partition. By default, the storage partition number
is assigned automatically.

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

XS advanced runtime host roles can be assigned automatically during installation. The installer will assign
the role xs_worker to every worker host and xs_standby to every standby host. To create a multiple-host
system with a dedicated XS worker host, hosts must be assigned manually during installation.
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 SAP HANA system with XS advanced runtime is installed. A log file is available.
After installing the SAP HANA system, you may want to perform configuration tasks. For more information,
see Managing the SAP HANA System After Installation or the platform lifecycle management section of the
SAP HANA Administration Guide.

Related Information
System Properties [page 85]
Using the SAP HANA Platform LCM Tools [page 24]
Changeable Default Values for Installation [page 50]
Managing the SAP HANA System After Installation [page 129]
SAP HANA Administration Guide

4.6

System Properties

SAP HANA system properties and XS advanced runtime properties.

System Properties
Table 13: SAP HANA System Properties
Property

Description

Local Host Name

Specifies the host name of the machine.

SAP HANA System ID

Specifies a system ID. The SAP system ID (SID) is the identifier for the
SAP HANA system.

Instance Number

Specifies the instance number of the SAP HANA system.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

85

Property

Description

Database Mode

Specifies whether the system is installed in single-container mode (de


fault) or multiple-container mode. A single-container system contains
one database but the system and the database are perceived as a single
unit. A multiple-container system contains one system database and any
number of tenant databases. The system database is created during the
installation process. A system administrator must create the required
tenant databases after installation. For general information about multi
ple-container systems, see Related Information.

System Usage

Specifies the usage type of the system to be installed. This setting is


stored in the global.ini file, and can be used to identify the intended
usage of the system.

Restrict maximum memory allocation?

Specifies whether maximum memory allocation is restricted for a new


system.
Specifies the maximum memory allocation for a new system in MB.

Restart system after machine reboot?

Restarts system after machine reboot.

Location of Data Volumes

Specifies the path to the data directory of the SAP HANA system.

Location of Log Volumes

Specifies the path to the log directory of the SAP HANA system.

Edit Certificate Host...

Specifies the hostname used for generation of self-signed SSL certifi


cates for the SAP host agent.

System Administrator User ID

Specifies the user ID of the system administrator. This parameter is rele


vant only if the operating system administrator (<sid>adm) does not
exist prior to installation.

ID of User Group (sapsys)

Specifies the SAP system (sapsys) group ID. This parameter is relevant
only if a sapsys group does not already exist on the host. If a sapsys
group already exists, passing the groupid parameter does not alter
the existing group.

System Administrator Login Shell

Specifies a system administrator login shell. This parameter is relevant


only if the operating system administrator (<sid>adm) does not exist
prior to installation.

System Administrator Home Directory

Specifies the home directory of the system administrator. This parame


ter is relevant only if the operating system administrator (<sid>adm)
does not exist prior to installation.

XS Advanced Runtime Properties


Table 14: 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. By default, the host


role XS_WORKER will be assigned to all worker hosts, the host role
XS_STANDBY will be assigned to all standby hosts.

86

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

Property

Description

XS Advanced Admin User

Creates a 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.

Customer Organization Name

Sets the name of the customer organization. Organizations enable de


velopers to collaborate by sharing resources, services, and applications.
Access to the shared resources, services, and applications is controlled
by the organization manager.

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.

Related Information
hostname [page 178]
sid [page 189]
number [page 182]
db_mode [page 174]
system_usage [page 191]
autoadd_xs_roles [page 166]
restrict_max_mem [page 187]
autostart [page 166]
datapath [page 173]
logpath [page 181]
certificates_hostmap [page 167]
userid [page 192]
groupid [page 176]
shell [page 188]
home [page 177]
org_manager_user [page 183]
org_name [page 183]
prod_space_name [page 184]

SAP HANA Server Installation and Update Guide


Installing an SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

87

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 and the product-specific AFLs POS, SAL, SCA, SOP,
UDF), SAP liveCache applications (SAP LCA or LCAPPS-Plugin), XS advanced runtime applications, or SAP
HANA smart data access (SDA) can be updated using the SAP HANA database lifecycle manager (HDBLCM).
To update an SAP HANA system, you need to first download the individual components from Service
Marketplace (SMP). This can be done manually, or from the SAP HANA studio. 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.
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.

Note
As of SAP HANA Support Package Stack (SPS) 09, updating the SAP HANA system can be performed as
the system administrator user <sid>adm.
An existing SAP HANA system that supports multitenant database containers can be updated using any of the
supported server update methods. If you would like to update a pre-SPS 09 SAP HANA system to support
multitenant database containers, you must first perform a regular system update to SPS 09 or later. Then
convert the SAP HANA system to support multitenant database containers. For more information about
converting the system, see Convert an SAP HANA System to Support Multitenant Database Containers in the
SAP HANA Administration Guide.

Note
If you have SAP HANA options installed, review the section about multitenant database containers 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
Preparing for Update [page 90]
Update an SAP HANA System Using the Graphical User Interface [page 101]
Update an SAP HANA System Using the Command-Line Interface [page 103]
Update an SAP HANA System Using the Web User Interface [page 105]

88

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

5.1

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 predefined values on the current host.
Table 15: Changeable Parameter Defaults
Parameter

System Default Value

client_path

${sapmnt}/${SID}/hdbclient

install_hostagent

Interactive
Mode Availa
bility

(on)

install_ssh_key

y
(on)

remote_execution

ssh

root_user

root

scope

system

studio_path

${sapmnt}/${SID}/hdbstudio

studio_repository

1
(on)

system_user

SYSTEM

Note
The default paths written in the form ${<parameter>} indicate that substitution of the parameter occurs
in the configuration file and in batch mode. Substitution also occurs in interactive mode in order to create a
suggested path. The advantage of substitution is that the SAP system ID (sid) and the installation path
(sapmnt, which is /hana/shared, by default) only need to be specified once, and are then substituted in to
the other parameter values. This ensures that the system has unique file system paths if multiple systems
are installed on the same host. However, if it is preferred to deviate from the default paths, it is necessary to
pay attention to the settings, especially in the configuration file, and when installing in batch mode.

Related Information
client_path [page 169]
install_hostagent [page 179]

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

89

install_ssh_key [page 179]


remote_execution [page 186]
root_user [page 187]
scope [page 188]
studio_path [page 190]
studio_repository [page 190]
system_user [page 191]

5.2

Preparing for Update

An SAP HANA system can be updated from a local host using the SAP HANA database lifecycle manager.
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 Optimizer (MOPZ) 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 configuration 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 Optimizer
(MOPZ) in SAP Solution Manager to generate an SPS and download the necessary archives to a specified
location. For more information about updating with the Maintenance Optimizer, 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.

Related Information
Preparing for Update in the SAP HANA Studio [page 91]
Using the Maintenance Optimizer in the SAP Solution Manager to Upgrade

90

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

5.2.1 Preparing for Update in the SAP HANA Studio


It is possible to check for available updates of the SAP HANA system and components 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.

Related Information
Download Software Components from SAP Service Marketplace Using the SAP HANA Studio [page 92]
Prepare the Software Archive for the Update [page 93]

5.2.1.1

Configure the Connection to SAP Service


Marketplace

Before downloading software components using the SAP HANA studio, configure the connection to SAP
Service Marketplace (SMP).

Procedure
1. Start the SAP HANA studio.
2. Select

Window

Preferences

SAP HANA

Lifecycle Management

Service Marketplace .

3. Select Use SMP configuration.


The Host Name is set to service.sap.com. This is the URL of SMP, where the files 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 configuration.

Note
To reset your entries, choose Restore Defaults.

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

91

Next Steps
After configuring the connection from the SAP HANA studio to SAP Service Marketplace, download the
software components from the SAP Service Marketplace. For more information about downloading software
components using the SAP HANA studio, see Related Information.

Related Information
Download Software Components from SAP Service Marketplace Using the SAP HANA Studio [page 92]

5.2.1.2

Download Software 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 configured connection properties to the SAP Service
Marketplace.
Your SAP HANA system must be Support Package Stack (SPS) 08 or newer and must have been installed
with the SAP HANA database lifecycle manager, so that the versions of the currently installed components
are correctly detected. Otherwise this information won't be available, but you can still proceed with the
download.
You need to provide system administrator user (<sid>adm) credentials.

Context
In order to update an SAP HANA system, you first need to download the corresponding update sources
(components) from SAP Service Marketplace. The SAP HANA studio provides functionality, which helps you
to easily check for available updates of the installed SAP HANA core components and download them locally
on the machine where the SAP HANA studio is started or on a shared file system. In addition to the
downloaded content you are provided with a shell script (hdblcm_prepare.sh), which must be run to extract
the archives in a directory structure, so that subsequent installation or update with the SAP HANA database
lifecycle manager works as expected.

92

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

Procedure
1. Right click on an SAP HANA system and choose

Lifecycle Management

Platform Lifecycle

Check for available software component updates .

Management

2. Choose which versions of the available components you want to download or choose skip to skip the
download of a particular component. The current version column shown the version of the components,
which is currently installed on the SAP HANA system.
Note that you can also select and download SAP HANA core components which are not currently, but can
be installed on the system.
3. Review the selected components and choose a download directory.
4. To start the download process, choose Finish.
5. You can run the download process in background by pressing the Run In Background button. To get the
current progress of the download, open the Progress View (

Window

Show View

Other

Progress ).

Next Steps
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
Prepare the Software Archive for the Update [page 93]

5.2.1.3

Prepare the Software Archive for the Update

After downloading the software components from SAP Service Marketplace, the software archive must be
prepared for the update.

Prerequisites
You have downloaded the software components from SAP Service Marketplace using the SAP HANA
studio.
You have copied the download directory to the SAP HANA host or in case it is a shared file system, make
sure it is accessible from the SAP HANA host.

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

93

Procedure
1. In the directory with the downloaded software component archive, there should be one additional shell
script hdblcm_prepare.sh. Give execute permissions to the hdblcm_prepare.sh:
chmod 755 hdblcm_prepare.sh
2. Execute the script:
./hdblcm_prepare.sh
The following are parameters of the script hdblcm_prepare.sh:
Table 16:
Option

Description

Default Value

-a <SAPCAR
path>

Location to the SAPCAR executable

/usr/sap/hostctrl/exe/
SAPCAR

-t <target
directory>

The target directory to extract the software component


archives to

<current dir>/
extracted<first free
index>

-h

Displays the help information

The script outputs a message, containing the component root directory to be used with the SAP HANA
database lifecycle manager (for example, </hana/shared/trans/inbox>).

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>

Related Information
Update an SAP HANA System Using the Graphical User Interface [page 101]
Update an SAP HANA System Using the Command-Line Interface [page 103]
Update an SAP HANA System Using the Web User Interface [page 105]

94

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

5.2.2 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
file to the subfolder (SAP_HANA_DATABASE, SAP_HANA_CLIENT, etc.), before extracting the next SAR in
order to avoid overwriting the SIGNATURE.SMF file. For more information, see also SAP Note 2178665 in
Related Information.

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.
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
extract_components [page 176]

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

95

Update an SAP HANA System Using the Graphical User Interface [page 101]
Update an SAP HANA System Using the Command-Line Interface [page 103]
Update an SAP HANA System Using the Web User Interface [page 105]

5.3

Prepare an Update for Reduced SAP HANA System


Downtime

As of SPS 10, you can run an SAP HANA system update in two phases - an update preparation phase and a
resume update phase - in order to reduced system downtime. You can perform the prepare update phase
using either the SAP HANA database lifecycle manager graphical user interface, command-line interface or
Web user interface. The update resume phase can be performed from any of the three SAP HANA database
lifecycle manager user interfaces.

Prerequisites
You are updating to a new SPS from an installation medium or you have prepared for update, either in the
SAP HANA studio or manually.
You have stopped the data replication.
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.
You have applied a valid license key for the SAP HANA system.

Context
After downloading the SAP HANA software, and preparing the downloaded archives for update execution, you
have the choice to update your SAP HANA system in one step, or to update it in a phased approach to
minimize system downtime.
When you start the SAP HANA database lifecycle manager with the prepare_update flag set, the SAP HANA
database lifecycle manager extracts the packages (like the SAP Host Agent, and delivery units) from the new
source, but does not actually perform the update. During the preparation phase the system is not modified by
the installer or restarted. The software switch occurs when the SAP HANA database lifecycle manager is run a
second time, resuming the system update.
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 conflicts

96

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

Preparing for Update [page 90]


Prepare an Update for Reduced SAP HANA System Downtime [page 96]
Update an SAP HANA System Using the Graphical User Interface [page 101]
Update an SAP HANA System Using the Graphical User Interface [page 101]

Procedure
1. Change to the following directory on the installation medium:
Description

Option
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 different directory, change to the directory where you
unpacked the archive.
2. Perform the update preparation phase step with the SAP HANA database lifecycle manager using one of
the following commands.
Option

Description

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.

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

97

Before triggering the update preparation phase, confirm 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 Configuration
dialog from the footer bar and select Prepare Update Only under General Parameters.
3. Resume the update.
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
Preparing for Update [page 90]
Update an SAP HANA System Using the Graphical User Interface [page 101]
Update an SAP HANA System Using the Command-Line Interface [page 103]
Update an SAP HANA System Using the Web User Interface [page 105]
prepare_update [page 183]

5.4

Perform an 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.

Prerequisites
You are updating to a new SPS from an installation medium or you have prepared for update, either in the
SAP HANA studio or manually.
You have stopped the data replication.
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.
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 standard mode, or to update it using optimized mode to

98

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

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
SAP HANA Remote Data Sync
SAP HANA Smart Data Streaming
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 conflicts or errors in preliminary steps,
such as archive preparation
Ensure consistency of component binaries during system start

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

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

99

Note
If you downloaded the components to a different directory, change to the directory where you
unpacked the archive.
2. Perform the optimized update with the SAP HANA database lifecycle manager using one of the following
commands.
Option

Description

Graphical user interface

./hdblcmgui --action=update -update_execution_mode=optimized

Command-line interface

./hdblcm --action=update --update_execution_mode=optimized

The command can be used together with the parameter --prepare_update to stop the update process
before the resume update phase.
Provide the required system update information and credentials. See Related Information for more details
about SAP HANA system update.
If you are using the SAP HANA HDBLCM Web user interface, open the Advanced Parameters Configuration
dialog from the footer bar and select the optimized update Update Execution Mode under General
Parameters.

Related Information
Preparing for Update [page 90]
Update an SAP HANA System Using the Graphical User Interface [page 101]
Update an SAP HANA System Using the Command-Line Interface [page 103]
Update an SAP HANA System Using the Web User Interface [page 105]
update_execution_mode [page 192]

100

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

5.5

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.
You have stopped the data replication.
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.
You have applied a valid license key for the SAP HANA system.

Context
The following procedure describes the update of an SAP HANA system in interactive mode and entering
parameters interactively. This procedure may also be performed in advanced interactive mode, with
parameters entered as call options or from a configuration file. For more information about interaction modes
and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.

Note
Not all parameters are requested interactively. Some parameters have default values, that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file using the graphical user or command-line interface and advanced interactive mode. For
more information about changeable default values, see Related Information.

Procedure
1. Change to the following directory on the installation medium:
Option
Intel-Based Hardware Platforms

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

Description

cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_X86_64

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

101

Option
IBM Power Systems

Description

cd <installation medium>/DATA_UNITS/
HDB_LCM_LINUX_PPC64

Note
If you downloaded the components to a different 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. Define additional properties, depending on which components are selected.
8. After specifying all system properties, review the summary, and select Update.

Next Steps
If your system is a multitenant database container system, SAP HANA content is installed on tenant databases
after their creation. After a system update, SAP HANA content on tenant databases must be updated from the
system database. Restarting the tenant databases is necessary to trigger the deployment of the updated
content on the tenant databases. You can restart the tenant databases once the delivery unit (DU) deployment
on the system database has finished. You can monitor the progress of DU deployment by executing the
following statement in the SQL console of the SAP HANA studio:
SELECT * FROM "PUBLIC"."M_SERVICE_THREADS" WHERE THREAD_TYPE = 'ImportOrUpdate
Content';

Related Information
Using the SAP HANA Platform LCM Tools [page 24]
Changeable Default Values for Update [page 89]
Use Advanced Interactive Mode to Perform Platform LCM Tasks [page 34]

102

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

Create a Lesser-Privileged Database User for Update [page 132]

5.6

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.
You have stopped the data replication.
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.
You have applied a valid license key for the SAP HANA system.

Context
The following procedure describes the update of an SAP HANA system in interactive mode and entering
parameters interactively. This procedure may also be performed in advanced interactive mode or batch mode,
with parameters entered as call options or from a configuration file. For more information about interaction
modes and parameter entry methods, see Using the SAP HANA Platform LCM Tools in Related Information.

Note
Not all parameters are requested interactively. Some parameters have default values that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file. For more information about changeable default values, see Related Information.

Procedure
1. Change to the following directory on the installation medium:

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

103

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 different directory, change to the directory where you
unpacked the archive.
2. Locate the SAP_HANA_DATABASE directory, and run the SAP HANA database lifecycle manager:
./hdblcm
3. Select the index for the system to be updated, then select Enter .
4. Select the components you would like to update as a comma-separated list, then select Enter .
5. Specify the SAP HANA authorization information.
When asked for database user, you have the opportunity to specify a lesser-privileged database user if you
have previously created one. For more information about creating a database user for update, see Related
Information.
6. Define additional properties, depending on which components are selected.
7. After specifying all system properties, review the summary, and select y.

Next Steps
If your system is a multitenant database container system, SAP HANA content is installed on tenant databases
after their creation. After a system update, SAP HANA content on tenant databases must be updated from the
system database. Restarting the tenant databases is necessary to trigger the deployment of the updated
content on the tenant databases. You can restart the tenant databases once the delivery unit (DU) deployment
on the system database has finished. You can monitor the progress of DU deployment by executing the
following statement in the SQL console of the SAP HANA studio:
SELECT * FROM "PUBLIC"."M_SERVICE_THREADS" WHERE THREAD_TYPE = 'ImportOrUpdate
Content';

Related Information
Using the SAP HANA Platform LCM Tools [page 24]
Changeable Default Values for Update [page 89]
Create a Lesser-Privileged Database User for Update [page 132]

104

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

5.7

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. This method is available only for update of SAP HANA Support Package Stack
(SPS) 09 systems to higher revision. SAP HANA SPS 08 systems cannot be updated to SPS 09 using the SAP
HANA database lifecycle manager Web user interface.

Prerequisites
You should verify that the following prerequisites are fulfilled before trying to access the SAP HANA database
lifecycle manager from a Web browser.
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 fulfilled:
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 .

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 in Related
Information.
You are logged on with the required root user or system administrator user <sid>adm credentials.
You should verify that the following additional prerequisites are fulfilled before trying to access the SAP HANA
database lifecycle manager from the SAP HANA studio.
The SAP HANA studio revision is 90 or higher.
For Linux:
The system property org.eclipse.swt.browser.XULRunnerPath should be set in
hdbstudio.ini to point to the path of XULRunner, for example:
-Dorg.eclipse.swt.browser.XULRunnerPath=<path to xulrunner>.
This hdbstudio.ini file is located in the same folder as the executable that is used to start the SAP
HANA studio. For Linux, the default location is hana/shared/<SID>/hdbstudio..
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.

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

105

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 Preparing for
Update in Related Information.
You have stopped the data replication.
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.

Context
If your system is a multitenant database container system, SAP HANA content is installed on tenant databases
after their creation. After a system update, SAP HANA content on tenant databases must be updated from the
system database. Restarting the tenant databases is necessary to trigger the deployment of the updated
content on the tenant databases. You can restart the tenant databases once the delivery unit (DU) deployment
on the system database has finished. You can monitor the progress of DU deployment by executing the
following statement in the SQL console of the SAP HANA studio:
SELECT * FROM "PUBLIC"."M_SERVICE_THREADS" WHERE THREAD_TYPE = 'ImportOrUpdate
Content';

Note
Not all parameters are requested interactively. Some parameters have default values that do not require
confirmation in interactive mode. Those parameters must be specified as call options or from a
configuration file. For more information about changeable default values, see Related Information.

Procedure
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
Studio

1. Start the SAP HANA studio.


2. In the SAP HANA studio, add the SAP HANA system.
3. Open the context menu (right-mouse click) in the Systems view, and select Add System.
For more information about adding a system, see Add an SAP HANA System in the SAP HANA Ad
ministration Guide in Related Information.
4. In the SAP HANA studio, log on to the system.

106

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

Option

Description
5. From the context menu of the selected system, select
Lifecycle Management

SAP HANA
Cockpit

1.

Lifecycle Management

SAP HANA Platform Lifecycle Management

Platform

Enter the SAP HANA cockpit URL in your browser.


The URL depends on whether you are connecting to a single-container system or to a database in
a multiple-container system.
A single-container system is accessed through the URL: http://<host_FQDN>:

80<instance>/sap/hana/admin/cockpit
For more information about the URLs in multiple-container systems, see Configure HTTP Access
to Multitenant Database Containers.

Note
FQDN = fully qualified domain name
2. The SAP HANA Platform Lifecycle Management tiles are visible on the homepage of the SAP HANA
cockpit. If they are not, you can add them from the SAP HANA Platform Lifecycle Management tile
catalog. For more information, see Customizing the Homepage of SAP HANA Cockpit.

2. Select the Update System and Components tile.


3. Enter the file path of the installation medium in the location field:
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

If you downloaded the components to a different directory, enter the file 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 file
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.
6. Specify the SAP HANA authorization information.
When asked for database user, you have the opportunity to specify a lesser-privileged database user if you
have previously created one. For more information about creating a database user for update, see Related
Information.
7. Define additional properties, depending on which components are selected.
8. After specifying all system properties, review the summary, and select Update.

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

107

Next Steps
If your system is a multitenant database container system, SAP HANA content is installed on tenant databases
after their creation. After a system update, SAP HANA content on tenant databases must be updated from the
system database. Restarting the tenant databases is necessary to trigger the deployment of the updated
content on the tenant databases. You can restart the tenant databases once the delivery unit (DU) deployment
on the system database has finished. You can monitor the progress of DU deployment by executing the
following statement in the SQL console of the SAP HANA studio:
SELECT * FROM "PUBLIC"."M_SERVICE_THREADS" WHERE THREAD_TYPE = 'ImportOrUpdate
Content';

Related Information
SAPUI5 Developer Guide
SAP HANA Administration Guide
Preparing for Update [page 90]
Changeable Default Values for Update [page 89]
Create a Lesser-Privileged Database User for Update [page 132]

108

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Updating the SAP HANA System

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-specific AFLs POS, SAL, SCA, SOP, TRD, UDF)
SAP liveCache applications (SAP LCA or LCAPPS-Plugin)
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.)

Note
As of SAP HANA Support Package Stack (SPS) 09, the SAP HANA studio repository is divided into core
and additional repositories.

Note
As of SAP HANA SPS 08, the Solution Manager Diagnostics Agent can no longer be installed or
uninstalled using the SAP HANA platform lifecycle management tools. To install or uninstall the
Solution Manager Diagnostics Agent, use Software Provisioning Manager (SWPM). For more
information about the setting up the Solution Manager Diagnostics Agent using SWPM, see SAP Note
1858920 in Related Information.

Note
As of SAP HANA SPS 09, SAP HANA platform lifecycle management no longer provides SAP LT
(Landscape Transformation) replication configuration. SAP LT replication configuration is a part of SL
Toolset 1.0. For more information about configuring SAP LT replication, see SAP Note 1891393 in
Related Information.
SAP HANA options
SAP HANA dynamic tiering
SAP HANA smart data streaming
SAP HANA accelerator for SAP ASE

SAP HANA Server Installation and Update Guide


Managing SAP HANA System Components

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

109

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 and Options in Related Information.

Related Information
SAP Note 1858920
SAP Note 1891393
Installing or Updating SAP HANA Components [page 110]
Remove SAP HANA System Components from a Local System Host [page 120]
SAP HANA Options in SAP Help Portal
Important Disclaimer for Features in SAP HANA Platform, Options and Capabilities [page 200]
Installing XS Advanced Runtime [page 76]

6.1

Installing or Updating SAP HANA Components

SAP HANA components - including system components and additional components - can be installed or
updated the following ways:
From the installation medium, using
the graphical user interface,
the command-line interface,
the Web user interface.
From the resident program, using
the graphical user interface,
the command-line interface.

Note
As of SAP HANA Support Package Stack (SPS) 09, installing or updating SAP HANA components can be
performed as the system administrator user <sid>adm.

110

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Managing SAP HANA System Components

Related Information
Add SAP HANA System Components from a Local Host [page 111]
Install or Update SAP HANA Components Using the Command-Line Interface [page 113]
Install or Update SAP HANA Components Using the Web User Interface [page 115]
Install or Update SAP HANA Components Using the Resident Program [page 117]
SAP Note 1858920

6.1.1 Add SAP HANA System Components from a Local Host


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 hdbclm(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 cant update the SAP HANA system components 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 add SAP HANA system components, you must start the hdblcm(gui) installer and select update.
The update component menu offers to update the server (if a more recent version is found) and also offers to
install additional components, which were not installed during the initial server installation. If you select the
action Install new system instead of Update existing system, hdblcm(gui) also installs the SAP HANA server, by
default. Therefore, if you would like to add only one additional system component, it is necessary to select the
action Update existing system, and select only that system component from the available component list.
To install and update software components in SAP HANA XS Advanced, the xs install command is
available in the XS Advanced command-line interface (CLI). For more information, see Installing and Updating
Software Components in SAP HANA XS Advanced Model in the SAP HANA Administration Guide.

Note
The product-specific AFLs are released individually and are no longer released as part of SAP HANA AFL.
Therefore, before updating AFL version SPS 07 to a current version, it is necessary to perform a migration.

SAP HANA Server Installation and Update Guide


Managing SAP HANA System Components

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

111

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. 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 different directory, change to the directory where you
unpacked the archive.
2. Start the update task:
To add system components with the command line interface:
Start the hdblcm command line tool interactively:
./hdblcm
and enter the index of the update action, or
Start the tool with the update action specified:
./hdblcm --action=update
To add system components with the graphical interface:
1. Start the hdblcmgui graphical interface tool:
./hdblcmgui
The hdblcmgui interface appears.
2. Review the detected software components, select Next.
3. Select Update existing system.
3. Select the SAP HANA system to which the system component should be added.
4. Select the desired system component for installation:
In the command line interface: Enter the index for Install <system component> .
In the graphical interface: Select the Install <system component> checkbox.
5. Continue with the installation, by entering the required passwords. Confirm the installation.

112

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Managing SAP HANA System Components

Results
A system component has been added to the SAP HANA system. The component list has been updated. A log
has been produced.

Related Information
SAP Note 2014334
SAP HANA Administration Guide

6.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 and the product-specific AFLs POS,
SAL, SCA, SOP, UDF), SAP liveCache applications (SAP LCA or LCAPPS-Plugin), XS advanced runtime
applications, or SAP HANA smart data access (SDA) 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 cant update the SAP HANA system components to a higher revision number unless you also update your
SAP HANA database to the same revision number.The installation and update of XS advanced runtime
components requires the installation/update of the XS advanced runtime.

Context
In order to install or update SAP HANA system components or additional components, you must start the SAP
HANA database lifecycle manager (HDBLCM) and run an update. The update component menu offers the
opportunity to update the components (if a more recent version is found) and to install additional
components, which were not installed during the initial server installation. If you select the action Install new
system instead of Update existing system, the SAP HANA database lifecycle manager (HDBLCM) also installs
the SAP HANA server, by default. Therefore, if you would like to add only one additional system component to
an existing system, it is necessary to select the action Update existing system, and select only that system
component from the available component list.

SAP HANA Server Installation and Update Guide


Managing SAP HANA System Components

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

113

Note
The product-specific AFLs are released individually and are no longer released as part of SAP HANA AFL.
Therefore, before updating AFL version SPS 07 to a current version, it is necessary to perform a migration.
For more information, see SAP Note 2014334 in Related Information. You can update AFL version SPS 08
to a current version as described.

Note
Adding SAP liveCache applications (SAP LCA or LCAPPS-Plugin) is only supported for the integrated SAP
liveCache, single-host scenario. The SAP LCA archive should be owned by the root user.

Procedure
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 different directory, change to the directory where you
unpacked the archive.
2. Start the SAP HANA database lifecycle manager interactively in the command line:
./hdblcm
3. Select the index for the system to be updated, then select Enter .
4. Select the components you would like to install or update as a comma-seperated list, then select Enter .
5. Specify the SAP HANA system properties.
You have the opportunity to specify a lesser-privileged database user if you have previously created one.
For more information about creating a database user for update, see Related Information.
6. After specifying all system properties, review the summary, and select y.

Related Information
SAP Note 2014334

114

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Managing SAP HANA System Components

6.1.3 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 and the product-specific AFLs POS,
SAL, SCA, SOP, UDF), SAP liveCache applications (SAP LCA or LCAPPS-Plugin), XS advanced runtime
applications, or SAP HANA smart data access (SDA) using the SAP HANA database lifecycle manager
(HDBLCM) Web user interface.

Prerequisites
You should verify that the following prerequisites are fulfilled before trying to access the SAP HANA database
lifecycle manager from a Web browser.
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 fulfilled:
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 .

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 in Related
Information.
You are logged on with the required root user or system administrator user <sid>adm credentials.
You should verify that the following additional prerequisites are fulfilled before trying to access the SAP HANA
database lifecycle manager from the SAP HANA studio.
The SAP HANA studio revision is 90 or higher.
For Linux:
The system property org.eclipse.swt.browser.XULRunnerPath should be set in
hdbstudio.ini to point to the path of XULRunner, for example:
-Dorg.eclipse.swt.browser.XULRunnerPath=<path to xulrunner>.
This hdbstudio.ini file is located in the same folder as the executable that is used to start the SAP
HANA studio. For Linux, the default location is hana/shared/<SID>/hdbstudio..
The system component should have the same version as the SAP HANA database. Do one of the following:

SAP HANA Server Installation and Update Guide


Managing SAP HANA System Components

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

115

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 cant update the SAP HANA system components 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

Note
The product-specific AFLs are released individually and are no longer released as part of SAP HANA AFL.
Therefore, before updating AFL version SPS 07 to a current version, it is necessary to perform a migration.
For more information, see SAP Note 2014334 in Related Information. You can update AFL version SPS 08
to a current version as described.

Procedure
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
Studio

1. Start the SAP HANA studio.


2. In the SAP HANA studio, add the SAP HANA system.
3. Open the context menu (right-mouse click) in the Systems view, and select Add System.
For more information about adding a system, see Add an SAP HANA System in the SAP HANA Ad
ministration Guide in Related Information.
4. In the SAP HANA studio, log on to the system.
5. From the context menu of the selected system, select
Lifecycle Management

SAP HANA
Cockpit

1.

Lifecycle Management

SAP HANA Platform Lifecycle Management

Platform

Enter the SAP HANA cockpit URL in your browser.


The URL depends on whether you are connecting to a single-container system or to a database in
a multiple-container system.
A single-container system is accessed through the URL: http://<host_FQDN>:

80<instance>/sap/hana/admin/cockpit
For more information about the URLs in multiple-container systems, see Configure HTTP Access
to Multitenant Database Containers.

116

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Managing SAP HANA System Components

Option

Description

Note
FQDN = fully qualified domain name
2. The SAP HANA Platform Lifecycle Management tiles are visible on the homepage of the SAP HANA
cockpit. If they are not, you can add them from the SAP HANA Platform Lifecycle Management tile
catalog. For more information, see Customizing the Homepage of SAP HANA Cockpit.

2. Select the Install or Update Additional Components tile.


3. Select Add Software Locations... to add SAP HANA components for installation or update.
4. 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. For more information about creating a
database user for update, see Related Information.
5. After specifying all system properties, review the summary, and select Run.

Related Information
SAP Note 2014334

6.1.4 Install or Update SAP HANA Components Using the


Resident Program
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 and the product-specific AFLs POS,
SAL, SCA, SOP, UDF), SAP liveCache applications (SAP LCA or LCAPPS-Plugin), XS advanced runtime
applications, or SAP HANA smart data access (SDA) using the SAP HANA database lifecycle manager
(HDBLCM) resident program.

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 cant update the SAP HANA system components 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.

SAP HANA Server Installation and Update Guide


Managing SAP HANA System Components

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

117

Context
You can install or update SAP HANA components using the SAP HANA resident HDBLCM. It's also possible to
specify additional SAP HANA options roles for existing hosts using the add_roles parameter. Multiple host
roles are not supported in production environments. See Related Information, for add_roles documentation.

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 [page 200].

Note
The product-specific AFLs are released individually and are no longer released as part of SAP HANA AFL.
Therefore, before updating AFL version SPS 07 to a current version, it is necessary to perform a migration.
For more information, see SAP Note 2014334 in Related Information. You can update AFL version SPS 08
to a current version as described.

Note
Adding SAP liveCache applications (SAP LCA or LCAPPS-Plugin) is only supported for the integrated SAP
liveCache, single-host scenario. The SAP LCA archive should be owned by the root user.
To install and update software components in SAP HANA XS Advanced, the xs install command is
available in the XS Advanced command-line interface (CLI). For more information, see Installing and Updating
Software Components in SAP HANA XS Advanced Model in the SAP HANA Administration Guide.

Note
The product-specific AFLs are released individually and are no longer released as part of SAP HANA AFL.
Therefore, before updating AFL version SPS 07 to a current version, it is necessary to perform a migration.
For more information, see SAP Note 2014334 in Related Information. You can update AFL version SPS 08
to a current version as described.

Procedure
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 field, or specify the component location as a call option in the command-line
interface using one of the following parameters:
component_dirs
component_medium
component_root
For more information about these parameters, see Related Information.

118

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Managing SAP HANA System Components

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
Graphical
User In
terface

Description
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
mandLine 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 specified --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.

Related Information
SAP Note 2014334
component_dirs [page 169]
component_medium [page 169]
component_root [page 170]
Create a Lesser-Privileged Database User for Update [page 132]
add_roles [page 164]

SAP HANA Server Installation and Update Guide


Managing SAP HANA System Components

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

119

6.2

Remove SAP HANA System Components from a Local


System Host

SAP HANA system components like the SAP HANA client, SAP HANA studio, Application Function Libraries
(AFL), or SAP liveCache applications (SAP LCA) can be removed from an SAP HANA system after installation
from a local host using the SAP HANA lifecycle management tool hdblcm(gui).

Prerequisites
You are logged in as root user.
The SAP HANA system has been installed with the SAP HANA database lifecycle manager (HDBLCM).
The SAP HANA database server is up and running. Otherwise, inconsistencies in the configuration occur.

Note
It is possible to remove the SAP HANA server, SAP HANA client, SAP HANA studio, AFL, or LCAPPS
components, but it is not possible to remove HLM, SDA, SAP Host Agent, or the SMD agent.
If you need to uninstall the SMD agent, see SAP Note 1858920 in Related Information.

Procedure
1. Change to the SAP HANA resident HDBLCM directory:
cd <sapmnt>/<SID>/hdblcm
By default, <sapmnt> is /hana/shared.
2. Start the system component removal task:
To remove system components with the command line interface:
Start the hdblcm command line tool interactively:
./hdblcm
and enter the index of the uninstall action, or
Start the tool with the uninstall parameter specified:
./hdblcm --uninstall

Note
It is also possible to uninstall individual components by specifying
--components=<component1>,<component2>

120

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Managing SAP HANA System Components

in combination with the uninstall parameter. For detailed information about the uninstallation
parameters, review the inline help before uninstalling from the command line:
./hdblcm --uninstall -h
To remove hosts with the graphical interface:
1. Start the hdblcmgui graphical interface tool:
./hdblcmgui
The hdblcmgui interface appears.
2. Choose Uninstall SAP HANA Components.
3. To continue with the task proceed as follows:
In the command line interface: Enter y.
In the graphical interface:
1. To display the summary of the configuration data, choose Next.
2. To execute the configuration task, choose Run. The system displays the configuration progress.
3. After the configuration task has finished, you can:
View the log. To do so, choose View Log.
Exit the graphical user interface. To do so, choose Finish.

Results
The selected components are uninstalled. A log file is available.

Related Information
1858920

6.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
You are logged in as root user.

SAP HANA Server Installation and Update Guide


Managing SAP HANA System Components

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

121

The SAP HANA system has been installed with the SAP HANA database lifecycle manager (HDBLCM).
The SAP HANA database server is up and running. Otherwise, inconsistencies in the configuration occur.

Note
It is possible to remove the SAP HANA server, SAP HANA client, SAP HANA studio system components, or
the Application Function Libraries (AFL and the product-specific AFLs POS, SAL, SCA, SOP, UDF), SAP
liveCache applications (SAP LCA or LCAPPS-Plugin) additional system components, but it is not possible to
remove HLM, SDA, SAP Host Agent, or the SMD agent. If you need to uninstall the SMD agent, see SAP
Note 1858920 in Related Information.

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 finalize the configuration.

Results
The selected components are uninstalled. A log file is available.

Related Information
SAP Note 1858920

122

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Managing SAP HANA System Components

6.2.2 Uninstall SAP HANA Components Using the CommandLine 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
You are logged in as root user.
The SAP HANA system has been installed with the SAP HANA database lifecycle manager (HDBLCM).
The SAP HANA database server is up and running. Otherwise, inconsistencies in the configuration occur.

Note
It is possible to remove the SAP HANA server, SAP HANA client, SAP HANA studio system components, or
the Application Function Libraries (AFL and the product-specific AFLs POS, SAL, SCA, SOP, UDF), SAP
liveCache applications (SAP LCA or LCAPPS-Plugin) additional system components, but it is not possible to
remove HLM, SDA, SAP Host Agent, or the SMD agent. If you need to uninstall the SMD agent, see SAP
Note 1858920 in Related Information.

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 components to be uninstalled as a comma-separated list of indexes. Then select Enter.
5. Review the summary, and select y to finalize the configuration.

Results
The selected components are uninstalled. A log file is available.

SAP HANA Server Installation and Update Guide


Managing SAP HANA System Components

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

123

Related Information
SAP Note 1858920

6.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, you have two
choices:
Uninstall the SAP HANA component using the uninstaller hdbuninst.
To uninstall using this method, follow the procedure below.
Install the SAP HANA resident HDBLCM, then perform component uninstallation as usual using the newly
available SAP HANA resident HDBLCM.
Start the SAP HANA database lifecycle manager from an SAP HANA server installation kit, which has the
same version as the installed SAP HANA database, with the following command:
./hdblcm --action=update --components=hdblcm
Then uninstall using one of the typical uninstallation procedures in Uninstalling SAP HANA Components.

Procedure
1. Change to the hdbuninst directory:
<installation_path>/<SID>/global/hdb/install/bin
2. Start hdbuninst interactively in the command-line interface:
./hdbuninst

124

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Managing SAP HANA System Components

3. Review the summary, and select y to finalize the configuration.

Related Information
Remove SAP HANA System Components from a Local System Host [page 120]

SAP HANA Server Installation and Update Guide


Managing SAP HANA System Components

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

125

Uninstalling the SAP HANA System

If required, you can uninstall the previously installed SAP HANA components by running either the SAP HANA
database lifecycle manager (HDBLCM) from the SAP HANA resident HDBLCM directory.

7.1

Uninstall the SAP HANA System Using the Graphical


User Interface

You can uninstall and SAP HANA system using the SAP HANA database lifecycle manager (HDBLCM)
graphical user interface.

Prerequisites
There is an installed SAP HANA system that should be uninstalled.
You are logged in as root user on the SAP HANA system.

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 and the product-specific AFLs POS,
SAL, SCA, SOP, UDF), SAP liveCache applications (LCAPPS), 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.

Context

Caution
Uninstalling the SAP HANA system removes all data volumes and log volumes. It is a permanent action that
cannot be undone!

126

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Uninstalling the SAP HANA System

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 SAP HANA Database version <version number> and all other components. Then select
Next.
5. Review the summary, and select Uninstall to finalize the configuration.

Results
The selected components are uninstalled. A log file is available.

Related Information
SAP Note 1858920

7.2

Uninstall the SAP HANA System Using the CommandLine Interface

You can uninstall and SAP HANA system using the SAP HANA database lifecycle manager (HDBLCM)
command-line interface.

Prerequisites
There is an installed SAP HANA system that should be uninstalled.
You are logged in as root user on the SAP HANA system.

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 and the product-specific AFLs POS,

SAP HANA Server Installation and Update Guide


Uninstalling the SAP HANA System

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

127

SAL, SCA, SOP, UDF), SAP liveCache applications (LCAPPS), 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.

Context

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 components to be uninstalled as a comma-separated list of indexes. Then select Enter .
5. Review the summary, and select y to finalize the configuration.

Results
The selected components are uninstalled. A log file is available.

Related Information
SAP Note 1858920

128

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Uninstalling the SAP HANA System

Managing the SAP HANA System After


Installation

After the installation has finished, 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 finished 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.
Change the master keys.
SAP HANA secures content in two secure stores in the file system (SSFS): the instance SSFS and the
system PKI SSFS. The initial default master key is changed during installation or update.If you received
your system preinstalled from a hardware or hosting partner, we recommend that you change it
immediately after handover to ensure that it is not known outside of your organization. For more
information, see Change the SSFS Master Keys in the SAP HANA Administration Guide.
Finalize your customization.
Use the SAP HANA lifecycle management tools to adapt the existing configuration, 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
SAP HANA Administration Guide
SAP HANA Security Guide

SAP HANA Server Installation and Update Guide


Managing the SAP HANA System After Installation

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

129

8.1

Start and Stop the SAP HANA System

After the installation has finished successfully, the SAP HANA system is up and running. So you do not need to
start the SAP HANA system.

Context
However, if required, you can start and stop the SAP HANA system from the command line in one of the
following ways:

Procedure
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.

130

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Managing the SAP HANA System After Installation

8.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
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
2016 SAP SE or an SAP affiliate company. All rights reserved.

131

8.3

Create a Lesser-Privileged Database User for Update

As the most powerful database user, SYSTEM is not intended for use in production systems. Create a lesserprivileged database user for updating a system.

Context
For security reasons, the SYSTEM user might not be available during a system update. It is, therefore, required
to import the delivery units as another user.
A database user should be created with the following granted roles and object privileges:
Granted Roles: CONTENT_ADMIN
Object Privileges: _SYS_REPO (SELECT)
By calling one of the update LCM tools with the system_user option specified, the previously defined
database user is used in place of SYSTEM to authenticate the configuration task.

Procedure
1. Add the SAP HANA system in the SAP HANA studio.
For more information, see Add an SAP HANA System in the SAP HANA Administration Guide.
2. Create the user in the SAP HANA studio and grant the new user the CONTENT_ADMIN role and the object
privilege SELECT on the catalog object _SYS_REPO.
For more information, see Create and Authorize a User in the SAP HANA Administration Guide.
3. Re-add the SAP HANA system in the SAP HANA studio as the new user, and create a new password when
prompted.
For more information, see Add an SAP HANA System with a Different User in the SAP HANA Administration
Guide.
4. Perform the SAP HANA system update as usual, specifying the new lesser-privileged user in place of the
SYSTEM user when prompted.

Related Information
system_user [page 191]
SAP HANA Security Guide

132

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Managing the SAP HANA System After Installation

8.4

Enable Data Volume Encryption

To ensure that the SAP HANA database can always be restored to its most recent committed state, all data is
periodically copied to disk. Privacy of data on disk can be ensured by enabling data volume encryption.

Prerequisites
A cryptographic service provider is available on the server.
SAP HANA supports the following cryptographic libraries:
CommonCryptoLib (default)
CommonCryptoLib (libsapcrypto.so) is installed by default as part of SAP HANA server installation at
$DIR_EXECUTABLE.
OpenSSL
The OpenSSL library is installed by default as part of the operating system installation.

Note
If you are using OpenSSL, it is recommended that you migrate to CommonCryptoLib after an upgrade
to Support Package Stack (SPS) 09. For more information, see SAP Note 2093286.

Caution
The distribution of CommonCryptoLib is subject to and controlled by German export regulations and is not
available to all customers. In addition, usage of CommonCryptoLib or OpenSSL may be subject to local
regulations of your own country that may further restrict the import, use, and export or re-export of
cryptographic software. If you have any further questions about this issue, contact your local SAP office.

Context
Data in the SAP HANA database is stored in persistent disk volumes that are organized in pages. If data
volume encryption is enabled, all pages that reside in the data area on the disk are encrypted using the
AES-256-CBC algorithm. Pages are transparently decrypted as part of the load process. When pages reside in
memory they are therefore not encrypted and there is no performance overhead for in-memory page
accesses. When changes to data are persisted to disk, the relevant pages are automatically encrypted as part
of the write operation.
Enabling data volume encryption does not increase data size.

Note
Do not enable data volume encryption if you plan to use the SAP HANA dynamic tiering option. It is not
possible to create extended storage in encrypted SAP HANA databases. Be aware that you need additional

SAP HANA Server Installation and Update Guide


Managing the SAP HANA System After Installation

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

133

licenses for SAP HANA options. For more information, see Important Disclaimer for Features in SAP HANA
Platform, Options and Capabilities [page 200].
For more information about data volume encryption, see Data Volume Encryption in the SAP HANA Security
Guide.
There are two ways to enable data volume encryption in an existing SAP HANA system. The recommended
way involves reinstalling your system. If this is not possible (for example, because it would result in too much
downtime), you can enable encryption immediately.

Related Information
SAP Note 1848999 - Central Note for CommonCryptoLib 8 (replacing SAPCRYPTOLIB)
SAP Note 2093286 - Migration from OpenSSL to CommonCryptoLib (SAPCrypto)
SAP HANA Security Guide
SAP HANA Administration Guide

8.4.1 Enable Data Volume Encryption with System


Reinstallation
The recommended way to enable data volume encryption in an existing SAP HANA system is after reinstalling
the system.

Prerequisites
You have the privileges required to perform an installation, as well as a backup and recovery.
You have the system privilege RESOURCE ADMIN.
If you are using the SAP HANA cockpit:
You have the role sap.hana.security.cockpit.roles::MaintainDataVolumeEncryption.
The Data Storage Security tile is visible on the homepage of the SAP HANA cockpit. If it's not, you can
add it from the SAP HANA Security Overview tile catalog. For more information, see Customize the
Homepage of SAP HANA Cockpit.
If the system is a secondary site in a system replication setup, you must have finished configuring system
replication before you enable data volume encryption. For more information see Setting Up System
Replication in the SAP HANA Administration Guide.

Context
Enabling data volume encryption after re-installing your system ensures that a new root encryption key is
generated. In addition, it provides complete protection. If you enable encryption without a re-installation, due

134

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Managing the SAP HANA System After Installation

to the shadow memory nature of SAP HANA persistence, outdated versions of pages may still remain
unencrypted on disk.

Procedure
1. Perform a data backup.
2. Uninstall your system.
If possible, overwrite the former data area with random values.
3. Reinstall your system.

Remember
If the system is a secondary site in a system replication setup, you must configure system replication
now, before enabling data volume encryption.
4. Enable data volume encryption:
You can do this using either the SAP HANA studio or the SAP HANA cockpit.
Option
SAP HANA studio

Description
1.

In the Security editor of the system or database to be encrypted, choose the Data Volume
Encryption tab.

2. Select Activate encryption of data volumes and choose


SAP HANA cock
pit

(Deploy).

1.

Open the Data Volume Encryption app by clicking the Data Storage Security tile on the
homepage of the SAP HANA cockpit..
2. Click Encrypt Data Volumes.

5. Recover your system.

Results
All data persisted to data volumes is encrypted. The status of data volume encryption is Encrypted.

Note
In the SAP HANA studio, you must refresh (

) the editor to see status changes.

Related Information
Installing an SAP HANA System [page 50]
SAP HANA Server Installation and Update Guide

SAP HANA Server Installation and Update Guide


Managing the SAP HANA System After Installation

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

135

SAP HANA SQL and System Views Reference

8.4.2 Enable Data Volume Encryption Without System


Reinstallation
If it is not possible to reinstall your SAP HANA system to enable data volume encryption, for example, because
it would result in too much downtime, you can enable encryption immediately. However, this is not
recommended.

Prerequisites
You have the credentials of the operating system user (<sid>adm user) that was created when the
system was installed.
You have the system privilege RESOURCE ADMIN.
If you are using the SAP HANA cockpit:
You have the role sap.hana.security.cockpit.roles::MaintainDataVolumeEncryption.
The Data Storage Security tile is visible on the homepage of the SAP HANA cockpit. If it's not, you can
add it from the SAP HANA Security Overview tile catalog. For more information, see Customize the
Homepage of SAP HANA Cockpit.
If the system is a secondary site in a system replication setup, you must have finished configuring system
replication before you enable data volume encryption on the system. For more information see Setting Up
System Replication in the SAP HANA Administration Guide.

Context
Enabling data volume encryption without a re-installation is not recommended as the resulting protection may
be incomplete. Due to the shadow memory nature of SAP HANA persistence, outdated versions of pages may
still remain unencrypted on disk.

Procedure
1. Log on to the SAP HANA system host as the operating system user, <sid>adm.
2. Optional: Change the root encryption key used for data volume encryption.

Note
SAP HANA generates new and unique root keys on installation. However, if you received SAP HANA
pre-installed from a hardware or hosting partner, you might want to change the root key used for data
volume encryption to ensure it is not known outside your organization.

136

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Managing the SAP HANA System After Installation

Caution
If the system is configured for system replication (either as a primary or secondary system), do not
change the data volume encryption root key.
a. Verify that no data is currently encrypted:
In the Security editor of the SAP HANA studio, choose the Data Volume Encryption tab and verify
that all services have the status Unencrypted.
In the SAP HANA cockpit, verify that the status of data encryption displayed on the Data Storage
Security tile is Off.

Caution
If data volume encryption was previously enabled and then disabled, it is important that the
decryption process that happens after disablement be allowed to fully complete. Changing the root
key while data is still encrypted will render the SAP HANA database unusable.
b. Shut the system down using the sapcontrol program:
/usr/sap/hostctrl/exe/sapcontrol -nr <instance_no> -function Stop
c. Generate a new root encryption key using the hdbnsutil program.
cd /usr/sap/<sid>/HDB<instance_no>/exe
./hdbnsutil - generateRootKeys --type=PERSISTENCE
d. Start the system using the sapcontrol program:
/usr/sap/hostctrl/exe/sapcontrol -nr <instance_no> -function Start
e. Reset the consistency information in the SSFS using the hdbcons program:
cd /usr/sap/<sid>/HDB<instance_no>/exe
./hdbcons "crypto ssfs resetConsistency"
The first time you execute the command, it does not reset the consistency information in the SSFS
but outputs only a warning. To actually reset the consistency information in the SSFS, you must
execute the command again within 20 seconds.
3. Enable data volume encryption:
You can do this using either the SAP HANA studio or the SAP HANA cockpit.
Option
SAP HANA studio

Description
1.

In the Security editor of the system or database to be encrypted, choose the Data Volume
Encryption tab.

2. Select Activate encryption of data volumes and choose


SAP HANA cock
pit

(Deploy).

1.

Open the Data Volume Encryption app by clicking the Data Storage Security tile on the
homepage of the SAP HANA cockpit..
2. Click Encrypt Data Volumes.

SAP HANA Server Installation and Update Guide


Managing the SAP HANA System After Installation

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

137

Results
Encryption is now active for new data saved to disk as of the next savepoint operation.
Once you have activated encryption, existing data starts being encrypted in the background. Depending on the
size of the SAP HANA system or database, this process can be very time consuming. Only after this process
has completed is all your data encrypted. You can monitor the progress of encryption service by service. Once
encryption of a data volume has completed, the status changes to Encrypted.

Note
In the SAP HANA studio, you must refresh (

) the editor to see status changes.

Remember
Due to the shadow memory nature of SAP HANA database persistence, the data area may still contain
outdated, unencrypted versions of pages. This approach is therefore not recommended.

Related Information
SAP HANA SQL and System Views Reference

8.5

Change the Root Key of the Internal Data Encryption


Service

SAP HANA generates new and unique root keys on installation. However, if you received SAP HANA preinstalled from a hardware or hosting partner, you might want to change the root key of the internal data
encryption service to ensure it is not known outside your organization. We recommend that you do this
immediately after system installation or handover from your hardware or hosting partner.

Prerequisites
You have the credentials of the operating system user (<sid>adm user) that was created when the
system was installed.
You have the credentials of the database user SYSTEM.
You have the system privilege RESOURCE ADMIN.

138

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Managing the SAP HANA System After Installation

Context
The internal data encryption service can be used by SAP HANA XS-based applications and SAP HANA internal
components to securely store data in the database. Consumers of this service include the secure internal
credential store for the logon of applications to remote systems (outbound connections), as well as all secure
stores defined using the SAP HANA XS $.security.Store API. Every consumer of the service has its own
system-internal application encryption key. Application encryption keys are encrypted with the root key of the
data encryption service.
You should only change this root key if you need to ensure that it is not known outside your organization.
Ideally, you change the root immediately after installation or receipt of your system from the hardware
partner. At the latest, you must change it before any data is encrypted using the service. This means before
you create any of the following things:
A remote data source
A HTTP destination
An XS secure store
A certificate collection with private key

Caution
Changing the root key after data has been encrypted will result in key information in the SSFS and the
database becoming inconsistent and encrypted data becoming inaccessible. Rectifying the problem could
result in data loss. We recommend that you contact SAP Support if errors related to inconsistent SSFS or
encryption failure occur.
Additionally, if the system supports multitenant database containers, you must change the root key before any
tenant databases have been created.

Procedure
1. Verify that no data has already been encrypted using the internal data encryption service by querying the
following system views:
CREDENTIALS (PUBLIC)
P_DPAPI_KEY_ (SYS)

Note
This view can only be accessed by user SYSTEM.
If the credential store is empty, then CREDENTIALS (PUBLIC) will also be empty. If there are no XS secure
stores, then P_DPAPI_KEY_ (SYS) will have no records with the caller XsEngine. If there are no certificate
collections with private keys, then there will be no records with the caller PSEStore.

Caution
Do not proceed with the root key change if there is encrypted data.

SAP HANA Server Installation and Update Guide


Managing the SAP HANA System After Installation

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

139

2. Log on to the SAP HANA system host as the operating system user, <sid>adm.
3. Shut the system down using the sapcontrol program:
/usr/sap/hostctrl/exe/sapcontrol -nr <instance_no> -function Stop
4. Generate a new root encryption key using the hdbnsutil program.
cd /usr/sap/<sid>/HDB<instance_no>/exe
./hdbnsutil - generateRootKeys --type=DPAPI
5. Start the system using the sapcontrol program:
/usr/sap/hostctrl/exe/sapcontrol -nr <instance_no> -function Start
6. Reset the consistency information in the SSFS using the hdbcons program:
cd /usr/sap/<sid>/HDB<instance_no>/exe
./hdbcons "crypto ssfs resetConsistency"
The first time you execute the command, it does not reset the consistency information in the SSFS but
outputs only a warning. To actually reset the consistency information in the SSFS, you must execute the
command again within 20 seconds.
7. Change all application keys so that they are encrypted with the new root key.
You do this by executing the following SQL statement, for example using the SAP HANA studio or SAP
HANA HDBSQL:
ALTER SYSTEM APPLICATION ENCRYPTION CREATE NEW KEY

Note
You need RESOURCE ADMIN to execute this command.
After the next savepoint operation, new random internal application keys are created. New data is
encrypted with the new application keys and the new keys are encrypted with the root encryption key. No
re-encryption takes place. Any data encrypted with existing keys continues to be encrypted with these
keys.

Note
Depending on the workload of the database, the next savepoint operation may not happen for some
time. You can force a savepoint with the statement: ALTER SYSTEM SAVEPOINT. In particular, you
should force a savepoint with this statement if you plan to shut down your database right after
generating the new application keys because a shutdown does not automatically write a savepoint and
your change would be lost.

Related Information
SAP HANA XS JavaScript API Reference
SAP HANA Security Guide

140

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Managing the SAP HANA System After Installation

SAP HANA Developer Guide (For SAP HANA Studio)

SAP HANA Server Installation and Update Guide


Managing the SAP HANA System After Installation

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

141

Tutorials

The following tutorials are a sampling of general use cases, which illustrate the functionality and versatility of
the SAP HANA database lifecycle manager.

9.1

Tutorial: Using Custom Configuration Files

During system installation, customized SAP HANA configuration (*.ini) files can be placed inside a dedicated
directory that is specified using the custom_cfg parameter.

Context
Custom configuration files can be placed inside a custom configuration folder. These files are used during
installation to override default settings. This reduces the number of restarts during installation and facilitates
configuration of the SAP HANA system.

Procedure
1. Create an empty directory that will contain your custom configuration files. The configuration files will be
copied to the following directory before system start and will override the default settings: <sapmnt>/
<SID>/global/hdb/custom/config
2. Create your own configuration files (*.ini) inside the custom configuration files directory. Alternatively, you
can copy existing files from another system to re-use a tested configuration. For more information on
configuration files, see Configuring SAP HANA System Properties (INI Files) in the SAP HANA
Administration Guide.
3. Now the installer can be called from the command line.
./hdblcm --action=install --custom_cfg=<path to directory containing custom
configuration files>

Related Information
custom_cfg [page 172]
SAP HANA Administration Guide
SAP Note 2267798 - Configuration of the SAP HANA Database during Installation Using hdbparam

142

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Tutorials

9.2

Tutorial: Installing a Multiple-Host System Using a


Configuration 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 configuration file. The installation is run in batch mode, so that once the installation is
started, both host installations are configured without any further input required.

Procedure
1. The following are the relevant parameters for the SAP HANA server. They are specified in a combination of
command line options and configuration file:
Table 17:
Parameter

Input

Location Specified

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

Configuration file

action

--action=install

Call option

sid

sid=ABC

Configuration file

number

number=01

Configuration file

root_user

root_user=sysroot

Configuration file

addhosts

addhosts=hananode1

Configuration file

configfile

--configfile=/home/sysroot/hdblcm.cfg

Call option

batch

-b

Call option

userid

userid=55

Configuration file

SAP HANA Server Installation and Update Guide


Tutorials

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

143

Parameter

Input

Location Specified

groupid

groupid=110

Configuration file

storage_cfg

storage_cfg=/home/sysroot/storage

Configuration file

2. The reusable installation parameter values are saved in the following configuration file:
[Server]
# Additional Hosts
addhosts=hananode1
# Root User Name (Default: root)
root_user=sysroot
# Root User Password
root_password=Root1234
# SAP HANA System ID
sid=ABC
# Instance Number (Default: <next available number>)
number=01
# SAP Host Agent (sapadm) Password
sapadm_password=Agent1234
# System Administrator Password
password=Adm1234
# System Administrator User ID (Default: <next available number>)
userid=55
# ID of User Group 'sapsys' (Default: 79)
groupid=110
# Directory containing a storage configuration
storage_cfg=/home/sysroot/storage
# Database User (SYSTEM) Password
system_user_password=Sys1234
3. Now the installer can be called from the command line, with the remaining parameters read from the
configuration file. The installation is run in batch mode, so no follow-up confirmation is required.
./hdblcm --action=install --configfile=/home/sysroot/hdblcm.cfg -b

9.3

Tutorial: Overwriting Configuration File Parameters


with Command Line Parameters

The following use case uses the same configuration file as above. However, this time, the desired system
deviates slightly from the one defined the configuration file. By specifying parameters in the command line
which are already specified in the configuration file, the configuration file settings are effectively overwritten.
The command line parameters take precedence over the configuration file parameters.

Procedure
1. The following are the desired parameters for the SAP HANA server. They are specified in a combination of
command line and configuration file:

144

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Tutorials

Table 18:
Parameter

Input

Location Specified

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

Configuration file

yes

action

--action=install

CLI

yes

sid

sid=ABC

Configuration file

no

sid

--sid=DB1

CLI

yes

number

number=01

Configuration file

no

number

-n 01

CLI

yes

root_user

root_user=sysroot

Configuration file

yes

addhosts

addhosts=hananode1

Configuration file

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

Configuration file

yes

groupid

groupid=110

Configuration file

yes

storage_cfg

storage_cfg=/home/sysroot/
storage

Configuration file

no

SAP HANA Server Installation and Update Guide


Tutorials

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

145

Parameter

storage_cfg

Input

--storage_cfg=/home/sysroot/
storage_new

Location Specified

Used for Installation

CLI

yes

2. The reusable installation parameter values are saved in the following configuration file:
[Server]
# Additional Hosts
addhosts=hananode1
# Root User Name (Default: root)
root_user=sysroot
# Root User Password
root_password=Root1234
# SAP HANA System ID
sid=ABC
# Instance Number (Default: <next available number>)
number=01
# SAP Host Agent (sapadm) Password
sapadm_password=Agent1234
# System Administrator Password
password=Adm1234
# System Administrator User ID (Default: <next available number>)
userid=55
# ID of User Group 'sapsys' (Default: 79)
groupid=110
# Directory containing a storage configuration
storage_cfg=/home/sysroot/storage
# Database User (SYSTEM) Password
system_user_password=Sys1234
3. Now the installer can be called from the command line, with the remaining parameters read from the
configuration file. The installation is run in batch mode, so no follow-up confirmation is required.
./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

9.4

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 configured without any further input required.

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.

146

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Tutorials

Table 19:
Parameter

Input

Location Specified

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 file is prepared with the accepted XML syntax:
hdb_passwords.xml
<?xml version="1.0" encoding="UTF-8"?>
<Passwords>
<password><![CDATA[Adm1234]]></password>
<sapadm_password><![CDATA[Agent1234]]></sapadm_password>
<system_user_password><![CDATA[Sys1234]]></system_user_password>
<root_password><![CDATA[Root1234]]></root_password>
</Passwords>
3. Now the installer can be called from the command line, with the passwords read from a standard input
stream. The installation is run in batch mode, so no follow-up confirmation is required.
cat ~/hdb_passwords.xml | ./hdblcm --sid=P02 --number 01 --root_user=sysroot
--read_password_from_stdin=xml --batch

9.5

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 configuration file 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 configuration file, command line options, and batch mode, so that an SAP HANA
system installation can be executed once without any follow-up selection.
To illustrate the purpose of installation automation, let us assume there is a hardware partner who offers SAP
HANA platforms (SAP HANA system installed on SAP verified hardware) in three sizes: Small, Large, and Extra
Large.

SAP HANA Server Installation and Update Guide


Tutorials

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

147

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.

148

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Tutorials

The hardware partner automates the installation of nine SAP HANA systems (1 Extra Large, 5 Large, and 3
Small). Previously, he has created configuration files for each of the three system types. So, when several
orders come in at the same time, he fine tunes his installation script to include the number of systems and
calls the SAP HANA database lifecycle manager using the command-line interface with the configuration file
parameter in batch mode. When the installation script is run, SAP HANA is installed on both the single-host
and multiple-host systems, without any additional input. By reusing the same configuration files, the
installations are reliable, flexible, and efficient.

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.
Table 20:
For All System Types
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

For security reasons, the data device and log device should

will be located?

not be the same. Refer to the SAP HANA System Types.

SAP HANA Server Installation and Update Guide


Tutorials

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

149

Where will the required file systems be located and is the

Refer to the Recommended File System Layout.

storage sufficient?
Have you performed a hardware check?

The installer performs a hardware check before installation,


for automated installation it is recommended to perform a
manual hardware check first. Refer to the Hardware and
Software Requirements.

Where will you specify passwords?

SYSTEM, <sid>adm, and root passwords must be specified


in the configuration file or in an XML file. Refer to the Speci
fying Passwords information.

For the Multiple-Host System Type Only


How many worker hosts and standby hosts will there be?

System processes and data are distributed among worker

How will they be grouped?

hosts, including the original host. Standby hosts do not per


form tasks. Refer to the Multiple-Host System Concepts.

How will storage devices be configured?

External storage can be configured so that hosts have


shared or non-shared access. Refer to the Multiple-Host
System Concepts.

The root user name must be the same for all hosts in a mul

If not, the root_user parameter must be specified during

tiple-host system. Will the root user name for all hosts be

installation. Refer to the root_user parameter information.

"root"?

Step 2: Review the installation scenario.


In order to provide flexibility, it is possible to install the same SAP HANA system in several ways. The
differences between installation methods are best depicted through a one-to-one comparison of the same
system installed with each available method.
In the following example, there is a hardware partner who plans to install several SAP HANA single-host
systems. His desired system has the following specifications:
System name: P01
Instance number: 01
Installation path: /hana/shared
Data path: /hana/data/P01
Log path: /hana/log/P01
User group ID: 110

150

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

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 configured system installation on several hosts at the same time, come back later, and the installed
SAP HANA platforms will be finished and ready to ship. To reach his goal, he installs the same system (P01)
three times, using:
Command line options
Configuration file
Configuration file 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 first from the
command line. He reviews the installation parameters and finds the corresponding parameter key-value pairs
for his desired P01 single-host system.
Table 21:
System Detail

Specification

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
2016 SAP SE or an SAP affiliate company. All rights reserved.

151

Upon review of the parameter syntax, he realizes he did not need to specify sapmnt, datapath, or logpath
parameters because he chose the default values. The rest of the parameters could also have been given the
short-form syntax. Therefore, the same P01 system installation could be simplified to the following syntax:
./hdblcm s P01 n 01 G 110
Table 22:
System Detail

Specification

Simplified 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


configuration file.
Now that the hardware partner successfully installed from the command line, he wants to make use of the
configuration file, since his end goal is to automate the installation.
He generates a template of the configuration file:
./hdblcm --action=install --dump_configfile_template=/home/root/HANA_install.cfg
He opens the blank configuration file template and fills 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
Since it was already discovered that only the SID, instance number, and group ID differ from the default values,
only they are specified in the configuration file. The hardware partner also realizes that there is automatic
substitution of the SID (sid) and installation path (sapmnt) throughout the configuration file according to
default values (for example, datapath default: /hana/data/${<sid>}), so he does not need to append the
SID (in this case, P01) to the paths.
Now, he can start the installer from the command line with the following simple command:
./hdblcm --configfile=/home/root/HANA_install.cfg

152

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Tutorials

Step 5: Automate the system installation using the configuration file 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 confirming other default parameters as part of interactive mode. Batch mode runs the
installer without asking for any confirmation or parameter entry, thereby allowing installation to run to
completion from one push of a button.
There are two choices for password entry in batch mode. Either the passwords can be stored in an XML file
and passed to the installer as a stream by standard input, or they can be specified in the configuration file.
Since the hardware partner is already making use of the configuration file, he decides to enter the passwords
there. The only mandatory parameters in batch mode are the SID and passwords, so he checks the other
defaults of the mandatory installation values before continuing the installation. In batch mode, the installer
accepts default values for any unspecified parameters.
With the addition of passwords to the configuration file, it now looks like this:
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 50]
SAP HANA Hardware and Software Requirements [page 16]
SAP HANA System Types [page 11]
Recommended File System Layout [page 18]
Specifying Passwords [page 54]
root_user [page 187]

SAP HANA Server Installation and Update Guide


Tutorials

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

153

Multiple-Host System Concepts [page 61]

154

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Tutorials

10 Troubleshooting

Troubleshooting should be referred to if the installation fails for an unknown reason, or for workarounds in
special circumstances.

Checking the Log Files


The SAP HANA lifecycle management tools hdblcm and hdblcmgui write log files during installation. The
most recent log file is always available under /var/tmp/hdblcm.log or /var/tmp/hdblcmgui.log.
Additionally, a copy of the log files is archived in the directory hdb_<SID>_hdblcm_<action>_<date>..
Since the SAP HANA lifecycle management tools hdblcm and hdblcmgui are wrappers for underlying
component installers, it is also possible to check the component logs. It is recommended to review and
analyze the SAP HANA lifecycle management tools hdblcm and hdblcmgui logs first. Once the source of the
problem is narrowed down to a specific component, then the component logs can be further analyzed.
The component log files 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 files 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 files, makes a detailed
analysis more easy
You can also view the last three log files in the SAP HANA studio using the administration function Diagnosis
Files. For more information, see the SAP HANA Database - Administration Guide.

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.

SAP HANA Server Installation and Update Guide


Troubleshooting

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

155

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 specified in combination
with pass_through_help.
Syntax
To view the help output for the installation or the update pass_through_help
parameters, use the following syntax:
--action=[install|update] --pass_through_help --help
or
--action=[install|update] --pass_through_help -h
Table 23: 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

--hdbinst_plugin_system_user
Specifies 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
Specifies the connectivity method for multiple host operations [default: ssh]

156

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Troubleshooting

Parameter

Install

Update

--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>
Specifies the HTTP port of the XS engine

--hdbinst_server_xs_engine_https_port=<port>
Specifies the HTTPS port of the XS engine

--hdbinst_studio_features=all|<feat1>[,<feat2>]...
Specifies 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]

--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

SAP HANA Server Installation and Update Guide


Troubleshooting

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

157

Parameter

Install

Update

--hdbupd_server_prepare_update
Stops the update before software version switch

--hdbupd_server_remote_execution
Specifies 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>
Specifies the HTTP port of the XS engine

--hdbupd_server_xs_engine_https_port=<port>
Specifies the HTTPS port of the XS engine
XML password tag: <hdbinst_plugin_password>
System administrator password

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 file for further analysis. You can switch on the installer trace by setting the
environment variable HDB_INSTALLER_TRACE_FILE to <tracefilename>. The directory containing the
trace file must already exist.

Locating all SAP HANA File System Components


In addition to the main components installed in the default file systems described in Recommended File
System Layout [page 18], it may also be necessary to locate the temporary files from the SAP HANA system.
They can be found in the following directories:
SAP HANA DB files:
/var/lib/hdb - IPC data (volatile)
/var/tmp - Installer log files, HDB_alive_*
/tmp - .hdb_*_lock (volatile)
sapstartsrv files:
/etc/init.d/sapinit* - Boot script
/tmp/.sap* - Sockets, lock files (volatile)

158

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Troubleshooting

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.

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

Adjusting the System Time


A host cannot be added using the SAP HANA lifecycle management tool hdblcm if the time difference between
the system time set on the installation host and the additional host is greater than 180 seconds. For
information about setting the system time, see the documentation of your Linux distribution.

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.
Table 24:
Graphical user interface

SAP HANA Server Installation and Update Guide


Troubleshooting

./hdblcmgui --action=update -update_execution_mode=standard

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

159

Command-line interface

./hdblcm --action=update -update_execution_mode=standard

If you are using the SAP HANA HDBLCM Web user interface, open the Advanced Parameters Configuration
dialog from the footer bar and select the standard update Update Execution Mode under General Parameters.

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 XSA server>"

160

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Troubleshooting

11

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 configuration file format for the parameter. Interactive
mode (for both the GUI and CLI) do not require the use of parameter syntax.
Options - The sub-specifications for the highly configurable parameters.
Remarks - Important information about the parameters, including default values and whether the
parameter is offered in interactive mode. If it is not available in interactive mode, and the default value is
not wanted, the parameter must be specified as a command line option or in the configuration file in
combination with the call to the installation tool in interactive mode.
Examples - The syntax in its common usage with acceptable parameter specifications.
Related Information - Links to relevant sections in the current document or to other documents which
contain more detailed information.

11.1

action

Specifies the action of hdblcm to be either installation or update.


Syntax
In the command line, the following syntax is used:
--action=[install|update]
Remarks
The default for this parameter is --action=install.
This parameter is available in interactive mode.

11.2

addhosts

Specifies additional hosts for the SAP HANA system as a comma-separated list. Individual host options are
specified by a colon-separated list.This parameter is used when configuring a multiple-host system during
installation.
Requirements
If the root user has a user name other than "root", the root_user parameter must
also be specified in combination with addhosts.

SAP HANA Server Installation and Update Guide


Parameter Reference

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

161

When used with command-line batch mode, the action parameter must be specified
in combination with addhosts.
Syntax
In the command line, the following syntax is used:
--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 configure the parameter:
role - Specifies the purpose of the SAP HANA host. SAP HANA hosts in
production environments must only have one host role. However, if XS advanced
runtime is installed, hosts can share multiple roles.
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.
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 smart data streaming
rdsync - Host for SAP HANA remote data sync
xs_worker - Host for SAP HANA XS advanced runtime
xs_standby - Standby host for SAP HANA XS advanced runtime
group - Specifies the host group ID for failover scenarios. If undefined, the host
group is named "default".
(The host group ID is NOT the same as the sapsys group ID, which is specified by
the parameter groupid).
storage_partition - Specifies the storage partition number, which is a logical
role number assigned to non-shared storage devices in a storage connector API.
Standby hosts do not have a storage partition. By default, the storage partition
number is assigned automatically.
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 Remote Data Sync
SAP HANA Smart Data Streaming

162

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Parameter Reference

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 [page 200].

Related Information
Multiple-Host System Concepts [page 61]
Install a Multiple-Host SAP HANA System Using the Graphical User Interface [page 64]
root_user [page 187]
action [page 161]

11.3

add_local_roles

Specifies additional roles of the local host during SAP HANA system installation. Multiple host roles are not
supported in production environments. However, if XS advanced runtime is installed, hosts can share multiple
roles.
Syntax
In the command line, the following syntax is used:
--add_local_roles=<role1>[,<role2>]
where the following roles can be specified:
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.
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 smart data streaming
rdsync - Host for SAP HANA remote data sync
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
SAP HANA Remote Data Sync

SAP HANA Server Installation and Update Guide


Parameter Reference

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

163

SAP HANA Smart Data Streaming

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 [page 200].

11.4

add_roles

Specifies additional roles for exisiting SAP HANA hosts during SAP HANA option installation. Multiple host
roles are not supported in production environments. However, if XS advanced runtime is installed, hosts can
share multiple roles.
Syntax
In the command line, the following syntax is used:
--add_roles=<host name>=<role> -R <host name>=<role>
where the following roles can be specified:
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
rdsync - Host for SAP HANA remote data sync
streaming - Host for SAP HANA smart data streaming
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 [page 200].

11.5

ase_datapath

Specifies the path to the directory of the SAP HANA accelerator for SAP ASE data. Required for installation of
SAP HANA accelerator for SAP ASE.
Syntax
In the command line, the following syntax is used:
--ase_datapath=<path to SAP HANA accelerator for SAP ASE data
directory>

164

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Parameter Reference

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 [page 200].

11.6

ase_logpath

Specifies the path to the directory of the SAP HANA accelerator for SAP ASE logs. Required for installation or
update of SAP HANA accelerator for SAP ASE.
Syntax
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 [page 200].

11.7

ase_user

Specifies 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>

SAP HANA Server Installation and Update Guide


Parameter Reference

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

165

Remarks
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 [page 200].

11.8

autoadd_xs_roles

Assigns XS_WORKER and XS_STANDBY host roles. By default, the host role XS_WORKER will be assigned to
all worker hosts, the host role XS_STANDBY will be assigned to all standby hosts.
Syntax
In the command line, the following syntax is used:
--autoadd_xs_roles[=off]
Remarks
The default for this parameter is --autoadd_xs_roles (on).
This parameter is available in interactive mode.

11.9

autostart

Restarts system after machine reboot.


Syntax
In the command line, the following syntax is used:
--autostart=[0|1]
where 0 = off, and 1 = on
Remarks
The default for this parameter is --autostart=0 (off).

166

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Parameter Reference

11.10

basepath_streaming

Specifies 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.

11.11

batch

Runs the SAP HANA lifecycle management tool from the command line in batch mode using default values for
unspecified parameters. If mandatory values are omitted or if invalid values are specified, the program issues
an error message.
Syntax
In the command line, the following syntax is used:
--batch
or, in short form:
-b

Related Information
Specifying Passwords [page 54]

11.12

certificates_hostmap

Specifies the hostname used for generation of self-signed SSL certificates for the SAP host agent.
Requirements

SAP HANA Server Installation and Update Guide


Parameter Reference

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

167

The key-value pair action=install must be specified 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 certificates for two hosts in the long-form syntax:
./hdblcm --action=install -certificates_hostmap=hananode01=server1.company.com -certificates_hostmap=hananode02=server2.company.com
The following example generates certificates for two hosts in the short-form syntax:
./hdblcm --action=install -C hananode01=server1.company.com -C
hananode02=server2.company.com
In this example, not all required installation parameters are specified in the command line. If this is the case,
the remaining mandatory parameters are requested interactively.

Related Information
action [page 161]
components [page 170]

11.13

checkmnt

Specifies a non-standard shared file system, which can be accessed by all hosts during installation. This
parameter is typically used when the SID is included in the mountpoint.
Syntax
In the command line, the following syntax is used:
--checkmnt=<path>

168

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Parameter Reference

11.14

check_only

Executes checks, but does not change the SAP HANA system.
Syntax
In the command line, the following syntax is used:
--check_only

11.15

client_path

Specifies 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.

11.16

component_dirs

Specifies the installer component directories as a comma-separated list.


Syntax
In the command line, the following syntax is used:
--component_dirs=<component directory>

11.17

component_medium

Specifies the location of the SAP HANA installation medium.


Syntax
In the command line, the following syntax is used:
--component_medium=<directory of the installation medium>

SAP HANA Server Installation and Update Guide


Parameter Reference

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

169

11.18

component_root

Specifies the directory root to search for components.


Syntax
In the command line, the following syntax is used:
--component_root=<component root directory>

11.19

components

Specifies the components to be installed in combination with the SAP HANA server: SAP HANA client, SAP
HANA studio, aAdditional system components like Application Function Libraries (AFL and the productspecific AFLs POS, SAL, SCA, SOP, UDF), SAP liveCache applications (SAP LCA or LCAPPS-Plugin), or SAP
HANA smart data access (SDA), or SAP HANA options. It is also possible to specify all components, or to
specify a combination of components as a comma-separated list. The server is always installed, even if it is not
explicitly specified.
Requirements
The parameter action must be specified in combination with components.
Syntax
In the command line, the following syntax is used:
--action=[install|update] --components[=all|client|
es|ets|lcapps|server|smartda|streaming|studio|afl|pos|sal|sca|
sop|trd|udf]
Remarks
The default for this parameter is --components=client,server and is dependent
on the installer finding installation sources for the components.

Caution
Be aware that you need additional licenses for SAP HANA options. For more
information, see Important Disclaimer for Features in SAP HANA Platform, Options
and Capabilities [page 200].
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 specification):
./hdblcm --action=install --components=client,studio

170

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Parameter Reference

In this example, not all required installation parameters are specified in the command line. If this is the case,
the remaining mandatory parameters are requested interactively.

Related Information
action [page 161]

11.20

configfile

Loads a configuration file 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:
--configfile=<file path>
Remarks
The configuration file makes installation and configuration tasks more efficient and
reliable. For more information, see Related Information.
This complement to this call option is the call option dump_configfile_template.

Related Information
dump_configfile_template [page 174]

11.21

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:
--continue_update[=off]
Remarks
The default for this parameter is --continue_update (on).

SAP HANA Server Installation and Update Guide


Parameter Reference

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

171

This parameter is available in interactive mode.

Related Information
Prepare an Update for Reduced SAP HANA System Downtime [page 96]

11.22

copy_repository

Specifies 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

11.23

custom_cfg

Specifies the path to the directory which contains custom configuration (*.ini) files.
Syntax
In the command line, the following syntax is used:
--custom_cfg=<path to directory containing custom
configuration files>
Remarks
Customized versions of SAP HANA configuration files for configuring the system as a
whole and individual tenant databases and services can be placed inside the directory.
These configuration files will be copied to the following directory before system start
and will override the default settings:
<sapmnt>/<SID>/global/hdb/custom/config

Related Information
SAP HANA Administration Guide

172

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Parameter Reference

SAP Note 2267798 - Configuration of the SAP HANA Database during Installation Using hdbparam
Tutorial: Using Custom Configuration Files [page 142]

11.24

datapath

Specifies the path to the data directory of the SAP HANA system.
Syntax
In the command line, the following syntax is used:
--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 specified if the new directory is located on a different physical
storage. The contents of the directory must be moved manually to the new location.

11.25

db_isolation

Specifies the isolation of the tenant databases on operating system level for multitenant database container
SAP HANA systems. By default, all database processes in a multiple-container system run under the default
OS user <sid>adm. If it's important to mitigate against cross-database attacks through OS mechanisms, you
can configure the system for high isolation. In this way, the processes of individual tenant databases must run
under dedicated OS users belonging to dedicated OS groups. Database-specific data on the file system is
subsequently protected using standard OS file and directory permissions.
Requirements
This parameter must be used in combination with db_mode=multiple_containers.
For more information, see Related Information.
Syntax
In the command line, the following syntax is used:
--db_isolation=high|low
Remarks
The default for this parameter is --db_isolation=low.
This parameter is available in interactive mode.
For more information about database isolation, see Database Isolation in the SAP
HANA Administration Guide or the SAP HANA Security Guide.

SAP HANA Server Installation and Update Guide


Parameter Reference

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

173

Related Information
db_mode [page 174]
SAP HANA Security Guide
SAP HANA Administration Guide

11.26

db_mode

Specifies whether the system is installed in single-container mode (default) or multiple-container mode. A
single-container system contains one database but the system and the database are perceived as a single
unit. A multiple-container system contains one system database and any number of tenant databases. The
system database is created during the installation process. A system administrator must create the required
tenant databases after installation. For general information about multiple-container systems, see Related
Information.
Syntax
In the command line, the following syntax is used:
--db_mode=multiple_containers|single_container
Remarks
The default for this parameter is --db_mode=single_container.
This parameter is available in interactive mode.

Related Information
SAP HANA Administration Guide

11.27

dump_configfile_template

Specifies a file path to which a template configuration file is exported. The call options in the template
configuration file are set to their default values, and can be edited.
Syntax
In the command line, the following syntax is used:
--dump_configfile_template=<file path>
Remarks

174

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Parameter Reference

The configuration file makes installation and configuration tasks more efficient and
reliable. For more information, see Related Information.
This complement to this call option is the call option configfile.

11.28

es_datapath

Specifies the path to the directory of the SAP HANA dynamic tiering data. Required for installation of SAP
HANA dynamic tiering.
Syntax
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 [page 200].

11.29

es_logpath

Specifies the path to the directory of the SAP HANA data tiering logs. Required for installation or update of
SAP HANA dynamic tiering.
Syntax
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 [page 200].

SAP HANA Server Installation and Update Guide


Parameter Reference

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

175

11.30

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 93]

11.31

groupid

Specifies the SAP system (sapsys) group ID. This parameter is relevant only if a sapsys group does not already
exist on the host. If a sapsys group already exists, passing the groupid parameter does not alter the existing
group.
Syntax
In the command line, the following syntax is used:
--groupid=<sapsys group ID>

176

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Parameter Reference

or, in short form:


-G <sapsys group ID>
Remarks
The default for this parameter is --groupid=79.
This parameter is available in interactive mode.

11.32

help

Displays the inline help information.


Syntax
In the command line, the following syntax is used:
--help
or, in short form:
-h
Remarks
A general help output is available for all SAP HANA lifecycle management programs.
Task-specific help output is available for some programs. Refer to the task
documentation for more details.

11.33

home

Specifies the home directory of the system administrator. This parameter is relevant only if the operating
system administrator (<sid>adm) does not exist prior to installation.
Syntax
In the command line, the following syntax is used:
--home=<home directory>
Remarks
The default for this parameter is --home=/usr/sap/<SID>/home.
This parameter is available in interactive mode.

SAP HANA Server Installation and Update Guide


Parameter Reference

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

177

11.34

hostname

Specifies 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
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).
The default for this parameter is the host name of the current machine.
This parameter is available in interactive mode.

11.35

ignore

Specifies failing preequisite checks that the SAP HANA platform lifecycle management tools should ignore.
Syntax
In the command line, the following syntax is used:
--ignore=<check1>[,<check2>]...

11.36

import_xs_content

Imports SAP HANA XS advanced runtime content.


Syntax
In the command line, the following syntax is used:
--import_xs_content[=off]
Remarks
The default for this parameter is --import_xs_content.

178

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Parameter Reference

11.37

install_hostagent

Enables the installation or update of the SAP host agent.


Syntax
In the command line, the following syntax is used:
--install_hostagent[=off]
Remarks
The default for this parameter is --install_hostagent (on).

11.38

install_ssh_key

Installs SSH key to access remote hosts.


Syntax
In the command line, the following syntax is used:
--install_ssh_key[=off]
Remarks
The default for this parameter is --install_ssh_key (on).

11.39

internal_network

Specifies the internal subnet address in CIDR notation.


Syntax
In the command line, the following syntax is used:
--internal_network=<address>|none
Example
The following example specifies the internal network address in CIDR notation.
--internal_network=192.168.1.0/24

SAP HANA Server Installation and Update Guide


Parameter Reference

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

179

11.40

listen_interface

Specifies 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 configuration is only an option for single installations as the server is not
reachable from outside. This option does not require an internal network address
entry.
Remarks
If you define a value other than local, the local interfaces will always be open.
When using listen_interface in batch mode, the global option must be specified
in combination with --internal_network=none to disable internal network binding.
This parameter is available in interactive mode.

11.41

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:
--list_systems
or, in short form:
-L

180

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Parameter Reference

11.42

load_initial_xs_content

Imports SAP HANA XS advanced runtime content if --import_xs_content=off 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.

11.43

logpath

Specifies the path to the log directory of the SAP HANA system.
Syntax
In the command line, the following syntax is used:
--logpath=<path to log directory>
Remarks
The default for this parameter is --logpath=/hana/log/<SID>.
This parameter is available in interactive mode.
The path must be specified if the new directory is located on a different physical
storage. The contents of the directory must be moved manually to the new location.

11.44

isc_mode

Specifies the inter-service communication mode.


Syntax
In the command line, the following syntax is used:
--isc_mode=standard
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.

SAP HANA Server Installation and Update Guide


Parameter Reference

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

181

11.45

max_mem

Specifies 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:
--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 187]

11.46

number

Specifies 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:
--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.

182

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Parameter Reference

11.47

org_manager_user

Creates a 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.
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.

11.48

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.
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.

11.49

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:
--prepare_update

SAP HANA Server Installation and Update Guide


Parameter Reference

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

183

Related Information
Prepare an Update for Reduced SAP HANA System Downtime [page 96]

11.50

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.
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.

11.51

rdsync_downloadpath

Specifies the location of SAP HANA remote data sync file download directory.
Syntax
In the command line, the following syntax is used:
--rdsync_downloadpath=<path>
Remarks
The default for this parameter is --rdsync_downloadpath=/hana/
download_rdsync/<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 [page 200].

184

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Parameter Reference

11.52

rdsync_uploadpath

Specifies the location of SAP HANA remote data sync file upload directory.
Syntax
In the command line, the following syntax is used:
--rdsync_uploadpath=<path>
Remarks
The default for this parameter is --rdsync_uploadpath=/hana/upload_rdsync/
<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 [page 200].

11.53

read_password_from_stdin

Reads passwords in XML syntax via input stream in batch mode.


Requirements
When using read_password_from_stdin in batch mode, the program looks for the
necessary passwords from an input stream. Therefore, the following two requirements
apply:
A text file with XML tagging is created before calling the
read_password_from_stdin parameter during installation.
Batch mode is specified from the command line.
Syntax
In the command line, the following syntax is used:
--read_password_from_stdin=xml
Remarks
Passwords can be specified in several ways depending on your installation method of
choice. For more details, refer to the information about passwords specification.

Example
The following example shows the file containing the passwords:
hdb_passwords.xml
<?xml version="1.0" encoding="UTF-8"?>

SAP HANA Server Installation and Update Guide


Parameter Reference

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

185

<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>

Related Information
Specifying Passwords [page 54]

11.54

remote_execution

Specifies the connectivity method for SAP HANA multiple-host system operations.
Syntax
In the command line, the following syntax is used:
--remote_execution=saphostagent|ssh
Remarks
The default for this parameter is --remote_execution=ssh.

11.55

repository

Defines 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.

186

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Parameter Reference

11.56

restrict_max_mem

Specifies whether maximum memory allocation is restricted for a new system.


Requirements
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 182]

11.57

root_user

Specifies 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.

11.58

sapmnt

Specifies the path to the SAP mount directory, which can be used as a shared directory between multiple
hosts.
Syntax

SAP HANA Server Installation and Update Guide


Parameter Reference

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

187

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 specified once and automatically subsituted throughout all
parameter defaults, which use sapmnt as part of their default value.

11.59

scope

Performs task on the SAP HANA System (all hosts) or only on the local instance.This parameter is available for
update only.
Syntax
In the command line, the following syntax is used:
--scope=instance|system
Remarks
The default for this parameter is --scope=system.

11.60

shell

Specifies a system administrator login shell. This parameter is relevant only if the operating system
administrator (<sid>adm) does not exist prior to installation.
Syntax
In the command line, the following syntax is used:
--shell=<admin login shell>
Remarks
The default for this parameter is --shell=/bin/sh.
This parameter is available in interactive mode.

188

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Parameter Reference

11.61

sid

Specifies a system ID. The SAP system ID (SID) is the identifier 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 first 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:
--sid=<SID>
or, in short form:
-s <SID>
Remarks
This parameter is available in interactive mode.
This parameter can be specified once and automatically substituted throughout all
parameter defaults, which use sid as part of their default value.

11.62

storage_cfg

Specifies a location where a global.ini is defined. It is possible to set up a storage connector, allowing SAP
HANA to use hardware vendor-specific scripts for automated resource allocation and input/output fencing
during failover.
Requirements
Resource allocation scripts are dependent on the hardware used. Therefore, only the
hardware partners can provide correct scripts.
Syntax
In the command line, the following syntax is used:
--storage_cfg=<directory of the storage configuration>

SAP HANA Server Installation and Update Guide


Parameter Reference

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

189

Related Information
Multiple-Host System Concepts [page 61]

11.63

studio_path

Specifies 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.

11.64

studio_repository

Enables the copying of the SAP HANA studio repository. When enabled (default), the SAP HANA studio
repository is copied to the location defined by copy_repository from the location defined by repository.
Syntax
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 172]
repository [page 186]

190

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Parameter Reference

11.65

system_usage

Specifies the usage type of the system to be installed. This setting is stored in the global.ini file, and can be
used to identify the intended usage of the system.
Syntax
In the command line, the following syntax is used:
--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
SAP HANA Administration Guide

11.66

system_user

Specifies the system user of the database.


Syntax
In the command line, the following syntax is used:
--system_user=<name>
Remarks
The default for this parameter is --system_user=SYSTEM.

11.67

timeouts

Sets customized timeouts (start_instance, start_service, stop_instance, stop_service).


Syntax

SAP HANA Server Installation and Update Guide


Parameter Reference

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

191

In the command line, the following syntax is used:


--timeouts=<name1>:<sec>[,<name2>:<sec>]...

11.68

update_execution_mode

Specifies the update mode of hdblcm to be either standard or optimized. If the optimized update mode is
selected, the update process will be carried out in a phased approach to minimize system downtime. For more
details about the optimized update, see Related Information.
Syntax
In the command line, the following syntax is used:
--update_execution_mode=[standard|optimized]
Remarks
The default for this parameter is --update_execution_mode=standard.

Related Information
Perform an Optimized Update [page 98]

11.69

userid

Specifies the user ID of the system administrator. This parameter is relevant only if the operating system
administrator (<sid>adm) does not exist prior to installation.
Syntax
In the command line, the following syntax is used:
--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.

192

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Parameter Reference

11.70

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

11.71

vm

Specifies the path of the Java runtime file. This parameter is only relevant if the SAP HANA studio is selected
for installation or update.
Syntax
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 specified with the environment
variable JAVA_HOME.

11.72

xs_components

Specifies the components to be installed or updated in combination with XS advanced runtime.


Syntax
In the command line, the following syntax is used:
--xs_components=all|comp1[,comp2]...
Remarks
The default for this parameter is --xs_components=all.
This parameter is available in interactive mode.

SAP HANA Server Installation and Update Guide


Parameter Reference

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

193

12

Important SAP Notes

Read the following SAP Notes before you start the installation. These SAP Notes contain the latest information
about the installation, as well as corrections to the installation documentation.
Make sure that you have the most up-to-date version of each SAP Note, which you can find on SAP Service
Marketplace at https://service.sap.com/notes .
SAP Note Number

Title

1514967

SAP HANA: Central Note

2227464

SAP HANA Platform SPS 11 Release Note

1523337

SAP HANA Database: Central Note

2000003

FAQ: SAP HANA

1944799

SAP HANA Guidelines for SLES Operating System

1824819

SAP HANA DB: Recommended OS settings for SLES 11 /


SLES for SAP Applications 11 SP2

1954788

SAP HANA DB: Recommended OS settings for SLES 11 /


SLES for SAP Applications 11 SP3

2009879

SAP HANA Guidelines for Red Hat Enterprise Linux (RHEL)

2013638

SAP HANA DB: Recommended OS settings for RHEL 6.5

2136965

SAP HANA DB: Recommended OS settings for RHEL 6.6

2055470

HANA on POWER Planning and Installation Specifics Central Note

2218464

Supported products when running SAP HANA on IBM


Power Systems

2235581

SAP HANA: Supported Operating Systems

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

194

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Important SAP Notes

SAP Note Number

Title

1828400

SAPUI5 tools disappeared after updating HANA Studio

1917938

Migrating the Statistic Server During Update to SPS 07

1927949

Standard Behavior for SAP Logon Tickets

1577128

Supported clients for SAP HANA

1514966

SAP HANA: Sizing SAP HANA Database

1637145

SAP BW on HANA: Sizing SAP HANA Database

1793345

Sizing for Suite on HANA

1824819

Optimal settings for SLES 11 SP2 and SLES 11 for SAP SP2

1597355

Swap space recommendation for Linux


For the SAP HANA system there are no special
requirements regarding swap space.

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 SAP HANA Data Center Intelligence
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-IOA SAP IT Operations Analytics
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-FLY SAP HANA InA Firefly
HAN-AS-INA-SVC SAP HANA InA Service
HAN-AS-INA-UI SAP HANA InA Toolkit, Fiori Search UI
HAN-AS-MDS SAP HANA Multidimensional Service
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 (XS Classic)
HAN-AS-XS-ADM SAP HANA XS Administration
HAN-AS-XS-JOB SAP HANA XS Scheduled Jobs
HAN-AS-XSA SAP HANA XS Basis Applications

SAP HANA Server Installation and Update Guide


Important SAP Notes

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

195

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 SAP HANA Workflow
SAP HANA Accelerator for SAP ASE
HAN-ASE SAP HANA Accelerator for SAP ASE
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-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-SYN SAP HANA remote data sync Cockpit
HAN-CPT-UM SAP HANA User Management
HAN-CPT-XS Please use HAN-AS-XS-ADM
SAP HANA Database
HAN-DB SAP HANA Database
HAN-DB-AFL Please use subcomponents, see SAP Note 2198403
HAN-DB-AFL-DQ SAP HANA Data Quality 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 Unified Demand Forecast
HAN-DB-BAC SAP HANA Backup and Recovery
HAN-DB-CDS SAP HANA Activation of HDBDD-files (CDS Definitions)
HAN-DB-CLI SAP HANA Clients (JDBC, ODBC)
HAN-DB-ENG SAP HANA DB Engines
HAN-DB-ENG-BW SAP HANA BW Engine
HAN-DB-ENG-GPH SAP HANA Graph Engine
HAN-DB-ENG-GPH-API SAP HANA Graph Engine API
HAN-DB-ENG-GPH-GEM Graph Exploration and Manipulation (GEM) Language
HAN-DB-ENG-IM Please use HAN-DB-SDQ
HAN-DB-ENG-PLE SAP HANA Planning Engine
HAN-DB-ENG-SPA SAP HANA Spatial Engine
HAN-DB-ENG-TXT SAP HANA Text Engine

196

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Important SAP Notes

HAN-DB-ENG-VE SAP HANA Velocity 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
HAN-DB-LVC SAP HANA integrated liveCache
HAN-DB-MDX SAP HANA MDX Engine/Excel Client
HAN-DB-MON SAP HANA Monitoring
HAN-DB-PER SAP HANA Database Persistence
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
SAP HANA Data Services
HAN-DP-DS SAP Data Services
HAN-DP-DXC SAP HANA Direct Extractor Connector
HAN-DP-ESS SAP HANA Enterprise Semantic Services (ESS)
HAN-DP-LTR SAP Landscape Transformation Replication Server
HAN-DP-REP SAP Sybase Replication Server
HAN-DP-SDI SAP HANA smart data integration
SAP HANA Dynamic Tiering
HAN-DYT SAP HANA Dynamic Tiering
SAP HANA Information Composer
HAN-IC SAP HANA Information Composer
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
SAP HANA Smart Data Streaming
HAN-SDSSAP HANA Smart Data Streaming
SAP HANA Studio (Eclipse)
HAN-STD SAP HANA Studio (Eclipse)
HAN-STD-ADM SAP HANA Administration
HAN-STD-ADM-BAC SAP HANA Backup and Recovery (Studio)

SAP HANA Server Installation and Update Guide


Important SAP Notes

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

197

HAN-STD-ADM-DBA SAP HANA Database Administration and Monitoring


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 CDS Tools
HAN-STD-DEV-CDS-GRA SAP HANA CDS Graphical Modeler
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 Component
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 Tools Platform / 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 Fiori Launchpad
HAN-STD-DEV-XS SAP HANA XS Editors and Wizards
SAP HANA Web IDE
HAN-WDE SAP HANA Web IDE
SAP HANA XS Advanced
BC-XS XS Engine (XS Advanced)
BC-XS-JAS Java Runtime
BC-XS-JS Javascript runtime
BC-XS-SEC UAA and Security for XS engine
BC-XS-SRV XS Engine Services and Administration
SAP HANA Database (CCMS, Porting and DB Interface)
BC-DB-HDB-CCM CCMS for SAP HANA
BC-DB-HDB-POR DB Porting for SAP HANA
BC-DB-HDB-SYS SAP HANA database interface/DBMS
End User Clients
BI-BIP, BI-BIP-CMC Business intelligence platform (formerly known as BOE)
BI-RA-EXP SAP BusinessObjects Explorer
BI-RA-CR, BI-BIP-CRS SAP Crystal Reports
BI-RA-XL Dashboard Designer
BI-BIP-IDT Information design tool
BI-RA-WBI Web Intelligence
BI-RA-AO-XLA MS Excel Add-In
The search also supports using the wildcard asterisk (*), so you can, for example, also search for BC-DB-HDB*
or similar and you will get results for all sub-components.

198

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Important SAP Notes

Reporting Incidents
If you encounter any problems with the software, report an incident on the SAP Service Marketplace athttp://
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. To create an S-user ID, follow the steps in this guide (SAP Active
Global Support Reference Guide ).
When reporting an incident, you can choose from the above list of components for the relevant software part.
SAP HANA server software and tools can be used for several SAP HANA platform and options scenarios as
well as the respective capabilities used in these scenarios. The availability of these is based on the available
SAP HANA licenses and the SAP HANA landscape, including the type and version of the back-end systems the
SAP HANA administration and development tools are connected to. There are several types of licenses
available for SAP HANA. Depending on your SAP HANA installation license type, some of the features and
tools described in the SAP HANA platform documentation may only be available in the SAP HANA options and
capabilities, which may be released independently of an SAP HANA Platform Support Package Stack (SPS).
Although various features included in SAP HANA options and capabilities are cited in the SAP HANA platform
documentation, each SAP HANA edition governs the options and capabilities available. Based on this,
customers do not necessarily have the right to use features included in SAP HANA options and capabilities.
For customers to whom these license restrictions apply, the use of features included in SAP HANA options and
capabilities in a production system requires purchasing the corresponding software license(s) from SAP. The
documentation for the SAP HANA optional components is available in SAP Help Portal at http://
help.sap.com/hana_options. If you have additional questions about what your particular license provides, or
wish to discuss licensing features available in SAP HANA options, please contact your SAP account team
representative.

SAP HANA Server Installation and Update Guide


Important SAP Notes

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

199

Important Disclaimer for Features in SAP


HANA Platform, Options and Capabilities

SAP HANA server software and tools can be used for several SAP HANA platform and options scenarios as
well as the respective capabilities used in these scenarios. The availability of these is based on the available
SAP HANA licenses and the SAP HANA landscape, including the type and version of the back-end systems the
SAP HANA administration and development tools are connected to. There are several types of licenses
available for SAP HANA. Depending on your SAP HANA installation license type, some of the features and
tools described in the SAP HANA platform documentation may only be available in the SAP HANA options and
capabilities, which may be released independently of an SAP HANA Platform Support Package Stack (SPS).
Although various features included in SAP HANA options and capabilities are cited in the SAP HANA platform
documentation, each SAP HANA edition governs the options and capabilities available. Based on this,
customers do not necessarily have the right to use features included in SAP HANA options and capabilities.
For customers to whom these license restrictions apply, the use of features included in SAP HANA options and
capabilities in a production system requires purchasing the corresponding software license(s) from SAP. The
documentation for the SAP HANA optional components is available in SAP Help Portal at http://
help.sap.com/hana_options. If you have additional questions about what your particular license provides, or
wish to discuss licensing features available in SAP HANA options, please contact your SAP account team
representative.

200

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP HANA Server Installation and Update Guide


Important Disclaimer for Features in SAP HANA Platform, Options and Capabilities

Important Disclaimers and Legal Information

Coding Samples
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system
environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and
completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, unless damages were caused by SAP
intentionally or by SAP's gross negligence.

Accessibility
The information contained in the SAP documentation represents SAP's current view of accessibility criteria as of the date of publication; it is in no way intended to be
a binding guideline on how to ensure accessibility of software products. SAP in particular disclaims any liability in relation to this document. This disclaimer, however,
does not apply in cases of wilful misconduct or gross negligence of SAP. Furthermore, this document does not result in any direct or indirect contractual obligations of
SAP.

Gender-Neutral Language
As far as possible, SAP documentation is gender neutral. Depending on the context, the reader is addressed directly with "you", or a gender-neutral noun (such as
"sales person" or "working days") is used. If when referring to members of both sexes, however, the third-person singular cannot be avoided or a gender-neutral noun
does not exist, SAP reserves the right to use the masculine form of the noun and pronoun. This is to ensure that the documentation remains comprehensible.

Internet Hyperlinks
The SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended to serve as a hint about where to find related information. SAP does
not warrant the availability and correctness of this related information or the ability of this information to serve a particular purpose. SAP shall not be liable for any
damages caused by the use of related information unless damages have been caused by SAP's gross negligence or willful misconduct. All links are categorized for
transparency (see: http://help.sap.com/disclaimer).

SAP HANA Server Installation and Update Guide


Important Disclaimers and Legal Information

PUBLIC
2016 SAP SE or an SAP affiliate company. All rights reserved.

201

go.sap.com/registration/
contact.html

2016 SAP SE or an SAP affiliate 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 affiliate 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 specifications may vary.
These materials are provided by SAP SE or an SAP affiliate company
for informational purposes only, without representation or warranty
of any kind, and SAP or its affiliated companies shall not be liable for
errors or omissions with respect to the materials. The only
warranties for SAP or SAP affiliate 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 affiliate company) in Germany and other
countries. All other product and service names mentioned are the
trademarks of their respective companies.
Please see http://www.sap.com/corporate-en/legal/copyright/
index.epx for additional trademark information and notices.

You might also like