Add documentation for goto rules with iptc.easy

ldx · May 19, 2019 · 57a7cc5 · 57a7cc5
1 parent 54c6368
commit 57a7cc5
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -141,7 +141,7 @@ High level abstractions
 ``python-iptables`` implements a low-level interface that tries to closely
 match the underlying C libraries. The module ``iptc.easy`` improves the
 usability of the library by providing a rich set of high-level functions
-designed to simplify the interaction with the library, for example::
+designed to simplify the interaction with the library, for example:
 
     >>> import iptc
     >>> iptc.easy.dump_table('nat', ipv6=False)
@@ -160,6 +160,11 @@ designed to simplify the interaction with the library, for example::
     [{'protocol': 'tcp', 'target': 'ACCEPT', 'tcp': {'dport': '22'}}]
     >>> iptc.easy.delete_chain('filter', 'TestChain', flush=True)
 
+    >>> # Example of goto rule // iptables -A FORWARD -p gre -g TestChainGoto
+    >>> iptc.easy.add_chain('filter', 'TestChainGoto')
+    >>> rule_goto_d = {'protocol': 'gre', 'target': {'goto': 'TestChainGoto'}}
+    >>> iptc.easy.insert_rule('filter', 'FORWARD', rule_goto_d)
+
 Rules
 -----
 

diff --git a/doc/examples.rst b/doc/examples.rst
@@ -7,7 +7,7 @@ High level abstractions
 ``python-iptables`` implements a low-level interface that tries to closely
 match the underlying C libraries. The module ``iptc.easy`` improves the
 usability of the library by providing a rich set of high-level functions
-designed to simplify the interaction with the library, for example::
+designed to simplify the interaction with the library, for example:
 
     >>> import iptc
     >>> iptc.easy.dump_table('nat', ipv6=False)
@@ -26,6 +26,11 @@ designed to simplify the interaction with the library, for example::
     [{'protocol': 'tcp', 'target': 'ACCEPT', 'tcp': {'dport': '22'}}]
     >>> iptc.easy.delete_chain('filter', 'TestChain', flush=True)
 
+    >>> # Example of goto rule // iptables -A FORWARD -p gre -g TestChainGoto
+    >>> iptc.easy.add_chain('filter', 'TestChainGoto')
+    >>> rule_goto_d = {'protocol': 'gre', 'target': {'goto': 'TestChainGoto'}}
+    >>> iptc.easy.insert_rule('filter', 'FORWARD', rule_goto_d)
+
 Rules
 -----