Show Menu

perfSONAR pScheduler Cheat Sheet by

Command Reference for perfSONAR's pScheduler

Essential Inform­ation

pScheduler and this cheat sheet are a work in progress.

Guide to Symbols

Something in develo­pment or used for develo­pment and debug purposes
Required argument or parameter

Basic Command Structure

All pScheduler commands follow the same format:
psche­duler COMMAND [ ARGUMENTS ]

An alias, psc is provided for conven­ience:

Argument Types

An ISO 8601 duration (e.g., PT1H30M or P3D). Months and years are not supported.
The DNS name or IP address of a host
A number, usually positive.
An ISO 8601 timestamp (e.g., 2016-­05-­04T­12:­34:­56-­04:00)

pScheduler Commands



Tells pScheduler to set up a task
--export - Export JSON for the task to the standard output and don't submit it for schedu­ling.
--format format - Output format for results. Valid formats are text, html, json and none. Default is text.
--import file - Import JSON for the task from file.
--quiet - Display nothing but results and errors.
--ref­erence json - Include the arbitrary blob of JSON json for the submit­ter's reference.
--tool tool - Force the tool tool to be used for the test. Repeat to allow a list of tools, preferred in the order specified.
--url - Print the URL for the task and exit.
Sche­duling TASK-O­PTI­ONS:
--max­-runs cardinal - Repeat the task up to the specified number of times. Requires --rep­eat.
--ran­dslip float - Randomize the start time by this fraction of the allowed slip. Must be in [0.0..1.0].
--repeat duration - Amount of time between runs.
--slip duration - Allow the start of any run to slip by the specified amount of time.
--start times­tamp - When the first run of the task should start.
--until times­tamp - Allow repeats to continue until the specified time. Requires --rep­eat.


psc watch URL
The watch command shows the results for runs of a task, identified by a URL, as they happen



latency - One-Way Network Traversal Time

This test is in develo­pment.

rtt - Round Trip Time Between Hosts

--count n - How many times the round-trip time should be tested
--dea­dline duration - Deadline for all measur­ements to finish
--dest host - The destin­ation host for the test
--flo­wlabel number - The flow label to be used on outgoing packets
--[no­-]h­ost­names - [Dis]able resolution of host names from IPs. Default is to resolve.
--int­erval duration - Time to wait between packets sent
--length number - Set the size of outgoing packets
--source host - Source address or interface
--tim­eout duration - How long to wait for each packet to return
--tos number - Set the IP type of service on outgoing packets
--ttl number - Set the time to live on outgoing packets

throughput - Available Bandwidth Between Hosts

This test is in develo­pment.

trace - Path Between Hosts

--alg­orithm - Use a specific algorithm for the trace. Valid value is paris­-tr­ace­route.
--[no­-]as - [Dis]able lookup of autonomous system numbers and owner inform­ation.
--des­t-port number - Port where packets will be sent when the probe type is udp or tcp.
--dest host - The far end of the trace
--fir­st-ttl number - Time to live on the first packet sent
--[no­-]f­rag­ment - [Dis]able fragme­ntation
--hops number - Maximum number of hops (largest TTL)
--[no­-]h­ost­names - [Dis]able resolution of host names from IPs. Default is to resolve.
--ip-­ver­sion number - Set the version of the IP protocol to be used. Valid values are 4 and 6.
--length number - Size of outgoing packets
--pro­be-­type t - Type of probes sent. Valid values are icmp, udp and tcp. Default is udp.
--que­ries number - Number of queries per hop. Default is 1.
--sen­dwait duration - Amount of time to wait between probes
--source host - Source address or host name
--tos number - IP type of service on outgoing packets
--wait duration - Wait time for probes to be returned

idle - Do Nothing Useful

--dur­ation duration - How long the test should do nothing
--host *host - The host which should be idle
--par­tin­g-c­omment text - Text to be logged at the end of the idle period
--sta­rti­ng-­com­ment text - Text to be logged at the start of the idle period
This test is intended for use in develo­pment and troubl­esh­ooting pSched­uler.

simple­stream - TCP Stream Between Hosts

--dest host - Receiving end of the stream
--dawdle duration - Maximum amount of time spent delaying before sending the test material
--fail proba­bility - Probab­ility that the test will be forced to fail
--tes­t-m­ate­rial text - String to be sent. Defaults to a message containing a timestamp.
--tim­eout duration - How long the receiving end should wait for the sending end before giving up
This test is intended for use in develo­pment and troubl­esh­ooting pSched­uler.


No comments yet. Add yours below!

Add a Comment

Your Comment

Please enter your name.

    Please enter your email address

      Please enter your Comment.