NAME

       ocf_heartbeat_oracle - Manages an Oracle Database instance

SYNOPSIS

       oracle [start | stop | status | monitor | meta-data | validate-all]

DESCRIPTION

       Resource script for oracle. Manages an Oracle Database instance as an HA resource.

SUPPORTED PARAMETERS

       sid
           The Oracle SID (aka ORACLE_SID). (required, string, no default)

       home
           The Oracle home directory (aka ORACLE_HOME). If not specified, then the SID along with
           its home should be listed in /etc/oratab. (optional, string, no default)

       user
           The Oracle owner (aka ORACLE_OWNER). If not specified, then it is set to the owner of
           file $ORACLE_HOME/dbs/*${ORACLE_SID}.ora. If this does not work for you, just set it
           explicitely. (optional, string, no default)

       ipcrm
           Sometimes IPC objects (shared memory segments and semaphores) belonging to an Oracle
           instance might be left behind which prevents the instance from starting. It is not
           easy to figure out which shared segments belong to which instance, in particular when
           more instances are running as same user. What we use here is the "oradebug" feature
           and its "ipc" trace utility. It is not optimal to parse the debugging information, but
           I am not aware of any other way to find out about the IPC information. In case the
           format or wording of the trace report changes, parsing might fail. There are some
           precautions, however, to prevent stepping on other peoples toes. There is also a
           dumpinstipc option which will make us print the IPC objects which belong to the
           instance. Use it to see if we parse the trace file correctly. Three settings are
           possible: - none: don't mess with IPC and hope for the best (beware: you'll probably
           be out of luck, sooner or later) - instance: try to figure out the IPC stuff which
           belongs to the instance and remove only those (default; should be safe) - orauser:
           remove all IPC belonging to the user which runs the instance (don't use this if you
           run more than one instance as same user or if other apps running as this user use IPC)
           The default setting "instance" should be safe to use, but in that case we cannot
           guarantee that the instance will start. In case IPC objects were already left around,
           because, for instance, someone mercilessly killing Oracle processes, there is no way
           any more to find out which IPC objects should be removed. In that case, human
           intervention is necessary, and probably _all_ instances running as same user will have
           to be stopped. The third setting, "orauser", guarantees IPC objects removal, but it
           does that based only on IPC objects ownership, so you should use that only if every
           instance runs as separate user. Please report any problems. Suggestions/fixes welcome.
           (optional, string, default instance)

       clear_backupmode
           The clear of the backup mode of ORACLE. (optional, boolean, default false)

       shutdown_method
           How to stop Oracle is a matter of taste it seems. The default method
           ("checkpoint/abort") is: alter system checkpoint; shutdown abort; This should be the
           fastest safe way bring the instance down. If you find "shutdown abort" distasteful,
           set this attribute to "immediate" in which case we will shutdown immediate; If you
           still think that there's even better way to shutdown an Oracle instance we are willing
           to listen. (optional, string, default checkpoint/abort)

SUPPORTED ACTIONS

       This resource agent supports the following actions (operations):

       start
           Starts the resource. Suggested minimum timeout: 120.

       stop
           Stops the resource. Suggested minimum timeout: 120.

       status
           Performs a status check. Suggested minimum timeout: 5.

       monitor
           Performs a detailed status check. Suggested minimum timeout: 30. Suggested interval:
           120.

       validate-all
           Performs a validation of the resource configuration. Suggested minimum timeout: 5.

       methods
           Suggested minimum timeout: 5.

       meta-data
           Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5.

EXAMPLE

       The following is an example configuration for a oracle resource using the crm(8) shell:

           primitive example_oracle ocf:heartbeat:oracle \
             params \
               sid=string \
             op monitor depth="0" timeout="30" interval="120"

SEE ALSO

       http://www.linux-ha.org/wiki/oracle_(resource_agent)

AUTHOR

       Linux-HA contributors (see the resource agent source for information about individual
       authors)