'\" t
.\"     Title: ocf_heartbeat_oralsnr
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 03/20/2024
.\"    Manual: OCF resource agents
.\"    Source: resource-agents UNKNOWN
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_ORALSN" "7" "03/20/2024" "resource-agents UNKNOWN" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_oralsnr \- Manages an Oracle TNS listener
.SH "SYNOPSIS"
.HP \w'\fBoralsnr\fR\ 'u
\fBoralsnr\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Resource script for Oracle Listener\&. It manages an Oracle Listener instance as an HA resource\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBsid\fR
.RS 4
The Oracle SID (aka ORACLE_SID)\&. Necessary for the monitor op, i\&.e\&. to do tnsping SID\&.
.sp
(unique, required, string, no default)
.RE
.PP
\fBhome\fR
.RS 4
The Oracle home directory (aka ORACLE_HOME)\&. If not specified, then the SID should be listed in /etc/oratab\&.
.sp
(optional, string, no default)
.RE
.PP
\fBuser\fR
.RS 4
Run the listener as this user\&.
.sp
(optional, string, no default)
.RE
.PP
\fBlistener\fR
.RS 4
Listener instance to be started (as defined in listener\&.ora)\&. Defaults to LISTENER\&.
.sp
(unique, optional, string, no default)
.RE
.PP
\fBtns_admin\fR
.RS 4
Full path to the directory that contains the Oracle listener tnsnames\&.ora configuration file\&. The shell variable TNS_ADMIN is set to the value provided\&.
.sp
(optional, string, no default)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 120s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 120s\&.
.RE
.PP
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 60s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 30s\&. Suggested interval: 10s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBmethods\fR
.RS 4
Suggested minimum timeout: 5s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a oralsnr resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_oralsnr ocf:heartbeat:oralsnr \e
  params \e
    sid=\fIstring\fR \e
  op monitor depth="0" timeout="30s" interval="10s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a oralsnr resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_oralsnr ocf:heartbeat:oralsnr \e
  sid=\fIstring\fR \e
  op monitor depth="0" timeout="30s" interval="10s" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR
