OCF_HEARTBEAT_SAPDAT(7) OCF resource agents OCF_HEARTBEAT_SAPDAT(7) NAME ocf_heartbeat_SAPDatabase - Manages a SAP database instance as an HA re- source. SYNOPSIS SAPDatabase [start | stop | status | monitor | meta-data | validate-all] DESCRIPTION Resource script for SAP databases. It manages a SAP database of any type as an HA resource. The purpose of the resource agent is to start, stop and monitor the data- base instance of a SAP system. Together with the RDBMS system it will also control the related network service for the database. Like the Oracle Lis- tener and the xserver of MaxDB. The resource agent expects a standard SAP installation of the database and therefore needs less parameters to config- ure. The resource agent supports the following databases: - Oracle 10.2, 11.2 and 12 - DB/2 UDB for Windows and Unix 9.x - SAP-DB / MaxDB 7.x - Sybase ASE 15.7 - SAP HANA Database since 1.00 - with SAP note 1625203 (http://sdn.sap.com) 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 fol- low SAP note 1031096 for the installation of SAPHostAgent. The required minimum version of SAPHostAgent is: Release: 7.20 Patch Number: 90 or com- pile time after: Dec 17 2011 To exemplify the usage, for a HANA database with SID "TST" and instance number "10", the resource configuration using crmsh syntax looks like: primitive rsc_SAPDatabase_TST_HDB10 ocf:heartbeat:SAPDatabase \ params DB- TYPE="HDB" SID="TST" \ op start interval="0" timeout="3600" \ op monitor interval="120" timeout="700" \ op stop interval="0" timeout="600" Make sure to tune the operations timeout values accordingly with your cho- sen Database and available infrastructure. Note that the same configuration can be achieved using any other CLI tool for cluster configuration available, like pcs or cibadmin. SUPPORTED PARAMETERS SID The unique database system identifier. e.g. P01 (unique, required, string, no default) DIR_EXECUTABLE The full qualified path where to find saphostexec and saphostctrl. Usu- ally you can leave this empty. Then the default: /usr/sap/hostctrl/exe is used. (optional, string, default "/usr/sap/hostctrl/exe") DBTYPE The name of the database vendor you use. Set either: ADA, DB6, ORA, SYB, HDB (required, string, no default) DBINSTANCE Must be used for special database implementations, when database in- stance name is not equal to the SID (e.g. Oracle DataGuard) (unique, optional, string, no default) DBOSUSER 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 ora- cle, SYB=sybSID, HDB=SIDadm (unique, optional, string, no default) NETSERVICENAME Deprecated - do not use anymore. This parameter will be deleted in one of the next releases. (optional, string, no default) DBJ2EE_ONLY Deprecated - do not use anymore. This parameter will be deleted in one of the next releases. (optional, boolean, default false) JAVA_HOME Deprecated - do not use anymore. This parameter will be deleted in one of the next releases. (optional, string, no default) STRICT_MONITORING This controls how the resource agent monitors the database. If set to true, it will use 'saphostctrl -function GetDatabaseStatus' to test the database state. If set to false, only operating system processes are monitored. (optional, boolean, default false) AUTOMATIC_RECOVER If you set this to true, 'saphostctrl -function StartDatabase' will al- ways be called with the '-force' option. (optional, boolean, default false) MONITOR_SERVICES Defines which services are monitored by the SAPDatabase resource agent. Service names must correspond with the output of the 'saphostctrl -function GetDatabaseStatus' command. The default MONITOR_SERVICES value is derived from the database type DBTYPE. For reference: - DBTYPE "ORA" sets MONITOR_SERVICES="Instance|Database|Listener"; - DBTYPE "HDB" sets MONITOR_SERVICES="hdbindexserver|hdbnameserver"; - DBTYPE "ADA" sets MONITOR_SERVICES="Database"; - DBTYPE "DB6" sets MONITOR_SERVICES="{SID}|{db2sid}"; - DBTYPE "SYB" sets MONITOR_SERVICES="Server". This parameter should be set ONLY if is needed to monitor different services than the ones listed above. (optional, string, no default) DIR_BOOTSTRAP Deprecated - do not use anymore. This parameter will be deleted in one of the next releases. (optional, string, no default) DIR_SECSTORE Deprecated - do not use anymore. This parameter will be deleted in one of the next releases. (optional, string, no default) DB_JARS Deprecated - do not use anymore. This parameter will be deleted in one of the next releases. (optional, string, no default) PRE_START_USEREXIT The full qualified path where to find a script or program which should be executed before this resource gets started. (optional, string, no default) POST_START_USEREXIT The full qualified path where to find a script or program which should be executed after this resource got started. (optional, string, no default) PRE_STOP_USEREXIT The full qualified path where to find a script or program which should be executed before this resource gets stopped. (optional, string, no default) POST_STOP_USEREXIT The full qualified path where to find a script or program which should be executed after this resource got stopped. (optional, string, no default) SUPPORTED ACTIONS This resource agent supports the following actions (operations): start Starts the resource. Suggested minimum timeout: 1800s. stop Stops the resource. Suggested minimum timeout: 1800s. status Performs a status check. Suggested minimum timeout: 60s. monitor Performs a detailed status check. Suggested minimum timeout: 60s. Sug- gested interval: 120s. validate-all Performs a validation of the resource configuration. Suggested minimum timeout: 5s. meta-data Retrieves resource agent metadata (internal use only). Suggested mini- mum timeout: 5s. methods Suggested minimum timeout: 5s. EXAMPLE CRM SHELL The following is an example configuration for a SAPDatabase resource using the crm(8) shell: primitive p_SAPDatabase ocf:heartbeat:SAPDatabase \ params \ SID=string \ DBTYPE=string \ op monitor depth="0" timeout="60s" interval="120s" EXAMPLE PCS The following is an example configuration for a SAPDatabase resource using pcs(8) pcs resource create p_SAPDatabase ocf:heartbeat:SAPDatabase \ SID=string \ DBTYPE=string \ op monitor OCF_CHECK_LEVEL="0" timeout="60s" interval="120s" SEE ALSO http://clusterlabs.org/ AUTHOR ClusterLabs contributors (see the resource agent source for information about individual authors) resource-agents 4.13.0 08/27/2026 OCF_HEARTBEAT_SAPDAT(7)
NAME | SYNOPSIS | DESCRIPTION | SUPPORTED PARAMETERS | SUPPORTED ACTIONS | EXAMPLE CRM SHELL | EXAMPLE PCS | SEE ALSO | AUTHOR
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=ocf_heartbeat_SAPDatabase&sektion=7&manpath=FreeBSD+Ports+15.1.quarterly>