# Driver `hb.multicast`

**Minimal configlet:**

	[hb#1]
	type = multicast

**Minimal setup command:**

	om node set --kw="type=multicast"

**Supported keywords:**

- addr
- comment
- interval
- intf
- port
- timeout
- type

## Keyword `addr`

	required:    false
	scopable:    true
	default:     224.3.29.71

**Description:**

The multicast address to send to and listen on.


## Keyword `comment`

	required:    false
	scopable:    false

**Description:**

A free form text describing the role of the object, of the node, or of the
section it is set in.

The keyword is accepted in any section, so the DEFAULT section can document a
configuration as a whole, and a resource, pool, heartbeat, array or network
section can document itself.

The agent does not interpret the value.


## Keyword `interval`

	required:    false
	scopable:    true
	default:     5s
	convert:     duration

**Description:**

The maximum interval between 2 heartbeat payload sends.

The actual interval is not fixed, because the daemon tries to send the
message as soon as it has something to notify. A minimum interval
protects the node from saturating the network and cpu with the daemon
synchronization workload.


## Keyword `intf`

	required:    false
	scopable:    true

**Default:**

The natural interface for `<addr>`

**Example:**

	intf=eth0

**Description:**

The interface to bind.


## Keyword `port`

	required:    false
	scopable:    true
	default:     10000
	convert:     int

**Description:**

The port for each node to send to or listen on.


## Keyword `timeout`

	required:    false
	scopable:    true
	default:     15s
	convert:     duration

**Description:**

The delay since the last received heartbeat from a node before considering this node is gone.


## Keyword `type`

	required:    true
	scopable:    false
	candidates:  unicast, multicast, disk, relay

**Description:**

The heartbeat driver name.