'\" t
.\"     Title: ocf_heartbeat_named
.\"    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_NAMED" "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_named \- Manages a named server
.SH "SYNOPSIS"
.HP \w'\fBnamed\fR\ 'u
\fBnamed\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Resource script for named (Bind) server\&. It manages named as an HA resource\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBnamed\fR
.RS 4
Path to the named command\&.
.sp
(optional, string, default "/usr/sbin/named")
.RE
.PP
\fBrndc\fR
.RS 4
Path to the rndc command\&.
.sp
(optional, string, default "/usr/sbin/rndc")
.RE
.PP
\fBhost\fR
.RS 4
Path to the host command\&.
.sp
(optional, string, default "/usr/bin/host")
.RE
.PP
\fBnamed_user\fR
.RS 4
User that should own named process\&.
.sp
(optional, string, default "named")
.RE
.PP
\fBnamed_config\fR
.RS 4
Configuration file for named\&.
.sp
(unique, optional, string, no default)
.RE
.PP
\fBnamed_pidfile\fR
.RS 4
PIDFILE file for named\&.
.sp
(unique, optional, string, default "/var/run/named/named\&.pid")
.RE
.PP
\fBnamed_rootdir\fR
.RS 4
Directory that named should use for chroot if any\&.
.sp
(unique, optional, string, no default)
.RE
.PP
\fBnamed_options\fR
.RS 4
Options for named process if any\&.
.sp
(optional, string, no default)
.RE
.PP
\fBnamed_keytab_file\fR
.RS 4
named service keytab file (for GSS\-TSIG)\&.
.sp
(optional, string, no default)
.RE
.PP
\fBmonitor_request\fR
.RS 4
Request that shall be sent to named for monitoring\&. Usually an A record in DNS\&.
.sp
(optional, string, default "localhost")
.RE
.PP
\fBmonitor_response\fR
.RS 4
Expected response from named server\&.
.sp
(optional, string, default "127\&.0\&.0\&.1")
.RE
.PP
\fBmonitor_ip\fR
.RS 4
IP Address where named listens\&.
.sp
(optional, string, default "127\&.0\&.0\&.1")
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 60\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 60\&.
.RE
.PP
\fBreload\fR
.RS 4
Suggested minimum timeout: 60\&.
.RE
.PP
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 10\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 30\&. 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
.PP
\fBmethods\fR
.RS 4
Suggested minimum timeout: 5\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a named resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_named ocf:heartbeat:named \e
  op monitor depth="0" timeout="30" interval="30" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a named resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_named ocf:heartbeat:named \e
  op monitor depth="0" timeout="30" 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