'\" t
.\"     Title: ocf_heartbeat_dnsupdate
.\"    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_DNSUPD" "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_dnsupdate \- IP take\-over via dynamic DNS update
.SH "SYNOPSIS"
.HP \w'\fBdnsupdate\fR\ 'u
\fBdnsupdate\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This resource agent manages IP take\-over via dynamic DNS updates\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBhostname\fR
.RS 4
The hostname whose IP address will need to be updated\&.
.sp
(unique, required, string, no default)
.RE
.PP
\fBip\fR
.RS 4
IP address to set\&.
.sp
(required, string, no default)
.RE
.PP
\fBttl\fR
.RS 4
Time to live, in seconds, for the DNS record\&. This affects how soon DNS updates propagate\&. It should be a reasonable compromise between update speed and DNS server load\&.
.sp
If using booth, the ticket timeout is a good start\&.
.sp
(optional, integer, default
300)
.RE
.PP
\fBkeyfile\fR
.RS 4
The file containing the shared secret needed to update the DNS record\&. Please see the nsupdate man page for the exact syntax\&.
.sp
(optional, string, no default)
.RE
.PP
\fBserver\fR
.RS 4
Which DNS server to send these updates for\&. When no server is provided, this defaults to the master server for the correct zone\&.
.sp
(optional, string, no default)
.RE
.PP
\fBserverport\fR
.RS 4
Port number on the DNS server\&.
.sp
Note: due to a limitation in the nsupdate command, this option will only take effect if you also specify the DNS server!
.sp
(optional, integer, default
53)
.RE
.PP
\fBnsupdate_opts\fR
.RS 4
Additional options to be passed to nsupdate\&.
.sp
(optional, string, no default)
.RE
.PP
\fBunregister_on_stop\fR
.RS 4
Whether or not to actively remove records on stop\&. This is not needed for normal operation, since the site taking over the IP address will delete all previous records\&.
.sp
(optional, boolean, default
false)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 30s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 30s\&.
.RE
.PP
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 30s\&. Suggested interval: 10s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 30s\&. 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: 5s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a dnsupdate resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_dnsupdate ocf:heartbeat:dnsupdate \e
  params \e
    hostname=\fIstring\fR \e
    ip=\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 dnsupdate resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_dnsupdate ocf:heartbeat:dnsupdate \e
  hostname=\fIstring\fR \e
  ip=\fIstring\fR \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