1ippool(1M)              System Administration Commands              ippool(1M)
2
3
4

NAME

6       ippool - user interface to the IP Filter pools
7

SYNOPSIS

9       ippool -a [-dnv] [-m poolname] [-o role] -i ipaddr
10            [/netmask]
11
12
13       ippool -A [-dnv] [-m poolname] [-o role] [-S seed]
14            [-t type]
15
16
17       ippool -f file [-dnuv]
18
19
20       ippool -F [-dv] [-o role] [-t type]
21
22
23       ippool -h [-dv] [-m poolname] [-t type]
24
25
26       ippool -l [-dv] [-m poolname] [-t type]
27
28
29       ippool -r [-dnv] [-m poolname] [-o role] -i ipaddr
30            [/netmask]
31
32
33       ippool -R [-dnv] [-m poolname] [-o role] [-t type]
34
35
36       ippool -s [-dtv] [-M core] [-N namelist]
37
38

DESCRIPTION

40       The ippool utility is used to manage information stored in the IP pools
41       subsystem of IP Filter software. Configuration file information can  be
42       parsed and loaded into the kernel and currently configured pools can be
43       removed, changed, or inspected.
44
45
46       ippool's use is restricted through access to /dev/ippool.  The  default
47       permissions  of  /dev/ippool  require  ippool to be run as root for all
48       operations.
49
50
51       The command line options used are divided into two sections: the global
52       options and the instance-specific options.
53
54
55       ippool's use is restricted through access to /dev/ipauth, /dev/ipl, and
56       /dev/ipstate. The default permissions of these files require ippool  to
57       be run as root for all operations.
58

OPTIONS

60       ippool supports the option categories described below.
61
62   Global Options
63       The following global options are supported:
64
65       -d    Toggle debugging of processing the configuration file.
66
67
68       -n    Prevents  ippool from doing anything, such as making ioctl calls,
69             that would alter the currently running kernel.
70
71
72       -v    Turn verbose mode on.
73
74
75   Instance-Specific Options
76       The following instance-specific options are supported:
77
78       -a         Add a new data node to an existing pool in the kernel.
79
80
81       -A         Add a new (empty) pool to the kernel.
82
83
84       -f file    Read in IP pool configuration information from file and load
85                  it into the kernel.
86
87
88       -F         Flush loaded pools from the kernel.
89
90
91       -h         Display a list of pools of the type: hash loaded in the ker‐
92                  nel.
93
94
95       -l         Display a list of pools of the type: tree loaded in the ker‐
96                  nel.
97
98
99       -r         Remove an existing data node from a pool in the kernel.
100
101
102       -R         Remove an existing pool from within the kernel.
103
104
105       -s         Display IP pool statistical information.
106
107
108   Other Options
109       The following, additional options are supported:
110
111       -i ipaddr[/netmask]    Sets  the  IP  address  for  the operation being
112                              undertaken with an all-one's  mask  or,  option‐
113                              ally,  a  specific netmask, given in either dot‐
114                              ted-quad notation or as a single integer.
115
116
117       -m poolname            Sets the pool name for the current operation.
118
119
120       -M core                Specify an alternative path  to  /dev/kmem  from
121                              which to retrieve statistical information.
122
123
124       -N namelist            Specify  an  alternative  path  to lookup symbol
125                              name  information  when  retrieving  statistical
126                              information.
127
128
129       -o role                Sets  the  role  with  which  this pool is to be
130                              used. Currently only ipf, auth,  and  count  are
131                              accepted as arguments to this option.
132
133
134       -S seed                Sets  the  hashing seed to the number specified.
135                              For use with hash-type pools only.
136
137
138       -t type                Sets the type of pool being defined. Must be one
139                              of pool, hash, or group-map.
140
141
142       -u                     When  parsing  a configuration file, rather than
143                              load new pool data into the kernel, unload it.
144
145

FILES

147       /dev/ippool             Link to IP Filter pseudo device.
148
149
150       /dev/kmem               Special file that provides  access  to  virtual
151                               address space.
152
153
154       /etc/ipf/ippool.conf    Location of ippool startup configuration file.
155
156

ATTRIBUTES

158       See attributes(5) for descriptions of the following attributes:
159
160
161
162
163       ┌─────────────────────────────┬─────────────────────────────┐
164       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
165       ├─────────────────────────────┼─────────────────────────────┤
166       │Availability                 │SUNWipfu                     │
167       ├─────────────────────────────┼─────────────────────────────┤
168       │Interface Stability          │Committed                    │
169       └─────────────────────────────┴─────────────────────────────┘
170

SEE ALSO

172       ipf(1M), ipfstat(1M), ippool(4), attributes(5)
173
174
175
176SunOS 5.11                        3 Apr 2008                        ippool(1M)
Impressum