host_net_test(1)
NAME
host_net_test - Do the net performance tests at the current host
SYNOPSIS
host_net_test |
[Option [...]] [NetperfOption [...]]
Host [...] |
DESCRIPTION
The script host_net_test does the net performance tests at this host
and print the results to Standard Output and Standard Error.
This script is typically called from a remote, controlling host which handles
the net performance measurements by running the script
net_test(1).
The following values are returned in the output streams:
- The load value of this host, to be obtained with
uptime(1).
- The round-trip values from this host to the hosts specified in the
argument vector, to be obtained with ping(8).
- The throughput values from this host to the hosts specified in the
argument vector, to be obtained with netperf(1).
- Various UDP bandwidth values from this host to the hosts specified
in the argument vector to be obtained by the udpmon_bw_mon
program from the UDPmon
package written by R.E. Hughes-Jones, the University of Manchester. The
following value types are listed:
- The receive data rate in [Mbit/s].
- The percentage frames lost.
The format of the Host arguments is as follows:
InetHost/QoSHost/HostTitle/NetperfPort/UDPBWPort
with:
- InetHost
- The hostname or the IP address for the usual route via the
Internet.
- QoSHost
- The hostname or the IP address for the Quality-of-Service route, when
such a route exists; if not: this field is ignored but should be
defined.
- HostTitle
- The title of the host used in the Web tables.
- NetperfPort
- The port to be used by netperf(1) for remote throughput
measurements to the remote host. When the port is less than zero the test
will be skipped.
- UDPBWPort
- The port to be used by udpmon_bw_mon for remote UDP
bandwidth measurements to the remote host. When the port is less than zero
the test will be skipped.
The order of the measurements is as follows:
- An uptime measurement of the current host.
- The round-trip measurements from the current host to the
specified hosts. All commands are started simultaneously.
- The throughput measurements from the current host to the
specified hosts. The commands are started one by one.
- The UDP bandwidth measurements from the current host to the
specified hosts. The commands are started one by one.
Options and arguments may also be specified with the resource file
$HOME/.host_net_test_rsc.
Resource file options and arguments are read before the options and arguments
from the argument vector.
Besides the usual ping(8) command, used for the round-trip
values, also the
"Nikhef" ping program can be used.
To be able to use this command it must be installed in
/usr/local/etc/ping
and the resource file
$HOME/.host_net_test_rsc
should contain the line
-ping nikhef
See also the OPTIONS section below.
OPTIONS
The following options may be specified:
- -ping PingType
- Set the ping type to use.
The following ping types can be selected:
- arch
- The ping command depends from the host architecture.
This is the default.
- nikhef
- Use the
"Nikhef" ping command.
See also the DESCRIPTION section above.
- -accept PingAccept [%]
- Set the count percentage of pings to be accepted after package lost.
The default is 80 %.
- -count PingCount
- Set the # ping measurements to be done.
The default is 3.
- -skip SkipPing
- Set the initial # ping values to skip.
The default is 1.
- -packet_size PingPacketSize [bytes]
- Set the ping packet size.
The default is 56 bytes.
- -udp_packet_size UDPPacketSize [bytes]
- Set the packet size of the UDP bandwidth tests. The default is
1400 bytes.
- -udp_nr_packets UDPNrPackets
- Set the # packets of the UDP bandwidth tests. The default
is 300.
- -udp_wait_time UDPWaitTime [micros]
- Set the wait time between sending packets in the UDP bandwidth tests. The
default is 80 micros.
- -udp_data_rate_bnd
UDPRecvDataRateBound [Mbit/s]
- Define an upper boundary for the UDP bandwidth receive data rate. Sometimes
an unrealistic high value is calculated for it. Receive data rate values are
skipped when they are larger than this boundary. No boundary is used when
the specified value is smaller than zero. The default is
1200 Mbit/s.
- -no_QoS
- Do no Quality-of-Service tests.
The default is to do QoS tests.
- -ip_qos QoSHost/IPQoSGateway
- Specify the IP address of the gateway which belongs to the
Quality-of-Service host.
This option may be multiple defined.
- -ip_inet InetHost/IPInetGateway
- Specify the IP address of the gateway which belongs to the usual Internet
host InetHost.
This option may be multiple defined.
- -test
- Print some extra information to Standard Error.
Also netperf(1) options can be specified.
See the corresponding man pages and other documentation.
DOCUMENTATION
- http://www.hep.man.ac.uk/~rich/net/
- This URL contains information about the UDPmon package, used in
this script.
SEE ALSO
net_test(1),
netperf(1),
ping(8),
uptime(1)