Merge "Add initial support for iperf3, both in client and server modes."

[osm/devops.git] / layers / netutils / README.md

diff --git a/layers/netutils/README.md b/layers/netutils/README.md
index 525c2d7..e8258c0 100644 (file)
--- a/layers/netutils/README.md
+++ b/layers/netutils/README.md
@@ -38,6 +38,16 @@ timing:
   enqueued: 2016-06-29 14:50:03 +0000 UTC
   started: 2016-06-29 14:50:03 +0000 UTC
 ```
+## iperf3
+
+Because iperf3 has a client and server component, the netutils charm can operate
+as both. Setting the iperf3 configuration value to True will start iperf3 in
+server mode, running as a daemon.
+```
+$ juju deploy cs:~nfv/netutils client
+$ juju deploy cs:~nfv/netutils server iperf3=True
+$ juju run-action client/0 iperf host=<ip of server> [...]
+```
 
 ## Scale out Usage