com.quantum.dxi.rest.replication

Class Snapshots

java.lang.Object

Base

com.quantum.dxi.rest.replication.Snapshots

public class Snapshots
extends Base

The Snapshots resource represents replication snapshots. The Snapshots resource includes services for getting the snapshots on the system, deleting snapshots, and performing failback and recovery of the snapshots.

The schema that defines the Snapshots resource is defined below.

 
    <xs:simpleType name="SharitionType">
        <xs:annotation>
            <xs:documentation>Share or Partition</xs:documentation>
        </xs:annotation>
        <xs:restriction base="xs:string">
            <xs:enumeration value="SHARE"/>
            <xs:enumeration value="PARTITION"/>
        </xs:restriction>
    </xs:simpleType>

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

    <xs:element name="Snapshot">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="ObjectName" type="xs:string"/>
                <xs:element name="SourceHostName" type="xs:string"/>
                <xs:element name="StartTimeString" type="xs:string">
                  <xs:annotation>
                      <xs:documentation>Local time.</xs:documentation>
                  </xs:annotation>
               </xs:element>
                <xs:element name="StartTime" type="xs:long" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>UTC value. A null StartTime indicates a failure to parse the StartTimeString due to unrecognized format. In this case sorting by StartTime column uses StartTimeString value.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="EndTimeString" type="xs:string">
                  <xs:annotation>
                      <xs:documentation>Local time.</xs:documentation>
                  </xs:annotation>
               </xs:element>
                <xs:element name="EndTime" type="xs:long" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>UTC value. A null EndTime indicates a failure to parse the EndTimeString due to unrecognized format. In this case sorting by EndTime column uses EndTimeString value.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Status" type="xs:string"/>
                <xs:element name="DetailedFailureMessage" type="xs:string" minOccurs="0"/>
                <xs:element name="BundleId" type="xs:string"/>
                <xs:element name="SnapshotObjectType" type="SharitionType"/>
                <xs:element name="Rate" type="xs:long"/>
                <xs:element name="OriginalBytes" type="xs:long"/>
                <xs:element name="ActualBytes" type="xs:long"/>
                <xs:element name="Index" type="xs:int"/>
                <xs:element name="Id" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>Snapshot Id is a combination of SourceHostName@SnapshotObjectType@ObjectName@BundleId</xs:documentation>
                    </xs:annotation>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="SnapshotColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="ObjectName"/>
            <xs:enumeration value="SourceHostName"/>
            <xs:enumeration value="StartTime"/>
            <xs:enumeration value="EndTime"/>
            <xs:enumeration value="Status"/>
            <xs:enumeration value="DetailedFailureMessage"/>
            <xs:enumeration value="BundleId"/>
            <xs:enumeration value="SnapshotObjectType"/>
            <xs:enumeration value="Rate"/>
            <xs:enumeration value="OriginalBytes"/>
            <xs:enumeration value="ActualBytes"/>
            <xs:enumeration value="Index"/>
            <xs:enumeration value="Id"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
Snapshots()

Method Summary

Modifier and Type	Method and Description
void	deleteAll(javax.servlet.http.HttpServletRequest request, java.lang.String objectType, java.lang.String sourceHostName, java.lang.String objectName) DELETE /rest/Snapshots
void	deleteSnapshot(javax.servlet.http.HttpServletRequest request, java.lang.String id) DELETE /rest/Snapshots/{id}
javax.ws.rs.core.Response	failbackSnapshot(javax.servlet.http.HttpServletRequest request, java.lang.String id, java.lang.String tgtHost, java.lang.String encType) POST /rest/Snapshots/{id}/failback/{tgtHost}
Snapshot	getSnapshot(javax.servlet.http.HttpServletRequest request, java.lang.String id, java.lang.String errorType) GET /rest/Snapshots/{id}
com.quantum.dxi.dao.types.Snapshots	getSnapshots(javax.servlet.http.HttpServletRequest request, boolean recent, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString) GET /rest/Snapshots
NumericScalarType	getSnapshotsCount(javax.servlet.http.HttpServletRequest request, java.lang.String filterString, java.lang.String errorType) GET /rest/Snapshots/getRowCount
javax.ws.rs.core.Response	recoverSnapshot(javax.servlet.http.HttpServletRequest request, java.lang.String id, java.lang.String recObjectName, java.lang.String owner) POST /rest/Snapshots/{id}/recover

Methods inherited from class java.lang.Object

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

Constructor Detail

Snapshots

public Snapshots()

Method Detail

getSnapshots

public com.quantum.dxi.dao.types.Snapshots getSnapshots(@Context
                                                        javax.servlet.http.HttpServletRequest request,
                                                        boolean recent,
                                                        int start,
                                                        int limit,
                                                        java.lang.String sortColumn,
                                                        java.lang.String sortDirection,
                                                        java.lang.String filterString)

GET /rest/Snapshots

Get the list of snapshots on the system.

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

The recent query parameter can be used to get only the most recent snapshot for each received share or partition. For when there are a lot of snapshots for each share or partition, this is much faster than quering all snapshots. The parameter is available since REST v1.2.

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

getSnapshot

public Snapshot getSnapshot(@Context
                            javax.servlet.http.HttpServletRequest request,
                            java.lang.String id,
                            java.lang.String errorType)

GET /rest/Snapshots/{id}

Get the snapshot represented by id. The id is a concatenation of the SourceHostName, SnapshotObjectType, ObjectName, and BundleId, separated by '@', e.g. {SourceHostName}@{SnapshotObjectType}@{ObjectName}@{BundleId}.

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

Since:

1.1

getSnapshotsCount

public NumericScalarType getSnapshotsCount(@Context
                                           javax.servlet.http.HttpServletRequest request,
                                           java.lang.String filterString,
                                           java.lang.String errorType)

GET /rest/Snapshots/getRowCount

Get the number of snapshots on the system.

getRowCount supports the table query parameters for filtering by column name. Column names are defined in <xs:simpleType name="SnapshotColumnNameType">

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

Since:

1.1

deleteAll

public void deleteAll(@Context
                      javax.servlet.http.HttpServletRequest request,
                      java.lang.String objectType,
                      java.lang.String sourceHostName,
                      java.lang.String objectName)

DELETE /rest/Snapshots

Delete multiple or all snapshots on the system.

The below parameters are available since REST v1.2:

• The objectType query parameter can be used to limit deletions to the given object type. Accepted values are: SHARE and PARTITION (case-agnostic).
• The sourceHostName query parameter can be used to limit deletions to the given source host.
• The objectName query parameter can be used to limit deletions to the given share or partition name.

deleteSnapshot

public void deleteSnapshot(@Context
                           javax.servlet.http.HttpServletRequest request,
                           java.lang.String id)

DELETE /rest/Snapshots/{id}

Delete the snapshot represented by id on the system. The id is a concatenation of the SourceHostName, SnapshotObjectType, ObjectName, and BundleId, separated by '@', e.g. {SourceHostName}@{SnapshotObjectType}@{ObjectName}@{BundleId}.

recoverSnapshot

public javax.ws.rs.core.Response recoverSnapshot(@Context
                                                 javax.servlet.http.HttpServletRequest request,
                                                 java.lang.String id,
                                                 java.lang.String recObjectName,
                                                 java.lang.String owner)

POST /rest/Snapshots/{id}/recover

Recover the snapshot identified by id. The id is a concatenation of the SourceHostName, SnapshotObjectType, ObjectName, and BundleId, separated by '@', e.g. {SourceHostName}@{SnapshotObjectType}@{ObjectName}@{BundleId}.
recObjectName Allows recovery of share or partition using a different name. Defaults to ObjectName.
owner Owner of the recovered CIFS share files at file system level (does not impact Windows ACL). The option is ignored for NFS shares. If omitted, files are recovered with their original user and group ids.

Use GET /rest/RecoveryJobs to monitor job status.

Since:

1.1

failbackSnapshot

public javax.ws.rs.core.Response failbackSnapshot(@Context
                                                  javax.servlet.http.HttpServletRequest request,
                                                  java.lang.String id,
                                                  java.lang.String tgtHost,
                                                  java.lang.String encType)

POST /rest/Snapshots/{id}/failback/{tgtHost}

Failback the snapshot identified by id to tgtHost The id is a concatenation of the SourceHostName, SnapshotObjectType, ObjectName, and BundleId, separated by '@', e.g. {SourceHostName}@{SnapshotObjectType}@{ObjectName}@{BundleId}.
tgtHost must have this system as one of the allowed replication sources. Use IP address if the hostname cannot be resolved from the system.
The transfer can optionally be encrypted by specifying the encType query parameter. Accepted values are: 128-BIT (or just 128), 256-BIT (256), and TLS-256 (tls).

Use GET /rest/FailbackJobs to monitor job status.

Since:

1.1