xref: /netbsd-src/usr.sbin/pf/pfs/pfs.8 (revision 6f43bcda13dd6c4f245ccf62101b76b916d6d052)
1*6f43bcdaSwiz.\"	$NetBSD: pfs.8,v 1.4 2010/05/09 14:02:10 wiz Exp $
2c4b86859Sdegroote.\"
3c4b86859Sdegroote.\" Copyright (c) 2010 The NetBSD Foundation, Inc.
4c4b86859Sdegroote.\" All rights reserved.
5c4b86859Sdegroote.\"
6c4b86859Sdegroote.\" Redistribution and use in source and binary forms, with or without
7c4b86859Sdegroote.\" modification, are permitted provided that the following conditions
8c4b86859Sdegroote.\" are met:
9c4b86859Sdegroote.\" 1. Redistributions of source code must retain the above copyright
10c4b86859Sdegroote.\"    notice, this list of conditions and the following disclaimer.
11c4b86859Sdegroote.\" 2. Redistributions in binary form must reproduce the above copyright
12c4b86859Sdegroote.\"    notice, this list of conditions and the following disclaimer in the
13c4b86859Sdegroote.\"    documentation and/or other materials provided with the distribution.
14c4b86859Sdegroote.\"
15c4b86859Sdegroote.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16c4b86859Sdegroote.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17c4b86859Sdegroote.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18c4b86859Sdegroote.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19c4b86859Sdegroote.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20c4b86859Sdegroote.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21c4b86859Sdegroote.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22c4b86859Sdegroote.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23c4b86859Sdegroote.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24c4b86859Sdegroote.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25c4b86859Sdegroote.\" SUCH DAMAGE.
26c4b86859Sdegroote.\"
27ca38e323Sdegroote.Dd July 21, 2009
28ca38e323Sdegroote.Dt PFS 8
29ca38e323Sdegroote.Os
30ca38e323Sdegroote.Sh NAME
31ca38e323Sdegroote.Nm pfs
32*6f43bcdaSwiz.Nd save and restore information for NAT and state tables
33ca38e323Sdegroote.Sh SYNOPSIS
34ca38e323Sdegroote.Nm
35ca38e323Sdegroote.Op Fl v
36ca38e323Sdegroote.Fl l
37ca38e323Sdegroote.Nm
3895b209a8Swiz.Op Fl bv
3995b209a8Swiz.Fl R
40ca38e323Sdegroote.Ar filename
41ca38e323Sdegroote.Nm
4295b209a8Swiz.Op Fl bv
43ca38e323Sdegroote.Fl r
44ca38e323Sdegroote.Ar filename
45ca38e323Sdegroote.Nm
46ca38e323Sdegroote.Op Fl v
4795b209a8Swiz.Fl u
4895b209a8Swiz.Nm
4995b209a8Swiz.Op Fl bv
5095b209a8Swiz.Fl W
51ca38e323Sdegroote.Ar filename
52ca38e323Sdegroote.Nm
5395b209a8Swiz.Op Fl bv
5495b209a8Swiz.Fl w
55ca38e323Sdegroote.Ar filename
56ca38e323Sdegroote.Sh DESCRIPTION
57ca38e323SdegrooteThe
58ca38e323Sdegroote.Nm
59ca38e323Sdegrootecommand allows state information created for NAT entries and rules using
6095b209a8Swiz.Dq keep state
61ca38e323Sdegrooteto be locked (modification prevented) and then saved to disk,
62ca38e323Sdegrooteallowing for the system to experience a reboot, followed by the restoration
63ca38e323Sdegrooteof that information, resulting in connections not being interrupted.
64ca38e323Sdegroote.Sh OPTIONS
6595b209a8Swiz.Bl -tag -width XrXfilenameXX
66ca38e323Sdegroote.It Fl b
6795b209a8SwizThe information are read or stored using binary format.
6895b209a8SwizThe default format is a readable ASCII format, similar to
69ca38e323Sdegroote.Pa pfctl.conf
70ca38e323Sdegrootesyntax.
71ca38e323Sdegroote.It Fl l
72ca38e323SdegrooteLock state tables in the kernel.
7395b209a8Swiz.It Fl R Ar filename
7495b209a8SwizRestore information from
7595b209a8Swiz.Ar filename
7695b209a8Swizand load it into the kernel.
7795b209a8SwizThe state tables are locked at the beginning of this operation and
7895b209a8Swizunlocked once complete.
7995b209a8Swiz.It Fl r Ar filename
8095b209a8SwizRead information in from
8195b209a8Swiz.Ar filename
8295b209a8Swizand load it into the kernel.
83ca38e323SdegrooteThis requires the state tables to have already been locked
84ca38e323Sdegrooteand does not change the lock once complete.
8595b209a8Swiz.It Fl u
8695b209a8SwizUnlock state tables in the kernel.
8795b209a8Swiz.It Fl v
8895b209a8SwizProvide a verbose description of what's being done.
8995b209a8Swiz.It Fl W Ar filename
9095b209a8SwizWrite information from the kernel out to
9195b209a8Swiz.Ar filename .
9295b209a8SwizThe state tables are locked at the beginning of this operation and
93ca38e323Sdegrooteunlocked once complete.
9495b209a8Swiz.It Fl w Ar filename
9595b209a8SwizWrite information from the kernel out to
9695b209a8Swiz.Ar filename .
9795b209a8SwizThis requires the state tables to have already been locked
9895b209a8Swizand does not change the lock once complete.
99ca38e323Sdegroote.El
100ca38e323Sdegroote.Sh FILES
10195b209a8Swiz.Pa /dev/pf
102ca38e323Sdegroote.Sh SEE ALSO
103ca38e323Sdegroote.Xr pf 4
104