Raritan PX2/PX3 JSON-RPC API
Public Member Functions | Public Attributes | List of all members
net::Diagnostics Interface Reference

Diagnostics interface. More...

import"Diagnostics.idl";

Public Member Functions

int ping (in string hostName, in int count, out vector< string > results)
 Ping a network host (send out ICMP echo requests) More...
 
int traceRoute (in string hostName, in int timeout, in boolean useIcmp, out vector< string > results)
 Get the route packet trace to a network host. More...
 
int listTcpConnections (out vector< string > results)
 List the currently active TCP connections (netstat -ta) (lists both listening as well as established connections) More...
 

Public Attributes

constant int NO_ERROR = 0
 No error.
 
constant int ERR_INVALID_PARAM = 1
 Invalid parameters.
 
constant int ERR_EXEC_FAIL = 2
 Error during execution.
 
constant int ERR_TIMEOUT = 3
 Timeout.
 
constant int ERR_RESOLVE_FAIL = 4
 Name resolution failure.
 

Detailed Description

Diagnostics interface.

Member Function Documentation

int net::Diagnostics::listTcpConnections ( out vector< string >  results)

List the currently active TCP connections (netstat -ta) (lists both listening as well as established connections)

Returns
NO_ERROR if netstat was successful
ERR_EXEC_FAIL if there was an error during netstat execution
int net::Diagnostics::ping ( in string  hostName,
in int  count,
out vector< string >  results 
)

Ping a network host (send out ICMP echo requests)

Parameters
hostNamehost that should be pinged
countnumber of echo requests that should be sent (up to 20)
resultsoutput of the ping command
Returns
NO_ERROR if ping command was successful
ERR_INVALID_PARAM if any parameters were invalid
ERR_EXEC_FAIL if there was an error during ping execution
ERR_RESOLVE_FAIL if the host name could not be resolved
int net::Diagnostics::traceRoute ( in string  hostName,
in int  timeout,
in boolean  useIcmp,
out vector< string >  results 
)

Get the route packet trace to a network host.

Parameters
hostNamedestination host to track
timeoutTimeout (in seconds) to wait for traceroute results (up to 900)
useIcmpuse ICMP packets instead of UDP packets
resultstrace output
Returns
NO_ERROR if traceroute was successful
ERR_INVALID_PARAM if any parameters were invalid
ERR_EXEC_FAIL if there was an error during traceroute execution
ERR_TIMEOUT if traceroute didn't finish before timeout elapsed
ERR_RESOLVE_FAIL if the host name could not be resolved

The documentation for this interface was generated from the following file: