[6/7] doc: update sample actions support in testpmd guide

Message ID 20210315124714.229757-7-salems@nvidia.com (mailing list archive)
State Superseded, archived
Delegated to: Ferruh Yigit
Headers
Series Add support for VXLAN and NVGRE encap as a sample actions |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Salem Sol March 15, 2021, 12:47 p.m. UTC
  Update documentation for sample action usage in testpmd utilizing
rte_flow_action_vxlan_encap and rte_flow_action_nvgre_encap and
show the command line example.

Signed-off-by: Salem Sol <salems@nvidia.com>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
  

Patch

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 3a31cc6237..5e40c9bc1c 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -4900,6 +4900,27 @@  and also mirrored the packets with encapsulation header and sent to port id 0.
  testpmd> set sample_actions 0 raw_encap / port_id id 0 / end
  testpmd> flow create 0 ingress transfer pattern eth / end actions
         sample ratio 1 index 0  / port_id id 2 / end
+E-Switch Mirroring rule, the matched ingress packets are sent to port id 2,
+and also mirrored the packets with VXLAN encapsulation header and sent to port id 0.
+
+::
+
+ testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
+        ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
+ testpmd> set sample_actions 0 vxlan_encap / port_id id 0 / end
+ testpmd> flow create 0 ingress transfer pattern eth / end actions
+        sample ratio 1 index 0  / port_id id 2 / end
+
+E-Switch Mirroring rule, the matched ingress packets are sent to port id 2,
+and also mirrored the packets with NVGRE encapsulation header and sent to port id 0.
+
+::
+
+ testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
+        eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
+ testpmd> set sample_actions 0 nvgre_encap / port_id id 0 / end
+ testpmd> flow create 0 ingress transfer pattern eth / end actions
+        sample ratio 1 index 0  / port_id id 2 / end
 
 BPF Functions
 --------------