'\" t
.\"     Title: ocf_heartbeat_eDir88
.\"    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: 06/07/2017
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.0.0~rc1-4~bpo8+1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_EDIR88" "7" "06/07/2017" "resource-agents 4.0.0~rc1-4~bp" "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_eDir88 \- Manages a Novell eDirectory directory server
.SH "SYNOPSIS"
.HP \w'\fBeDir88\fR\ 'u
\fBeDir88\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Resource script for managing an eDirectory instance\&. Manages a single instance of eDirectory as an HA resource\&. The "multiple instances" feature or eDirectory has been added in version 8\&.8\&. This script will not work for any version of eDirectory prior to 8\&.8\&. This RA can be used to load multiple eDirectory instances on the same host\&.
.PP
It is very strongly recommended to put eDir configuration files (as per the eDir_config_file parameter) on local storage on each node\&. This is necessary for this RA to be able to handle situations where the shared storage has become unavailable\&. If the eDir configuration file is not available, this RA will fail, and heartbeat will be unable to manage the resource\&. Side effects include STONITH actions, unmanageable resources, etc\&.\&.\&.
.PP
Setting a high action timeout value is _very_ _strongly_ recommended\&. eDir with IDM can take in excess of 10 minutes to start\&. If heartbeat times out before eDir has had a chance to start properly, mayhem _WILL ENSUE_\&.
.PP
The LDAP module seems to be one of the very last to start\&. So this script will take even longer to start on installations with IDM and LDAP if the monitoring of IDM and/or LDAP is enabled, as the start command will wait for IDM and LDAP to be available\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBeDir_config_file\fR
.RS 4
Path to configuration file for eDirectory instance\&.
.sp
(unique, optional, string, default "/etc/opt/novell/eDirectory/conf/nds\&.conf")
.RE
.PP
\fBeDir_monitor_ldap\fR
.RS 4
Should we monitor if LDAP is running for the eDirectory instance?
.sp
(optional, boolean, default
0)
.RE
.PP
\fBeDir_monitor_idm\fR
.RS 4
Should we monitor if IDM is running for the eDirectory instance?
.sp
(optional, boolean, default
0)
.RE
.PP
\fBeDir_jvm_initial_heap\fR
.RS 4
Value for the DHOST_INITIAL_HEAP java environment variable\&. If unset, java defaults will be used\&.
.sp
(optional, integer, no default)
.RE
.PP
\fBeDir_jvm_max_heap\fR
.RS 4
Value for the DHOST_MAX_HEAP java environment variable\&. If unset, java defaults will be used\&.
.sp
(optional, integer, no default)
.RE
.PP
\fBeDir_jvm_options\fR
.RS 4
Value for the DHOST_OPTIONS java environment variable\&. If unset, original values will be used\&.
.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: 600\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 600\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 60\&. Suggested interval: 30\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a eDir88 resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_eDir88 ocf:heartbeat:eDir88 \e
  op monitor timeout="60" interval="30" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a eDir88 resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_eDir88 ocf:heartbeat:eDir88 \e
  op monitor timeout="60" interval="30" 
.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