'\" t
.\"     Title: ocf_heartbeat_SAPDatabase
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 06/07/2017
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.0.0~rc1-4~bpo8+1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_SAPDAT" "7" "06/07/2017" "resource-agents 4.0.0~rc1-4~bp" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_SAPDatabase \- Manages a SAP database instance as an HA resource\&.
.SH "SYNOPSIS"
.HP \w'\fBSAPDatabase\fR\ 'u
\fBSAPDatabase\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Resource script for SAP databases\&. It manages a SAP database of any type as an HA resource\&.
.PP
The purpose of the resource agent is to start, stop and monitor the database instance of a SAP system\&. Together with the RDBMS system it will also control the related network service for the database\&. Like the Oracle Listener and the xserver of MaxDB\&. The resource agent expects a standard SAP installation of the database and therefore needs less parameters to configure\&. The resource agent supports the following databases:
.PP
\- Oracle 10\&.2, 11\&.2 and 12
.PP
\- DB/2 UDB for Windows and Unix 9\&.x
.PP
\- SAP\-DB / MaxDB 7\&.x
.PP
\- Sybase ASE 15\&.7
.PP
\- SAP HANA Database since 1\&.00 \- with SAP note 1625203 (http://sdn\&.sap\&.com)
.PP
In fact this resource agent does not run any database commands directly\&. It uses the SAP standard process SAPHostAgent to control the database\&. The SAPHostAgent must be installed on each cluster node locally\&. It will not work, if you try to run the SAPHostAgent also as a HA resource\&. Please follow SAP note 1031096 for the installation of SAPHostAgent\&. The required minimum version of SAPHostAgent is: Release: 7\&.20 Patch Number: 90 or compile time after: Dec 17 2011
.SH "SUPPORTED PARAMETERS"
.PP
\fBSID\fR
.RS 4
The unique database system identifier\&. e\&.g\&. P01
.sp
(unique, required, string, no default)
.RE
.PP
\fBDIR_EXECUTABLE\fR
.RS 4
The full qualified path where to find saphostexec and saphostctrl\&. Usually you can leave this empty\&. Then the default: /usr/sap/hostctrl/exe is used\&.
.sp
(optional, string, default "/usr/sap/hostctrl/exe")
.RE
.PP
\fBDBTYPE\fR
.RS 4
The name of the database vendor you use\&. Set either: ADA, DB6, ORA, SYB, HDB
.sp
(required, string, no default)
.RE
.PP
\fBDBINSTANCE\fR
.RS 4
Must be used for special database implementations, when database instance name is not equal to the SID (e\&.g\&. Oracle DataGuard)
.sp
(unique, optional, string, no default)
.RE
.PP
\fBDBOSUSER\fR
.RS 4
The parameter can be set, if the database processes on operating system level are not executed with the default user of the used database type\&. Defaults: ADA=taken from /etc/opt/sdb, DB6=db2SID, ORA=oraSID and oracle, SYB=sybSID, HDB=SIDadm
.sp
(unique, optional, string, no default)
.RE
.PP
\fBNETSERVICENAME\fR
.RS 4
Deprecated \- do not use anymore\&. This parameter will be deleted in one of the next releases\&.
.sp
(optional, string, no default)
.RE
.PP
\fBDBJ2EE_ONLY\fR
.RS 4
Deprecated \- do not use anymore\&. This parameter will be deleted in one of the next releases\&.
.sp
(optional, boolean, default
false)
.RE
.PP
\fBJAVA_HOME\fR
.RS 4
Deprecated \- do not use anymore\&. This parameter will be deleted in one of the next releases\&.
.sp
(optional, string, no default)
.RE
.PP
\fBSTRICT_MONITORING\fR
.RS 4
This controls how the resource agent monitors the database\&. If set to true, it will use \*(Aqsaphostctrl \-function GetDatabaseStatus\*(Aq to test the database state\&. If set to false, only operating system processes are monitored\&.
.sp
(optional, boolean, default
false)
.RE
.PP
\fBAUTOMATIC_RECOVER\fR
.RS 4
If you set this to true, \*(Aqsaphostctrl \-function StartDatabase\*(Aq will always be called with the \*(Aq\-force\*(Aq option\&.
.sp
(optional, boolean, default
false)
.RE
.PP
\fBMONITOR_SERVICES\fR
.RS 4
Defines which services are monitored by the SAPDatabase resource agent, if STRICT_MONITORING is set to true\&. Service names must correspond with the output of the \*(Aqsaphostctrl \-function GetDatabaseStatus\*(Aq command\&.
.sp
(optional, string, default "Instance|Database|Listener")
.RE
.PP
\fBDIR_BOOTSTRAP\fR
.RS 4
Deprecated \- do not use anymore\&. This parameter will be deleted in one of the next releases\&.
.sp
(optional, string, no default)
.RE
.PP
\fBDIR_SECSTORE\fR
.RS 4
Deprecated \- do not use anymore\&. This parameter will be deleted in one of the next releases\&.
.sp
(optional, string, no default)
.RE
.PP
\fBDB_JARS\fR
.RS 4
Deprecated \- do not use anymore\&. This parameter will be deleted in one of the next releases\&.
.sp
(optional, string, no default)
.RE
.PP
\fBPRE_START_USEREXIT\fR
.RS 4
The full qualified path where to find a script or program which should be executed before this resource gets started\&.
.sp
(optional, string, no default)
.RE
.PP
\fBPOST_START_USEREXIT\fR
.RS 4
The full qualified path where to find a script or program which should be executed after this resource got started\&.
.sp
(optional, string, no default)
.RE
.PP
\fBPRE_STOP_USEREXIT\fR
.RS 4
The full qualified path where to find a script or program which should be executed before this resource gets stopped\&.
.sp
(optional, string, no default)
.RE
.PP
\fBPOST_STOP_USEREXIT\fR
.RS 4
The full qualified path where to find a script or program which should be executed after this resource got stopped\&.
.sp
(optional, string, no default)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 1800\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 1800\&.
.RE
.PP
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 60\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 60\&. Suggested interval: 120\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5\&.
.RE
.PP
\fBmethods\fR
.RS 4
Suggested minimum timeout: 5\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a SAPDatabase resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_SAPDatabase ocf:heartbeat:SAPDatabase \e
  params \e
    SID=\fIstring\fR \e
    DBTYPE=\fIstring\fR \e
  op monitor depth="0" timeout="60" interval="120" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a SAPDatabase resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_SAPDatabase ocf:heartbeat:SAPDatabase \e
  SID=\fIstring\fR \e
  DBTYPE=\fIstring\fR \e
  op monitor depth="0" timeout="60" interval="120" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR