usr/src/man/man1m/ippool.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 IPPOOL 1M "Apr 3, 2008"
   6 .SH NAME
   7 ippool \- user interface to the IP Filter pools
   8 .SH SYNOPSIS
   9 .LP
  10 .nf
  11 \fBippool\fR \fB-a\fR [\fB-dnv\fR] [\fB-m\fR \fIpoolname\fR] [\fB-o\fR \fIrole\fR] \fB-i\fR \fIipaddr\fR
  12      [/\fInetmask\fR]
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fBippool\fR \fB-A\fR [\fB-dnv\fR] [\fB-m\fR \fIpoolname\fR] [\fB-o\fR \fIrole\fR] [\fB-S\fR \fIseed\fR]
  18      [\fB-t\fR \fItype\fR]
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBippool\fR \fB-f\fR \fIfile\fR [\fB-dnuv\fR]
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBippool\fR \fB-F\fR [\fB-dv\fR] [\fB-o\fR \fIrole\fR] [\fB-t\fR \fItype\fR]
  29 .fi
  30
  31 .LP
  32 .nf
  33 \fBippool\fR \fB-h\fR [\fB-dv\fR] [\fB-m\fR \fIpoolname\fR] [\fB-t\fR \fItype\fR]
  34 .fi
  35
  36 .LP
  37 .nf
  38 \fBippool\fR \fB-l\fR [\fB-dv\fR] [\fB-m\fR \fIpoolname\fR] [\fB-t\fR \fItype\fR]
  39 .fi
  40
  41 .LP
  42 .nf
  43 \fBippool\fR \fB-r\fR [\fB-dnv\fR] [\fB-m\fR \fIpoolname\fR] [\fB-o\fR \fIrole\fR] \fB-i\fR \fIipaddr\fR
  44      [/\fInetmask\fR]
  45 .fi
  46
  47 .LP
  48 .nf
  49 \fBippool\fR \fB-R\fR [\fB-dnv\fR] [\fB-m\fR \fIpoolname\fR] [\fB-o\fR \fIrole\fR] [\fB-t\fR \fItype\fR]
  50 .fi
  51
  52 .LP
  53 .nf
  54 \fBippool\fR \fB-s\fR [\fB-dtv\fR] [\fB-M\fR \fIcore\fR] [\fB-N\fR \fInamelist\fR]
  55 .fi
  56
  57 .SH DESCRIPTION
  58 .sp
  59 .LP
  60 The \fBippool\fR utility is used to manage information stored in the IP pools
  61 subsystem of IP Filter software. Configuration file information can be parsed
  62 and loaded into the kernel and currently configured pools can be removed,
  63 changed, or inspected.
  64 .sp
  65 .LP
  66 \fBippool\fR's use is restricted through access to \fB/dev/ippool\fR. The
  67 default permissions of \fB/dev/ippool\fR require \fBippool\fR to be run as root
  68 for all operations.
  69 .sp
  70 .LP
  71 The command line options used are divided into two sections: the global options
  72 and the instance-specific options.
  73 .sp
  74 .LP
  75 \fBippool\fR's use is restricted through access to \fB/dev/ipauth\fR,
  76 \fB/dev/ipl\fR, and \fB/dev/ipstate\fR. The default permissions of these files
  77 require \fBippool\fR to be run as root for all operations.
  78 .SH OPTIONS
  79 .sp
  80 .LP
  81 \fBippool\fR supports the option categories described below.
  82 .SS "Global Options"
  83 .sp
  84 .LP
  85 The following global options are supported:
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fB-d\fR\fR
  90 .ad
  91 .RS 6n
  92 Toggle debugging of processing the configuration file.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fB-n\fR\fR
  99 .ad
 100 .RS 6n
 101 Prevents \fBippool\fR from doing anything, such as making ioctl calls, that
 102 would alter the currently running kernel.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fB-v\fR\fR
 109 .ad
 110 .RS 6n
 111 Turn verbose mode on.
 112 .RE
 113
 114 .SS "Instance-Specific Options"
 115 .sp
 116 .LP
 117 The following instance-specific options are supported:
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fB-a\fR\fR
 122 .ad
 123 .RS 11n
 124 Add a new data node to an existing pool in the kernel.
 125 .RE
 126
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fB-A\fR\fR
 131 .ad
 132 .RS 11n
 133 Add a new (empty) pool to the kernel.
 134 .RE
 135
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fB-f\fR \fIfile\fR\fR
 140 .ad
 141 .RS 11n
 142 Read in IP pool configuration information from \fIfile\fR and load it into the
 143 kernel.
 144 .RE
 145
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fB-F\fR\fR
 150 .ad
 151 .RS 11n
 152 Flush loaded pools from the kernel.
 153 .RE
 154
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fB-h\fR\fR
 159 .ad
 160 .RS 11n
 161 Display a list of pools of the type: hash loaded in the kernel.
 162 .RE
 163
 164 .sp
 165 .ne 2
 166 .na
 167 \fB\fB-l\fR\fR
 168 .ad
 169 .RS 11n
 170 Display a list of pools of the type: tree loaded in the kernel.
 171 .RE
 172
 173 .sp
 174 .ne 2
 175 .na
 176 \fB\fB-r\fR\fR
 177 .ad
 178 .RS 11n
 179 Remove an existing data node from a pool in the kernel.
 180 .RE
 181
 182 .sp
 183 .ne 2
 184 .na
 185 \fB\fB-R\fR\fR
 186 .ad
 187 .RS 11n
 188 Remove an existing pool from within the kernel.
 189 .RE
 190
 191 .sp
 192 .ne 2
 193 .na
 194 \fB\fB-s\fR\fR
 195 .ad
 196 .RS 11n
 197 Display IP pool statistical information.
 198 .RE
 199
 200 .SS "Other Options"
 201 .sp
 202 .LP
 203 The following, additional options are supported:
 204 .sp
 205 .ne 2
 206 .na
 207 \fB\fB-i\fR \fIipaddr\fR[/\fInetmask\fR]\fR
 208 .ad
 209 .RS 23n
 210 Sets the IP address for the operation being undertaken with an all-one's mask
 211 or, optionally, a specific netmask, given in either dotted-quad notation or as
 212 a single integer.
 213 .RE
 214
 215 .sp
 216 .ne 2
 217 .na
 218 \fB\fB-m\fR \fIpoolname\fR\fR
 219 .ad
 220 .RS 23n
 221 Sets the pool name for the current operation.
 222 .RE
 223
 224 .sp
 225 .ne 2
 226 .na
 227 \fB\fB-M\fR \fIcore\fR\fR
 228 .ad
 229 .RS 23n
 230 Specify an alternative path to \fB/dev/kmem\fR from which to retrieve
 231 statistical information.
 232 .RE
 233
 234 .sp
 235 .ne 2
 236 .na
 237 \fB\fB-N\fR \fInamelist\fR\fR
 238 .ad
 239 .RS 23n
 240 Specify an alternative path to lookup symbol name information when retrieving
 241 statistical information.
 242 .RE
 243
 244 .sp
 245 .ne 2
 246 .na
 247 \fB\fB-o\fR \fIrole\fR\fR
 248 .ad
 249 .RS 23n
 250 Sets the role with which this pool is to be used. Currently only \fBipf\fR,
 251 \fBauth\fR, and \fBcount\fR are accepted as arguments to this option.
 252 .RE
 253
 254 .sp
 255 .ne 2
 256 .na
 257 \fB\fB-S\fR \fIseed\fR\fR
 258 .ad
 259 .RS 23n
 260 Sets the hashing seed to the number specified. For use with hash-type pools
 261 only.
 262 .RE
 263
 264 .sp
 265 .ne 2
 266 .na
 267 \fB\fB-t\fR \fItype\fR\fR
 268 .ad
 269 .RS 23n
 270 Sets the type of pool being defined. Must be one of \fBpool\fR, \fBhash\fR, or
 271 \fBgroup-map\fR.
 272 .RE
 273
 274 .sp
 275 .ne 2
 276 .na
 277 \fB\fB-u\fR\fR
 278 .ad
 279 .RS 23n
 280 When parsing a configuration file, rather than load new pool data into the
 281 kernel, unload it.
 282 .RE
 283
 284 .SH FILES
 285 .sp
 286 .ne 2
 287 .na
 288 \fB\fB/dev/ippool\fR\fR
 289 .ad
 290 .RS 24n
 291 Link to IP Filter pseudo device.
 292 .RE
 293
 294 .sp
 295 .ne 2
 296 .na
 297 \fB\fB/dev/kmem\fR\fR
 298 .ad
 299 .RS 24n
 300 Special file that provides access to virtual address space.
 301 .RE
 302
 303 .sp
 304 .ne 2
 305 .na
 306 \fB\fB/etc/ipf/ippool.conf\fR\fR
 307 .ad
 308 .RS 24n
 309 Location of \fBippool\fR startup configuration file.
 310 .RE
 311
 312 .SH ATTRIBUTES
 313 .sp
 314 .LP
 315 See \fBattributes\fR(5) for descriptions of the following attributes:
 316 .sp
 317
 318 .sp
 319 .TS
 320 box;
 321 c | c
 322 l | l .
 323 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 324 _
 325 Interface Stability     Committed
 326 .TE
 327
 328 .SH SEE ALSO
 329 .sp
 330 .LP
 331 \fBipf\fR(1M), \fBipfstat\fR(1M), \fBippool\fR(4), \fBattributes\fR(5)