com.quantum.dxi.rest.dxi

Class Reports

java.lang.Object

Base

com.quantum.dxi.rest.dxi.Reports

public class Reports
extends Base

The Reports resource provides interfaces for generating and retrieving various system reports. Reports are returned as zip files.

 Available reports are:
   System diagnostic collection
   Storage Array diagnostic collection (not avaialble on all systems)
   Replication report
 

Constructor Summary

Constructors

Constructor and Description
Reports()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	genArrayDiagLog(javax.servlet.http.HttpServletRequest request) POST /rest/Reports/genArrayDiagLog
javax.ws.rs.core.Response	genReplicationReport(javax.servlet.http.HttpServletRequest request, String target, long startTime, long endTime) POST /rest/Reports/genReplication
javax.ws.rs.core.Response	genSystemDiagLog(javax.servlet.http.HttpServletRequest request) POST /rest/Reports/genSystemDiagLog
javax.ws.rs.core.Response	getArrayDiagLog(javax.servlet.http.HttpServletRequest request) GET /rest/Reports/arrayDiagLog
NumericScalarType	getLastArrayDiagTime(javax.servlet.http.HttpServletRequest request) GET /rest/Reports/arrayDiagLog/lastGen
NumericScalarType	getLastReplicationReportTime(javax.servlet.http.HttpServletRequest request) GET /rest/Reports/replication/lastGen
NumericScalarType	getLastSystemDiagTime(javax.servlet.http.HttpServletRequest request) GET /rest/Reports/systemDiagLog/lastGen
javax.ws.rs.core.Response	getReplicationReport(javax.servlet.http.HttpServletRequest request) GET /rest/Reports/replication
javax.ws.rs.core.Response	getSystemDiagLog(javax.servlet.http.HttpServletRequest request) GET /rest/Reports/systemDiagLog

Methods inherited from class java.lang.Object

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

Constructor Detail

Reports

public Reports()

Method Detail

genSystemDiagLog

public javax.ws.rs.core.Response genSystemDiagLog(@Context
                                                  javax.servlet.http.HttpServletRequest request)
                                           throws DaoException

POST /rest/Reports/genSystemDiagLog

Generate the system diagnostic file.

This is a long-running operation and runs as a background job. The response includes a Job Id that can be used to query the status of the job via the /rest/BackgroundJobs resource.

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

Throws:

DaoException

Since:

1.2

getSystemDiagLog

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

GET /rest/Reports/systemDiagLog

Retrieve the system diagnostic file collection.

Returns the diagnostic file collection as a zip file.

On success, the accept headers are overridden and the content-type will be set to application/vnd.quantum.dxi.rest.1.2+zip.

Response Entity type: Zip file

Since:

1.2

getLastSystemDiagTime

public NumericScalarType getLastSystemDiagTime(@Context
                                               javax.servlet.http.HttpServletRequest request)
                                        throws DaoException

GET /rest/Reports/systemDiagLog/lastGen

Retrieve the date and time the last system diagnostic file collection was generated.

Returns the time stamp of the latest diagnostic file collection.

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

Throws:

DaoException

Since:

1.2

genArrayDiagLog

public javax.ws.rs.core.Response genArrayDiagLog(@Context
                                                 javax.servlet.http.HttpServletRequest request)
                                          throws DaoException

POST /rest/Reports/genArrayDiagLog

Generate the storage array diagnostic file.
Storage array diagnostics are not supported on all systems.

This is a long-running operation and runs as a background job. The response includes a Job Id that can be used to query the status of the job via the /rest/BackgroundJobs resource.

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

Throws:

DaoException

Since:

1.2

getArrayDiagLog

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

GET /rest/Reports/arrayDiagLog

Retrieve the storage array diagnostic file collection.
Storage array diagnostics are not supported on all systems.

Returns the storage array collection as a zip file.

On success, the accept headers are overridden and the content-type will be set to application/vnd.quantum.dxi.rest.1.2+zip.

Response Entity type: Zip file

Since:

1.2

getLastArrayDiagTime

public NumericScalarType getLastArrayDiagTime(@Context
                                              javax.servlet.http.HttpServletRequest request)
                                       throws DaoException

GET /rest/Reports/arrayDiagLog/lastGen

Retrieve the date and time the last storage array diagnostic file collection was generated.
Storage array diagnostics are not supported on all systems.

Returns the time stamp of the latest diagnostic file collection.

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

Throws:

DaoException

Since:

1.2

genReplicationReport

public javax.ws.rs.core.Response genReplicationReport(@Context
                                                      javax.servlet.http.HttpServletRequest request,
                                                      String target,
                                                      long startTime,
                                                      long endTime)
                                               throws DaoException

POST /rest/Reports/genReplication

Generate the replication report file for all targets.

This can be a long-running operation and runs as a background job. The response includes a Job Id that can be used to query the status of the job via the /rest/BackgroundJobs resource.

The report can be limited to a specific target with an optional query parameter: target.
The time span of the collected report can be specified with optional query parameters: startTime and endTime.
The startTime and endTime are Unix epoch values.
If startTime is specified without endTime, all records from startTime to current are reported.
If endTime is specified without startTime, all records through endTime are reported.
If no data is found, the reports are created but empty.

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

Throws:

DaoException

Since:

1.2

getReplicationReport

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

GET /rest/Reports/replication

Retrieve the replication report file collection.

Returns the replication report collection as a zip file.

On success, the accept headers are overridden and the content-type will be set to application/vnd.quantum.dxi.rest.1.2+zip.

Response Entity type: Zip file

Since:

1.2

getLastReplicationReportTime

public NumericScalarType getLastReplicationReportTime(@Context
                                                      javax.servlet.http.HttpServletRequest request)
                                               throws DaoException

GET /rest/Reports/replication/lastGen

Retrieve the date and time the last replication report file collection was generated.

Returns the time stamp of the latest replication report file collection.

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

Throws:

DaoException

Since:

1.2