From 862693ff30babe8613632886d0ab40f9c2628dcf Mon Sep 17 00:00:00 2001 From: Elise Lennion Date: Thu, 9 Feb 2017 15:35:25 -0200 Subject: doc: Document sets This patch adds the missing documentation for sets. Signed-off-by: Elise Lennion Signed-off-by: Pablo Neira Ayuso --- doc/nft.xml | 124 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 124 insertions(+) (limited to 'doc') diff --git a/doc/nft.xml b/doc/nft.xml index ac31c3b9..be729a89 100644 --- a/doc/nft.xml +++ b/doc/nft.xml @@ -667,6 +667,130 @@ filter input iif $int_ifs accept + + Sets + + + add + set + family + table + set + { + type + flags + timeout + gc-interval + elements + size + policy + } + + + + delete + list + flush + + set + family + table + set + + + + Sets are elements containers of an user-defined data type, they are uniquely identified by an user-defined name and attached to tables. + + + + + + + + Add a new set in the specified table. + + + + + + + + Delete the specified set. + + + + + + + + Display the elements in the specified set. + + + + + + + + Remove all elements from the specified set. + + + + + + + Set specifications + + + + + + + Keyword + Description + Type + + + + + type + data type of set elements + string: ipv4_addr, ipv6_addr, ether_addr, inet_proto, inet_service, mark + + + flags + set flags + string: constant, interval, timeout + + + timeout + time an element stays in the set + string, decimal followed by unit. Units are: d, h, m, s + + + gc-interval + garbage collection interval, only available when timeout or flag timeout are active + string, decimal followed by unit. Units are: d, h, m, s + + + elements + elements contained by the set + set data type + + + size + maximun number of elements in the set + unsigned integer (64 bit) + + + policy + set policy + string: performance, memory + + + +
+ + Stateful objects -- cgit v1.2.3