1OCF_HEARTBEAT_ORACLE(7) OCF resource agents OCF_HEARTBEAT_ORACLE(7)
2
6 ocf_heartbeat_oracle - Manages an Oracle Database instance
7
9 oracle [start | stop | status | monitor | meta-data | validate-all]
10
12 Resource script for oracle. Manages an Oracle Database instance as an
13 HA resource.
14
16 sid
17 The Oracle SID (aka ORACLE_SID).
18 (unique, required, string, no default)
20 home
22 The Oracle home directory (aka ORACLE_HOME). If not specified, then
23 the SID along with its home should be listed in /etc/oratab.
24 (optional, string, no default)
26 user
28 The Oracle owner (aka ORACLE_OWNER). If not specified, then it is
29 set to the owner of file $ORACLE_HOME/dbs/*${ORACLE_SID}.ora. If
30 this does not work for you, just set it explicitely.
31 (optional, string, no default)
33 monuser
35 Monitoring user name. Every connection as sysdba is logged in an
36 audit log. This can result in a large number of new files created.
37 A new user is created (if it doesn't exist) in the start action and
38 subsequently used in monitor. It should have very limited rights.
39 Make sure that the password for this user does not expire.
40 (optional, string, default "OCFMON")
42 monpassword
44 Password for the monitoring user. Make sure that the password for
45 this user does not expire. Need to explicitly set a password to a
46 new monitor user for the security reason.
47 (optional, string, default "OCFMON")
49 monprofile
51 Profile used by the monitoring user. If the profile does not exist,
52 it will be created with a non-expiring password.
53 (optional, string, default "OCFMONPROFILE")
55 ipcrm
57 Sometimes IPC objects (shared memory segments and semaphores)
58 belonging to an Oracle instance might be left behind which prevents
59 the instance from starting. It is not easy to figure out which
60 shared segments belong to which instance, in particular when more
61 instances are running as same user.
62 What we use here is the "oradebug" feature and its "ipc" trace
64 utility. It is not optimal to parse the debugging information, but
65 I am not aware of any other way to find out about the IPC
66 information. In case the format or wording of the trace report
67 changes, parsing might fail. There are some precautions, however,
68 to prevent stepping on other peoples toes. There is also a
69 dumpinstipc option which will make us print the IPC objects which
70 belong to the instance. Use it to see if we parse the trace file
71 correctly.
72 Three settings are possible:
74 - none: don't mess with IPC and hope for the best (beware: you'll
76 probably be out of luck, sooner or later)
77 - instance: try to figure out the IPC stuff which belongs to the
79 instance and remove only those (default; should be safe)
80 - orauser: remove all IPC belonging to the user which runs the
82 instance (don't use this if you run more than one instance as same
83 user or if other apps running as this user use IPC)
84 The default setting "instance" should be safe to use, but in that
86 case we cannot guarantee that the instance will start. In case IPC
87 objects were already left around, because, for instance, someone
88 mercilessly killing Oracle processes, there is no way any more to
89 find out which IPC objects should be removed. In that case, human
90 intervention is necessary, and probably _all_ instances running as
91 same user will have to be stopped. The third setting, "orauser",
92 guarantees IPC objects removal, but it does that based only on IPC
93 objects ownership, so you should use that only if every instance
94 runs as separate user.
95 Please report any problems. Suggestions/fixes welcome.
97 (optional, string, default "instance")
99 clear_backupmode
101 The clear of the backup mode of ORACLE.
102 (optional, boolean, default false)
104 shutdown_method
106 How to stop Oracle is a matter of taste it seems. The default
107 method ("checkpoint/abort") is:
108 alter system checkpoint; shutdown abort;
110 This should be the fastest safe way bring the instance down. If you
112 find "shutdown abort" distasteful, set this attribute to
113 "immediate" in which case we will
114 shutdown immediate;
116 If you still think that there's even better way to shutdown an
118 Oracle instance we are willing to listen.
119 (optional, string, default "checkpoint/abort")
121
123 This resource agent supports the following actions (operations):
124 start
126 Starts the resource. Suggested minimum timeout: 120s.
127 stop
129 Stops the resource. Suggested minimum timeout: 120s.
130 status
132 Performs a status check. Suggested minimum timeout: 5s.
133 monitor
135 Performs a detailed status check. Suggested minimum timeout: 30s.
136 Suggested interval: 120s.
137 validate-all
139 Performs a validation of the resource configuration. Suggested
140 minimum timeout: 5s.
141 methods
143 Suggested minimum timeout: 5s.
144 meta-data
146 Retrieves resource agent metadata (internal use only). Suggested
147 minimum timeout: 5s.
148
150 The following is an example configuration for a oracle resource using
151 the crm(8) shell:
152 primitive p_oracle ocf:heartbeat:oracle \
154 params \
155 sid=string \
156 op monitor depth="0" timeout="30s" interval="120s"
157
159 The following is an example configuration for a oracle resource using
160 pcs(8)
161 pcs resource create p_oracle ocf:heartbeat:oracle \
163 sid=string \
164 op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="120s"
165
167 http://clusterlabs.org/
168
170 ClusterLabs contributors (see the resource agent source for information
171 about individual authors)
172resource-agents UNKNOWN 10/11/2023 OCF_HEARTBEAT_ORACLE(7)