contrib/ipfilter/man/ipfs.8

   1 .\"     $FreeBSD$
   2 .\"
   3 .TH IPFS 8
   4 .SH NAME
   5 ipfs \- saves and restores information for NAT and state tables.
   6 .SH SYNOPSIS
   7 .B ipfs
   8 [-nv] -l
   9 .PP
  10 .B ipfs
  11 [-nv] -u
  12 .PP
  13 .B ipfs
  14 [-nv] [
  15 .B \-d
  16 <\fIdirname\fP>
  17 ] -R
  18 .PP
  19 .B ipfs
  20 [-nv] [
  21 .B \-d
  22 <\fIdirname\fP>
  23 ] -W
  24 .PP
  25 .B ipfs
  26 [-nNSv] [
  27 .B \-f
  28 <\fIfilename\fP>
  29 ] -r
  30 .PP
  31 .B ipfs
  32 [-nNSv] [
  33 .B \-f
  34 <\fIfilename\fP>
  35 ] -w
  36 .PP
  37 .B ipfs
  38 [-nNSv]
  39 .B \-f
  40 <\fIfilename\fP>
  41 .B \-i
  42 <if1>,<if2>
  43 .SH DESCRIPTION
  44 .PP
  45 \fBipfs\fP allows state information created for NAT entries and rules using
  46 \fIkeep state\fP to be locked (modification prevented) and then saved to disk,
  47 allowing for the system to experience a reboot, followed by the restoration
  48 of that information, resulting in connections not being interrupted.
  49 .SH OPTIONS
  50 .TP
  51 .B \-d
  52 Change the default directory used with
  53 .B \-R
  54 and
  55 .B \-W
  56 options for saving state information.
  57 .TP
  58 .B \-n
  59 Don't actually take any action that would affect information stored in
  60 the kernel or on disk.
  61 .TP
  62 .B \-v
  63 Provides a verbose description of what's being done.
  64 .TP
  65 .B \-i <ifname1>,<ifname2>
  66 Change all instances of interface name ifname1 in the state save file to
  67 ifname2.  Useful if you're restoring state information after a hardware
  68 reconfiguration or change.
  69 .TP
  70 .B \-N
  71 Operate on NAT information.
  72 .TP
  73 .B \-S
  74 Operate on filtering state information.
  75 .TP
  76 .B \-u
  77 Unlock state tables in the kernel.
  78 .TP
  79 .B \-l
  80 Lock state tables in the kernel.
  81 .TP
  82 .B \-r
  83 Read information in from the specified file and load it into the
  84 kernel.  This requires the state tables to have already been locked
  85 and does not change the lock once complete.
  86 .TP
  87 .B \-w
  88 Write information out to the specified file and from the kernel.
  89 This requires the state tables to have already been locked
  90 and does not change the lock once complete.
  91 .TP
  92 .B \-R
  93 Restores all saved state information, if any, from two files,
  94 \fIipstate.ipf\fP and \fIipnat.ipf\fP, stored in the \fI/var/db/ipf\fP
  95 directory unless otherwise specified by the
  96 .B \-d
  97 option.  The state tables are locked at the beginning of this
  98 operation and unlocked once complete.
  99 .TP
 100 .B \-W
 101 Saves in-kernel state information, if any, out to two files,
 102 \fIipstate.ipf\fP and \fIipnat.ipf\fP, stored in the \fI/var/db/ipf\fP
 103 directory unless otherwise specified by the
 104 .B \-d
 105 option.  The state tables are locked at the beginning of this
 106 operation and unlocked once complete.
 107 .DT
 108 .SH FILES
 109 /var/db/ipf/ipstate.ipf
 110 .br
 111 /var/db/ipf/ipnat.ipf
 112 .br
 113 /dev/ipl
 114 .br
 115 /dev/ipstate
 116 .br
 117 /dev/ipnat
 118 .SH SEE ALSO
 119 ipf(8), ipl(4), ipmon(8), ipnat(8)
 120 .SH DIAGNOSTICS
 121 .PP
 122 Perhaps the -W and -R operations should set the locking but rather than
 123 undo it, restore it to what it was previously.  Fragment table information
 124 is currently not saved.
 125 .SH BUGS
 126 .PP
 127 If you find any, please send email to me at darrenr@pobox.com