'\" t
.\"     Title: ocf_heartbeat_ids
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 12/17/2020
.\"    Manual: OCF resource agents
.\"    Source: resource-agents UNKNOWN
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_IDS" "7" "12/17/2020" "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_ids \- Manages an Informix Dynamic Server (IDS) instance
.SH "SYNOPSIS"
.HP \w'\fBids\fR\ 'u
\fBids\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
OCF resource agent to manage an IBM Informix Dynamic Server (IDS) instance as an High\-Availability resource\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBinformixdir\fR
.RS 4
The value the environment variable INFORMIXDIR has after a typical installation of IDS\&. Or in other words: the path (without trailing \*(Aq/\*(Aq) where IDS was installed to\&. If this parameter is unspecified the script will try to get the value from the shell environment\&.
.sp
(optional, string, no default)
.RE
.PP
\fBinformixserver\fR
.RS 4
The value the environment variable INFORMIXSERVER has after a typical installation of IDS\&. Or in other words: the name of the IDS server instance to manage\&. If this parameter is unspecified the script will try to get the value from the shell environment\&.
.sp
(optional, string, no default)
.RE
.PP
\fBonconfig\fR
.RS 4
The value the environment variable ONCONFIG has after a typical installation of IDS\&. Or in other words: the name of the configuration file for the IDS instance specified in INFORMIXSERVER\&. The specified configuration file will be searched at \*(Aq/etc/\*(Aq\&. If this parameter is unspecified the script will try to get the value from the shell environment\&.
.sp
(optional, string, no default)
.RE
.PP
\fBdbname\fR
.RS 4
This parameter defines which database to use in order to monitor the IDS instance\&. If this parameter is unspecified the script will use the \*(Aqsysmaster\*(Aq database as a default\&.
.sp
(optional, string, default "sysmaster")
.RE
.PP
\fBsqltestquery\fR
.RS 4
SQL test query to run on the database specified by the parameter \*(Aqdbname\*(Aq in order to monitor the IDS instance and determine if it\*(Aqs functional or not\&. If this parameter is unspecified the script will use \*(AqSELECT COUNT(*) FROM systables;\*(Aq as a default\&.
.sp
(optional, string, default "SELECT COUNT(*) FROM systables;")
.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
.PP
\fBusage\fR
.RS 4
Suggested minimum timeout: 5s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a ids resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_ids ocf:heartbeat:ids \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 ids resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_ids ocf:heartbeat:ids \e
  op monitor OCF_CHECK_LEVEL="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