Regular Testing Configuration File¶

The regular testing configuration file is used to define the schedule of measurements that your host will run and the location(s) where the results of those tests will be stored. In general you will not need to edit this file by hand. Most configurations use either the central mesh configuration software (often referred to as MeshConfig) or the the perfSONAR Toolkit web interface to generate this file. Some cases where you may need to edit this file by hand are as follows (this is not an exhaustive list):

You are running only a small number of non-Toolkit measurement hosts and have no central mesh defined.
You would like to set parameters not supported by the GUI or MeshConfig.
You need to change or set authentication tokens used to register to a measurement archive.
You want to use an alternative or additional measurement archive as opposed to the one defined by your default toolkit installation and/or in your central mesh configuration file

The basic structure of this file is as follows:

A set of top-level directives that set values of general user and/or global defaults
The list of tests you want to run
The list of measurement archives where data should be stored.

With these items in mind the remainder of this section contains a full reference of the options available in the ref:regular testing configuration file <config_files-regtesting-conf-main>.

General Settings¶

added_by_mesh Directive¶

Description:	If set to 1, indicates the parent element was added by the MeshConfig software. This means the MeshConfig software will change or remove the test as needed. If set to 0 (the default) then the MeshConfig will not change the parent element.
Syntax:	`added_by_mesh 0\|1`
Contexts:	measurement_archive,: ref:test <config_regular_testing-test>,
Occurrences:	Zero or One
Default:	0
Compatibility:	3.4 and later

default_parameters Directive¶

Description:	A set of parameters to assign to any test of the specified type where the provided parameters are not otherwise set. For valid parameters see the relevant type-specific test parameters section.
Syntax:	`<default_parameters>...</default_parameters>`
Contexts:	top level
Occurrences:	Zero or More
Default:	N/A
Compatibility:	3.4 and later

description Directive¶

Description:	A human-readable description of the parent directive. For display and identification purposes only.
Syntax:	`description DESCRIPTION`
Contexts:	measurement_archive, test, target
Occurrences:	Exactly One
Default:	N/A
Compatibility:	3.4 and later

measurement_archive Directive¶

Description:	Describes a measurement archive where results can be stored. See Measurement Archives for more details on the parameters that can be set in this block.
Syntax:	`<measurement_archive>...</measurement_archive>`
Contexts:	top level, test
Occurrences:	Zero or More
Default:	N/A
Compatibility:	3.4 and later

test_result_directory Directive¶

Description:	The directory where results are temporarily queued before being sent to the measurement archive(s)
Syntax:	`test_result_directory DIR`
Contexts:	top level
Occurrences:	Zero or One
Default:	/var/lib/perfsonar/regulartesting
Compatibility:	3.4 and later

test Directive¶

Description:	Describes a measurement to be performed. See Tests for more details on defining this block.
Syntax:	`<test>...</test>`
Contexts:	top level
Occurrences:	Zero or More
Default:	N/A
Compatibility:	3.4 and later

Measurement Archives¶

ca_certificate_file Directive¶

Description:	The location of a certificate authority’s (CA) certificate file that can be used to verify a server’s SSL certificate when using HTTPS.
Syntax:	`ca_certificate_file FILE`
Contexts:	measurement_archive
Occurrences:	Zero or One
Default:	N/A
Compatibility:	3.4 and later

ca_certificate_path Directive¶

Description:	The location of a directory containing one or more certificate authority (CA) certificate files that can be used to verify a server’s SSL certificate when using HTTPS.
Syntax:	`ca_certificate_path DIR`
Contexts:	measurement_archive
Occurrences:	Zero or One
Default:	N/A
Compatibility:	3.4 and later

database Directive¶

Description:	The URL of the measurement archive where results will be stored.
Syntax:	`database URL`
Contexts:	measurement_archive
Occurrences:	Exactly One
Default:	N/A
Compatibility:	3.4 and later

disable_default_summaries Directive¶

Description:	Disables a default set of summaries being used if no summary directives are provided.
Syntax:	`disable_default_summaries 0\|1`
Contexts:	measurement_archive
Occurrences:	Exactly One
Default:	0
Compatibility:	3.5 and later

max_parallelism Directive¶

Description:	The maximum number of processes to concurrently spawn dedicated to writing results to this measurement archive.
Syntax:	`max_parallelism NUMBER`
Contexts:	measurement_archive
Occurrences:	Exactly One
Default:	5
Compatibility:	3.4 and later

password Directive¶

Description:	The password or API key to use when authenticating to the measurement archive. If not set, then IP authentication or another means must be configured on the server.
Syntax:	`password PASSWD`
Contexts:	measurement_archive
Occurrences:	Zero or One
Default:	N/A
Compatibility:	3.4 and later

queue_directory Directive¶

Description:	The directory to keep results while they are in the queue to be written to the measurement archive.
Syntax:	`queue_directory DIR`
Contexts:	measurement_archive
Occurrences:	Zero or One
Default:	A subdirectory named with type and the host portion of database under the directory defined by test_results_directory
Compatibility:	3.4 and later

summary Directive¶

Description:	Describes a summarization you would like the measurement archive to perform on the data. See Measurement Archive Summaries for more information.
Syntax:	`<summary>...<summary>`
Contexts:	measurement_archive
Occurrences:	Zero or More
Default:	N/A
Compatibility:	3.4 and later

timeout Directive¶

Description:	The number of seconds to wait for the archive server to return a response when writing data.
Syntax:	`timeout SECONDS`
Contexts:	measurement_archive
Occurrences:	Zero or More
Default:	60
Compatibility:	3.4 and later

type Directive¶

Description:	The type of measurement archive.
Syntax:	`type esmond/latency\|esmond/throughput\|esmond/traceroute\|null`
Contexts:	measurement_archive
Occurrences:	Exactly One
Default:	N/A
Compatibility:	3.4 and later

The currently supported options for this value are:

esmond/latency - Stores OWAMP(powstream and bwping) and Ping results
esmond/throughput - Stores BWCTL results that use throughput tools like iperf and iperf3
esmond/raceroute - Stores traceroute (and similar tools such as tracepath and paris-traceroute) results as reported by bwtraceroute.
null - For testing only. Does not store results anywhere.

username Directive¶

Description:	The username to use when authenticating to a measurement archive. If not set, then it is assumed IP authentication or some other mechanism will be used to register data.
Syntax:	`username USER`
Contexts:	measurement_archive
Occurrences:	Zero or One
Default:	N/A
Compatibility:	3.4 and later

verify_hostname Directive¶

Description:	If using https, indicates whether the hostname should be matched against the common name in the server’s X.509 certificate.
Syntax:	`verify_hostname 0\|1`
Contexts:	measurement_archive
Occurrences:	Zero or One
Default:	0
Compatibility:	3.4 and later

Measurement Archive Summaries¶

event_type Directive¶

Description:	The event type to summarize. See the official event type list for valid values.
Syntax:	`event_type TYPE`
Contexts:	summary
Occurrences:	Exactly One
Default:	N/A
Compatibility:	3.4 and later

summary_type Directive¶

Description:	The type of summary. Valid values are aggregation, average and statistics though which of those is supported is dependent on the event type. See the API specification for full details
Syntax:	`summary_type TYPE`
Contexts:	summary
Occurrences:	Exactly One
Default:	N/A
Compatibility:	3.4 and later

summary_window Directive¶

Description:	The time in seconds over which the data should be summarized.
Syntax:	`summary_window SECONDS`
Contexts:	summary
Occurrences:	Exactly One
Default:	N/A
Compatibility:	3.4 and later

Tests¶

disabled Directive¶

Description:	If set to 1, then the enclosing test is not run
Syntax:	`disabled 0\|1`
Contexts:	test
Occurrences:	Zero or One
Default:	0
Compatibility:	3.4 and later

local_address Directive¶

Description:	The IP address or hostname to use as the local address for tests. This must map to an address on the host where regular_testing is running. Takes precedence over local_interface if both specified.
Syntax:	`local_address ADDRESS`
Contexts:	test
Occurrences:	Zero or One
Default:	The address on local_interface if set or the address on the outgoing interface as chosen by the local routing tables
Compatibility:	3.4 and later

local_interface Directive¶

Description:	The name of the interface where tests should be run. This must map to an interface name on the host where regular_testing is running. This is ignored in favor of local_address if both specified.
Syntax:	`local_interface IFNAME`
Contexts:	test
Occurrences:	Zero or One
Default:	The address set by local_address if set or the address on the outgoing interface as chosen by the local routing tables
Compatibility:	3.4 and later

parameters Directive¶

Description:	The parameters of the test. See General Test Parameters for details on common parameters and the type specific sections for tool-related values.
Syntax:	`<parameters>...</parameters>`
Contexts:	test
Occurrences:	Exactly One
Default:	N/A
Compatibility:	3.4 and later

schedule Directive¶

Description:	The schedule indicating how often the tests will run. See Test Schedules for more details on the options available.
Syntax:	`<schedule>...</schedule>`
Contexts:	test
Occurrences:	Exactly One
Default:	N/A
Compatibility:	3.4 and later

target Directive¶

Syntax (Simple):
Description:	The remote location to and from which tests should be performed. The syntax for this directive can take a simple form where it is given just an address and a complex form where a block is provided that allows parameters to be overwritten to just the target address. See Test Targets for more details on the complex form.
	`target ADDRESS`
Syntax (Complex):
	`<target>...</target>`
Contexts:	test
Occurrences:	Zero or More
Default:	N/A
Compatibility:	3.4 and later

Test Targets¶

address Directive¶

Description:	The IP address or hostname of the target with which to perform a test.
Syntax:	`address ADDRESS`
Contexts:	target
Occurrences:	Exactly One
Default:	N/A
Compatibility:	3.4 and later

override_parameters Directive¶

Description:	A set of parameters to use only to this target. It will override any parameters of the same type already set. See General Test Parameters and the test-specific parameter sections for a list of valid options.
Syntax:	`<override_parameters>...</override_parameters>`
Contexts:	target
Occurrences:	Zero or One
Default:	N/A
Compatibility:	3.4 and later

Test Schedules¶

interval Directive¶

Description:	The number of seconds to wait in between tests to the same target.
Syntax:	`interval SECONDS`
Contexts:	schedule where type is regular_intervals
Occurrences:	Exactly One
Default:	N/A
Compatibility:	3.4 and later

random_start_percentage Directive¶

Description:	The percentage of variation between intervals of a test. Specified as a number between 0 and 50 (inclusive).
Syntax:	`random_start_percentage PERCENTAGE`
Contexts:	schedule where type is regular_intervals
Occurrences:	Zero or One
Default:	Tool default
Compatibility:	3.4 and later

time_slot Directive¶

Description:	A list of specific times at which to run a test. Can be specified as `HH:MM` or `:MM` where `` indicates that the test should be run every hour. Only compatible with tools that support timed scheduling and actual runtime with respect to the time defined may vary depending on the tool. You can specify multiple times.
Syntax:	`time_slot HH:MM\|*:MM`
Contexts:	schedule where type is time_schedule
Occurrences:	One or More
Default:	Tool default
Compatibility:	3.4 and later

type Directive¶

Description:	The type of schedule. See below for valid options. Certain tests only support certain schedules.
Syntax:	`type TYPE`
Contexts:	schedule
Occurrences:	Exactly one
Default:	N/A
Compatibility:	3.4 and later

Valid types include:

regular_intervals - Runs a test a specified number of seconds apart (see interval Directive) with an optional variation (see random_start_percentage Directive).
streaming - Constantly runs test.
time_schedule - Runs a test at an explicitly set sequence of times (see time_slot Directive)

General Test Parameters¶

control_address Directive¶

Description:	The IP address of the interface out which you want BWCTL control messages sent. Use this if you want to send control messages over a separate interface than the data packets. You will most likely do this for firewall reasons.
Syntax:	`control_address ADDRESS`
Contexts:	parameters, override_parameters, default_parameters where type is one of the bwctl, bwping, bwping/owamp, bwtraceroute
Occurrences:	Zero or One
Default:	Uses local routing table
Compatibility:	3.5.1 and later

force_ipv4 Directive¶

Description:	Forces the test to use IPv4.
Syntax:	`force_ipv4 0\|1`
Contexts:	parameters, override_parameters, default_parameters
Occurrences:	Zero or One
Default:	0
Compatibility:	3.4 and later

force_ipv6 Directive¶

Description:	Forces the test to use IPv6.
Syntax:	`force_ipv6 0\|1`
Contexts:	parameters, override_parameters, default_parameters
Occurrences:	Zero or One
Default:	0
Compatibility:	3.4 and later

latest_time Directive¶

Description:	The number of seconds in the future a test may be scheduled before being considered failed. Corresponds to the various bwctl or bwctl2 tools -L option.
Syntax:	`latest_time SECONDS`
Contexts:	parameters, override_parameters, default_parameters where type is one of the bwctl, bwctl2, bwping, bwping2, bwping/owamp, bwping2/owamp, bwtraceroute, bwtraceroute2
Occurrences:	Zero or One
Default:	Tool default
Compatibility:	3.4 and later

local_firewall Directive¶

Description:	Indicates the local host is behind a NAT or firewall so the connection initiator should always be the local host to prevent incoming connections that will get blocked. Corresponds to the bwctl or bwctl2 tools -o option.
Syntax:	`local_firewall 0\|1`
Contexts:	parameters, override_parameters, default_parameters where type is one of the bwctl, bwctl2, bwping, bwping2, bwping/owamp, bwping2/owamp, bwtraceroute, bwtraceroute2
Occurrences:	Zero or One
Default:	Tool default
Compatibility:	3.4 and later

packet_tos_bits Directive¶

Description:	The TOS bits to set in the IP header as an integer. Corresponds to BWCTL -S option.
Syntax:	`packet_tos_bits TOS`
Contexts:	parameters, override_parameters, default_parameters where type is bwctl, bwctl2, bwping, bwping2, bwtraceroute, bwtraceroute2
Occurrences:	Zero or One
Default:	N/A
Compatibility:	3.4 and later

receive_only Directive¶

Description:	Indicates that tests should only be run in the direction where the local host is the receiver and the target host is the sender.
Syntax:	`receive_only 0\|1`
Contexts:	parameters, override_parameters, default_parameters
Occurrences:	Zero or One
Default:	0
Compatibility:	3.4 and later

send_only Directive¶

Description:	Indicates that tests should only be run in the direction where the local host is the sender and the target host is the receiver.
Syntax:	`send_only 0\|1`
Contexts:	parameters, override_parameters, default_parameters
Occurrences:	Zero or One
Default:	0
Compatibility:	3.4 and later

test_ipv4_ipv6 Directive¶

Description:	Indicates both an IPv4 and IPv6 test should be performed.
Syntax:	`test_ipv4_ipv6 0\|1`
Contexts:	parameters, override_parameters, default_parameters
Occurrences:	Zero or One
Default:	0
Compatibility:	3.4 and later

type Directive¶

Description:	The type of test to run. Determines the set of supported directives in the rest of this block. See below for more details.
Syntax:	`type TYPE`
Contexts:	parameters, override_parameters, default_parameters
Occurrences:	Exactly one
Default:	N/A
Compatibility:	3.4 and later

Valid types include:

bwctl - Runs a BWCTL throughput test. See for bwctl Test Parameters for supported parameters specific to this type.
bwctl2 - WARNING: BETA ONLY. Runs a BWCTL2 throughput test. See bwctl Test Parameters for supported parameters specific to this type.
bwping - Runs a scheduled ping test using bwping. See bwping Test Parameters for supported parameters specific to this type.
bwping2 - WARNING: BETA ONLY. Runs a scheduled ping test using bwping2. See bwping Test Parameters for supported parameters specific to this type.
bwping/owamp - Runs a scheduled OWAMP test using bwping. See bwping Test Parameters for supported parameters specific to this type.
bwping2/owamp - WARNING: BETA ONLY. Runs a scheduled OWAMP test using bwping2. See bwping Test Parameters for supported parameters specific to this type.
bwtraceroute - Runs a scheduled traceroute test using bwtraceroute. See bwtraceroute Test Parameters for supported parameters specific to this type.
bwtraceroute2 - WARNING: BETA ONLY. Runs a scheduled traceroute test using bwtraceroute2. See bwtraceroute Test Parameters for supported parameters specific to this type.
powstream - Runs a streaming OWAMP test using the powstream tool. See powstream Test Parameters for supported parameters specific to this type.

bwctl Test Parameters¶

buffer_length Directive¶

Description:	The length of read/write buffers in bytes. Corresponds to the BWCTL -l option.
Syntax:	`buffer_length BYTES`
Contexts:	parameters, override_parameters, default_parameters where type is bwctl or bwctl2
Occurrences:	Zero or One
Default:	N/A
Compatibility:	3.4 and later

bwctl_cmd Directive¶

Description:	The path to the bwctl command to run
Syntax:	`bwctl_cmd CMD`
Contexts:	parameters, override_parameters, default_parameters where type is bwctl or bwctl2
Occurrences:	Zero or One
Default:	/usr/bin/bwctl for bwctl and /usr/bin/bwctl2 for bwctl2
Compatibility:	3.4 and later

duration Directive¶

Description:	The time in seconds to run the test. Corresponds to the BWCTL -t option.
Syntax:	`duration SECONDS`
Contexts:	parameters, override_parameters, default_parameters where type is bwctl or bwctl2
Occurrences:	Zero or One
Default:	10
Compatibility:	3.4 and later

omit_interval Directive¶

Description:	The number of seconds at the beginning of the test to ignore results. Useful for high-latency TCP transfers where throughput needs time to ramp-up. Note that this extends the time of the test the number of seconds specified. Corresponds to BWCTL -O option.
Syntax:	`omit_interval SECONDS`
Contexts:	parameters, override_parameters, default_parameters where type is bwctl or bwctl2 and tool is iperf3
Occurrences:	Zero or One
Default:	0
Compatibility:	3.4 and later

streams Directive¶

Description:	The number of parallel streams to run. Corresponds to BWCTL -P option.
Syntax:	`streams COUNT`
Contexts:	parameters, override_parameters, default_parameters where type is bwctl or bwctl2
Occurrences:	Zero or One
Default:	1
Compatibility:	3.4 and later

tool Directive¶

Description:	The tool to use when running the BWCTL test. Valid values are iperf and iperf3. Separating the tools by commas tells BWCTL to try the first tool in the list and fallback in sequence to the remaining tools in the list until it finds one both endpoints have in common. Corresponds to the BWCTL -T option.
Syntax:	`tool TOOL`
Contexts:	parameters, override_parameters, default_parameters where type is bwctl or bwctl2
Occurrences:	Zero or One
Default:	iperf
Compatibility:	3.4 and later

udp_bandwidth Directive¶

Description:	For UDP tests, the rate at which to send packets in bits per second (bps). Corresponds to BWCTL -b option.
Syntax:	`udp_bandwidth BITSPERSECOND`
Contexts:	parameters, override_parameters, default_parameters where type is bwctl or bwctl2 AND use_udp is 1
Occurrences:	Zero or One
Default:	Tool default
Compatibility:	3.4 and later

use_udp Directive¶

Description:	Indicates whether this is a UDP test. Corresponds to BWCTL -u option.
Syntax:	`use_udp 0\|1`
Contexts:	parameters, override_parameters, default_parameters where type is bwctl or bwctl2
Occurrences:	Zero or One
Default:	0
Compatibility:	3.4 and later

window_size Directive¶

Description:	The TCP window size. Corresponds to BWCTL -w option.
Syntax:	`window_size BYTES`
Contexts:	parameters, override_parameters, default_parameters where type is bwctl or bwctl2
Occurrences:	Zero or One
Default:	N/A
Compatibility:	3.4 and later

bwping Test Parameters¶

bwping_cmd Directive¶

Description:	The location of the bwping command
Syntax:	`bwping_cmd CMD`
Contexts:	parameters, override_parameters, default_parameters where type is bwping, bwping2, bwping/owamp or bwping2/owamp
Occurrences:	Zero or One
Default:	/usr/bin/bwping for bwping and bwping/owamp. /usr/bin/bwping2 for bwping2 and bwping2/owamp
Compatibility:	3.4 and later

inter_packet_time Directive¶

Description:	The time in seconds to wait in between packets. Corresponds to the bwping -i option.
Syntax:	`inter_packet_time SECONDS`
Contexts:	parameters, override_parameters, default_parameters where type is bwping, bwping2, bwping/owamp or bwping2/owamp
Occurrences:	Zero or One
Default:	1.0
Compatibility:	3.4 and later

packet_count Directive¶

Description:	The number of packets to send. Corresponds to the bwping -N option.
Syntax:	`packet_count COUNT`
Contexts:	parameters, override_parameters, default_parameters where type is bwping, bwping2, bwping/owamp or bwping2/owamp
Occurrences:	Zero or One
Default:	10
Compatibility:	3.4 and later

packet_length Directive¶

Description:	The size in bytes of packets to send. Corresponds to the bwping -l option.
Syntax:	`packet_length BYTES`
Contexts:	parameters, override_parameters, default_parameters where type is bwping, bwping2, bwping/owamp or bwping2/owamp
Occurrences:	Zero or One
Default:	1000
Compatibility:	3.4 and later

packet_ttl Directive¶

Description:	The maximum number of hops a packet may traverse before being dropped. Corresponds to the bwping -t option.
Syntax:	`packet_ttl TTL`
Contexts:	parameters, override_parameters, default_parameters where type is bwping, bwping2, bwping/owamp or bwping2/owamp
Occurrences:	Zero or One
Default:	N/A
Compatibility:	3.4 and later

bwtraceroute Test Parameters¶

bwtraceroute_cmd Directive¶

Description:	The location of the bwtraceroute command
Syntax:	`bwtraceroute_cmd CMD`
Contexts:	parameters, override_parameters, default_parameters where type is bwtraceroute or bwtraceroute2
Occurrences:	Zero or One
Default:	/usr/bin/bwtraceroute for bwping and /usr/bin/bwtraceroute2 for bwtraceroute2
Compatibility:	3.4 and later

packet_first_ttl Directive¶

Description:	Only compatible when tool is traceroute. The first hop to display (starting at 1) of the traceroute. Corresponds to the bwtraceroute -F option.
Syntax:	`tool TOOL`
Contexts:	parameters, override_parameters, default_parameters where type is bwtraceroute or bwtraceroute2 and tool is traceroute
Occurrences:	Zero or One
Default:	Tool default
Compatibility:	3.4 and later

packet_length Directive¶

Description:	The size of the packets to send in bytes. Corresponds to the bwtraceroute -l option.
Syntax:	`tool BYTES`
Contexts:	parameters, override_parameters, default_parameters where type is bwtraceroute or bwtraceroute2
Occurrences:	Zero or One
Default:	Tool default
Compatibility:	3.4 and later

packet_max_ttl Directive¶

Description:	Only compatible when tool is traceroute. The maximum number of hops traceroute will try before reaching the destination. Corresponds to the bwtraceroute -M option.
Syntax:	`tool TOOL`
Contexts:	parameters, override_parameters, default_parameters where type is bwtraceroute or bwtraceroute2 and tool is traceroute
Occurrences:	Zero or One
Default:	Tool default
Compatibility:	3.4 and later

tool Directive¶

Description:	The tool to use when running the bwtraceroute test. Valid values are traceroute, tracepath and paris-traceroute. Separating the tools by commas tells BWCTL to try the first tool in the list and fallback in sequence to the remaining tools in the list until it finds one both endpoints have in common. Corresponds to the bwtraceroute -T option.
Syntax:	`tool TOOL`
Contexts:	parameters, override_parameters, default_parameters where type is bwtraceroute or bwtraceroute2
Occurrences:	Zero or One
Default:	tracepath,traceroute
Compatibility:	3.4 and later

powstream Test Parameters¶

inter_packet_time Directive¶

Description:	The number of seconds in between sending packets. Note that this may be a floating-point number less than 1 to send multiple packets per second. Corresponds to powstream -i option.
Syntax:	`inter_packet_time SECONDS`
Contexts:	parameters, override_parameters, default_parameters where type is powstream
Occurrences:	Zero or One
Default:	.1
Compatibility:	3.4 and later

log_level Directive¶

Description:	Controls the number and detail of messages sent to syslog. Keeping this reasonable is especially important when using a central syslog server as not to flood the server with requests. Corresponds to powstream -g option.
Syntax:	`log_level FATAL\|WARN\|INFO\|DEBUG\|ALL\|NONE`
Contexts:	parameters, override_parameters, default_parameters where type is powstream
Occurrences:	Zero or One
Default:	Tool default
Compatibility:	3.4 and later

owstats_cmd Directive¶

Description:	The location of the owstats command
Syntax:	`owstats_cmd CMD`
Contexts:	parameters, override_parameters, default_parameters where type is powstream
Occurrences:	Zero or One
Default:	/usr/bin/owstats
Compatibility:	3.4 and later

packet_length Directive¶

Description:	The size in bytes to add to the packet payload. Corresponds to powstream -s option.
Syntax:	`packet_length BYTES`
Contexts:	parameters, override_parameters, default_parameters where type is powstream
Occurrences:	Zero or One
Default:	0
Compatibility:	3.4 and later

powstream_cmd Directive¶

Description:	The location of the powstream command
Syntax:	`powstream_cmd CMD`
Contexts:	parameters, override_parameters, default_parameters where type is powstream
Occurrences:	Zero or One
Default:	/usr/bin/powstream
Compatibility:	3.4 and later

receive_port_range Directive¶

Description:	The range of ports to use for receiving UDP data packets used to perform OWAMP measurements. Note that powstream does not talk to the local OWAMPD instance, so this needs to be set separately from the corresponding value in OWAMP server configuration. Corresponds to powstream -P option.
Syntax:	`receive_port_range RANGE`
Contexts:	parameters, override_parameters, default_parameters where type is powstream
Occurrences:	Zero or One
Default:	N/A
Compatibility:	3.4 and later

resolution Directive¶

Description:	The number of seconds to run a test before reporting results.
Syntax:	`resolution SECONDS`
Contexts:	parameters, override_parameters, default_parameters where type is powstream
Occurrences:	Zero or One
Default:	60
Compatibility:	3.4 and later

Navigation

Regular Testing Configuration File¶

General Settings¶

added_by_mesh Directive¶

default_parameters Directive¶

description Directive¶

measurement_archive Directive¶

test_result_directory Directive¶

test Directive¶

Measurement Archives¶

ca_certificate_file Directive¶

ca_certificate_path Directive¶

database Directive¶

disable_default_summaries Directive¶

max_parallelism Directive¶

password Directive¶

queue_directory Directive¶

summary Directive¶

timeout Directive¶

type Directive¶

username Directive¶

verify_hostname Directive¶

Measurement Archive Summaries¶

event_type Directive¶

summary_type Directive¶

summary_window Directive¶

Tests¶

disabled Directive¶

local_address Directive¶

local_interface Directive¶

parameters Directive¶

schedule Directive¶

target Directive¶

Test Targets¶

address Directive¶

override_parameters Directive¶

Test Schedules¶

interval Directive¶

random_start_percentage Directive¶

time_slot Directive¶

type Directive¶

General Test Parameters¶

control_address Directive¶

force_ipv4 Directive¶

force_ipv6 Directive¶

latest_time Directive¶

local_firewall Directive¶

packet_tos_bits Directive¶

receive_only Directive¶

send_only Directive¶

test_ipv4_ipv6 Directive¶

type Directive¶

bwctl Test Parameters¶

buffer_length Directive¶

bwctl_cmd Directive¶

duration Directive¶

omit_interval Directive¶

streams Directive¶

tool Directive¶

udp_bandwidth Directive¶

use_udp Directive¶

window_size Directive¶

bwping Test Parameters¶

bwping_cmd Directive¶

inter_packet_time Directive¶

packet_count Directive¶

packet_length Directive¶

packet_ttl Directive¶

bwtraceroute Test Parameters¶

bwtraceroute_cmd Directive¶

packet_first_ttl Directive¶

packet_length Directive¶

packet_max_ttl Directive¶

tool Directive¶

powstream Test Parameters¶

inter_packet_time Directive¶

log_level Directive¶

owstats_cmd Directive¶

packet_length Directive¶

powstream_cmd Directive¶