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.
46 (optional, string, default "OCFMON")
48 monprofile
50 Profile used by the monitoring user. If the profile does not exist,
51 it will be created with a non-expiring password.
52 (optional, string, default "OCFMONPROFILE")
54 ipcrm
56 Sometimes IPC objects (shared memory segments and semaphores)
57 belonging to an Oracle instance might be left behind which prevents
58 the instance from starting. It is not easy to figure out which
59 shared segments belong to which instance, in particular when more
60 instances are running as same user.
61 What we use here is the "oradebug" feature and its "ipc" trace
63 utility. It is not optimal to parse the debugging information, but
64 I am not aware of any other way to find out about the IPC
65 information. In case the format or wording of the trace report
66 changes, parsing might fail. There are some precautions, however,
67 to prevent stepping on other peoples toes. There is also a
68 dumpinstipc option which will make us print the IPC objects which
69 belong to the instance. Use it to see if we parse the trace file
70 correctly.
71 Three settings are possible:
73 - none: don't mess with IPC and hope for the best (beware: you'll
75 probably be out of luck, sooner or later)
76 - instance: try to figure out the IPC stuff which belongs to the
78 instance and remove only those (default; should be safe)
79 - orauser: remove all IPC belonging to the user which runs the
81 instance (don't use this if you run more than one instance as same
82 user or if other apps running as this user use IPC)
83 The default setting "instance" should be safe to use, but in that
85 case we cannot guarantee that the instance will start. In case IPC
86 objects were already left around, because, for instance, someone
87 mercilessly killing Oracle processes, there is no way any more to
88 find out which IPC objects should be removed. In that case, human
89 intervention is necessary, and probably _all_ instances running as
90 same user will have to be stopped. The third setting, "orauser",
91 guarantees IPC objects removal, but it does that based only on IPC
92 objects ownership, so you should use that only if every instance
93 runs as separate user.
94 Please report any problems. Suggestions/fixes welcome.
96 (optional, string, default "instance")
98 clear_backupmode
100 The clear of the backup mode of ORACLE.
101 (optional, boolean, default false)
103 shutdown_method
105 How to stop Oracle is a matter of taste it seems. The default
106 method ("checkpoint/abort") is:
107 alter system checkpoint; shutdown abort;
109 This should be the fastest safe way bring the instance down. If you
111 find "shutdown abort" distasteful, set this attribute to
112 "immediate" in which case we will
113 shutdown immediate;
115 If you still think that there's even better way to shutdown an
117 Oracle instance we are willing to listen.
118 (optional, string, default "checkpoint/abort")
120
122 This resource agent supports the following actions (operations):
123 start
125 Starts the resource. Suggested minimum timeout: 120s.
126 stop
128 Stops the resource. Suggested minimum timeout: 120s.
129 status
131 Performs a status check. Suggested minimum timeout: 5s.
132 monitor
134 Performs a detailed status check. Suggested minimum timeout: 30s.
135 Suggested interval: 120s.
136 validate-all
138 Performs a validation of the resource configuration. Suggested
139 minimum timeout: 5s.
140 methods
142 Suggested minimum timeout: 5s.
143 meta-data
145 Retrieves resource agent metadata (internal use only). Suggested
146 minimum timeout: 5s.
147
149 The following is an example configuration for a oracle resource using
150 the crm(8) shell:
151 primitive p_oracle ocf:heartbeat:oracle \
153 params \
154 sid=string \
155 op monitor depth="0" timeout="30s" interval="120s"
156
158 The following is an example configuration for a oracle resource using
159 pcs(8)
160 pcs resource create p_oracle ocf:heartbeat:oracle \
162 sid=string \
163 op monitor depth="0" timeout="30s" interval="120s"
164
166 http://clusterlabs.org/
167
169 ClusterLabs contributors (see the resource agent source for information
170 about individual authors)
171resource-agents UNKNOWN 10/23/2019 OCF_HEARTBEAT_ORACLE(7)