'\" t
.\"     Title: heartbeat
.\"    Author: Alan Robertson <alanr@unix.sh>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 2 Dec 2014
.\"    Manual: System administration utilities
.\"    Source: Heartbeat 3.0.6
.\"  Language: English
.\"
.TH "HEARTBEAT" "8" "2 Dec 2014" "Heartbeat 3.0.6" "System administration utilitie"
.\" -----------------------------------------------------------------
.\" * 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"
heartbeat \- Heartbeat subsystem for High\-Availability Linux
.SH "DESCRIPTION"
.PP
heartbeat is a basic heartbeat subsystem for Linux\-HA\&. It will run scripts at initialisation, and when machines go up or down\&. This version will also perform IP address takeover using gratuitous ARPs\&. It works correctly for a 2\-node configuration, and is extensible to larger configurations\&.
.PP
It implements the following kinds of heartbeats:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
UDP/IP v4 broadcast;
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
UDP/IP v4/v6 multicast;
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
UDP/IP v4/v6 unicast;
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Even such exotic protocols as TIPC or RDS\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Bidirectional Serial Rings ("raw" serial ports) \(em this type is deprecated and should no longer be used;
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
special "ping" heartbeats for routers, etc\&. \(em this type has been superseded by functionality in
\fBpacemaker\fR()
and should no longer be used\&.
.RE
.PP
Comprehensive documentation on heartbeat is available in the Heartbeat User\*(Aqs Guide\&. If this documentation is not installed on your system, it can be found at http://linux\-ha\&.org/\&.
.SH "OPTIONS"
.PP
The following options are supported by heartbeat:
.PP
\fB\-d\fR
.RS 4
Increment debugging level\&. Higher levels are more verbose\&.
.RE
.PP
\fB\-r\fR
.RS 4
Reload heartbeat\&. This option is functionally identical to sending a running heartbeat process a HUP signal\&. If the configuration has not changed, then this option is essentially a no\-op\&. If
\fBha.cf\fR(5)
or
\fBauthkeys\fR(5)
has changed, then heartbeat will re\-read these files and update its configuration\&.
.sp
This option may not be used together with
\fB\-R\fR\&.
.RE
.PP
\fB\-k\fR
.RS 4
Kill (stop) heartbeat\&.
.RE
.PP
\fB\-s\fR
.RS 4
Report heartbeat status\&.
.RE
.PP
\fB\-R\fR
.RS 4
Heartbeat restart exec flag (internal use only)\&. May not be used with
\fB\-r\fR\&.
.RE
.PP
\fB\-C\fR
.RS 4
Heartbeat current resource state for restart (internal use only)\&. Only valid with
\fB\-R\fR\&.
.RE
.PP
\fB\-V\fR
.RS 4
Print out heartbeat version\&.
.RE
.PP
Note that most of these options are used for supporting the heartbeat init script, which provides the conventional start, stop, status and restart options (among others)\&. It is recommended to use this rather than invoking the heartbeat command directly\&.
.SH "SEE ALSO"
.PP
\fBha.cf\fR(5),
\fBauthkeys\fR(5)
.SH "AUTHORS"
.PP
\fBAlan Robertson\fR <\&alanr@unix\&.sh\&>
.RS 4
heartbeat
.RE
.PP
\fBLars Ellenberg\fR <\&lars\&.ellenberg@linbit\&.com\&>
.RS 4
Heartbeat Maintainer; code fixes; documentation updates
.RE
.PP
\fBJuan Pedro Paredes Caballero\fR <\&juampe@retemail\&.es\&>
.RS 4
man page
.RE
.PP
\fBSimon Horman\fR <\&horms@verge\&.net\&.au\&>
.RS 4
man page
.RE
.PP
\fBFlorian Haas\fR <\&florian\&.haas@linbit\&.com\&>
.RS 4
man page
.RE