com.quantum.dxi.rest.dxi

Class Dxi

java.lang.Object

Base

com.quantum.dxi.rest.dxi.Dxi

public class Dxi
extends Base

The Dxi resource represents the global properties of the system. The DXi resource includes services to get the system properties, and to perform high level actions such as shutdown and reboot.

The schema that defines the Dxi resource is defined below.

 
   <xs:simpleType name="DxiStateType">
       <xs:restriction base="xs:string">
           <xs:enumeration value="Normal"/>
           <xs:enumeration value="Warning"/>
           <xs:enumeration value="Attention"/>
           <xs:enumeration value="Error"/>
       </xs:restriction>
   </xs:simpleType>
   <xs:element name="Dxi">
       <xs:complexType>
           <xs:sequence>
               <xs:element name="AdvancedReportingURL" type="xs:string"/>
               <xs:element name="CompanyName" type="xs:string"/>
               <xs:element name="CompanyURL" type="xs:string"/>
               <xs:element name="ModelName" type="xs:string"/>
               <xs:element name="CompanyKey" type="xs:string"/>
               <xs:element name="BrandName" type="xs:string"/>
               <xs:element name="SerialNumber" type="xs:string"/>
               <xs:element name="SystemState" type="DxiStateType"/>
               <xs:element name="CauseOfState" type="xs:string"/>
               <xs:element name="LimitedMode">
                   <xs:simpleType>
                       <xs:restriction base="xs:string">
                           <xs:enumeration value="Normal"/>
                           <xs:enumeration value="FirmwareUpgrade"/>
                           <xs:enumeration value="BlockPoolVerify"/>
                           <xs:enumeration value="BlockPoolFatal"/>
                           <xs:enumeration value="SecureShred"/>
                           <xs:enumeration value="Unknown"/>
                       </xs:restriction>
                   </xs:simpleType>
               </xs:element>
               <xs:element name="BaseVersion" type="xs:string"/>
               <xs:element name="AppVersion" type="xs:string"/>
               <xs:element name="Uptime" type="xs:long"/>
               <xs:element name="GuiMode">
                   <xs:simpleType>
                       <xs:restriction base="xs:string">
                           <xs:enumeration value="Normal"/>
                           <xs:enumeration value="GettingStartedWelcome"/>
                           <xs:enumeration value="GettingStartedLicense"/>
                           <xs:enumeration value="GettingStartedNetwork"/>
                           <xs:enumeration value="GettingStartedDateTime"/>
                           <xs:enumeration value="ConfigurationWizard"/>
                           <xs:enumeration value=""/>
                       </xs:restriction>
                   </xs:simpleType>
               </xs:element>
               <xs:element name="DatapathState" type="DxiStateType"/>
               <xs:element name="DatapathStatus" type="xs:string"/>
               <xs:element name="DatapathDetails" type="xs:string"/>
           </xs:sequence>
       </xs:complexType>
   </xs:element>
   <xs:element name="FailedLoginCount">
       <xs:complexType>
           <xs:sequence>
               <xs:element name="UserCount" type="xs:int">
                   <xs:annotation>
                       <xs:documentation>Failed login attempts for the current user since the last successful login.</xs:documentation>
                   </xs:annotation>
               </xs:element>
               <xs:element name="TotalCount" type="xs:int">
                   <xs:annotation>
                       <xs:documentation>Failed login attempts for all users since the last successful login.</xs:documentation>
                   </xs:annotation>
               </xs:element>
           </xs:sequence>
       </xs:complexType>
   </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
Dxi()

Method Summary

Modifier and Type	Method and Description
void	callAction(javax.servlet.http.HttpServletRequest request, String actionString, InputStream is) Deprecated. As of 1.1 ?action=reboot replaced by reboot(HttpServletRequest) ?action=shutdown replaced by shutdown(HttpServletRequest) ?action=restartServicesFromDiagnosticMode replaced by restartServicesFromDiagnosticMode(HttpServletRequest) ?action=resetFailedLogins replaced by resetFailedLogins(HttpServletRequest)
com.quantum.dxi.dao.types.Dxi	getDxi(javax.servlet.http.HttpServletRequest request) GET /rest/Dxi
com.quantum.dxi.dao.types.FailedLoginCount	getFailedLoginCount(javax.servlet.http.HttpServletRequest request) GET /rest/Dxi/failedLoginCount
GuiAttributes	getGuiAttributes(javax.servlet.http.HttpServletRequest request) GET /rest/Dxi/guiAttributes
LogsForGui	getLogsForGui(javax.servlet.http.HttpServletRequest request) GET /rest/Dxi/logsForGui
BooleanScalarType	isRebootRequired(javax.servlet.http.HttpServletRequest request) GET /rest/Dxi/reboot
void	reboot(javax.servlet.http.HttpServletRequest request) POST /rest/Dxi/reboot
void	resetFailedLogins(javax.servlet.http.HttpServletRequest request) POST /rest/Dxi/resetFailedLogins
void	restartServicesFromDiagnosticMode(javax.servlet.http.HttpServletRequest request) POST /rest/Dxi/restartServicesFromDiagnosticMode
void	shutdown(javax.servlet.http.HttpServletRequest request) POST /rest/Dxi/shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

Dxi

public Dxi()

Method Detail

getDxi

public com.quantum.dxi.dao.types.Dxi getDxi(@Context
                                            javax.servlet.http.HttpServletRequest request)

GET /rest/Dxi

Get the global system properties.

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

isRebootRequired

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

GET /rest/Dxi/reboot

Returns true if a reboot is required.

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

Since:

1.2.5

reboot

public void reboot(@Context
                   javax.servlet.http.HttpServletRequest request)

POST /rest/Dxi/reboot

Reboot the system. The system will shut down and start back up without user intervention.

Since:

1.1

shutdown

public void shutdown(@Context
                     javax.servlet.http.HttpServletRequest request)

POST /rest/Dxi/shutdown

Shut down the system. The system will stay down until someone manually restarts it.

Since:

1.1

restartServicesFromDiagnosticMode

public void restartServicesFromDiagnosticMode(@Context
                                              javax.servlet.http.HttpServletRequest request)

POST /rest/Dxi/restartServicesFromDiagnosticMode

For a system in "Diagnostic Mode", restart all services in order to transition the system to normal operational mode.

Since:

1.1

resetFailedLogins

public void resetFailedLogins(@Context
                              javax.servlet.http.HttpServletRequest request)

POST /rest/Dxi/resetFailedLogins

Reset (delete) the failed login counts for all users.

Since:

1.1

getFailedLoginCount

public com.quantum.dxi.dao.types.FailedLoginCount getFailedLoginCount(@Context
                                                                      javax.servlet.http.HttpServletRequest request)

GET /rest/Dxi/failedLoginCount

Get the number of failed login attempts preceding the current login.

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

Since:

1.2.8

getGuiAttributes

public GuiAttributes getGuiAttributes(@Context
                                      javax.servlet.http.HttpServletRequest request)

GET /rest/Dxi/guiAttributes

Returns different system attributes required to build the web page.

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

Since:

1.2.8

getLogsForGui

public LogsForGui getLogsForGui(@Context
                                javax.servlet.http.HttpServletRequest request)

GET /rest/Dxi/logsForGui

Returns logs shown on the web page.

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

Since:

1.2.8

callAction

public void callAction(@Context
                       javax.servlet.http.HttpServletRequest request,
                       String actionString,
                       InputStream is)

Deprecated. As of 1.1
?action=reboot replaced by reboot(HttpServletRequest)
?action=shutdown replaced by shutdown(HttpServletRequest)
?action=restartServicesFromDiagnosticMode replaced by restartServicesFromDiagnosticMode(HttpServletRequest)
?action=resetFailedLogins replaced by resetFailedLogins(HttpServletRequest)

POST /rest/Dxi

Perform an action on the system.

The action query parameter is required.

Supported actions are:

• ?action=reboot Reboot the system. The system will shut down and start back up without user intervention.
• ?action=shutdown Shut down the system. The system will stay down until someone manually restarts it.
• ?action=restartServicesFromDiagnosticMode For a system in "Diagnostic Mode", restart all services in order to transition the system to normal operational mode.
• ?action=resetFailedLogins Reset (delete) the failed login counts for all users.