'\" t
.\"     Title: ocf_heartbeat_SAPInstance
.\"    Author: Linux-HA contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 02/03/2011
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 1.0.3
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_SAPINS" "7" "02/03/2011" "resource-agents 1.0.3" "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_SAPInstance \- Manages a SAP instance
.SH "SYNOPSIS"
.HP \w'\fBSAPInstance\fR\ 'u
\fBSAPInstance\fR [start | stop | status | monitor | promote | demote | validate\-all | meta\-data | methods]
.SH "DESCRIPTION"
.PP
Resource script for SAP\&. It manages a SAP Instance as an HA resource\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBInstanceName\fR
.RS 4
The full qualified SAP instance name\&. e\&.g\&. P01_DVEBMGS00_sapp01ci (required, string, no default)
.RE
.PP
\fBDIR_EXECUTABLE\fR
.RS 4
The full qualified path where to find sapstartsrv and sapcontrol\&. (optional, string, no default)
.RE
.PP
\fBDIR_PROFILE\fR
.RS 4
The full qualified path where to find the SAP START profile\&. (optional, string, no default)
.RE
.PP
\fBSTART_PROFILE\fR
.RS 4
The name of the SAP START profile\&. (optional, string, no default)
.RE
.PP
\fBSTART_WAITTIME\fR
.RS 4
After that time in seconds a monitor operation is executed by the resource agent\&. Does the monitor return SUCCESS, the start is handled as SUCCESS\&. This is useful to resolve timing problems with e\&.g\&. the J2EE\-Addin instance\&. (optional, string, default
3600)
.RE
.PP
\fBAUTOMATIC_RECOVER\fR
.RS 4
The SAPInstance resource agent tries to recover a failed start attempt automatically one time\&. This is done by killing runing instance processes and executing cleanipc\&. (optional, boolean, default
false)
.RE
.PP
\fBMONITOR_SERVICES\fR
.RS 4
(optional, string, default
disp+work|msg_server|enserver|enrepserver|jcontrol|jstart)
.RE
.PP
\fBERS_InstanceName\fR
.RS 4
(optional, string, no default)
.RE
.PP
\fBERS_START_PROFILE\fR
.RS 4
(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\&. (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\&. (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\&. (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\&. (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: 180\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 240\&.
.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
\fBpromote\fR
.RS 4
Promotes the resource to the Master role\&. Suggested minimum timeout: 320\&.
.RE
.PP
\fBdemote\fR
.RS 4
Demotes the resource to the Slave role\&. Suggested minimum timeout: 320\&.
.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 SAPInstance resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive example_SAPInstance ocf:heartbeat:SAPInstance \e
  params \e
    InstanceName=\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/SAPInstance_(resource_agent)\fR\m[]
.SH "AUTHOR"
.PP
\fBLinux\-HA contributors (see the resource agent source for information about individual authors)\fR