usr/src/man/man1m/ipfs.1m

   1 '\" te
   2 .\" To view license terms, attribution, and copyright for IP Filter, the default path is /usr/lib/ipf/IPFILTER.LICENCE. If the Solaris operating environment has been installed anywhere other than the default, modify the given path to access the file at the installed
   3 .\" location.
   4 .\" Portions Copyright (c) 2008, Sun Microsystems Inc. All Rights Reserved.
   5 .TH IPFS 1M "Apr 3, 2008"
   6 .SH NAME
   7 ipfs \- saves and restores information for NAT and state tables
   8 .SH SYNOPSIS
   9 .LP
  10 .nf
  11 \fBipfs\fR [\fB-nv\fR] \fB-l\fR
  12 .fi
  13
  14 .LP
  15 .nf
  16 \fBipfs\fR [\fB-nv\fR] \fB-u\fR
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBipfs\fR [\fB-nv\fR] [\fB-d\fR \fIdirname\fR] \fB-R\fR
  22 .fi
  23
  24 .LP
  25 .nf
  26 \fBipfs\fR [\fB-nv\fR] [\fB-d\fR \fIdirname\fR] \fB-W\fR
  27 .fi
  28
  29 .LP
  30 .nf
  31 \fBipfs\fR [\fB-nNSv\fR] [\fB-f\fR \fIfilename\fR] \fB-r\fR
  32 .fi
  33
  34 .LP
  35 .nf
  36 \fBipfs\fR [\fB-nNSv\fR] [\fB-f\fR \fIfilename\fR] \fB-w\fR
  37 .fi
  38
  39 .LP
  40 .nf
  41 \fBipfs\fR [\fB-nNSv\fR] \fB-f\fR \fIfilename\fR \fB-i\fR \fI<if1>\fR,\fI<if2>\fR
  42 .fi
  43
  44 .SH DESCRIPTION
  45 .sp
  46 .LP
  47 The \fBipfs\fR utility enables the saving of state information across reboots.
  48 Specifically, the utility allows state information created for NAT entries and
  49 rules using "keep state" to be locked (modification prevented) and then saved
  50 to disk. Then, after a reboot, that information is restored. The result of this
  51 state-saving is that connections are not interrupted.
  52 .SH OPTIONS
  53 .sp
  54 .LP
  55 The following options are supported:
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fB-d\fR\fR
  60 .ad
  61 .RS 6n
  62 Change the default directory used with \fB-R\fR and \fB-W\fR options for saving
  63 state information.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fB-n\fR\fR
  70 .ad
  71 .RS 6n
  72 Do not take any action that would affect information stored in the kernel or on
  73 disk.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fB-v\fR\fR
  80 .ad
  81 .RS 6n
  82 Provides a verbose description of \fBipfs\fR activities.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fB-N\fR\fR
  89 .ad
  90 .RS 6n
  91 Operate on NAT information.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fB-S\fR\fR
  98 .ad
  99 .RS 6n
 100 Operate on filtering state information.
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fB-u\fR\fR
 107 .ad
 108 .RS 6n
 109 Unlock state tables in the kernel.
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fB-l\fR\fR
 116 .ad
 117 .RS 6n
 118 Lock state tables in the kernel.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fB-r\fR\fR
 125 .ad
 126 .RS 6n
 127 Read information in from the specified file and load it into the kernel. This
 128 requires the state tables to have already been locked and does not change the
 129 lock once complete.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fB-w\fR\fR
 136 .ad
 137 .RS 6n
 138 Write information out to the specified file and from the kernel. This requires
 139 the state tables to have already been locked and does not change the lock once
 140 complete.
 141 .RE
 142
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fB-R\fR\fR
 147 .ad
 148 .RS 6n
 149 Restores all saved state information, if any, from two files, \fBipstate.ipf\fR
 150 and \fBipnat.ipf\fR, stored in the \fB/var/db/ipf\fR directory. This directory
 151 can be changed with the \fB-d\fR option. The state tables are locked at the
 152 beginning of this operation and unlocked once complete.
 153 .RE
 154
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fB-W\fR\fR
 159 .ad
 160 .RS 6n
 161 Saves in-kernel state information, if any, out to two files, \fBipstate.ipf\fR
 162 and \fBipnat.ipf\fR, stored in the \fB/var/db/ipf\fR directory. This directory
 163 can be changed with the \fB-d\fR option. The state tables are locked at the
 164 beginning of this operation and unlocked once complete.
 165 .RE
 166
 167 .SH FILES
 168 .RS +4
 169 .TP
 170 .ie t \(bu
 171 .el o
 172 \fB/var/db/ipf/ipstate.ipf\fR
 173 .RE
 174 .RS +4
 175 .TP
 176 .ie t \(bu
 177 .el o
 178 \fB/var/db/ipf/ipnat.ipf\fR
 179 .RE
 180 .RS +4
 181 .TP
 182 .ie t \(bu
 183 .el o
 184 \fB/dev/ipl\fR
 185 .RE
 186 .RS +4
 187 .TP
 188 .ie t \(bu
 189 .el o
 190 \fB/dev/ipstate\fR
 191 .RE
 192 .RS +4
 193 .TP
 194 .ie t \(bu
 195 .el o
 196 \fB/dev/ipnat\fR
 197 .RE
 198 .SH ATTRIBUTES
 199 .sp
 200 .LP
 201 See \fBattributes\fR(5) for descriptions of the following attributes:
 202 .sp
 203
 204 .sp
 205 .TS
 206 box;
 207 c | c
 208 l | l .
 209 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 210 _
 211 Interface Stability     Committed
 212 .TE
 213
 214 .SH SEE ALSO
 215 .sp
 216 .LP
 217 \fBipf\fR(1M), \fBipmon\fR(1M), \fBipnat\fR(1M), \fBattributes\fR(5)
 218 .SH DIAGNOSTICS
 219 .sp
 220 .LP
 221 Arguably, the \fB-W\fR and \fB-R\fR operations should set the locking and,
 222 rather than undo it, restore it to what it was previously.
 223 .sp
 224 .LP
 225 Fragment table information is currently not saved.