xref: /openbsd/usr.sbin/ifstated/ifstated.8 (revision 73471bf0)
1.\" $OpenBSD: ifstated.8,v 1.10 2017/08/08 14:16:12 rob Exp $
2.\"
3.\" Copyright (c) 2004 Ryan McBride <mcbride@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: August 8 2017 $
18.Dt IFSTATED 8
19.Os
20.Sh NAME
21.Nm ifstated
22.Nd Interface State daemon
23.Sh SYNOPSIS
24.Nm ifstated
25.Op Fl dhinv
26.Op Fl D Ar macro Ns = Ns Ar value
27.Op Fl f Ar file
28.Sh DESCRIPTION
29The
30.Nm
31daemon runs commands in response to network state changes, which it
32determines by monitoring interface link state or running external
33tests.
34For example, it can be used with
35.Xr carp 4
36to change running services or to ensure that
37.Xr carp 4
38interfaces stay in sync, or with
39.Xr pf 4
40to test server or link availability and modify translation or routing rules.
41The options are as follows:
42.Bl -tag -width Ds
43.It Fl D Ar macro Ns = Ns Ar value
44Define
45.Ar macro
46to be set to
47.Ar value
48on the command line.
49Overrides the definition of
50.Ar macro
51in the configuration file.
52.It Fl d
53Do not daemonize and log to
54.Em stdout .
55.It Fl f Ar file
56Specify an alternate location,
57.Ar file ,
58for the configuration file.
59.It Fl h
60Print help message.
61.It Fl i
62Ignore initial interface states.
63.It Fl n
64Configtest mode.
65Check config validity, then exit.
66.It Fl v
67Verbose mode.
68Use twice to further increase verbosity.
69.El
70.Pp
71Upon receiving
72.Dv SIGHUP ,
73.Nm
74reloads the configuration file.
75.Sh FILES
76.Bl -tag -width "/etc/ifstated.conf" -compact
77.It Pa /etc/ifstated.conf
78.Nm
79configuration file.
80.El
81.Sh SEE ALSO
82.Xr carp 4 ,
83.Xr pf 4 ,
84.Xr ifstated.conf 5
85.Sh HISTORY
86The
87.Nm
88program first appeared in
89.Ox 3.8 .
90