IEPM Web Services

IEPM Home Page IEPM Site Map Network Monitoring PingER IEPM Papers and Presentations

IEPM web services

The IEPM group is now providing access to some of its measurement data via Web Services.

There are 3 components to the SLAC IEPM Web services:

• the Network Measurement Working Group schemas, that define the interfaces to the services;
• the request that is sent to the server;
• the response that is recieved from the server.

We have implemented a SOAP server and an XMLRPC server. We will show how to make a request to each one of them.

Access to the measurement is also provided via a WSDL file IEPM.wsdl.

We have two SOAP web-based client that can be used to access (print or plot) measurements:

• IEPM measurement IEPM Web Services Client
• PINGER measurement PINGER Web Services Client

Note= we still support the previous IEPM schema. Reference to this can be found in here

To make a request to the SLAC web services you must follow the schema defined by the Network Measurement Working Group.
The schema can be found at:
NM-WG Request schema

There are 3 input quantities that you have to provide at request time:

• characteristic
  This indicates which network characteristic is requested.
• subject
  This indicates which end node or path the measurement refers to.
• timeInterval
  This is the time period in which the measurement(s) has been performed. Note, that in the current Request schema by the NM-WG this is not a required quantity: we enforce it for performance reasons.

Implemented characteristics

The following is the list of available characteristics:

Name	ToolName	Project
path.bandwidth.hoplist	traceroute	IEPM-BW
path.delay.roundTrip	ping	PingER
path.bandwidth.achievable.TCP	iperf	IEPM-BW
path.bandwidth.achievable.TCP.multiStream	iperf, bbftp, GridFTP	IEPM-BW
path.bandwidth.capacity	ABwE	IEPM-BW
path.bandwidth.utilization	ABwE	IEPM-BW

Request examples

We provide example code for SOAP and XMLRPC Perl clients.
We also provide example code for making a request with a SOAP Python client.

• SOAP Perl client
  

  #!/usr/local/bin/perl -w
  use SOAP::Lite;
  use Data::Dumper;
  my $startDate = "2004-06-01";
  my $endDate = "2004-06-04";
  my $destination = "node1.cacr.caltech.edu";
  my %request = 
  (
   characteristic => "path.bandwidth.achievable.TCP",
   subject => 
   { 
       path => 
       {
           destination => 
           {
               name => "$destination",
           },
       },
   },
   methodology => {
       tool => { name => "iperf",},
   },
   startTime => "$startDate",
   endTime   => "$endDate",
   );
  my $measurement = SOAP::Lite
      ->uri('NetworkMonWebServices')
      ->proxy('http://www-iepm.slac.stanford.edu/cgi-wrap/maggie.cgi')
      ->NetworkMeasurementRequest(\%request)
      ->result;
  print Dumper ($measurement);
  exit;
  

• XML-RPC Perl client

  #!/usr/local/bin/perl -w
  
  use XMLRPC::Lite;
  use Data::Dumper;
  
  my $startDate = "2004-06-01";
  my $endDate = "2004-06-04";
  my $destination = "node1.cacr.caltech.edu";
  
  
  my %request = 
  (
   characteristic => "path.bandwidth.achievable.TCP",
   subject => 
   { 
       path => 
       {
  	 destination => 
  	 {
  	     name => "$destination",
  	 },
       },
   },
   methodology => {
       tool => { name => "iperf",},
   },
   startTime => "$startDate",
   endTime   => "$endDate",
   );
  
  my $measurement = XMLRPC::Lite
      ->proxy('http://www-iepm.slac.stanford.edu/cgi-wrap/advisor.cgi')
      ->call('NetworkMonWebServices.NetworkMeasurementRequest',
  	   \%request)
      ->result;
  
  print Dumper ($measurement);
  exit;
  

• SOAP Python client
  Information on how to install SOAPy is provided in a separate page: SOAPy and Python Web Services.

  #!/usr/bin/python
   
  from SOAPpy import SOAPProxy
   
  request = {"characteristic": "path.bandwidth.achievable.TCP.multiStream",
             "subject": {"path":
                         {"destination":
                          {"name": "node1.cacr.caltech.edu"}}},
             "methodology" : {"tool":
                              {"name":"iperf",
                               "sourceCommandLine":{"arg":"8"}
                              }
                              },
             "startTime": "2004-08-01T00:00:00-5:00",
             "endTime": "2004-08-01T23:59:59-5:00"
  }
   
  service = SOAPProxy("http://www-iepm.slac.stanford.edu/cgi-wrap/maggie.cgi",
                      namespace="http://www-iepm.slac.stanford.edu/NetworkMonWebServices",
                      soapaction="http://www-iepm.slac.stanford.edu/NetworkMonWebServices#NetworkMe
  asurementRequest")
   
  result = service.NetworkMeasurementRequest(request)
   
  print "The characteristic returned is = ", result.networkMeasurementSet.networkMeasurement.charac
  teristic
  print "The destination node is = ", result.networkMeasurementSet.networkMeasurement.subject.path.
  destination.name
  print "The results are = " , result.networkMeasurementSet.networkMeasurement.results
  
  

The response provided by the SLAC IEPM Web Services follows the schema defined by the Network Measurement Working Group. The latest schema can be found here: NM-WG report schema

Any report will contain the following quantities:

• characteristic
  This is the requested characteristic.
• subject
  This is the end node or path to which the results apply.
• methodology
  This is the tool and the parameters used to obtain the results.
• results
  This is the list of results the satisfy the request criteria. Each individual result will specify the timestamp of the measurement and the quantity measured.

The Perl module Data::Dumper can help in reviewing the structure of the data returned. An example report will look like:

$VAR1 = {
          'networkMeasurementSet' => {
              'networkMeasurement' => {
                 'characteristic' => 'path.bandwidth.achievable.TCP',
                 'methodology' => {
                         'tool' => {
                               'versionString' => '',
                               'name' => 'iperf'
                                   }
                                 },
                 'subject' => {
                      'path' => {
                         'destination' => {
                                  'name' => 'node1.cacr.caltech.edu'
                                           },
                         'source' => {
                                  'name' => 'SLAC'
                                     }
                                }
                              },
                  'results' => {
                     'timeInterval' => {
                         'timestampEnd' => '1086393000',
                        'timestampStart' => '1086377400'
                                       },
                      'result0001' => {
                           'timeInterval' => {
                                'timestamp' => '1086378987'
                                             },
                           'achievableBandwidth' => '233.45'
                                      },
                      'result0002' => {
                           'timeInterval' => {
                                 'timestamp' => '1086384389'
                                             },
                           'achievableBandwidth' => '236.2'
                                       }
                                }
                       },
            'version' => 'http://www-didc.lbl.gov/NMWG/schemas/relax/report.html'
                  }
        };