Introduction
============

There are the following configuration files for the amplet:

   cacert.pem  			(key generating system)
   client-cert.pem              (client)
   client-privkey.pem           (client)
   server-cert.pem        	(server ONLY)
   server-privkey.pem		(server ONLY)

are ssl keys and certificates.  See the file doc/certsandkeys for
documentation on their use.

   ampname			(client)

Stores the name of this amplet.

   collectors			(client)

Stores the names of the deata collector(s)

   nametable			(client)

Stores the mapping from amp name to IP address for all the sites that
measurements are made to.

   schedule			(client)

controls what regular test are run when.

ampname, collectors and nametable are straight forward and are
described by comments in the default files.  schedule is described
below.

Once you have configured the system run 

  xfer -d   and
  measured -d

on the clients and

  xferd -d

in the server(s)



SCHEDULE File Format
======== ==== ======

The schedule file is structured as: 

   
 amp-aarn,ipmp,D,0,0,60000
 amp-aarn,icmp,D,30,0,60000,-r
 amp-xyz,impulse,W,3600,3600,0

 Where the fields are:
  o  destination monitor
  o  test name
  o  repeat schedule,  H=hourly, D=daily,  W=weekly,  M=monthly  
  o  start time in milliseconds after start of the period
  o  end time in milliseconds after start time. 
  o  frequency to repeat measurement in milliseconds 0=no repeats
  o  Any fields after first 6 are parameters to the test command. 



For example, to schedule an ipmp (ping) test to amp-foo every 10
seconds, starting at midnight add the line:
  
   amp-foo,icmp,D,0,86400000,10000



Test Types and Parameters
==== ===== === ==========

The test types are 

  icmp       -ping test
  ipmp       -ipmp based ping test, also records path if 
	      USE_IPMP_INFO_EXCHANGE is TRUE.
  traceroute use a traceroute like technique to measure the current path
  pop3		 -pop3 throughput test         

other tests are relitively simple to add to the code.  Read: doc/add_test.

Some of the test support parameters.  They are listed here:

 o Most tests
   -p ms	perturb test starting time by specified no. of ms

 o icmp

   -s size  generate ICMP packet size bytes long
   -S size  line -s but ignores size range checking
   -r       create random sized packets upto 1480 bytes

 o ipmp

   -s size  generate ICMP packet size bytes long
   -r       create random sized packets upto 1480 bytes

 o tput

  The tests to perform are given to the client in a -t schedule
  parameter.  The schedule is formatted as a series of letter/size
  pairs separated by commas.  The letter determines the
  type of the test, the size the size of the test.  The letters are:
     s : bytes to send from the client to the server
     S : bytes to send from the server to the client
     t : ms to send from the client to the server
     T : ms to send from the server to the client
     p : ms to pause 

  The size may be either a single number or a pair of numbers
  separated by a : In the first case the number is the
  number of 1000 byte packets or the time the test should run for in
  ms.  In the latter case the first is the number of packets or
  duration and the second is the packet size

  E.G. s100,s1000:4096,p10000,S100,s1000:4096,P10000

  means do six tests.  the first from the client to the server of
  100,000 bytes in 1000 byte packets.  The second is 4,096,000 bytes
  in 4096 byte packets, the third a 10 second test from the client to
  the server using 1000 byte packets. Tests four to six are the same
  test, but from the server to the client.

  The packet size is mostly relevant for reporting statistics at the
  end of the test. TCP will normally repackage the writes tput
  does. Larger writes require less CPU time and may permit slightly
  higher total throughput if the bandwidth is high.

 o pop3
   -s server pop3 server to connect to
   -u user	 username to connect with
   -P pass	 password to connect with