com.quantum.dxi.rest.StorageArray

Class StorageArrays

java.lang.Object

Base

com.quantum.dxi.rest.StorageArray.StorageArrays

public class StorageArrays
extends Base

The StorageArrays resource represents the premium feature key (PFK) encryption of a system's storage arrays. The StorageArrays interface includes services for getting status about the storage array's encryption and and for managing the encryption.

Deprecated as of 1.1:
This resource applies to DXi versions prior to 4.0.0. For information about the operational status and configuration of storage arrays, see the StorageArray resource.

The schema that defines the StorageArrays resource is described below.

 
    <xs:element name="StorageArrays">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0"/>
                <xs:element ref="StorageArray" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="StorageArray">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Name" type="xs:string"/>
                <xs:element name="SerialNumber" type="xs:string" minOccurs="0"/>
                <xs:element name="FeatureId" type="xs:string" minOccurs="0"/>
                <xs:element name="PFKFileInstalled" type="xs:boolean" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Encryption PFK File Installed</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="TurboPFKFileInstalled" type="xs:boolean" minOccurs="0"/>
                <xs:element name="ModelIdentifier" type="xs:string" minOccurs="0"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="StorageArrayColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Name"/>
            <xs:enumeration value="SerialNumber"/>
            <xs:enumeration value="FeatureId"/>
            <xs:enumeration value="PFKFileInstalled"/>
            <xs:enumeration value="TurboPFKFileInstalled"/>
            <xs:enumeration value="ModelIdentifier"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
StorageArrays()

Method Summary

Modifier and Type	Method and Description
StorageArray	getStorageArray(javax.servlet.http.HttpServletRequest request, String arrayName, String errorType) GET /rest/StorageArrays/{arrayName}
Object	getStorageArrays(javax.servlet.http.HttpServletRequest request, int start, int limit, String sortColumn, String sortDirection, String actionString, String filterString, String errorType) GET /rest/StorageArrays
NumericScalarType	getStorageArraysCount(javax.servlet.http.HttpServletRequest request, int start, int limit, String filterString, String errorType) GET /rest/StorageArrays/getRowCount
StringListScalarType	getStorageArraysNames(javax.servlet.http.HttpServletRequest request, int start, int limit, String filterString, String errorType) GET /rest/StorageArrays/getNames
javax.ws.rs.core.Response	installPfkFile(javax.servlet.http.HttpServletRequest request, String arrayName, String file, String errorType) POST /rest/StorageArrays/{arrayName}/installPfkFile/{file}
void	installPfkFile(javax.servlet.http.HttpServletRequest request, String actionString, String arrayName, String file, String errorType) Deprecated. As of 1.1 ?action=installPfkFilt replaced by installPfkFile(HttpServletRequest, String, String, String) ?action=installTurboPfkFile replaced by installTurboPfkFile(HttpServletRequest, String, String, String)
javax.ws.rs.core.Response	installTurboPfkFile(javax.servlet.http.HttpServletRequest request, String arrayName, String file, String errorType) POST /rest/StorageArrays/{arrayName}/installTurboPfkFile/{file}

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageArrays

public StorageArrays()

Method Detail

getStorageArraysCount

public NumericScalarType getStorageArraysCount(@Context
                                               javax.servlet.http.HttpServletRequest request,
                                               int start,
                                               int limit,
                                               String filterString,
                                               String errorType)

GET /rest/StorageArrays/getRowCount

Get the number of the system's storage arrays.

getStorageArraysCount supports the table query parameters for filtering by column name. Column names are defined in <xs:element name="StorageArrayColumnNames">

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

Since:

1.1

getStorageArraysNames

public StringListScalarType getStorageArraysNames(@Context
                                                  javax.servlet.http.HttpServletRequest request,
                                                  int start,
                                                  int limit,
                                                  String filterString,
                                                  String errorType)

GET /rest/StorageArrays/getNames

Get the names of the system's storage arrays.

getStorageArraysNames supports the table query parameters for filtering by column name. Column names are defined in <xs:element name="StorageArrayColumnNames">

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

Since:

1.1

getStorageArrays

public Object getStorageArrays(@Context
                               javax.servlet.http.HttpServletRequest request,
                               int start,
                               int limit,
                               String sortColumn,
                               String sortDirection,
                               @Deprecated
                               String actionString,
                               String filterString,
                               String errorType)

GET /rest/StorageArrays

Get the system's storage arrays.

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

<xs:element name="StorageArrays"> supports the table query parameters. Column names for sorting and filtering are defined in <xs:element name="StorageArrayColumnNames">

Deprecated as of 1.1:
The "action" query parameter is deprecated.
?action=getRowCount replaced by getStorageArraysCount(HttpServletRequest, int, int, String, String)
?action=getNames replaced by getStorageArraysNames(HttpServletRequest, int, int, String, String)

Response Entity type: <xs:element name="NumericScalarType"> for query parameter ?action=getRowCount

The service also supports the ?action=getNames query parameter, which returns only the storage array names.

Response Entity type: <xs:element name="StringListScalarType"> for query parameter ?action=getNames

getStorageArray

public StorageArray getStorageArray(@Context
                                    javax.servlet.http.HttpServletRequest request,
                                    String arrayName,
                                    String errorType)

GET /rest/StorageArrays/{arrayName}

Get the storage array on the system identified by {araryName}

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

installPfkFile

public javax.ws.rs.core.Response installPfkFile(@Context
                                                javax.servlet.http.HttpServletRequest request,
                                                String arrayName,
                                                String file,
                                                String errorType)

POST /rest/StorageArrays/{arrayName}/installPfkFile/{file}

install the previously uploaded PFK file identified by {file}.

Since:

1.1

installTurboPfkFile

public javax.ws.rs.core.Response installTurboPfkFile(@Context
                                                     javax.servlet.http.HttpServletRequest request,
                                                     String arrayName,
                                                     String file,
                                                     String errorType)

POST /rest/StorageArrays/{arrayName}/installTurboPfkFile/{file}

install the previously uploaded TurboPFK file identified by {file}.

Since:

1.1

installPfkFile

public void installPfkFile(@Context
                           javax.servlet.http.HttpServletRequest request,
                           String actionString,
                           String arrayName,
                           String file,
                           String errorType)

Deprecated. As of 1.1
?action=installPfkFilt replaced by installPfkFile(HttpServletRequest, String, String, String)
?action=installTurboPfkFile replaced by installTurboPfkFile(HttpServletRequest, String, String, String)

POST /rest/StorageArrays/{arrayName}

Perform the requested action on the array identified by {arrayName}. The action query parameter is required.

Supported actions are:

• ?action=installPfkFile&file=<file> install the previously uploaded PFK file identified by <file>
• ?action=installTurboPfkFile&file=<file> install the previously uploaded Turbo PFK file identified by <file>