From: Elise Lennion Subject: [PATCH nft] doc: Document sets Date: Thu, 9 Feb 2017 15:35:25 -0200 Message-ID: <20170209173525.GA10010@lennorien.com> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Cc: netfilter-devel@vger.kernel.org To: pablo@netfilter.org Return-path: Received: from mail-qk0-f196.google.com ([209.85.220.196]:34797 "EHLO mail-qk0-f196.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1754354AbdBIRfd (ORCPT ); Thu, 9 Feb 2017 12:35:33 -0500 Received: by mail-qk0-f196.google.com with SMTP id e1so1605627qkh.1 for ; Thu, 09 Feb 2017 09:35:32 -0800 (PST) Content-Disposition: inline Sender: netfilter-devel-owner@vger.kernel.org List-ID: This patch adds the missing documentation for sets. Signed-off-by: Elise Lennion --- doc/nft.xml | 124 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 124 insertions(+) diff --git a/doc/nft.xml b/doc/nft.xml index ac31c3b..be729a8 100644 --- a/doc/nft.xml +++ b/doc/nft.xml @@ -668,6 +668,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 -- 2.7.4