Builtin cli reference

vperf client

vperf client [nclients <n>] [bytes <bytes>[k|m|g] | run-time <seconds>]
[test-timeout <seconds>] [syn-timeout <seconds>] [echo-bytes]
[fifo-size <bytes>[k|m|g]] [appns <id>] [http1|http2|http3] [tls-engine <id>]
[private-segment-size <bytes>[k|m|g]] [preallocate-fifos] [preallocate-sessions]
[client-batch <n>] [max-tx-chunk <bytes>[k|m]] [nstreams <n>]
[throughput <bytes>[k|m|g]] [report-interval[-total] [<seconds>]] [report-jitter]
[uri <proto://ip:port>] [test-bytes] [verbose] [all-scope|local-scope|global-scope]
[connect-tcp|connect-udp]

Client for performing network throughput measurements. It can test TCP, UDP, TLS or QUIC throughput. To perform test you must establish both a server and a client.

Example of how to measure upload speed, test duration 10 seconds and measurement interval 1 second (zero copy):

vperf client uri tcp://6.0.1.2:1234

Declaration: vp_client_command src/plugins/vperf/builtin/vperf_cli.c line 367

Implementation: vp_client_command_fn

vperf server

vperf server [uri <proto://ip:port>] [fifo-size <bytes>[k|m|g]]
[private-segment-count <n>] [private-segment-size <bytes>[k|m|g]]
[all-scope|local-scope|global-scope] [secret <n>] [stop] [tls-engine <id>]
[prealloc-fifos <n>] [appns <id>] [report-interval [<seconds>]]

Server for performing network throughput measurements. It can test TCP, UDP, TLS or QUIC throughput. To perform test you must establish both a server and a client.

Example of how to start server:

vperf server uri tcp://6.0.1.2:1234

Declaration: vp_server_create_command src/plugins/vperf/builtin/vperf_cli.c line 163

Implementation: vp_server_create_command_fn