com.quantum.dxi.rest.Security

Class HardDriveSecurity

java.lang.Object

Base

com.quantum.dxi.rest.Security.HardDriveSecurity

public class HardDriveSecurity
extends Base

The HardDriveSecurity resource represents hard drive security via encryption on the system's hard drives. The HardDriveSecurity interfaces includes services for getting details about hard drive security configuration, and for performing actions related to the hard drive security configuration of the system.

The schema that defines the HardDriveSecurity resource is defined below. The schema and corresponding APIs are deprecated since version 1.2.

 
    <xs:element name="HardDriveSecurity">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Enable" type="xs:boolean" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>ReadOnly</xs:documentation>
                    </xs:annotation>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="HardDriveSecurityScalarName">
        <xs:simpleType>
            <xs:restriction base="xs:string">
                <xs:enumeration value="HarddrivesecurityEnable"/>
            </xs:restriction>
        </xs:simpleType>
    </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
HardDriveSecurity()

Method Summary

Modifier and Type	Method and Description
NumericScalarType	callAction(javax.servlet.http.HttpServletRequest request, String actionString, String password, String recipients, String errorType) Deprecated. as of 1.1 ?action=enableEncryption @see #enableEncryption(HttpServletRequest, StringScalarType, String) ?action=emailSecurityKeys @see #emailSecurityKeys(HttpServletRequest, StringListScalarType, String) ?action=checkEncryption @see #checkEncryption(HttpServletRequest, String)
javax.ws.rs.core.Response	checkEncryption(javax.servlet.http.HttpServletRequest request, String errorType) POST /rest/HardDriveSecurity/checkEncryption
javax.ws.rs.core.Response	downloadSecurityKeys(javax.servlet.http.HttpServletRequest request, StringScalarType password, String errorType) POST /rest/HardDriveSecurity/downloadSecurityKeys
void	emailSecurityKeys(javax.servlet.http.HttpServletRequest request, StringListScalarType parameters, String errorType) POST /rest/HardDriveSecurity/emailSecurityKeys
javax.ws.rs.core.Response	enableEncryption(javax.servlet.http.HttpServletRequest request, StringScalarType passphrase, String errorType) POST /rest/HardDriveSecurity/enableEncryption
BooleanScalarType	getEncryptionEnabled(javax.servlet.http.HttpServletRequest request, String errorType) GET /rest/HardDriveSecurity/enabled
Object	getHardDriveSecurity(javax.servlet.http.HttpServletRequest request, String actionString, String password, String errorType) Deprecated. As of 1.2, @see #getEncryptionEnabled(HttpServletRequest, String)

Methods inherited from class java.lang.Object

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

Constructor Detail

HardDriveSecurity

public HardDriveSecurity()

Method Detail

downloadSecurityKeys

public javax.ws.rs.core.Response downloadSecurityKeys(@Context
                                                      javax.servlet.http.HttpServletRequest request,
                                                      StringScalarType password,
                                                      String errorType)

POST /rest/HardDriveSecurity/downloadSecurityKeys

Download a data-at-rest recovery file. The recovery file is a password-protected zip file containing the keys that are used to perform data encryption, and the passphrase that was used to generate the keys when data-at-rest encryption was initially enabled. The password must be 8-32 characters long, include at least 1 digit [0-9], include at least 1 upper-case letter [A-Z], include at least 1 lower-case letter [a-z], include at least 1 non-alphanumeric character (note, underscore '_' is considered an alphanumeric character), and must NOT include space, tab, single-quote, double-quote, or dollar sign.

Note, the password used to password-protect the recovery zip file is not the same thing as the passphrase that was used to generate the encryption keys.

Request Entity type: <xs:element name="StringScalarType"> containing the password that will be used to protect the zip file. The scalar name should be "password"

Since:

1.1

getEncryptionEnabled

public BooleanScalarType getEncryptionEnabled(@Context
                                              javax.servlet.http.HttpServletRequest request,
                                              String errorType)

GET /rest/HardDriveSecurity/enabled

Get whether hard drive security (Data-at-Rest encryption) is enabled.

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

Since:

1.2

getHardDriveSecurity

public Object getHardDriveSecurity(@Context
                                   javax.servlet.http.HttpServletRequest request,
                                   @Deprecated
                                   String actionString,
                                   @Deprecated
                                   String password,
                                   String errorType)

Deprecated. As of 1.2, @see #getEncryptionEnabled(HttpServletRequest, String)

GET /rest/HardDriveSecurity

Get the hard drive security configuration on the system.

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

Deprecated as of 1.1:
The "action" and "password" query parameters are deprecated.
?action=downloadSecurityKeys&password=<password>, @see #downloadSecurityKeys(HttpServletRequest, StringScalarType, String)

Response Entity type: password-protected zip file attachment

enableEncryption

public javax.ws.rs.core.Response enableEncryption(@Context
                                                  javax.servlet.http.HttpServletRequest request,
                                                  StringScalarType passphrase,
                                                  String errorType)

POST /rest/HardDriveSecurity/enableEncryption

Start a background job to enable data-at-rest encryption on the system's hard drives. Enabling data-at-request encryption requires a passphrase, which is used to generate the keys that are used to perform the encryption. The passphrase must be 8-32 characters long, include at least 1 digit [0-9], include at least 1 upper-case letter [A-Z], include at least 1 lower-case letter [a-z], include at least 1 non-alphanumeric character (note, underscore '_' is considered an alphanumeric character), and must NOT include space, tab, single-quote, double-quote, or dollar sign.

Request Entity type: <xs:element name="StringScalarType"> containing the passphrase that will be used to enable encryption. The scalar name should be "passphrase"

Response Entity type: <xs:element name="NumericScalarType"> representing the job id

Since:

1.1

emailSecurityKeys

public void emailSecurityKeys(@Context
                              javax.servlet.http.HttpServletRequest request,
                              StringListScalarType parameters,
                              String errorType)

POST /rest/HardDriveSecurity/emailSecurityKeys

Email a data-at-rest recovery file to the listed email recipients. The recovery file is a password-protected zip file containing the keys that are used to perform data encryption, and the passphrase that was used to generate the keys when data-at-rest encryption was initially enabled. The password must be 8-32 characters long, include at least 1 digit [0-9], include at least 1 upper-case letter [A-Z], include at least 1 lower-case letter [a-z], include at least 1 non-alphanumeric character (note, underscore '_' is considered an alphanumeric character), and must NOT include space, tab, single-quote, double-quote, or dollar sign.

Note, the password used to password-protect the recovery zip file is not the same thing as the passphrase that was used to generate the encryption keys.

Request Entity type: <xs:element name="StringListScalarType"> containing the password for protecting the zip file and the list of email recipients. The scalar should be named "parameters", and the value list should contain two strings. The first string in the list should be the password, the second string in the list should be a comma-separated list of recipients.

Since:

1.1

checkEncryption

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

POST /rest/HardDriveSecurity/checkEncryption

Start a background job to check the encryption support on the hard drives.

Response Entity type: <xs:element name="NumericScalarType"> representing the job id

Since:

1.1

callAction

public NumericScalarType callAction(@Context
                                    javax.servlet.http.HttpServletRequest request,
                                    String actionString,
                                    String password,
                                    String recipients,
                                    String errorType)

Deprecated. as of 1.1
?action=enableEncryption @see #enableEncryption(HttpServletRequest, StringScalarType, String)
?action=emailSecurityKeys @see #emailSecurityKeys(HttpServletRequest, StringListScalarType, String)
?action=checkEncryption @see #checkEncryption(HttpServletRequest, String)

POST /rest/HardDriveSecurity

Perform the requested action on the hard drive security configuration. The action query parameter is required.

Supported actions are:

• ?action=enableEncryption&password=<password> start a background job to enable encryption on the hard drives
• ?action=emailSecurityKeys&recipients=<recipient1@foo.com,recipient2@bar.com>&password=<password> email hard drive security keys to the listed email recipients
• ?action=emailSecurityKeys&recipients=<recipient1@foo.com,recipient2@bar.com> email hard drive security keys to the listed email recipients
• ?action=checkEncryption start a background job to check the encryption on the hard drives

Response Entity type: <xs:element name="NumericScalarType"> representing the job id