diff options
author | Elise Lennion <elise.lennion@gmail.com> | 2017-03-17 12:04:48 -0300 |
---|---|---|
committer | Pablo Neira Ayuso <pablo@netfilter.org> | 2017-03-20 11:17:23 +0100 |
commit | cad4da77d6330d08eea6a4c73c70c012d20d4e3b (patch) | |
tree | a1ad82e3b723c840041c9a195ae54d069740231a /doc | |
parent | 6d37dae4b313e162d3196c2e5aa1670dbaf43bff (diff) |
doc: Document add / delete element operations of sets and maps
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>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/nft.xml | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/doc/nft.xml b/doc/nft.xml index 5b754690..31c664d8 100644 --- a/doc/nft.xml +++ b/doc/nft.xml @@ -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"> |