Scroll to navigation

OCF_HEARTBEAT_DNSUPD(7) OCF resource agents OCF_HEARTBEAT_DNSUPD(7)

NAME

ocf_heartbeat_dnsupdate - IP take-over via dynamic DNS update

SYNOPSIS

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

DESCRIPTION

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

SUPPORTED PARAMETERS

hostname

Either the hostname whose IP address will need to be updated (in case of type=A) or alias whose hostname will need to be updated (in case of type=CNAME).

(unique, required, string, no default)

type

The type of DNS record that need to be updated (A or CNAME).

(optional, string, default "A")

ip

IP address to set.

(optional, string, no default)

cname

The CNAME whose hostname address will need to be updated.

(optional, string, no default)

ttl

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.

If using booth, the ticket timeout is a good start.

(optional, integer, default 300)

keyfile

The file containing the shared secret needed to update the DNS record. Please see the nsupdate man page for the exact syntax.

(optional, string, no default)

server

Which DNS server to send these updates for. When no server is provided, this defaults to the promoted server for the correct zone.

(optional, string, no default)

serverport

Port number on the DNS server.

Note: due to a limitation in the nsupdate command, this option will only take effect if you also specify the DNS server!

(optional, integer, default 53)

nsupdate_opts

Additional options to be passed to nsupdate.

(optional, string, no default)

unregister_on_stop

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.

(optional, boolean, default false)

SUPPORTED ACTIONS

This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 30s.

stop

Stops the resource. Suggested minimum timeout: 30s.

status

Performs a status check. Suggested minimum timeout: 30s. Suggested interval: 10s.

monitor

Performs a detailed status check. Suggested minimum timeout: 30s. Suggested interval: 10s.

meta-data

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

validate-all

Performs a validation of the resource configuration. Suggested minimum timeout: 5s.

EXAMPLE CRM SHELL

The following is an example configuration for a dnsupdate resource using the crm(8) shell:

primitive p_dnsupdate ocf:heartbeat:dnsupdate \


  params \


    hostname=string \


  op monitor depth="0" timeout="30s" interval="10s"

EXAMPLE PCS

The following is an example configuration for a dnsupdate resource using pcs(8)

pcs resource create p_dnsupdate ocf:heartbeat:dnsupdate \


  hostname=string \


  op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="10s"

SEE ALSO

http://clusterlabs.org/

AUTHOR

ClusterLabs contributors (see the resource agent source for information about individual authors)

04/13/2023 resource-agents 4.12.0-2