]> git.ipfire.org Git - thirdparty/nftables.git/commitdiff
doc: Document add / delete element operations of sets and maps
authorElise Lennion <elise.lennion@gmail.com>
Fri, 17 Mar 2017 15:04:48 +0000 (12:04 -0300)
committerPablo Neira Ayuso <pablo@netfilter.org>
Mon, 20 Mar 2017 10:17:23 +0000 (11:17 +0100)
The add / delete operations weren't documented yet. They fit better
in the sets and maps blocks since these operations are used to directly
modify their content.

Signed-off-by: Elise Lennion <elise.lennion@gmail.com>
Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
doc/nft.xml

index 5b75469077df603316d1b11489439213bb418b5e..31c664d88b996ad6b4ab6866bca0d2a7678685fe 100644 (file)
@@ -697,6 +697,19 @@ filter input iif $int_ifs accept
                                <arg choice="req"><replaceable>table</replaceable></arg>
                                <arg choice="req"><replaceable>set</replaceable></arg>
                        </cmdsynopsis>
+                       <cmdsynopsis>
+                               <group choice="req">
+                                       <arg>add</arg>
+                                       <arg>delete</arg>
+                               </group>
+                               <command> element</command>
+                               <arg choice="opt"><replaceable>family</replaceable></arg>
+                               <arg choice="req"><replaceable>table</replaceable></arg>
+                               <arg choice="req"><replaceable>set</replaceable></arg>
+                               {
+                               <arg choice="req"><replaceable>elements</replaceable></arg>
+                               }
+                       </cmdsynopsis>
                </para>
                <para>
                        Sets are elements containers of an user-defined data type, they are uniquely identified by an user-defined name and attached to tables.
@@ -735,6 +748,22 @@ filter input iif $int_ifs accept
                                        </para>
                                </listitem>
                        </varlistentry>
+                       <varlistentry>
+                               <term><option>add element</option></term>
+                               <listitem>
+                                       <para>
+                                               Comma-separated list of elements to add into the specified set.
+                                       </para>
+                               </listitem>
+                       </varlistentry>
+                       <varlistentry>
+                               <term><option>delete element</option></term>
+                               <listitem>
+                                       <para>
+                                               Comma-separated list of elements to delete from the specified set.
+                                       </para>
+                               </listitem>
+                       </varlistentry>
                </variablelist>
 
                <table frame="all">
@@ -819,6 +848,19 @@ filter input iif $int_ifs accept
                                <arg choice="req"><replaceable>table</replaceable></arg>
                                <arg choice="req"><replaceable>map</replaceable></arg>
                        </cmdsynopsis>
+                       <cmdsynopsis>
+                               <group choice="req">
+                                       <arg>add</arg>
+                                       <arg>delete</arg>
+                               </group>
+                               <command> element</command>
+                               <arg choice="opt"><replaceable>family</replaceable></arg>
+                               <arg choice="req"><replaceable>table</replaceable></arg>
+                               <arg choice="req"><replaceable>map</replaceable></arg>
+                               {
+                               <arg choice="req"><replaceable>elements</replaceable></arg>
+                               }
+                       </cmdsynopsis>
                </para>
                <para>
                        Maps store data based on some specific key used as input, they are uniquely identified by an user-defined name and attached to tables.
@@ -857,6 +899,22 @@ filter input iif $int_ifs accept
                                        </para>
                                </listitem>
                        </varlistentry>
+                       <varlistentry>
+                               <term><option>add element</option></term>
+                               <listitem>
+                                       <para>
+                                               Comma-separated list of elements to add into the specified map.
+                                       </para>
+                               </listitem>
+                       </varlistentry>
+                       <varlistentry>
+                               <term><option>delete element</option></term>
+                               <listitem>
+                                       <para>
+                                               Comma-separated list of element keys to delete from the specified map.
+                                       </para>
+                               </listitem>
+                       </varlistentry>
                </variablelist>
 
                <table frame="all">