ocf_heartbeat_SAPDatabase(7)

1OCF_HEARTBEAT_SAPDAT(7)       OCF resource agents      OCF_HEARTBEAT_SAPDAT(7)
2
3
4

NAME

6       ocf_heartbeat_SAPDatabase - Manages a SAP database instance as an HA
7       resource.
8

SYNOPSIS

10       SAPDatabase [start | stop | status | monitor | meta-data |
11                   validate-all]
12

DESCRIPTION

14       Resource script for SAP databases. It manages a SAP database of any
15       type as an HA resource.
16
17       The purpose of the resource agent is to start, stop and monitor the
18       database instance of a SAP system. Together with the RDBMS system it
19       will also control the related network service for the database. Like
20       the Oracle Listener and the xserver of MaxDB. The resource agent
21       expects a standard SAP installation of the database and therefore needs
22       less parameters to configure. The resource agent supports the following
23       databases:
24
25       - Oracle 10.2, 11.2 and 12
26
27       - DB/2 UDB for Windows and Unix 9.x
28
29       - SAP-DB / MaxDB 7.x
30
31       - Sybase ASE 15.7
32
33       - SAP HANA Database since 1.00 - with SAP note 1625203
34       (http://sdn.sap.com)
35
36       In fact this resource agent does not run any database commands
37       directly. It uses the SAP standard process SAPHostAgent to control the
38       database. The SAPHostAgent must be installed on each cluster node
39       locally. It will not work, if you try to run the SAPHostAgent also as a
40       HA resource. Please follow SAP note 1031096 for the installation of
41       SAPHostAgent. The required minimum version of SAPHostAgent is: Release:
42       7.20 Patch Number: 90 or compile time after: Dec 17 2011
43
44       A single HANA is managed as a primitive resource by the SAPDatabase RA.
45       Therefor the parameter MONITOR_SERVICES has to match the output service
46       names of the command "sapcontrol -nr $InstNr -function GetProcessList".
47       "$InstNr" has to be replaced by the respective instance number.
48
49       For an HANA database with SID "TST" and instance number "10", the
50       resource configuration looks like: primitive rsc_SAPDatabase_TST_HDB10
51       ocf:heartbeat:SAPDatabase \ params DBTYPE="HDB" SID="TST" \
52       MONITOR_SERVICES="hdbindexserver|hdbnameserver" \ op start interval="0"
53       timeout="3600" \ op monitor interval="120" timeout="700" \ op stop
54       interval="0" timeout="600"
55

SUPPORTED PARAMETERS

57       SID
58           The unique database system identifier. e.g. P01
59
60           (unique, required, string, no default)
61
62       DIR_EXECUTABLE
63           The full qualified path where to find saphostexec and saphostctrl.
64           Usually you can leave this empty. Then the default:
65           /usr/sap/hostctrl/exe is used.
66
67           (optional, string, default "/usr/sap/hostctrl/exe")
68
69       DBTYPE
70           The name of the database vendor you use. Set either: ADA, DB6, ORA,
71           SYB, HDB
72
73           (required, string, no default)
74
75       DBINSTANCE
76           Must be used for special database implementations, when database
77           instance name is not equal to the SID (e.g. Oracle DataGuard)
78
79           (unique, optional, string, no default)
80
81       DBOSUSER
82           The parameter can be set, if the database processes on operating
83           system level are not executed with the default user of the used
84           database type. Defaults: ADA=taken from /etc/opt/sdb, DB6=db2SID,
85           ORA=oraSID and oracle, SYB=sybSID, HDB=SIDadm
86
87           (unique, optional, string, no default)
88
89       NETSERVICENAME
90           Deprecated - do not use anymore. This parameter will be deleted in
91           one of the next releases.
92
93           (optional, string, no default)
94
95       DBJ2EE_ONLY
96           Deprecated - do not use anymore. This parameter will be deleted in
97           one of the next releases.
98
99           (optional, boolean, default false)
100
101       JAVA_HOME
102           Deprecated - do not use anymore. This parameter will be deleted in
103           one of the next releases.
104
105           (optional, string, no default)
106
107       STRICT_MONITORING
108           This controls how the resource agent monitors the database. If set
109           to true, it will use 'saphostctrl -function GetDatabaseStatus' to
110           test the database state. If set to false, only operating system
111           processes are monitored.
112
113           (optional, boolean, default false)
114
115       AUTOMATIC_RECOVER
116           If you set this to true, 'saphostctrl -function StartDatabase' will
117           always be called with the '-force' option.
118
119           (optional, boolean, default false)
120
121       MONITOR_SERVICES
122           Defines which services are monitored by the SAPDatabase resource
123           agent. Service names must correspond with the output of the
124           'saphostctrl -function GetDatabaseStatus' command. The default
125           value is derived from the database type DBTYPE. For example, DBTYPE
126           "ORA" sets MONITOR_SERVICES="Instance|Database|Listener".
127
128           (optional, string, no default)
129
130       DIR_BOOTSTRAP
131           Deprecated - do not use anymore. This parameter will be deleted in
132           one of the next releases.
133
134           (optional, string, no default)
135
136       DIR_SECSTORE
137           Deprecated - do not use anymore. This parameter will be deleted in
138           one of the next releases.
139
140           (optional, string, no default)
141
142       DB_JARS
143           Deprecated - do not use anymore. This parameter will be deleted in
144           one of the next releases.
145
146           (optional, string, no default)
147
148       PRE_START_USEREXIT
149           The full qualified path where to find a script or program which
150           should be executed before this resource gets started.
151
152           (optional, string, no default)
153
154       POST_START_USEREXIT
155           The full qualified path where to find a script or program which
156           should be executed after this resource got started.
157
158           (optional, string, no default)
159
160       PRE_STOP_USEREXIT
161           The full qualified path where to find a script or program which
162           should be executed before this resource gets stopped.
163
164           (optional, string, no default)
165
166       POST_STOP_USEREXIT
167           The full qualified path where to find a script or program which
168           should be executed after this resource got stopped.
169
170           (optional, string, no default)
171

SUPPORTED ACTIONS

173       This resource agent supports the following actions (operations):
174
175       start
176           Starts the resource. Suggested minimum timeout: 1800s.
177
178       stop
179           Stops the resource. Suggested minimum timeout: 1800s.
180
181       status
182           Performs a status check. Suggested minimum timeout: 60s.
183
184       monitor
185           Performs a detailed status check. Suggested minimum timeout: 60s.
186           Suggested interval: 120s.
187
188       validate-all
189           Performs a validation of the resource configuration. Suggested
190           minimum timeout: 5s.
191
192       meta-data
193           Retrieves resource agent metadata (internal use only). Suggested
194           minimum timeout: 5s.
195
196       methods
197           Suggested minimum timeout: 5s.
198

EXAMPLE CRM SHELL

200       The following is an example configuration for a SAPDatabase resource
201       using the crm(8) shell:
202
203           primitive p_SAPDatabase ocf:heartbeat:SAPDatabase \
204             params \
205               SID=string \
206               DBTYPE=string \
207             op monitor depth="0" timeout="60s" interval="120s"
208

EXAMPLE PCS

210       The following is an example configuration for a SAPDatabase resource
211       using pcs(8)
212
213           pcs resource create p_SAPDatabase ocf:heartbeat:SAPDatabase \
214             SID=string \
215             DBTYPE=string \
216             op monitor depth="0" timeout="60s" interval="120s"
217

AUTHOR

222       ClusterLabs contributors (see the resource agent source for information
223       about individual authors)
224
225
226
227resource-agents UNKNOWN           03/15/2019           OCF_HEARTBEAT_SAPDAT(7)