1KEEPALIVED(8) System Manager's Manual KEEPALIVED(8)
2
6 keepalived - load-balancing and high-availability service
7
10 keepalived [-f|--use-file=FILE] [-P|--vrrp] [-C|--check]
11 [-l|--log-console] [-D|--log-detail] [-S|--log-facility={0-7}]
12 [-X|--release-vips] [-V|--dont-release-vrrp] [-I|--dont-release-ipvs]
13 [-R|--dont-respawn] [-n|--dont-fork] [-d|--dump-conf] [-p|--pid=FILE]
14 [-r|--vrrp_pid=FILE] [-c|--checkers_pid=FILE] [-a|--address-monitoring]
15 [-x|--snmp] [-A|--snmp-agent-socket=FILE] [-m|--core-dump]
16 [-M|--core-dump-format[=PATTERN]] [-v|--version] [-h|--help]
17
20 Keepalived provides simple and robust facilities for load-balancing and
21 high-availability. The load-balancing framework relies on the
22 well-known and widely used Linux Virtual Server (IPVS) kernel module
23 providing Layer4 load-balancing. Keepalived implements a set of
24 checkers to dynamically and adaptively maintain and manage a
25 load-balanced server pool according to their health. Keepalived also
26 implements the VRRPv2 and VRRPv3 protocols to achieve high-availability
27 with director failover.
28
31 -f, --use-file=FILE
32 Use the specified configuration file. The default configuration
33 file is "/etc/keepalived/keepalived.conf".
34 -P, --vrrp
36 Only run the VRRP subsystem. This is useful for configurations
37 that do not use the IPVS load balancer.
38 -C, --check
40 Only run the healthcheck subsystem. This is useful for
41 configurations that use the IPVS load balancer with a single
42 director with no failover.
43 -l, --log-console
45 Log messages to the local console. The default behavior is to
46 log messages to syslog.
47 -D, --log-detail
49 Detailed log messages.
50 -S, --log-facility=[0-7]
52 Set syslog facility to LOG_LOCAL[0-7]. The default syslog
53 facility is LOG_DAEMON.
54 -X, --release-vips
56 Drop VIP on transition from signal.
57 -V, --dont-release-vrrp
59 Don't remove VRRP VIPs and VROUTEs on daemon stop. The default
60 behavior is to remove all VIPs and VROUTEs when keepalived
61 exits.
62 -I, --dont-release-ipvs
64 Don't remove IPVS topology on daemon stop. The default behavior
65 it to remove all entries from the IPVS virtual server table when
66 keepalived exits.
67 -R, --dont-respawn
69 Don't respawn child processes. The default behavior is to
70 restart the VRRP and checker processes if either process exits.
71 -n, --dont-fork
73 Don't fork the daemon process. This option will cause keepalived
74 to run in the foreground.
75 -d, --dump-conf
77 Dump the configuration data.
78 -p, --pid=FILE
80 Use the specified pidfile for the parent keepalived process. The
81 default pidfile for keepalived is "/var/run/keepalived.pid",
82 unless a network namespace is being used. See NAMESPACES below
83 for more details.
84 -r, --vrrp_pid=FILE
86 Use the specified pidfile for the VRRP child process. The
87 default pidfile for the VRRP child process is
88 "/var/run/keepalived_vrrp.pid", unless a network namespace is
89 being used.
90 -c, --checkers_pid=FILE
92 Use the specified pidfile for checkers child process. The
93 default pidfile for the checker child process is
94 "/var/run/keepalived_checkers.pid" unless a network namespace is
95 being used.
96 -a, --address-monitoring
98 Log all address additions/deletions reported by netlink.
99 -x, --snmp
101 Enable the SNMP subsystem.
102 -A, --snmp-agent-socket=FILE
104 Use the specified socket for connection to SNMP master agent.
105 -m, --core-dump
107 Override the RLIMIT_CORE hard and soft limits to enable
108 keepalived to produce a coredump in the event of a segfault or
109 other failure. This is most useful if keepalived has been built
110 with 'make debug'. Core dumps will be created in /, unless
111 keepalived is run with the --dont-fork option, in which case
112 they will be created in the directory from which keepalived was
113 run, or they will be created in the directory of a configuraton
114 file if the fault occurs while reading the file.
115 -M, --core-dump-pattern[=PATTERN]
117 Sets option --core-dump, and also updates
118 /proc/sys/kernel/core_pattern to the pattern specified, or
119 'core' if none specified. Provided the parent process doesn't
120 terminate abnormally, it will restore
121 /proc/sys/kernel/core_pattern to its original value on exit.
122 Note: This will also affect any other process producing a core
124 dump while keepalived is running.
125 -v, --version
127 Display the version and exit.
128 -h, --help
130 Display this help message and exit.
131
134 keepalived can be run in a network namespace (see keepalived.conf(5)
135 for configuration details). When run in a network namespace, a local
136 mount namespace is also created, and
137 /var/run/keepalived/keepalived_NamespaceName is mounted on
138 /var/run/keepalived. By default, pid files with the usual default names
139 are then created in /var/run/keepalived from the perspective of a
140 process in the mount namespace, and they will be visible in
141 /var/run/keepalived/keepalived_NamespaceName for a process running in
142 the default mount namespace.
143
146 keepalived reacts to a set of signals. You can send a signal to the
147 parent keepalived process using the following:
148 kill -SIGNAL $(cat /var/run/keepalived.pid)
150 Note that -SIGNAL must be replaced with the actual signal you are
152 trying to send, e.g. with HUP. So it then becomes:
153 kill -HUP $(cat /var/run/keepalived.pid)
155 HUP This causes keepalived to close down all interfaces, reload its
157 configuration, and start up with the new configuration.
158 TERM, INT
160 keepalived will shut down.
161 USR1 Write configuration data to /tmp/keepalived.data
163 USR2 Write statistics info to /tmp/keepalived.stats
165
167 keepalived.conf(5), ipvsadm(8)
168
171 This man page was written by Ryan O'Hara <rohara@redhat.com>
172 April 2016 KEEPALIVED(8)