com.quantum.dxi.rest.ost

Class Lsus

java.lang.Object

Base

com.quantum.dxi.rest.ost.Lsus

public class Lsus
extends Base

The Lsus resource represents Logical Storage Units on storages servers configured on the system. The Lsus service includes interfaces for getting, adding, updating, and deleting logical storage units on storage servers.

The schema that defines the Lsus resource is defined below.

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

    <xs:element name="LSU">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Name" type="xs:string" minOccurs="0" />
                <xs:element name="Capacity" type="xs:long" minOccurs="0" />
                <xs:element name="Description" type="xs:string" minOccurs="0" />
                <xs:element name="StorageServer" type="xs:string" />
                <xs:element name="SecureSnapshots" type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Secure Snapshots feature state. Read-Only field.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="SnapshotRetention" type="xs:int" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Secure snapshot retention period in days.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="EnableWorm" type="xs:boolean" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Since 1.2.3.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                    <xs:element name="WormMinLock" type="xs:long" minOccurs="0">
                        <xs:annotation>
                            <xs:documentation>WORM minimum lock period in seconds. Since 1.2.3.</xs:documentation>
                        </xs:annotation>
                    </xs:element>
                <xs:element name="WormMaxLock" type="xs:long" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>WORM maximum lock period in seconds. Since 1.2.3.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="CloudShare" type="xs:boolean" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>
                            True or false. If system Cloud Share setting is disabled this element is disabled.
                            Since 1.2.6. Read only.
                        </xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element ref="OstAir" minOccurs="0" maxOccurs="1">
                    <xs:annotation>
                        <xs:documentation>Since 1.2.10.</xs:documentation>
                    </xs:annotation>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="LSUColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Name" />
            <xs:enumeration value="Capacity" />
            <xs:enumeration value="Description" />
            <xs:enumeration value="StorageServer" />
            <xs:enumeration value="SecureSnapshots"/>
            <xs:enumeration value="SnapshotRetention"/>
            <xs:enumeration value="EnableWorm">
                <xs:annotation>
                    <xs:documentation>Since 1.2.3.</xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="WormMinLock">
                <xs:annotation>
                    <xs:documentation>Since 1.2.3.</xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="WormMaxLock">
                <xs:annotation>
                    <xs:documentation>Since 1.2.3.</xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="CloudShare">
                <xs:annotation>
                    <xs:documentation>Since 1.2.6.</xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="OstAir">
                <xs:annotation>
                    <xs:documentation>Since 1.2.10.</xs:documentation>
                </xs:annotation>
            </xs:enumeration>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
Lsus()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addLsu(javax.servlet.http.HttpServletRequest request, LSU lsu) POST /rest/Lsus
void	deleteStorageServer(javax.servlet.http.HttpServletRequest request, String storageServer, String name) DELETE /rest/Lsus/{storageServer}/{name}
com.quantum.dxi.dao.types.LSU	getLsu(javax.servlet.http.HttpServletRequest request, String storageServer, String name) GET /rest/Lsus/{storageServer}/{name}
com.quantum.dxi.dao.types.LSUs	getLsus(javax.servlet.http.HttpServletRequest request, String storageServer, int start, int limit, String sortColumn, String sortDirection, String filterString) GET /rest/Lsus/{storageServer}
NumericScalarType	getLsusCount(javax.servlet.http.HttpServletRequest request, String storageServer, int start, int limit, String filterString) GET /rest/Lsus/{storageServer}/getRowCount
LSU	updateLsu(javax.servlet.http.HttpServletRequest request, String storageServer, String name, LSU lsu) PUT /rest/Lsus/{storageServer}/{name}

Methods inherited from class java.lang.Object

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

Constructor Detail

Lsus

public Lsus()

Method Detail

getLsusCount

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

GET /rest/Lsus/{storageServer}/getRowCount

Get the number of LSUs on the specified storage server on the system.

getLsusCount supports the table query parameters for paging and filtering. Column names for filtering are defined in <xs:element name="LSUColumnNameType">

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

Since:

1.1

getLsus

public com.quantum.dxi.dao.types.LSUs getLsus(@Context
                                              javax.servlet.http.HttpServletRequest request,
                                              String storageServer,
                                              int start,
                                              int limit,
                                              String sortColumn,
                                              String sortDirection,
                                              String filterString)

GET /rest/Lsus/{storageServer}

Get the list of LSUs on the specified storage server on the system.

A null return value for the Capacity element indicates that the LSU is configured to use the available capacity of the storage server.

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

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

Since:

1.1

getLsu

public com.quantum.dxi.dao.types.LSU getLsu(@Context
                                            javax.servlet.http.HttpServletRequest request,
                                            String storageServer,
                                            String name)

GET /rest/Lsus/{storageServer}/{name}

Get a specific LSU on the specified storage server on the system.

A null return value for the Capacity element indicates that the LSU is configured to use the available capacity of the storage server.

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

Since:

1.2.1

deleteStorageServer

public void deleteStorageServer(@Context
                                javax.servlet.http.HttpServletRequest request,
                                String storageServer,
                                String name)

DELETE /rest/Lsus/{storageServer}/{name}

Delete the LSU identified by {name} from the storage server identified by {storageServer}.

Since:

1.1

updateLsu

public LSU updateLsu(@Context
                     javax.servlet.http.HttpServletRequest request,
                     String storageServer,
                     String name,
                     LSU lsu)

PUT /rest/Lsus/{storageServer}/{name}

Update the LSU identified by {name} on the storage server identified by {storageServer}. Only the Description and Capacity can be changed.

Request Entity type: <xs:element name="Lsu">

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

Since:

1.1

addLsu

public javax.ws.rs.core.Response addLsu(@Context
                                        javax.servlet.http.HttpServletRequest request,
                                        LSU lsu)

POST /rest/Lsus

Add a LSU to a storage server on the system.

To create a LSU that is a subset of the total storage on the storage server, specify a Name and Capacity in GB for the LSU.

To create a LSU that uses the available capacity of the storage server, pass null values for the Name and Capacity. A LSU with the reserved name _PhysicalLSU will be created.

Request Entity type: <xs:element name="Lsu">

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

Since:

1.1