net_test(1)

NAME

net_test - Do the net performance tests at the specified set of hosts

SYNOPSIS

net_test  [Option [...]] Host [...]

DESCRIPTION

The script net_test does the net performance tests at the specified set of hosts. At each host the measurements are executed via a remote shell which also delivers the results to this script. The tests are in general periodically repeated, using the crontab(1) command. The tests at the remote host are executed with the script host_net_test(1).

The following values are obtained from the remote host:

The network tests (round-trip, throughput and UDP bandwidth) between all host combinations can be done a-symmetric in one direction or bi-directional. One-directional is the default.

The net data are stored (in ZIP format) in the following type of data files:

The program netperf(1) is used to do the throughput measurements. This program requires that a server, netserver(8), is started at the at the other end of the line to test. Also before the tests are started it is checked at each host of the set if the server is running and at which communication port it runs. If not, it is started at the first available port. To be able do this, the script start_netserver(1) is started at each of the remote hosts from the set.

Comparably, the program udpmon_bw_mon from the UDPmon package is used to do the UDP bandwidth measurements. This program requires that a server, udpmon_resp, is started at the other end of the line to test. Also before the tests are started it is checked at each host of the set if the server is running and at which communication port it listens. If not, it is started at the first available port. To be able to do this, the script start_udpmon_resp(1) is started at each of the remote hosts from the set.

The format of the Host arguments is as follows:

InetHost/QoSHost/HostTitle/RemoteUser

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.

RemoteUser
The user which should be used to start a remote shell at the host Host.

OPTIONS

The following options may be specified:

-period Period [min.]
Set the measurement period in minutes. The default is 30 [min.].

-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.

-accept PingAccept [%]
Set the count percentage of pings to be accepted after package lost. The default is 80 %.

-packet_size PingPacketSize [bytes]
Set the ping packet size. The default is 56 bytes.

-no_udp_bw
Do not execute UDP bandwidth tests.

-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

-skip_qos_conn SrcHost DestHost
Skip the round-trip and throughput tests for the Quality-of-Service connection from SrcHost to DestHost. When one-directional tests are, or will be selected, also the reverse connection is skipped. The \fISrcHost\fP and \fIDestHost\fP arguments should be hostnames or IP addresses.

-skip_inet_conn SrcHost DestHost
Skip the round-trip and throughput tests for the "normal" Internet connection from SrcHost to DestHost. When one-directional tests are, or will be selected, also the reverse connection is skipped. The SrcHost and DestHost arguments should be hostnames or IP addresses. This option may be multiple specified.

-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.

-lines MaxNrLines
Set the maximum # lines to be stored in the data files for the several time values per individual measurement result. The default is 3.

-nr_weeks NrWeeks
Set the # weeks to store the data into weekly data history files. Each week will be stored in a separate file. The default is 3.

-week_mean_min_lines WeekMeanLines
Specify the minimum # lines that data must be obtained before these network data of a host will be added to the year covering week mean data file. The default is 1.

-nr_days NrDays
Set the # days to store the data of the days mean values. The default is 3.

-day_mean_min_lines DayMeanMinLines
Specify the minimum # lines that data must be obtained before these network data of a host will be added to the days mean. The default is 1.

-set_title HostsSetTitle
Set the title of the hosts set. Default it will be set to undefined: ***.

-data_root Path
Set the root directory of the data files. The default is the present working directory.

-rsh {RemoteShell, InetHost:RemoteShell}
Set the remote shell to use. In the right expression (or expression below) a remote shell for an individual host is specified. The "usual" Internet hostname should be given. This option may be multiple specified. The default is rsh(1) for all hosts.

-path InetHost:Path
Specify for an individual host the directory path where the net performance test scripts can be used. This option may be multiple specified. Default we rely at the shell startup files and no such paths are used.

-netserver_timeout NetserverTimeout [s]
Specify the timeout used by the start of the netserver at a specific host. The default is 300 [s].

-net_perf_timeout NetPerfTimeout [s]
Specify the timeout used to do the net performance test at a specific host. The default is 900 [s].

-test
Print some extra information to Standard Error.

-two_direct
Do the tests two-directional. The default is one-directional.

-no_QoS
There is no Quality-of-Service net available.

-QoS_title QoSTitle
Set the Quality-of-Service title. The default is QoS.

-Inet_title InetTitle
Set the title of the "usual" Internet route. It is only used in combination with QoS tests. The default is Inet.

DOCUMENTATION

http://www.hep.man.ac.uk/~rich/net/
This URL contains information about the UDPmon package, used in this script.

SEE ALSO

crontab(1), get_user_pids(1), host_net_test(1),, net_test_mean(1), netperf(1), netserver(8), rsh(1), start_netserver(1), start_udpmon_resp(1), zip(1)