'\" t
.\"     Title: ocf_heartbeat_SAPDatabase
.\"    Author: Linux-HA contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 03/09/2014
.\"    Manual: OCF resource agents
.\"    Source: resource-agents UNKNOWN
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_SAPDAT" "7" "03/09/2014" "resource-agents UNKNOWN" "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 any SAP database (based on Oracle, MaxDB, or DB2)
.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\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBSID\fR
.RS 4
The unique SAP system identifier\&. e\&.g\&. P01
(unique, required, string, no default)
.RE
.PP
\fBDIR_EXECUTABLE\fR
.RS 4
The full qualified path where to find sapstartsrv and sapcontrol\&.
(unique, optional, string, no default)
.RE
.PP
\fBDBTYPE\fR
.RS 4
The name of the database vendor you use\&. Set either: ORA,DB6,ADA
(unique, required, string, no default)
.RE
.PP
\fBNETSERVICENAME\fR
.RS 4
The Oracle TNS listener name\&.
(unique, optional, string, no default)
.RE
.PP
\fBDBJ2EE_ONLY\fR
.RS 4
If you do not have a ABAP stack installed in the SAP database, set this to TRUE
(unique, optional, boolean, default
false)
.RE
.PP
\fBJAVA_HOME\fR
.RS 4
This is only needed if the DBJ2EE_ONLY parameter is set to true\&. Enter the path to the Java SDK which is used by the SAP WebAS Java
(unique, 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 SAP tools to test the connect to the database\&. Do not use with Oracle, because it will result in unwanted failovers in case of an archiver stuck
(unique, optional, boolean, default
false)
.RE
.PP
\fBAUTOMATIC_RECOVER\fR
.RS 4
The SAPDatabase resource agent tries to recover a failed start attempt automatically one time\&. This is done by running a forced abort of the RDBMS and/or executing recovery commands\&.
(unique, optional, boolean, default
false)
.RE
.PP
\fBDIR_BOOTSTRAP\fR
.RS 4
The full qualified path where to find the J2EE instance bootstrap directory\&. e\&.g\&. /usr/sap/P01/J00/j2ee/cluster/bootstrap
(unique, optional, string, no default)
.RE
.PP
\fBDIR_SECSTORE\fR
.RS 4
The full qualified path where to find the J2EE security store directory\&. e\&.g\&. /usr/sap/P01/SYS/global/security/lib/tools
(unique, optional, string, no default)
.RE
.PP
\fBDB_JARS\fR
.RS 4
The full qualified filename of the jdbc driver for the database connection test\&. It will be automatically read from the bootstrap\&.properties file in Java engine 6\&.40 and 7\&.00\&. For Java engine 7\&.10 and higher the parameter is mandatory\&.
(unique, 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\&.
(unique, 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\&.
(unique, 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\&.
(unique, 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\&.
(unique, 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"
.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 "SEE ALSO"
.PP

\m[blue]\fB\%http://www.linux-ha.org/wiki/SAPDatabase_(resource_agent)\fR\m[]
.SH "AUTHOR"
.PP
\fBLinux\-HA contributors (see the resource agent source for information about individual authors)\fR