contrib/ipfilter/man/ipfs.8

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