aboutsummaryrefslogtreecommitdiffstats
path: root/man/pingu.conf.5.in
blob: 8a8cced2a40819e124e870f2a608e09e8a41b7ef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
.Dd October 19, 2011
.Dt PINGU.CONF 8 Linux
.Os

.Sh NAME
.Nm pingu.conf
.Nd pingu daemon configuration file

.Sh DESCRIPTION
The file can contain 3 different contexts: Global context, interface context
and host context.
.Pp
Blank lines and lines starting with # are ignored.


.Sh GLOBAL CONTEXT
The config file starts in global context. In this section the default values
for the keywords used in interface on hosts sections are set. Values set in
global context can be overridden in interface and host sections.

.Bl -tag -indent
.It Cd interval
Set the default ping burst interval
.It Cd timeout
The default ping timout value in seconds. If the ping response does not come
back within "timeout" seconds the ping is considered lost.
.It Cd required
The minimum required ping responses of a burst to consider the host online.
.It Cd retries
Maximum sent ping packets for a burst.
.It Cd up-action
The default action to execute when a ping host goes online.
.It Cd down-action
The default action to execute when a ping host goes offline.
.El

.Sh INTERFACE CONTEXT
Example:
.Bd -literal
interface eth0 {
	keyword value
	...
}
.Ed

The keywords valid in an interface sections are:
.Bl -tag -indent
.It Cd gateway-down-action
Execute this action when a gateway is considered offline.
.It Cd gateway-up-action
Execute this action when a gateway is considered online.
.It Cd label
A user defined label that will be used in logs and by pinguctl.
.It Cd load-balance
Enable balancing for this interface. A minimum of two interfaces need to
be configured in order for load-balancing to work. An optional weight
value can be given.
.It Cd required-hosts-online
The minimum number of ping hosts that needs to be online to consider the
gateway online.
.It Cd route-table
The alternate route table for this interface.
.It Cd rule-priority
The preference value for the ip rule.
.El

.Sh HOST CONTEXT
Example:
.Bd -literal
host 1.2.3.4 {
	keyword value
	...
}
.Ed

.Bl -tag -indent
.It Cd bind-interface
Bind the pings to this interface.
.It Cd down-action
Execute this action when ping host goes offline
.It Cd interval
The interval for ping bursts
.It Cd label
A label to be used in logs and pinguctl
.It Cd required
The number of required ping responses to consider host online.
.It Cd retry
The maximum number of retries for a ping burst.
.It Cd timeout
The ping response timeout value in seconds. If no ping response returns within
this value the ping is considered lost.
.It Cd up-action
Execute this action when a ping host goes online
.El

.Sh AUTHORS
.An Natanael Copa
.Aq ncopa@alpinelinux.org