-
Notifications
You must be signed in to change notification settings - Fork 0
/
ipset.man.html
1449 lines (1220 loc) · 50.7 KB
/
ipset.man.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
Content-type: text/html; charset=UTF-8
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of IPSET</TITLE>
</HEAD><BODY>
<H1>IPSET</H1>
Section: (8)<BR>Updated: Jun 25, 2015<BR><A HREF="#index">Index</A>
<!-- <A HREF="/cgi-bin/man/man2html">Return to Main Contents</A>--><HR>
<A NAME="lbAB"> </A>
<H2>NAME</H2>
ipset --- administration tool for IP sets
<A NAME="lbAC"> </A>
<H2>SYNOPSIS</H2>
<B>ipset</B> [ <I>OPTIONS</I> ] <I>COMMAND</I> [ <I>COMMAND-OPTIONS</I> ]
<P>
COMMANDS := { <B>create</B> | <B>add</B> | <B>del</B> | <B>test</B> | <B>destroy</B> | <B>list</B> | <B>save</B> | <B>restore</B> | <B>flush</B> | <B>rename</B> | <B>swap</B> | <B>help</B> | <B>version</B> | <B>-</B> }
<P>
<I>OPTIONS</I> := { <B>-exist</B> | <B>-output</B> { <B>plain</B> | <B>save</B> | <B>xml</B> } | <B>-quiet</B> | <B>-resolve</B> | <B>-sorted</B> | <B>-name</B> | <B>-terse</B> | <B>-file</B> <I>filename</I> }
<P>
<B>ipset</B> <B>create</B> <I>SETNAME</I> <I>TYPENAME</I> [ <I>CREATE-OPTIONS</I> ]
<P>
<B>ipset</B> <B>add</B> <I>SETNAME</I> <I>ADD-ENTRY</I> [ <I>ADD-OPTIONS</I> ]
<P>
<B>ipset</B> <B>del</B> <I>SETNAME</I> <I>DEL-ENTRY</I> [ <I>DEL-OPTIONS</I> ]
<P>
<B>ipset</B> <B>test</B> <I>SETNAME</I> <I>TEST-ENTRY</I> [ <I>TEST-OPTIONS</I> ]
<P>
<B>ipset</B> <B>destroy</B> [ <I>SETNAME</I> ]
<P>
<B>ipset</B> <B>list</B> [ <I>SETNAME</I> ]
<P>
<B>ipset</B> <B>save</B> [ <I>SETNAME</I> ]
<P>
<B>ipset</B> <B>restore</B>
<P>
<B>ipset</B> <B>flush</B> [ <I>SETNAME</I> ]
<P>
<B>ipset</B> <B>rename</B> <I>SETNAME-FROM</I> <I>SETNAME-TO</I>
<P>
<B>ipset</B> <B>swap</B> <I>SETNAME-FROM</I> <I>SETNAME-TO</I>
<P>
<B>ipset</B> <B>help</B> [ <I>TYPENAME</I> ]
<P>
<B>ipset</B> <B>version</B>
<P>
<B>ipset</B> <B>-</B>
<A NAME="lbAD"> </A>
<H2>DESCRIPTION</H2>
<B>ipset</B>
is used to set up, maintain and inspect so called IP sets in the Linux
kernel. Depending on the type of the set, an IP set may store IP(v4/v6)
addresses, (TCP/UDP) port numbers, IP and MAC address pairs, IP address
and port number pairs, etc. See the set type definitions below.
<P>
<B>Iptables</B>
matches and targets referring to sets create references, which
protect the given sets in the kernel. A set cannot be destroyed
while there is a single reference pointing to it.
<A NAME="lbAE"> </A>
<H2>OPTIONS</H2>
The options that are recognized by
<B>ipset</B>
can be divided into several different groups.
<A NAME="lbAF"> </A>
<H3>COMMANDS</H3>
These options specify the desired action to perform. Only one of them
can be specified on the command line unless otherwise specified below.
For all the long versions of the command names, you need to use only enough
letters to ensure that
<B>ipset</B>
can differentiate it from all other commands. The
<B>ipset</B>
parser follows the order here when looking for the shortest match
in the long command names.
<DL COMPACT>
<DT><B>n</B>, <B>create</B> <I>SETNAME</I> <I>TYPENAME</I> [ <I>CREATE-OPTIONS</I> ]<DD>
Create a set identified with setname and specified type. The type may require
type specific options. If the
<B>-exist</B>
option is specified,
<B>ipset</B>
ignores the error otherwise raised when the same set (setname and create parameters
are identical) already exists.
<DT><B>add</B> <I>SETNAME</I> <I>ADD-ENTRY</I> [ <I>ADD-OPTIONS</I> ]<DD>
Add a given entry to the set. If the
<B>-exist</B>
option is specified,
<B>ipset</B>
ignores if the entry already added to the set.
<DT><B>del</B> <I>SETNAME</I> <I>DEL-ENTRY</I> [ <I>DEL-OPTIONS</I> ]<DD>
Delete an entry from a set. If the
<B>-exist</B>
option is specified and the entry is not in the set (maybe already expired),
then the command is ignored.
<DT><B>test</B> <I>SETNAME</I> <I>TEST-ENTRY</I> [ <I>TEST-OPTIONS</I> ]<DD>
Test whether an entry is in a set or not. Exit status number is zero
if the tested entry is in the set and nonzero if it is missing from
the set.
<DT><B>x</B>, <B>destroy</B> [ <I>SETNAME</I> ]<DD>
Destroy the specified set or all the sets if none is given.
<P>
If the set has got reference(s), nothing is done and no set destroyed.
<DT><B>list</B> [ <I>SETNAME</I> ] [ <I>OPTIONS</I> ]<DD>
List the header data and the entries for the specified set, or for
all sets if none is given. The
<B>-resolve</B>
option can be used to force name lookups (which may be slow). When the
<B>-sorted</B>
option is given, the entries are listed/saved sorted (which may be slow).
The option
<B>-output</B>
can be used to control the format of the listing:
<B>plain</B>, <B>save</B> or <B>xml</B>.
(The default is
<B>plain</B>.)
If the option
<B>-name</B>
is specified, just the names of the existing sets are listed. If the option
<B>-terse</B>
is specified, just the set names and headers are listed. The output is printed
to stdout, the option
<B>-file</B>
can be used to specify a filename instead of stdout.
<DT><B>save</B> [ <I>SETNAME</I> ]<DD>
Save the given set, or all sets if none is given
to stdout in a format that
<B>restore</B>
can read. The option
<B>-file</B>
can be used to specify a filename instead of stdout.
<DT><B>restore</B><DD>
Restore a saved session generated by
<B>save</B>.
The saved session can be fed from stdin or the option
<B>-file</B>
can be used to specify a filename instead of stdin.
<P>
Please note, existing sets and elements are not erased by
<B>restore</B> unless specified so in the restore file. All commands
are allowed in restore mode except <B>list</B>, <B>help</B>,
<B>version</B>, interactive mode and <B>restore</B> itself.
<DT><B>flush</B> [ <I>SETNAME</I> ]<DD>
Flush all entries from the specified set or flush
all sets if none is given.
<DT><B>e</B>, <B>rename</B> <I>SETNAME-FROM</I> <I>SETNAME-TO</I><DD>
Rename a set. Set identified by
<I>SETNAME-TO</I>
must not exist.
<DT><B>w</B>, <B>swap</B> <I>SETNAME-FROM</I> <I>SETNAME-TO</I><DD>
Swap the content of two sets, or in another words,
exchange the name of two sets. The referred sets must exist and
compatible type of sets can be swapped only.
<DT><B>help</B> [ <I>TYPENAME</I> ]<DD>
Print help and set type specific help if
<I>TYPENAME</I>
is specified.
<DT><B>version</B><DD>
Print program version.
<DT><B>-</B><DD>
If a dash is specified as command, then
<B>ipset</B>
enters a simple interactive mode and the commands are read from the standard input.
The interactive mode can be finished by entering the pseudo-command
<B>quit</B>.
</DL>
<P>
<A NAME="lbAG"> </A>
<H3>OTHER OPTIONS</H3>
The following additional options can be specified. The long option names
cannot be abbreviated.
<DL COMPACT>
<DT><B>-!</B>, <B>-exist</B><DD>
Ignore errors when exactly the same set is to be created or already
added entry is added or missing entry is deleted.
<DT><B>-o</B>, <B>-output</B> { <B>plain</B> | <B>save</B> | <B>xml</B> }<DD>
Select the output format to the
<B>list</B>
command.
<DT><B>-q</B>, <B>-quiet</B><DD>
Suppress any output to stdout and stderr.
<B>ipset</B>
will still exit with error if it cannot continue.
<DT><B>-r</B>, <B>-resolve</B><DD>
When listing sets, enforce name lookup. The
program will try to display the IP entries resolved to
host names which requires
<B>slow</B>
DNS lookups.
<DT><B>-s</B>, <B>-sorted</B><DD>
Sorted output. When listing or saving sets, the entries are listed sorted.
<DT><B>-n</B>, <B>-name</B><DD>
List just the names of the existing sets, i.e. suppress listing of set headers and members.
<DT><B>-t</B>, <B>-terse</B><DD>
List the set names and headers, i.e. suppress listing of set members.
<DT><B>-f</B>, <B>-file</B> <I>filename</I><DD>
Specify a filename to print into instead of stdout
(<B>list</B>
or
<B>save</B>
commands) or read from instead of stdin
(<B>restore</B>
command).
</DL>
<A NAME="lbAH"> </A>
<H2>INTRODUCTION</H2>
A set type comprises of the storage method by which the data is stored and
the data type(s) which are stored in the set. Therefore the
<I>TYPENAME</I>
parameter of the
<B>create</B>
command follows the syntax
<P>
<I>TYPENAME</I> := <I>method</I><B>:</B><I>datatype</I>[<B>,</B><I>datatype</I>[<B>,</B><I>datatype</I>]]
<P>
where the current list of the methods are
<B>bitmap</B>, <B>hash</B>, and <B>list</B> and the possible data types
are <B>ip</B>, <B>net</B>, <B>mac</B>, <B>port</B> and <B>iface</B>.
The dimension of a set is equal to the number of data types in its type name.
<P>
When adding, deleting or testing entries in a set, the same comma separated
data syntax must be used for the entry parameter of the commands, i.e
<DL COMPACT>
<DT><DD>
ipset add foo ipaddr,portnum,ipaddr
</DL>
<P>
If host names or service names with dash in the name are used instead of IP
addresses or service numbers, then the host name or service name must be enclosed
in square brackets. Example:
<DL COMPACT>
<DT><DD>
ipset add foo [test-hostname],[ftp-data]
</DL>
<P>
In the case of host names the DNS resolver is called internally
by <B>ipset</B> but if it returns multiple IP addresses, only the
first one is used.
<P>
The <B>bitmap</B> and <B>list</B> types use a fixed sized storage. The <B>hash</B>
types use a hash to store the elements. In order to avoid clashes in the hash,
a limited number of chaining, and if that is exhausted, the doubling of the hash size
is performed when adding entries by the
<B>ipset</B>
command. When entries added by the
<B>SET</B>
target of
<B>iptables/ip6tables</B>,
then the hash size is fixed and the set won't be duplicated, even if the new
entry cannot be added to the set.
<A NAME="lbAI"> </A>
<H2>GENERIC CREATE AND ADD OPTIONS</H2>
<A NAME="lbAJ"> </A>
<H3>timeout</H3>
All set types supports the optional <B>timeout</B>
parameter when creating a set and adding entries. The value of the <B>timeout</B>
parameter for the <B>create</B> command means the default timeout value (in seconds)
for new entries. If a set is created with timeout support, then the same
<B>timeout</B> option can be used to specify non-default timeout values
when adding entries. Zero timeout value means the entry is added permanent to the set.
The timeout value of already added elements can be changed by re-adding the element
using the <B>-exist</B> option. The largest possible timeout value is 2147483
(in seconds). Example:
<DL COMPACT>
<DT><DD>
ipset create test hash:ip timeout 300
<DT><DD>
ipset add test 192.168.0.1 timeout 60
<DT><DD>
ipset -exist add test 192.168.0.1 timeout 600
</DL>
<P>
When listing the set, the number of entries printed in the header might be
larger than the listed number of entries for sets with the timeout extensions:
the number of entries in the set is updated when elements added/deleted to the
set and periodically when the garbage collector evicts the timed out entries.
<P>
<A NAME="lbAK"> </A>
<H3>counters, packets, bytes</H3>
All set types support the optional <B>counters</B>
option when creating a set. If the option is specified then the set is created
with packet and byte counters per element support. The packet and byte counters
are initialized to zero when the elements are (re-)added to the set,
unless the packet and byte counter values are explicitly specified by the
<B>packets</B> and <B>bytes</B> options. An example when an element is added
to a set with non-zero counter values:
<DL COMPACT>
<DT><DD>
ipset create foo hash:ip counters
<DT><DD>
ipset add foo 192.168.1.1 packets 42 bytes 1024
</DL>
<P>
<A NAME="lbAL"> </A>
<H3>comment</H3>
All set types support the optional <B>comment</B> extension.
Enabling this extension on an ipset enables you to annotate an ipset entry with
an arbitrary string. This string is completely ignored by both the kernel and ipset
itself and is purely for providing a convenient means to document the reason for an
entry's existence. Comments must not contain any quotation marks and the usual escape
character (\) has no meaning. For example, the following shell command is illegal:
<DL COMPACT>
<DT><DD>
ipset add foo 1.1.1.1 comment "this comment is \"bad\""
</DL>
<P>
In the above, your shell will of course escape the quotation marks and ipset will see
the quote marks in the argument for the comment, which will result in a parse error.
If you are writing your own system, you should avoid creating comments containing a
quotation mark if you do not want to break "ipset save" and "ipset restore",
nonetheless, the kernel will not stop you from doing so. The following is perfectly
acceptable:
<DL COMPACT>
<DT><DD>
ipset create foo hash:ip comment
<DT><DD>
ipset add foo 192.168.1.1/24 comment "allow access to SMB share on \\\\fileserv\\"
<DT><DD>
the above would appear as: "allow access to SMB share on \\fileserv\"
</DL>
<P>
<A NAME="lbAM"> </A>
<H3>skbinfo, skbmark, skbprio, skbqueue</H3>
All set types support the optional <B>skbinfo</B> extension. This extension allows you to
store the metainfo (firewall mark, tc class and hardware queue) with every entry and map it to
packets by usage of SET netfilter target with --map-set option.
<B>skbmark</B> option format: <B>MARK</B> or <B>MARK/MASK</B>, where <B>MARK</B> and <B>MASK</B> are 32bit hex
numbers with 0x prefix. If only <B>mark</B> is specified mask 0xffffffff are used.
<B>skbprio</B> option has tc class format: <B>MAJOR:MINOR</B>, where <B>major</B> and <B>minor</B> numbers
are hex without 0x prefix.
<B>skbqueue</B> option is just decimal number.
<DL COMPACT>
<DT><DD>
ipset create foo hash:ip skbinfo
<DT><DD>
ipset add foo skbmark 0x1111/0xff00ffff skbprio 1:10 skbqueue 10
</DL>
<P>
<A NAME="lbAN"> </A>
<H3>hashsize</H3>
This parameter is valid for the <B>create</B> command of all <B>hash</B> type sets.
It defines the initial hash size for the set, default is 1024. The hash size must be a power
of two, the kernel automatically rounds up non power of two hash sizes to the first
correct value.
Example:
<DL COMPACT>
<DT><DD>
ipset create test hash:ip hashsize 1536
</DL>
<P>
<A NAME="lbAO"> </A>
<H3>maxelem</H3>
This parameter is valid for the <B>create</B> command of all <B>hash</B> type sets.
It does define the maximal number of elements which can be stored in the set, default 65536.
Example:
<DL COMPACT>
<DT><DD>
ipset create test hash:ip maxelem 2048.
</DL>
<P>
<A NAME="lbAP"> </A>
<H3>family { inet | inet6 }</H3>
This parameter is valid for the <B>create</B> command of all <B>hash</B> type sets
except for hash:mac.
It defines the protocol family of the IP addresses to be stored in the set. The default is
<B>inet</B>, i.e IPv4.
For the <B>inet</B> family one can add or delete multiple entries by specifying
a range or a network of IPv4 addresses in the IP address part of the entry:
<P>
<I>ipaddr</I> := { <I>ip</I> | <I>fromaddr</I>-<I>toaddr</I> | <I>ip</I>/<I>cidr</I> }
<P>
<I>netaddr</I> := { <I>fromaddr</I>-<I>toaddr</I> | <I>ip</I>/<I>cidr</I> }
<P>
Example:
<DL COMPACT>
<DT><DD>
ipset create test hash:ip family inet6
</DL>
<P>
<A NAME="lbAQ"> </A>
<H3>nomatch</H3>
The <B>hash</B> set types which can store <B>net</B> type of data (i.e. hash:*net*)
support the optional <B>nomatch</B>
option when adding entries. When matching elements in the set, entries marked
as <B>nomatch</B> are skipped as if those were not added to the set, which makes
possible to build up sets with exceptions. See the example at hash type
<B>hash:net</B> below.
<P>
When elements are tested by <B>ipset</B>, the <B>nomatch</B>
flags are taken into account. If one wants to test the existence of an element
marked with <B>nomatch</B> in a set, then the flag must be specified too.
<A NAME="lbAR"> </A>
<H3>forceadd</H3>
All hash set types support the optional <B>forceadd</B> parameter when creating a set.
When sets created with this option become full the next addition to the set may
succeed and evict a random entry from the set.
<DL COMPACT>
<DT><DD>
ipset create foo hash:ip forceadd
</DL>
<P>
<A NAME="lbAS"> </A>
<H2>SET TYPES</H2>
<A NAME="lbAT"> </A>
<H3>bitmap:ip</H3>
The <B>bitmap:ip</B> set type uses a memory range to store either IPv4 host
(default) or IPv4 network addresses. A <B>bitmap:ip</B> type of set can store up
to 65536 entries.
<P>
<I>CREATE-OPTIONS</I> := <B>range</B> <I>fromip</I>-<I>toip</I>|<I>ip</I>/<I>cidr</I> [ <B>netmask</B> <I>cidr</I> ] [ <B>timeout</B> <I>value</I> ] [ <B>counters</B> ] [ <B>comment</B> ] [ <B>skbinfo</B> ]
<P>
<I>ADD-ENTRY</I> := { <I>ip</I> | <I>fromip</I>-<I>toip</I> | <I>ip</I>/<I>cidr</I> }
<P>
<I>ADD-OPTIONS</I> := [ <B>timeout</B> <I>value</I> ] [ <B>packets</B> <I>value</I> ] [ <B>bytes</B> <I>value</I> ] [ <B>comment</B> <I>string</I> ] [ <B>skbmark</B> <I>value</I> ] [ <B>skbprio</B> <I>value</I> ] [ <B>skbqueue</B> <I>value</I> ]
<P>
<I>DEL-ENTRY</I> := { <I>ip</I> | <I>fromip</I>-<I>toip</I> | <I>ip</I>/<I>cidr</I> }
<P>
<I>TEST-ENTRY</I> := <I>ip</I>
<P>
Mandatory <B>create</B> options:
<DL COMPACT>
<DT><B>range</B> <I>fromip</I>-<I>toip</I>|<I>ip</I>/<I>cidr</I><DD>
Create the set from the specified inclusive address range expressed in an
IPv4 address range or network. The size of the range (in entries) cannot exceed
the limit of maximum 65536 elements.
</DL>
<P>
Optional <B>create</B> options:
<DL COMPACT>
<DT><B>netmask</B> <I>cidr</I><DD>
When the optional <B>netmask</B> parameter specified, network addresses will be
stored in the set instead of IP host addresses. The <I>cidr</I> prefix value must be
between 1-32.
An IP address will be in the set if the network address, which is resulted by
masking the address with the specified netmask, can be found in the set.
</DL>
<P>
The <B>bitmap:ip</B> type supports adding or deleting multiple entries in one
command.
<P>
Examples:
<DL COMPACT>
<DT><DD>
ipset create foo bitmap:ip range 192.168.0.0/16
<DT><DD>
ipset add foo 192.168.1/24
<DT><DD>
ipset test foo 192.168.1.1
</DL>
<A NAME="lbAU"> </A>
<H3>bitmap:ip,mac</H3>
The <B>bitmap:ip,mac</B> set type uses a memory range to store IPv4 and a MAC address pairs. A <B>bitmap:ip,mac</B> type of set can store up to 65536 entries.
<P>
<I>CREATE-OPTIONS</I> := <B>range</B> <I>fromip</I>-<I>toip</I>|<I>ip</I>/<I>cidr</I> [ <B>timeout</B> <I>value</I> ] [ <B>counters</B> ] [ <B>comment</B> ] [ <B>skbinfo</B> ]
<P>
<I>ADD-ENTRY</I> := <I>ip</I>[,<I>macaddr</I>]
<P>
<I>ADD-OPTIONS</I> := [ <B>timeout</B> <I>value</I> ] [ <B>packets</B> <I>value</I> ] [ <B>bytes</B> <I>value</I> ] [ <B>comment</B> <I>string</I> ] [ <B>skbmark</B> <I>value</I> ] [ <B>skbprio</B> <I>value</I> ] [ <B>skbqueue</B> <I>value</I> ]
<P>
<I>DEL-ENTRY</I> := <I>ip</I>[,<I>macaddr</I>]
<P>
<I>TEST-ENTRY</I> := <I>ip</I>[,<I>macaddr</I>]
<P>
Mandatory options to use when creating a <B>bitmap:ip,mac</B> type of set:
<DL COMPACT>
<DT><B>range</B> <I>fromip</I>-<I>toip</I>|<I>ip</I>/<I>cidr</I><DD>
Create the set from the specified inclusive address range expressed in an
IPv4 address range or network. The size of the range cannot exceed the limit
of maximum 65536 entries.
</DL>
<P>
The <B>bitmap:ip,mac</B> type is exceptional in the sense that the MAC part can
be left out when adding/deleting/testing entries in the set. If we add an entry
without the MAC address specified, then when the first time the entry is
matched by the kernel, it will automatically fill out the missing MAC address with the
MAC address from the packet. The source MAC address is used if the entry matched
due to a <B>src</B> parameter of the <B>set</B> match, and the destination MAC
address is used if available and the entry matched due to a <B>dst</B> parameter.
If the entry was specified with a timeout value, the timer starts off when the
IP and MAC address pair is complete.
<P>
The <B>bitmap:ip,mac</B> type of sets require two <B>src/dst</B> parameters of
the <B>set</B> match and <B>SET</B> target netfilter kernel modules. For matches
on destination MAC addresses, see COMMENTS below.
<P>
Examples:
<DL COMPACT>
<DT><DD>
ipset create foo bitmap:ip,mac range 192.168.0.0/16
<DT><DD>
ipset add foo 192.168.1.1,12:34:56:78:9A:BC
<DT><DD>
ipset test foo 192.168.1.1
</DL>
<A NAME="lbAV"> </A>
<H3>bitmap:port</H3>
The <B>bitmap:port</B> set type uses a memory range to store port numbers
and such a set can store up to 65536 ports.
<P>
<I>CREATE-OPTIONS</I> := <B>range</B> <I>fromport</I>-<I>toport [ </I><B>timeout</B> <I>value</I> ] [ <B>counters</B> ] [ <B>comment</B> ] [ <B>skbinfo</B> ]
<P>
<I>ADD-ENTRY</I> := { <I>[proto:]port</I> | <I>[proto:]fromport</I>-<I>toport</I> }
<P>
<I>ADD-OPTIONS</I> := [ <B>timeout</B> <I>value</I> ] [ <B>packets</B> <I>value</I> ] [ <B>bytes</B> <I>value</I> ] [ <B>comment</B> <I>string</I> ] [ <B>skbmark</B> <I>value</I> ] [ <B>skbprio</B> <I>value</I> ] [ <B>skbqueue</B> <I>value</I> ]
<P>
<I>DEL-ENTRY</I> := { <I>[proto:]port</I> | <I>[proto:]fromport</I>-<I>toport</I> }
<P>
<I>TEST-ENTRY</I> := <I>[proto:]port</I>
<P>
Mandatory options to use when creating a <B>bitmap:port</B> type of set:
<DL COMPACT>
<DT><B>range</B> <I>[proto:]fromport</I>-<I>toport</I><DD>
Create the set from the specified inclusive port range.
</DL>
<P>
The <B>set</B> match and <B>SET</B> target netfilter kernel modules interpret
the stored numbers as TCP or UDP port numbers.
<P>
<B>proto</B> only needs to be specified if a service name is used,
and that name does not exist as a TCP service.
<P>
Examples:
<DL COMPACT>
<DT><DD>
ipset create foo bitmap:port range 0-1024
<DT><DD>
ipset add foo 80
<DT><DD>
ipset test foo 80
<DT><DD>
ipset del foo udp:[macon-udp]-[tn-tl-w2]
</DL>
<A NAME="lbAW"> </A>
<H3>hash:ip</H3>
The <B>hash:ip</B> set type uses a hash to store IP host addresses (default) or
network addresses. Zero valued IP address cannot be stored in a <B>hash:ip</B>
type of set.
<P>
<I>CREATE-OPTIONS</I> := [ <B>family</B> { <B>inet</B> | <B>inet6</B> } ] | [ <B>hashsize</B> <I>value</I> ] [ <B>maxelem</B> <I>value</I> ] [ <B>netmask</B> <I>cidr</I> ] [ <B>timeout</B> <I>value</I> ] [ <B>counters</B> ] [ <B>comment</B> ] [ <B>skbinfo</B> ]
<P>
<I>ADD-ENTRY</I> := <I>ipaddr</I>
<P>
<I>ADD-OPTIONS</I> := [ <B>timeout</B> <I>value</I> ] [ <B>packets</B> <I>value</I> ] [ <B>bytes</B> <I>value</I> ] [ <B>comment</B> <I>string</I> ] [ <B>skbmark</B> <I>value</I> ] [ <B>skbprio</B> <I>value</I> ] [ <B>skbqueue</B> <I>value</I> ]
<P>
<I>DEL-ENTRY</I> := <I>ipaddr</I>
<P>
<I>TEST-ENTRY</I> := <I>ipaddr</I>
<P>
Optional <B>create</B> options:
<DL COMPACT>
<DT><B>netmask</B> <I>cidr</I><DD>
When the optional <B>netmask</B> parameter specified, network addresses will be
stored in the set instead of IP host addresses. The <I>cidr</I> prefix value must be
between 1-32 for IPv4 and between 1-128 for IPv6. An IP address will be in the set
if the network address, which is resulted by masking the address with the netmask,
can be found in the set.
Examples:
<DT><DD>
ipset create foo hash:ip netmask 30
<DT><DD>
ipset add foo 192.168.1.0/24
<DT><DD>
ipset test foo 192.168.1.2
</DL>
<A NAME="lbAX"> </A>
<H3>hash:mac</H3>
The <B>hash:mac</B> set type uses a hash to store MAC addresses. Zero valued MAC addresses cannot be stored in a <B>hash:mac</B>
type of set. For matches on destination MAC addresses, see COMMENTS below.
<P>
<I>CREATE-OPTIONS</I> := [ <B>hashsize</B> <I>value</I> ] [ <B>maxelem</B> <I>value</I> ] [ <B>timeout</B> <I>value</I> ] [ <B>counters</B> ] [ <B>comment</B> ] [ <B>skbinfo</B> ]
<P>
<I>ADD-ENTRY</I> := <I>macaddr</I>
<P>
<I>ADD-OPTIONS</I> := [ <B>timeout</B> <I>value</I> ] [ <B>packets</B> <I>value</I> ] [ <B>bytes</B> <I>value</I> ] [ <B>comment</B> <I>string</I> ] [ <B>skbmark</B> <I>value</I> ] [ <B>skbprio</B> <I>value</I> ] [ <B>skbqueue</B> <I>value</I> ]
<P>
<I>DEL-ENTRY</I> := <I>macaddr</I>
<P>
<I>TEST-ENTRY</I> := <I>macaddr</I>
<P>
Examples:
<DL COMPACT>
<DT><DD>
ipset create foo hash:mac
<DT><DD>
ipset add foo 01:02:03:04:05:06
<DT><DD>
ipset test foo 01:02:03:04:05:06
<P>
</DL>
<A NAME="lbAY"> </A>
<H3>hash:ip,mac</H3>
The <B>hash:ip,mac</B> set type uses a hash to store IP and a MAC address pairs. Zero valued MAC addresses cannot be stored in a <B>hash:ip,mac</B>
type of set. For matches on destination MAC addresses, see COMMENTS below.
<P>
<I>CREATE-OPTIONS</I> := [ <B>family</B> { <B>inet</B> | <B>inet6</B> } ] | [ <B>hashsize</B> <I>value</I> ] [ <B>maxelem</B> <I>value</I> ] [ <B>timeout</B> <I>value</I> ] [ <B>counters</B> ] [ <B>comment</B> ] [ <B>skbinfo</B> ]
<P>
<I>ADD-ENTRY</I> := <I>ipaddr</I>,<I>macaddr</I>
<P>
<I>ADD-OPTIONS</I> := [ <B>timeout</B> <I>value</I> ] [ <B>packets</B> <I>value</I> ] [ <B>bytes</B> <I>value</I> ] [ <B>comment</B> <I>string</I> ] [ <B>skbmark</B> <I>value</I> ] [ <B>skbprio</B> <I>value</I> ] [ <B>skbqueue</B> <I>value</I> ]
<P>
<I>DEL-ENTRY</I> := <I>ipaddr</I>,<I>macaddr</I>
<P>
<I>TEST-ENTRY</I> := <I>ipaddr</I>,<I>macaddr</I>
<P>
Examples:
<DL COMPACT>
<DT><DD>
ipset create foo hash:ip,mac
<DT><DD>
ipset add foo 1.1.1.1,01:02:03:04:05:06
<DT><DD>
ipset test foo 1.1.1.1,01:02:03:04:05:06
<P>
</DL>
<A NAME="lbAZ"> </A>
<H3>hash:net</H3>
The <B>hash:net</B> set type uses a hash to store different sized IP network addresses.
Network address with zero prefix size cannot be stored in this type of sets.
<P>
<I>CREATE-OPTIONS</I> := [ <B>family</B> { <B>inet</B> | <B>inet6</B> } ] | [ <B>hashsize</B> <I>value</I> ] [ <B>maxelem</B> <I>value</I> ] [ <B>timeout</B> <I>value</I> ] [ <B>counters</B> ] [ <B>comment</B> ] [ <B>skbinfo</B> ]
<P>
<I>ADD-ENTRY</I> := <I>netaddr</I>
<P>
<I>ADD-OPTIONS</I> := [ <B>timeout</B> <I>value</I> ] [ <B>nomatch</B> ] [ <B>packets</B> <I>value</I> ] [ <B>bytes</B> <I>value</I> ] [ <B>comment</B> <I>string</I> ] [ <B>skbmark</B> <I>value</I> ] [ <B>skbprio</B> <I>value</I> ] [ <B>skbqueue</B> <I>value</I> ]
<P>
<I>DEL-ENTRY</I> := <I>netaddr</I>
<P>
<I>TEST-ENTRY</I> := <I>netaddr</I>
<P>
where
<I>netaddr</I> := <I>ip</I>[/<I>cidr</I>]
<P>
When adding/deleting/testing entries, if the cidr prefix parameter is not specified,
then the host prefix value is assumed. When adding/deleting entries, the exact
element is added/deleted and overlapping elements are not checked by the kernel.
When testing entries, if a host address is tested, then the kernel tries to match
the host address in the networks added to the set and reports the result accordingly.
<P>
From the <B>set</B> netfilter match point of view the searching for a match
always starts from the smallest size of netblock (most specific
prefix) to the largest one (least specific prefix) added to the set.
When adding/deleting IP addresses to the set by the <B>SET</B> netfilter target,
it will be added/deleted by the most specific prefix which can be found in the
set, or by the host prefix value if the set is empty.
<P>
The lookup time grows linearly with the number of the different prefix
values added to the set.
<P>
Example:
<DL COMPACT>
<DT><DD>
ipset create foo hash:net
<DT><DD>
ipset add foo 192.168.0.0/24
<DT><DD>
ipset add foo 10.1.0.0/16
<DT><DD>
ipset add foo 192.168.0/24
<DT><DD>
ipset add foo 192.168.0/30 nomatch
</DL>
<P>
When matching the elements in the set above, all IP addresses will match
from the networks 192.168.0.0/24, 10.1.0.0/16 and 192.168.0/24 except
the ones from 192.168.0/30.
<A NAME="lbBA"> </A>
<H3>hash:net,net</H3>
The <B>hash:net,net</B> set type uses a hash to store pairs of different sized IP
network addresses. Bear in mind that the first parameter has precedence
over the second, so a nomatch entry could be potentially be ineffective if a more specific
first parameter existed with a suitable second parameter.
Network address with zero prefix size cannot be stored in this type of set.
<P>
<I>CREATE-OPTIONS</I> := [ <B>family</B> { <B>inet</B> | <B>inet6</B> } ] | [ <B>hashsize</B> <I>value</I> ] [ <B>maxelem</B> <I>value</I> ] [ <B>timeout</B> <I>value</I> ] [ <B>counters</B> ] [ <B>comment</B> ] [ <B>skbinfo</B> ]
<P>
<I>ADD-ENTRY</I> := <I>netaddr</I>,<I>netaddr</I>
<P>
<I>ADD-OPTIONS</I> := [ <B>timeout</B> <I>value</I> ] [ <B>nomatch</B> ] [ <B>packets</B> <I>value</I> ] [ <B>bytes</B> <I>value</I> ] [ <B>comment</B> <I>string</I> ] [ <B>skbmark</B> <I>value</I> ] [ <B>skbprio</B> <I>value</I> ] [ <B>skbqueue</B> <I>value</I> ]
<P>
<I>DEL-ENTRY</I> := <I>netaddr</I>,<I>netaddr</I>
<P>
<I>TEST-ENTRY</I> := <I>netaddr</I>,<I>netaddr</I>
<P>
where
<I>netaddr</I> := <I>ip</I>[/<I>cidr</I>]
<P>
When adding/deleting/testing entries, if the cidr prefix parameter is not specified,
then the host prefix value is assumed. When adding/deleting entries, the exact
element is added/deleted and overlapping elements are not checked by the kernel.
When testing entries, if a host address is tested, then the kernel tries to match
the host address in the networks added to the set and reports the result accordingly.
<P>
From the <B>set</B> netfilter match point of view the searching for a match
always starts from the smallest size of netblock (most specific
prefix) to the largest one (least specific prefix) with the first param
having precedence.
When adding/deleting IP addresses to the set by the <B>SET</B> netfilter target,
it will be added/deleted by the most specific prefix which can be found in
the set, or by the host prefix value if the set is empty.
<P>
The lookup time grows linearly with the number of the different prefix
values added to the first parameter of the set. The number of secondary prefixes
further increases this as the list of secondary prefixes is traversed per primary
prefix.
<P>
Example:
<DL COMPACT>
<DT><DD>
ipset create foo hash:net,net
<DT><DD>
ipset add foo 192.168.0.0/24,10.0.1.0/24
<DT><DD>
ipset add foo 10.1.0.0/16,10.255.0.0/24
<DT><DD>
ipset add foo 192.168.0/24,192.168.54.0-192.168.54.255
<DT><DD>
ipset add foo 192.168.0/30,192.168.64/30 nomatch
</DL>
<P>
When matching the elements in the set above, all IP addresses will match
from the networks 192.168.0.0/24<->10.0.1.0/24, 10.1.0.0/16<->10.255.0.0/24
and 192.168.0/24<->192.168.54.0/24 except the ones from
192.168.0/30<->192.168.64/30.
<A NAME="lbBB"> </A>
<H3>hash:ip,port</H3>
The <B>hash:ip,port</B> set type uses a hash to store IP address and port number pairs.
The port number is interpreted together with a protocol (default TCP) and zero
protocol number cannot be used.
<P>
<I>CREATE-OPTIONS</I> := [ <B>family</B> { <B>inet</B> | <B>inet6</B> } ] | [ <B>hashsize</B> <I>value</I> ] [ <B>maxelem</B> <I>value</I> ] [ <B>timeout</B> <I>value</I> ] [ <B>counters</B> ] [ <B>comment</B> ] [ <B>skbinfo</B> ]
<P>
<I>ADD-ENTRY</I> := <I>ipaddr</I>,[<I>proto</I>:]<I>port</I>
<P>
<I>ADD-OPTIONS</I> := [ <B>timeout</B> <I>value</I> ] [ <B>packets</B> <I>value</I> ] [ <B>bytes</B> <I>value</I> ] [ <B>comment</B> <I>string</I> ] [ <B>skbmark</B> <I>value</I> ] [ <B>skbprio</B> <I>value</I> ] [ <B>skbqueue</B> <I>value</I> ]
<P>
<I>DEL-ENTRY</I> := <I>ipaddr</I>,[<I>proto</I>:]<I>port</I>
<P>
<I>TEST-ENTRY</I> := <I>ipaddr</I>,[<I>proto</I>:]<I>port</I>
<P>
The
[<I>proto</I>:]<I>port</I>
part of the elements may be expressed in the following forms, where the range
variations are valid when adding or deleting entries:
<DL COMPACT>
<DT><I>portname[-portname]</I><DD>
TCP port or range of ports expressed in TCP portname identifiers from /etc/services
<DT><I>portnumber[-portnumber]</I><DD>
TCP port or range of ports expressed in TCP port numbers
<DT><B>tcp</B>|<B>sctp</B>|<B>udp</B>|<B>udplite</B>:<I>portname</I>|<I>portnumber</I>[-<I>portname</I>|<I>portnumber</I>]<DD>
TCP, SCTP, UDP or UDPLITE port or port range expressed in port name(s) or port number(s)
<DT><B>icmp</B>:<I>codename</I>|<I>type</I>/<I>code</I><DD>
ICMP codename or type/code. The supported ICMP codename identifiers can always
be listed by the help command.
<DT><B>icmpv6</B>:<I>codename</I>|<I>type</I>/<I>code</I><DD>
ICMPv6 codename or type/code. The supported ICMPv6 codename identifiers can always
be listed by the help command.
<DT><I>proto</I>:0<DD>
All other protocols, as an identifier from /etc/protocols or number. The pseudo
port number must be zero.
</DL>
<P>
The <B>hash:ip,port</B> type of sets require
two <B>src</B>/<B>dst</B> parameters of the <B>set</B> match and <B>SET</B>
target kernel modules.
<P>
Examples:
<DL COMPACT>
<DT><DD>
ipset create foo hash:ip,port
<DT><DD>
ipset add foo 192.168.1.0/24,80-82
<DT><DD>
ipset add foo 192.168.1.1,udp:53
<DT><DD>
ipset add foo 192.168.1.1,vrrp:0
<DT><DD>
ipset test foo 192.168.1.1,80
</DL>
<A NAME="lbBC"> </A>
<H3>hash:net,port</H3>
The <B>hash:net,port</B> set type uses a hash to store different sized IP network
address and port pairs. The port number is interpreted together with a protocol
(default TCP) and zero protocol number cannot be used. Network
address with zero prefix size is not accepted either.
<P>
<I>CREATE-OPTIONS</I> := [ <B>family</B> { <B>inet</B> | <B>inet6</B> } ] | [ <B>hashsize</B> <I>value</I> ] [ <B>maxelem</B> <I>value</I> ] [ <B>timeout</B> <I>value</I> ] [ <B>counters</B> ] [ <B>comment</B> ] [ <B>skbinfo</B> ]
<P>
<I>ADD-ENTRY</I> := <I>netaddr</I>,[<I>proto</I>:]<I>port</I>
<P>
<I>ADD-OPTIONS</I> := [ <B>timeout</B> <I>value</I> ] [ <B>nomatch</B> ] [ <B>packets</B> <I>value</I> ] [ <B>bytes</B> <I>value</I> ] [ <B>comment</B> <I>string</I> ] [ <B>skbmark</B> <I>value</I> ] [ <B>skbprio</B> <I>value</I> ] [ <B>skbqueue</B> <I>value</I> ]
<P>
<I>DEL-ENTRY</I> := <I>netaddr</I>,[<I>proto</I>:]<I>port</I>
<P>
<I>TEST-ENTRY</I> := <I>netaddr</I>,[<I>proto</I>:]<I>port</I>
<P>
where
<I>netaddr</I> := <I>ip</I>[/<I>cidr</I>]
<P>
For the <I>netaddr</I> part of the elements
see the description at the <B>hash:net</B> set type. For the
[<I>proto</I>:]<I>port</I>
part of the elements see the description at the
<B>hash:ip,port</B> set type.
<P>
When adding/deleting/testing entries, if the cidr prefix parameter is not specified,
then the host prefix value is assumed. When adding/deleting entries, the exact
element is added/deleted and overlapping elements are not checked by the kernel.
When testing entries, if a host address is tested, then the kernel tries to match
the host address in the networks added to the set and reports the result accordingly.
<P>
From the <B>set</B> netfilter match point of view the searching for a match
always starts from the smallest size of netblock (most specific
prefix) to the largest one (least specific prefix) added to the set.
When adding/deleting IP
addresses to the set by the <B>SET</B> netfilter target, it will be
added/deleted by the most specific prefix which can be found in the
set, or by the host prefix value if the set is empty.
<P>
The lookup time grows linearly with the number of the different prefix
values added to the set.
<P>
Examples:
<DL COMPACT>
<DT><DD>
ipset create foo hash:net,port
<DT><DD>
ipset add foo 192.168.0/24,25
<DT><DD>
ipset add foo 10.1.0.0/16,80
<DT><DD>
ipset test foo 192.168.0/24,25
</DL>
<A NAME="lbBD"> </A>
<H3>hash:ip,port,ip</H3>
The <B>hash:ip,port,ip</B> set type uses a hash to store IP address, port number
and a second IP address triples. The port number is interpreted together with a
protocol (default TCP) and zero protocol number cannot be used.
<P>
<I>CREATE-OPTIONS</I> := [ <B>family</B> { <B>inet</B> | <B>inet6</B> } ] | [ <B>hashsize</B> <I>value</I> ] [ <B>maxelem</B> <I>value</I> ] [ <B>timeout</B> <I>value</I> ] [ <B>counters</B> ] [ <B>comment</B> ] [ <B>skbinfo</B> ]
<P>
<I>ADD-ENTRY</I> := <I>ipaddr</I>,[<I>proto</I>:]<I>port</I>,<I>ip</I>
<P>
<I>ADD-OPTIONS</I> := [ <B>timeout</B> <I>value</I> ] [ <B>packets</B> <I>value</I> ] [ <B>bytes</B> <I>value</I> ] [ <B>comment</B> <I>string</I> ] [ <B>skbmark</B> <I>value</I> ] [ <B>skbprio</B> <I>value</I> ] [ <B>skbqueue</B> <I>value</I> ]
<P>
<I>DEL-ENTRY</I> := <I>ipaddr</I>,[<I>proto</I>:]<I>port</I>,<I>ip</I>
<P>
<I>TEST-ENTRY</I> := <I>ipaddr</I>,[<I>proto</I>:]<I>port</I>,<I>ip</I>