Packet Sniffer Scheduler

The following functions are only available to a root customer user.

dumpIPTraffic()


Parameters:

  • email - email address to be informed of the process status. Valid email. String. Required.
  • target_hosts - target hosts to dump ip traffic for, for exmaple 1.2.3.4 or www.google.com. Array of Strings. Required.
  • period - duration of dump in minutes. value between 1 and 60. Integer. Required.
  • interface - interface for traffic capture. In case of hosted platform there are two options, either dump initiated by root environment or hosted environment. For root environment any interface may be used (for example em0, igb1). For hosted environments only corresponding interface may be used in union with its assigned ip address, for example em0:1.2.3.4. String. Required.


Returned values:

  • result - OK means that new traffic dump task was added successfully. String.
  • i_ip_traffic_dump - Id of added packet dump task. Integer.


  • XMLRPC fault in case of any error.

dumpIPTrafficStatus()


Parameters:

  • i_ip_traffic_dump - ID of the packet dump process. Integer. Required.


Returned values:

  • result - OK means that request finished at no errors. String.
  • status - the current status of the packet dump. 'pending' means that the packet has not yet started. 'in_progress' means that the packet dump is currently in progress. 'timed_out' signals that the operation failed for some reason. String.
  • url - in case of successful capture the URL to the packet dump file is returned. String.


  • XMLRPC fault in case of any error.