ocf_heartbeat_dnsupdate(7)

1OCF_HEARTBEAT_DNSUPD(7)       OCF resource agents      OCF_HEARTBEAT_DNSUPD(7)
2
3
4

NAME

6       ocf_heartbeat_dnsupdate - IP take-over via dynamic DNS update
7

SYNOPSIS

9       dnsupdate [start | stop | status | monitor | meta-data | validate-all]
10

DESCRIPTION

12       This resource agent manages IP take-over via dynamic DNS updates.
13

SUPPORTED PARAMETERS

15       hostname
16           The hostname whose IP address will need to be updated.
17
18           (unique, required, string, no default)
19
20       ip
21           IP address to set.
22
23           (required, string, no default)
24
25       ttl
26           Time to live, in seconds, for the DNS record. This affects how soon
27           DNS updates propagate. It should be a reasonable compromise between
28           update speed and DNS server load.
29
30           If using booth, the ticket timeout is a good start.
31
32           (optional, integer, default 300)
33
34       keyfile
35           The file containing the shared secret needed to update the DNS
36           record. Please see the nsupdate man page for the exact syntax.
37
38           (optional, string, no default)
39
40       server
41           Which DNS server to send these updates for. When no server is
42           provided, this defaults to the master server for the correct zone.
43
44           (optional, string, no default)
45
46       serverport
47           Port number on the DNS server.
48
49           Note: due to a limitation in the nsupdate command, this option will
50           only take effect if you also specify the DNS server!
51
52           (optional, integer, default 53)
53
54       nsupdate_opts
55           Additional options to be passed to nsupdate.
56
57           (optional, string, no default)
58
59       unregister_on_stop
60           Whether or not to actively remove records on stop. This is not
61           needed for normal operation, since the site taking over the IP
62           address will delete all previous records.
63
64           (optional, boolean, default false)
65

SUPPORTED ACTIONS

67       This resource agent supports the following actions (operations):
68
69       start
70           Starts the resource. Suggested minimum timeout: 30s.
71
72       stop
73           Stops the resource. Suggested minimum timeout: 30s.
74
75       status
76           Performs a status check. Suggested minimum timeout: 30s. Suggested
77           interval: 10s.
78
79       monitor
80           Performs a detailed status check. Suggested minimum timeout: 30s.
81           Suggested interval: 10s.
82
83       meta-data
84           Retrieves resource agent metadata (internal use only). Suggested
85           minimum timeout: 5s.
86
87       validate-all
88           Performs a validation of the resource configuration. Suggested
89           minimum timeout: 5s.
90

EXAMPLE CRM SHELL

92       The following is an example configuration for a dnsupdate resource
93       using the crm(8) shell:
94
95           primitive p_dnsupdate ocf:heartbeat:dnsupdate \
96             params \
97               hostname=string \
98               ip=string \
99             op monitor depth="0" timeout="30s" interval="10s"
100

EXAMPLE PCS

102       The following is an example configuration for a dnsupdate resource
103       using pcs(8)
104
105           pcs resource create p_dnsupdate ocf:heartbeat:dnsupdate \
106             hostname=string \
107             ip=string \
108             op monitor depth="0" timeout="30s" interval="10s"
109

AUTHOR

114       ClusterLabs contributors (see the resource agent source for information
115       about individual authors)
116
117
118
119resource-agents UNKNOWN           03/09/2020           OCF_HEARTBEAT_DNSUPD(7)