com.quantum.dxi.rest.system

Class Analyzer

java.lang.Object

Base

com.quantum.dxi.rest.system.Analyzer

public class Analyzer
extends Base

The Analyzer resource allows to perform Network and Disk throughput analysis. The Analyzer resource includes services to perform analysis, get results of the latest analysis, and start/stop NetServer to use the system as a target for network analysis.

The schema that defines Throughput object is defined below.

 
    <xs:element name="Throughput">
        <xs:complexType>
            <xs:annotation>
                <xs:documentation>Throughput values are given in bytes per second.</xs:documentation>
            </xs:annotation>
            <xs:sequence>
                <xs:element name="ReadThroughput" type="xs:long" minOccurs="0"/>
                <xs:element name="WriteThroughput" type="xs:long" minOccurs="0"/>
                <xs:element name="NetworkThroughput" type="xs:long" minOccurs="0"/>
                <xs:element name="AnalyzerStatus" type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>The field is present when throughput values are not available
                                          - analysis is in progress or has failed.</xs:documentation>
                    </xs:annotation>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
Analyzer()

Method Summary

Modifier and Type	Method and Description
Throughput	getDiskThroughput(javax.servlet.http.HttpServletRequest request) GET /rest/Analyzer/diskThroughput
Throughput	getNetworkThroughput(javax.servlet.http.HttpServletRequest request) GET /rest/Analyzer/networkThroughput
BooleanScalarType	isNetServerRunning(javax.servlet.http.HttpServletRequest request) GET /rest/Analyzer/netServer
javax.ws.rs.core.Response	startNetServer(javax.servlet.http.HttpServletRequest request) POST /rest/Analyzer/netServer/start
javax.ws.rs.core.Response	stopNetServer(javax.servlet.http.HttpServletRequest request) POST /rest/Analyzer/netServer/stop
javax.ws.rs.core.Response	testDiskThroughput(javax.servlet.http.HttpServletRequest request) POST /rest/Analyzer/testDiskThroughput
javax.ws.rs.core.Response	testNetworkThroughput(javax.servlet.http.HttpServletRequest request, String ipAddress) POST /rest/Analyzer/testNetworkThroughput/{ipAddress}

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Analyzer

public Analyzer()

Method Detail

isNetServerRunning

public BooleanScalarType isNetServerRunning(@Context
                                            javax.servlet.http.HttpServletRequest request)

GET /rest/Analyzer/netServer

Get whether NetServer is running.

Response Entity type: <xs:element name="BooleanScalarType">

Since:

1.2

startNetServer

public javax.ws.rs.core.Response startNetServer(@Context
                                                javax.servlet.http.HttpServletRequest request)

POST /rest/Analyzer/netServer/start

Start NetServer. This allows to use the current system as a target for network throughput analysis, see testNetworkThroughput(HttpServletRequest, String)

Since:

1.2

stopNetServer

public javax.ws.rs.core.Response stopNetServer(@Context
                                               javax.servlet.http.HttpServletRequest request)

POST /rest/Analyzer/netServer/stop

Stop NetServer.

Since:

1.2

getDiskThroughput

public Throughput getDiskThroughput(@Context
                                    javax.servlet.http.HttpServletRequest request)

GET /rest/Analyzer/diskThroughput

Get results of the latest disk throughput analysis.

Response Entity type: <xs:element name="Throughput">

Since:

1.2

getNetworkThroughput

public Throughput getNetworkThroughput(@Context
                                       javax.servlet.http.HttpServletRequest request)

GET /rest/Analyzer/networkThroughput

Get results of the latest network throughput analysis.

Response Entity type: <xs:element name="Throughput">

Since:

1.2

testDiskThroughput

public javax.ws.rs.core.Response testDiskThroughput(@Context
                                                    javax.servlet.http.HttpServletRequest request)

POST /rest/Analyzer/testDiskThroughput

Start a background job to analyze disk throughput.

Response Entity type: <xs:element name="NumericScalarType">

Since:

1.2

testNetworkThroughput

public javax.ws.rs.core.Response testNetworkThroughput(@Context
                                                       javax.servlet.http.HttpServletRequest request,
                                                       String ipAddress)

POST /rest/Analyzer/testNetworkThroughput/{ipAddress}

Start a background job to analyze network throughput from this system to a target system specified by {ipAddress}. NetServer must be running on the target system to perform the analysis, see isNetServerRunning(HttpServletRequest).

Response Entity type: <xs:element name="NumericScalarType">

Since:

1.2