Latest revision as of 02:45, 16 August 2024

Alteeve Wiki :: Man Pages :: Anvil-network-profiler

NAME

anvil-network-profiler - Tool to test the network performance between this host and a target host.

SYNOPSIS

anvil-network-profiler <command> [options]

DESCRIPTION

This program uses 'iperf' to determine the real world network performance between this host and a target over a given network. This uses unfragmentable pings to detect the maximum usable MTU, and then repeatedly tests the performance, incrementing the MTU by a set amount between each test. In this way, the optimal MTU is also found.

Warning!

This test manipulates the network interface during the test. As such, DO NOT run this test on any host (as source or target) that is in active use!

OPTIONS

-?, -h, --help: Show this man page.
--log-secure: When logging, record sensitive data, like passwords.
-v, -vv, -vvv: Set the log level to 1, 2 or 3 respectively. Be aware that level 3 generates a significant amount of log data.

Commands:

--max-mtu <bytes>

This option sets a limit of the maximum MTU that will be used, bypassing max MTU size auto detection.
--password <string>: If passwordless SSH is not configured with the target host, then specify the root user password used to ssh into the target. This is needed to alter the MTU and setup iperf.
--stepping <bytes>: By default, the MTU is incremented by 500 bytes between tests. If you want to use a different stepping, specify the number of bytes to increment between tests with this switch.
--source <ip address>: This is the local IP address that will be used during the test. The interface with this IP address will have its MTU size manipulated during the test.
--target <ip address>: This is the IP address on the peer that will be used to connect to the target. The interface with this IP on the peer will have its MTU size adjusted during the test.
--tests <number>: By default, each tested MTU will be run three times and the results will be averaged. If you want to change the number of tests run per MTU size, use this switch.

AUTHOR

Written by Madison Kelly, Alteeve staff and the Anvil! project contributors.

REPORTING BUGS

Report bugs to users@clusterlabs.org

Any questions, feedback, advice, complaints or meanderings are welcome.
`Alteeve's Niche!`	`Enterprise Support: Alteeve Support`	`Community Support`
© Alteeve's Niche! Inc. 1997-2024		Anvil! "Intelligent Availability®" Platform
`legal stuff: All info is provided "As-Is". Do not use anything here unless you are willing and able to take responsibility for your own actions.`

@@ Line 11: / Line 11: @@
 = DESCRIPTION =
-This program uses 'iperf' to determine the real world network performance between this host and a target over a given network. This uses unfragmentable pings to detect the maximum usable MTU, and then repeatedly tests the performance, incrementing the MTU by a set amount between each tests. In this way, the optimal MTU is also found.
+This program uses 'iperf' to determine the real world network performance between this host and a target over a given network. This uses unfragmentable pings to detect the maximum usable [[MTU]], and then repeatedly tests the performance, incrementing the MTU by a set amount between each test. In this way, the optimal MTU is also found.
 ; '''Warning!'''
@@ Line 30: / Line 30: @@
 : This option sets a limit of the maximum MTU that will be used, bypassing max MTU size auto detection.
 ; '''--password''' &lt;string&gt;
-: If passwordless SSH is not configured with the target host, then specify the root user password used to ssh into the target. This is needed to alter the MTU and setup iperf.
+: If passwordless SSH is not configured with the target host, then specify the root user password used to ssh into the target. This is needed to alter the MTU and setup <span class="code">[[iperf]]</span>.
 ; '''--stepping''' &lt;bytes&gt;
 : By default, the MTU is incremented by 500 bytes between tests. If you want to use a different stepping, specify the number of bytes to increment between tests with this switch.
 ; '''--source''' &lt;ip address&gt;
-: This is the local IP address that will be used during the test. The interface with this IP address will have it's MTU size manipulated during the test.
+: This is the local IP address that will be used during the test. The interface with this IP address will have its MTU size manipulated during the test.
 ; '''--target''' &lt;ip address&gt;
-: This is the IP address on the peer that will be used to connect to the target. The interface with this IP on the peer will have it's MTU size adjusted during the test.
+: This is the IP address on the peer that will be used to connect to the target. The interface with this IP on the peer will have its MTU size adjusted during the test.
 ; '''--tests''' &lt;number&gt;
 : By default, each tested MTU will be run three times and the results will be averaged. If you want to change the number of tests run per MTU size, use this switch.

Anvil-network-profiler: Difference between revisions