xref: /openbsd-src/usr.sbin/ifstated/ifstated.8 (revision 668cac5d3f1db05176cc1f9befe1be5bead21694)
1*668cac5dSrob.\" $OpenBSD: ifstated.8,v 1.10 2017/08/08 14:16:12 rob Exp $
2cd97c3b8Smcbride.\"
3cd97c3b8Smcbride.\" Copyright (c) 2004 Ryan McBride <mcbride@openbsd.org>
4cd97c3b8Smcbride.\"
5cd97c3b8Smcbride.\" Permission to use, copy, modify, and distribute this software for any
6cd97c3b8Smcbride.\" purpose with or without fee is hereby granted, provided that the above
7cd97c3b8Smcbride.\" copyright notice and this permission notice appear in all copies.
8cd97c3b8Smcbride.\"
9cd97c3b8Smcbride.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10cd97c3b8Smcbride.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11cd97c3b8Smcbride.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12cd97c3b8Smcbride.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13cd97c3b8Smcbride.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14cd97c3b8Smcbride.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15cd97c3b8Smcbride.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16cd97c3b8Smcbride.\"
17*668cac5dSrob.Dd $Mdocdate: August 8 2017 $
18cd97c3b8Smcbride.Dt IFSTATED 8
19cd97c3b8Smcbride.Os
20cd97c3b8Smcbride.Sh NAME
21cd97c3b8Smcbride.Nm ifstated
2297bef895Sjmc.Nd Interface State daemon
23cd97c3b8Smcbride.Sh SYNOPSIS
24cd97c3b8Smcbride.Nm ifstated
25fb210867Smcbride.Op Fl dhinv
26233ceeddSschwarze.Op Fl D Ar macro Ns = Ns Ar value
27cd97c3b8Smcbride.Op Fl f Ar file
28cd97c3b8Smcbride.Sh DESCRIPTION
29cd97c3b8SmcbrideThe
30cd97c3b8Smcbride.Nm
3197bef895Sjmcdaemon runs commands in response to network state changes, which it
32cd97c3b8Smcbridedetermines by monitoring interface link state or running external
33cd97c3b8Smcbridetests.
34cd97c3b8SmcbrideFor example, it can be used with
35cd97c3b8Smcbride.Xr carp 4
36cd97c3b8Smcbrideto change running services or to ensure that
37cd97c3b8Smcbride.Xr carp 4
38cd97c3b8Smcbrideinterfaces stay in sync, or with
39cd97c3b8Smcbride.Xr pf 4
40cd97c3b8Smcbrideto test server or link availability and modify translation or routing rules.
41cd97c3b8SmcbrideThe options are as follows:
42cd97c3b8Smcbride.Bl -tag -width Ds
4397bef895Sjmc.It Fl D Ar macro Ns = Ns Ar value
44cd97c3b8SmcbrideDefine
45cd97c3b8Smcbride.Ar macro
46cd97c3b8Smcbrideto be set to
47cd97c3b8Smcbride.Ar value
48cd97c3b8Smcbrideon the command line.
49cd97c3b8SmcbrideOverrides the definition of
50cd97c3b8Smcbride.Ar macro
51cd97c3b8Smcbridein the configuration file.
52cd97c3b8Smcbride.It Fl d
53cd97c3b8SmcbrideDo not daemonize and log to
54cd97c3b8Smcbride.Em stdout .
55cd97c3b8Smcbride.It Fl f Ar file
56cd97c3b8SmcbrideSpecify an alternate location,
57cd97c3b8Smcbride.Ar file ,
58cd97c3b8Smcbridefor the configuration file.
59a100839bSjmc.It Fl h
60a100839bSjmcPrint help message.
61a100839bSjmc.It Fl i
62a100839bSjmcIgnore initial interface states.
63cd97c3b8Smcbride.It Fl n
64cd97c3b8SmcbrideConfigtest mode.
65cd97c3b8SmcbrideCheck config validity, then exit.
66fb210867Smcbride.It Fl v
6797bef895SjmcVerbose mode.
6897bef895SjmcUse twice to further increase verbosity.
69cd97c3b8Smcbride.El
703ce03a50Sjaredy.Pp
713ce03a50SjaredyUpon receiving
723ce03a50Sjaredy.Dv SIGHUP ,
733ce03a50Sjaredy.Nm
743ce03a50Sjaredyreloads the configuration file.
75cd97c3b8Smcbride.Sh FILES
76cd97c3b8Smcbride.Bl -tag -width "/etc/ifstated.conf" -compact
77cd97c3b8Smcbride.It Pa /etc/ifstated.conf
78cd97c3b8Smcbride.Nm
79cd97c3b8Smcbrideconfiguration file.
80cd97c3b8Smcbride.El
81cd97c3b8Smcbride.Sh SEE ALSO
82cd97c3b8Smcbride.Xr carp 4 ,
83ed8d1828Sjmc.Xr pf 4 ,
84ed8d1828Sjmc.Xr ifstated.conf 5
85cd97c3b8Smcbride.Sh HISTORY
86cd97c3b8SmcbrideThe
87cd97c3b8Smcbride.Nm
88cd97c3b8Smcbrideprogram first appeared in
8908b3be83Smpf.Ox 3.8 .
90