'\" t
.\"     Title: ocf_heartbeat_dhcpd
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/13/2024
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.13.0-1+b1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_DHCPD" "7" "03/13/2024" "resource-agents 4.13.0-1+b1" "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_dhcpd \- Chrooted ISC DHCP server resource agent\&.
.SH "SYNOPSIS"
.HP \w'\fBdhcpd\fR\ 'u
\fBdhcpd\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Manage an ISC DHCP server service in a chroot environment\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBconfig\fR
.RS 4
The absolute path to the DHCP server configuration file\&.
.sp
(unique, required, string, no default)
.RE
.PP
\fBchrooted\fR
.RS 4
Configure the dhcpd service to run in a chrooted or non\-chrooted mode\&.
.sp
(unique, optional, boolean, default
true)
.RE
.PP
\fBchrooted_path\fR
.RS 4
The absolute path of the chrooted DHCP environment\&.
.sp
(unique, optional, string, default "/var/lib/dhcp")
.RE
.PP
\fBbinary\fR
.RS 4
The binary for the DHCP server process\&. An absolute path definition is not required, but can be used to override environment path\&.
.sp
(optional, string, default "dhcpd")
.RE
.PP
\fBuser\fR
.RS 4
The system user the DHCP server process will run as when it is chrooted\&.
.sp
(optional, string, default "dhcpd")
.RE
.PP
\fBgroup\fR
.RS 4
The system group the DHCP server process will run as when it is chrooted\&.
.sp
(optional, string, default "nogroup")
.RE
.PP
\fBinterface\fR
.RS 4
The network interface(s) the DHCP server process will bind to\&. A blank value will bind the process to all interfaces\&.
.sp
(optional, string, no default)
.RE
.PP
\fBincludes\fR
.RS 4
This parameter provides a means to copy include files into the chrooted environment\&. If a dhcpd\&.conf file contains a line similar to this:
.sp
include "/etc/named\&.keys";
.sp
Then an admin also has to tell the dhcpd RA that this file should be pulled into the chrooted environment\&. This is a space delimited list\&.
.sp
(optional, string, no default)
.RE
.PP
\fBleases\fR
.RS 4
The leases database file, relative to chrooted_path\&.
.sp
(optional, string, default "/db/dhcpd\&.leases")
.RE
.PP
\fBpid\fR
.RS 4
The path and filename of the PID file\&. It is relative to chrooted_path\&.
.sp
(optional, string, default "/var/run/dhcpd\&.pid")
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBrestart\fR
.RS 4
Suggested minimum timeout: 20s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 10s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 20s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a dhcpd resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_dhcpd ocf:heartbeat:dhcpd \e
  params \e
    config=\fIstring\fR \e
  op monitor timeout="20s" interval="10s" depth="0" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a dhcpd resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_dhcpd ocf:heartbeat:dhcpd \e
  config=\fIstring\fR \e
  op monitor timeout="20s" interval="10s" OCF_CHECK_LEVEL="0" 
.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