com.quantum.dxi.rest.vtl

Class Partitions

java.lang.Object

Base

com.quantum.dxi.rest.vtl.Partitions

public class Partitions
extends Base

The Partitions resource represents VTL partitions on the system. The Partitions interface includes services for getting, updating, creating, and deleting partitions, and for initiating operations on partitions.

Clients can query Library, Drive, and Media types for Paritions from the system using the following web services:
GET /rest/SupportedLibraries
GET /rest/SupportedDrives
GET /rest/SupportedMediaTypes/{driveType}

The schema that defines the Partitions resource is defined below.

 
    <xs:element name="Partitions">
        <xs:annotation>
            <xs:documentation>Multiple VTL Partitions</xs:documentation>
        </xs:annotation>
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0"/>
                <xs:element ref="Partition" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="Partition">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Name" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>
                            Read-only after resource is created. Must consist of alphanumeric characters and begin with a letter.
                        </xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Online" type="xs:boolean">
                    <xs:annotation>
                        <xs:documentation>Read-only field.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="LibraryType" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>
                            Accepted values can be obtained using the SupportedLibraries API (Description field).
                        </xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="DriveType" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>
                            Read-only after resource is created, so can be specified either when creating a new partition or assigning drive model
                            to a partition after recovery. Accepted values can be obtained using the SupportedDrives API (Description field).
                        </xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="NumberDrives" type="xs:int"/>
                <xs:element name="NumberSlots" type="xs:int">
                    <xs:annotation>
                        <xs:documentation>
                            Number of Storage Slots. One I/E Slot is created for each Storage Slot, until maximum of 240 I/E Slots exist.
                        </xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="DedupEnabled" type="xs:boolean">
                    <xs:annotation>
                        <xs:documentation>Read-only after resource is created.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="ReplicationEnabled" type="xs:boolean"/>
                <xs:element name="AutoExportEnabled" type="xs:boolean"/>
                <xs:element name="SerialNumber" type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Read-only field.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="NumberIESlots" type="xs:int" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>
                            Read-only field. Number of I/E Slots corresponds to the number of Storage Slots, but there can be no more than 240 I/E Slots.
                        </xs:documentation>
                    </xs:annotation>
                </xs:element>
                <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:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="PartitionColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Name"/>
            <xs:enumeration value="Online"/>
            <xs:enumeration value="LibraryType"/>
            <xs:enumeration value="DriveType"/>
            <xs:enumeration value="NumberDrives"/>
            <xs:enumeration value="NumberSlots"/>
            <xs:enumeration value="DedupEnabled"/>
            <xs:enumeration value="ReplicationEnabled"/>
            <xs:enumeration value="SerialNumber"/>
            <xs:enumeration value="NumberIESlots"/>
            <xs:enumeration value="SecureSnapshots"/>
            <xs:enumeration value="SnapshotRetention"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
Partitions()

Method Summary

Modifier and Type	Method and Description
StringScalarType	actionOnPartition(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String actionString, java.lang.String target, java.lang.String syncId, java.lang.String cartridgeBase, java.lang.String errorType) Deprecated. As of 1.1 ?action=synchronize replaced by synchronize(HttpServletRequest, String, String, String) ?action=replicate replaced by replicate(HttpServletRequest, String, String, String) ?action=enableReplication&syncId=None replaced by enableReplication(HttpServletRequest, String, String) ?action=enableReplication&syncId=<syncId> replaced by enableReplication(HttpServletRequest, String, String, String) ?action=disableReplication&fileDirBase=false replaced by disableReplication(HttpServletRequest, String, String) ?action=disableReplication&fileDirBase=true replaced by disableFileDirReplication(HttpServletRequest, String, String) ?action=setOffLine replaced by setOffLine(HttpServletRequest, String, String) ?action=setOffLine replaced by setOnLine(HttpServletRequest, String, String)
javax.ws.rs.core.Response	addPartition_1_1(javax.servlet.http.HttpServletRequest request, Partition partition, java.lang.String errorType) POST /rest/Partitions
Partition	addPartition(javax.servlet.http.HttpServletRequest request, Partition partition, java.lang.String errorType) Deprecated. As of 1.1, replaced by addPartition_1_1(HttpServletRequest, Partition, String)
void	deletePartition(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String errorType) DELETE /rest/Partitions/{name}
javax.ws.rs.core.Response	disableFileDirReplication(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String errorType) POST /rest/Partitions/{name}/disableFileDirReplication
javax.ws.rs.core.Response	disableReplication(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String errorType) POST /rest/Partitions/{name}/disableReplication
javax.ws.rs.core.Response	enableReplication(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String errorType) POST /rest/Partitions/{name}/enableReplication
javax.ws.rs.core.Response	enableReplication(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String syncId, java.lang.String errorType) POST /rest/Partitions/{name}/enableReplication/{syncId}
Partition	getPartition(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String errorType) GET /rest/Partitions/{name}
java.lang.Object	getPartitions(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String actionString, java.lang.String filterString, java.lang.String errorType) GET /rest/Partitions
NumericScalarType	getPartitionsCount(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String filterString, java.lang.String errorType) GET /rest/Partitions/getRowCount
StringListScalarType	getPartitionsNames(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String filterString, java.lang.String errorType) GET /rest/Partitions/getNames
javax.ws.rs.core.Response	replicate(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String target, java.lang.String errorType) POST /rest/Partitions/{name}/replicate/{target}
javax.ws.rs.core.Response	setOffLine(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String errorType) POST /rest/Partitions/{name}/setOffLine
javax.ws.rs.core.Response	setOnLine(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String errorType) POST /rest/Partitions/{name}/setOnLine
javax.ws.rs.core.Response	synchronize(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String target, java.lang.String errorType) POST /rest/Partitions/{name}/synchronize/{target}
Partition	updatePartition(javax.servlet.http.HttpServletRequest request, java.lang.String name, Partition partition, java.lang.String errorType) PUT /rest/Partitions/{name}

Methods inherited from class java.lang.Object

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

Constructor Detail

Partitions

public Partitions()

Method Detail

getPartitionsCount

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

GET /rest/Partitions/getRowCount

Get the number of VTL partitions on the system.

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

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

Since:

1.1

getPartitionsNames

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

GET /rest/Partitions/getNames

Get the names of VTL partitions on the system.

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

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

Since:

1.1

getPartitions

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

GET /rest/Partitions

Get the VTL partitions on the system.

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

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

Deprecated as of 1.1:
The "action" query parameter is deprecated.
?action=getRowCount replaced by getPartitionsCount(HttpServletRequest, int, int, String, String)
?action=getNames replaced by getPartitionsNames(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 partition names.

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

getPartition

public Partition getPartition(@Context
                              javax.servlet.http.HttpServletRequest request,
                              java.lang.String name,
                              java.lang.String errorType)

GET /rest/Partitions/{name}

Get the VTL partition on the system identified by {name}.

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

deletePartition

public void deletePartition(@Context
                            javax.servlet.http.HttpServletRequest request,
                            java.lang.String name,
                            java.lang.String errorType)

DELETE /rest/Partitions/{name}

Delete the VTL partition on the system identified by {name}.

updatePartition

public Partition updatePartition(@Context
                                 javax.servlet.http.HttpServletRequest request,
                                 java.lang.String name,
                                 Partition partition,
                                 java.lang.String errorType)

PUT /rest/Partitions/{name}

Update the VTL partition on the system identified by {name}.

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

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

addPartition_1_1

public javax.ws.rs.core.Response addPartition_1_1(@Context
                                                  javax.servlet.http.HttpServletRequest request,
                                                  Partition partition,
                                                  java.lang.String errorType)

POST /rest/Partitions

Create a new VTL partition on the system.

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

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

Since:

1.1

addPartition

public Partition addPartition(@Context
                              javax.servlet.http.HttpServletRequest request,
                              Partition partition,
                              java.lang.String errorType)

Deprecated. As of 1.1, replaced by addPartition_1_1(HttpServletRequest, Partition, String)

POST /rest/Partitions

Create a new VTL partition on the system.

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

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

synchronize

public javax.ws.rs.core.Response synchronize(@Context
                                             javax.servlet.http.HttpServletRequest request,
                                             java.lang.String name,
                                             java.lang.String target,
                                             java.lang.String errorType)

POST /rest/Partitions/{name}/synchronize/{target}

Initiate synchronization on the named partition to the specified target host.

Since:

1.1

replicate

public javax.ws.rs.core.Response replicate(@Context
                                           javax.servlet.http.HttpServletRequest request,
                                           java.lang.String name,
                                           java.lang.String target,
                                           java.lang.String errorType)

POST /rest/Partitions/{name}/replicate/{target}

Initiate replication on the named partition to the specified target host.

Since:

1.1

enableReplication

public javax.ws.rs.core.Response enableReplication(@Context
                                                   javax.servlet.http.HttpServletRequest request,
                                                   java.lang.String name,
                                                   java.lang.String errorType)

POST /rest/Partitions/{name}/enableReplication

Enable replication on the named partition.

Since:

1.1

enableReplication

public javax.ws.rs.core.Response enableReplication(@Context
                                                   javax.servlet.http.HttpServletRequest request,
                                                   java.lang.String name,
                                                   java.lang.String syncId,
                                                   java.lang.String errorType)

POST /rest/Partitions/{name}/enableReplication/{syncId}

Enable file/directory based replication on the named partition to a specific target share identified by syncId.

Since:

1.1

disableReplication

public javax.ws.rs.core.Response disableReplication(@Context
                                                    javax.servlet.http.HttpServletRequest request,
                                                    java.lang.String name,
                                                    java.lang.String errorType)

POST /rest/Partitions/{name}/disableReplication

Disable all replication on the named partition.

Since:

1.1

disableFileDirReplication

public javax.ws.rs.core.Response disableFileDirReplication(@Context
                                                           javax.servlet.http.HttpServletRequest request,
                                                           java.lang.String name,
                                                           java.lang.String errorType)

POST /rest/Partitions/{name}/disableFileDirReplication

Disable file/directory based replication on the named partition.

Since:

1.1

setOffLine

public javax.ws.rs.core.Response setOffLine(@Context
                                            javax.servlet.http.HttpServletRequest request,
                                            java.lang.String name,
                                            java.lang.String errorType)

POST /rest/Partitions/{name}/setOffLine

Set the named partition offline.

Since:

1.1

setOnLine

public javax.ws.rs.core.Response setOnLine(@Context
                                           javax.servlet.http.HttpServletRequest request,
                                           java.lang.String name,
                                           java.lang.String errorType)

POST /rest/Partitions/{name}/setOnLine

Set the named partition online.

Since:

1.1

actionOnPartition

public StringScalarType actionOnPartition(@Context
                                          javax.servlet.http.HttpServletRequest request,
                                          java.lang.String name,
                                          java.lang.String actionString,
                                          java.lang.String target,
                                          java.lang.String syncId,
                                          java.lang.String cartridgeBase,
                                          java.lang.String errorType)

Deprecated. As of 1.1
?action=synchronize replaced by synchronize(HttpServletRequest, String, String, String)
?action=replicate replaced by replicate(HttpServletRequest, String, String, String)
?action=enableReplication&syncId=None replaced by enableReplication(HttpServletRequest, String, String)
?action=enableReplication&syncId=<syncId> replaced by enableReplication(HttpServletRequest, String, String, String)
?action=disableReplication&fileDirBase=false replaced by disableReplication(HttpServletRequest, String, String)
?action=disableReplication&fileDirBase=true replaced by disableFileDirReplication(HttpServletRequest, String, String)
?action=setOffLine replaced by setOffLine(HttpServletRequest, String, String)
?action=setOffLine replaced by setOnLine(HttpServletRequest, String, String)

POST /rest/Partitions/{name}

Perform the requested action on the partition identified by {name}. The action query parameter is required.

Supported actions are:

• ?action=synchronize&target=<target> initiate synchronization on the named partition to the target host identified by <target>
• ?action=replicate&target=<target> initiate replication on the named partition to the target host identified by <target>
• ?action=enableReplication&syncId='None'|<syncId> enable replication on the named partition
• ?action=disableReplication&cartridgeBase=true|false> disable replication on the named partition
• ?action=setOffLine
• ?action=setOnLine

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