1OCF_HEARTBEAT_ORACLE(7)       OCF resource agents      OCF_HEARTBEAT_ORACLE(7)
2
3
4

NAME

6       ocf_heartbeat_oracle - Manages an Oracle Database instance
7

SYNOPSIS

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

DESCRIPTION

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

SUPPORTED PARAMETERS

16       sid
17           The Oracle SID (aka ORACLE_SID).  (unique, required, string, no
18           default)
19
20       home
21           The Oracle home directory (aka ORACLE_HOME). If not specified, then
22           the SID along with its home should be listed in /etc/oratab.
23           (optional, string, no default)
24
25       user
26           The Oracle owner (aka ORACLE_OWNER). If not specified, then it is
27           set to the owner of file $ORACLE_HOME/dbs/*${ORACLE_SID}.ora. If
28           this does not work for you, just set it explicitely.  (optional,
29           string, no default)
30
31       ipcrm
32           Sometimes IPC objects (shared memory segments and semaphores)
33           belonging to an Oracle instance might be left behind which prevents
34           the instance from starting. It is not easy to figure out which
35           shared segments belong to which instance, in particular when more
36           instances are running as same user. .sp What we use here is the
37           "oradebug" feature and its "ipc" trace utility. It is not optimal
38           to parse the debugging information, but I am not aware of any other
39           way to find out about the IPC information. In case the format or
40           wording of the trace report changes, parsing might fail. There are
41           some precautions, however, to prevent stepping on other peoples
42           toes. There is also a dumpinstipc option which will make us print
43           the IPC objects which belong to the instance. Use it to see if we
44           parse the trace file correctly. .sp Three settings are possible:
45           .sp - none: don't mess with IPC and hope for the best (beware:
46           you'll probably be out of luck, sooner or later) - instance: try to
47           figure out the IPC stuff which belongs to the instance and remove
48           only those (default; should be safe) - orauser: remove all IPC
49           belonging to the user which runs the instance (don't use this if
50           you run more than one instance as same user or if other apps
51           running as this user use IPC) .sp The default setting "instance"
52           should be safe to use, but in that case we cannot guarantee that
53           the instance will start. In case IPC objects were already left
54           around, because, for instance, someone mercilessly killing Oracle
55           processes, there is no way any more to find out which IPC objects
56           should be removed. In that case, human intervention is necessary,
57           and probably _all_ instances running as same user will have to be
58           stopped. The third setting, "orauser", guarantees IPC objects
59           removal, but it does that based only on IPC objects ownership, so
60           you should use that only if every instance runs as separate user.
61           .sp Please report any problems. Suggestions/fixes welcome.
62           (optional, string, default instance)
63
64       clear_backupmode
65           The clear of the backup mode of ORACLE.  (optional, boolean,
66           default false)
67
68       shutdown_method
69           How to stop Oracle is a matter of taste it seems. The default
70           method ("checkpoint/abort") is: .sp alter system checkpoint;
71           shutdown abort; .sp This should be the fastest safe way bring the
72           instance down. If you find "shutdown abort" distasteful, set this
73           attribute to "immediate" in which case we will .sp shutdown
74           immediate; .sp If you still think that there's even better way to
75           shutdown an Oracle instance we are willing to listen.  (optional,
76           string, default checkpoint/abort)
77

SUPPORTED ACTIONS

79       This resource agent supports the following actions (operations):
80
81       start
82           Starts the resource. Suggested minimum timeout: 120.
83
84       stop
85           Stops the resource. Suggested minimum timeout: 120.
86
87       status
88           Performs a status check. Suggested minimum timeout: 5.
89
90       monitor
91           Performs a detailed status check. Suggested minimum timeout: 30.
92           Suggested interval: 120.
93
94       validate-all
95           Performs a validation of the resource configuration. Suggested
96           minimum timeout: 5.
97
98       methods
99           Suggested minimum timeout: 5.
100
101       meta-data
102           Retrieves resource agent metadata (internal use only). Suggested
103           minimum timeout: 5.
104

EXAMPLE

106       The following is an example configuration for a oracle resource using
107       the crm(8) shell:
108
109           primitive p_oracle ocf:heartbeat:oracle \
110             params \
111               sid=string \
112             op monitor depth="0" timeout="30" interval="120"
113

SEE ALSO

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

AUTHOR

118       Linux-HA contributors (see the resource agent source for information
119       about individual authors)
120
121
122
123resource-agents 3.9.2             07/08/2011           OCF_HEARTBEAT_ORACLE(7)
Impressum