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

SUPPORTED ACTIONS

80       This resource agent supports the following actions (operations):
81
82       start
83           Starts the resource. Suggested minimum timeout: 30s.
84
85       stop
86           Stops the resource. Suggested minimum timeout: 30s.
87
88       status
89           Performs a status check. Suggested minimum timeout: 30s. Suggested
90           interval: 10s.
91
92       monitor
93           Performs a detailed status check. Suggested minimum timeout: 30s.
94           Suggested interval: 10s.
95
96       meta-data
97           Retrieves resource agent metadata (internal use only). Suggested
98           minimum timeout: 5s.
99
100       validate-all
101           Performs a validation of the resource configuration. Suggested
102           minimum timeout: 5s.
103

EXAMPLE CRM SHELL

105       The following is an example configuration for a dnsupdate resource
106       using the crm(8) shell:
107
108           primitive p_dnsupdate ocf:heartbeat:dnsupdate \
109             params \
110               hostname=string \
111             op monitor depth="0" timeout="30s" interval="10s"
112

EXAMPLE PCS

114       The following is an example configuration for a dnsupdate resource
115       using pcs(8)
116
117           pcs resource create p_dnsupdate ocf:heartbeat:dnsupdate \
118             hostname=string \
119             op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="10s"
120

AUTHOR

125       ClusterLabs contributors (see the resource agent source for information
126       about individual authors)
127
128
129
130resource-agents UNKNOWN           10/11/2023           OCF_HEARTBEAT_DNSUPD(7)