com.quantum.dxi.rest.nas

Class Shares

java.lang.Object

Base

com.quantum.dxi.rest.nas.Shares

public class Shares
extends Base

The Shares resource represents NAS shares on the system. The Shares interface includes services for getting, updating, creating, and deleting shares, and for initiating operations on shares.

The schema that defines the Shares resource is defined below.

 
    <xs:element name="Shares">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Total number of shares</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element ref="Share" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="Share">
        <xs:complexType>
            <xs:annotation>
                <xs:documentation>A single NAS Share</xs:documentation>
            </xs:annotation>
            <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="Protocol">
                    <xs:annotation>
                        <xs:documentation>Read-only after resource is created.</xs:documentation>
                    </xs:annotation>
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="CIFS"/>
                            <xs:enumeration value="NFS"/>
                            <xs:enumeration value="APP_SPECIFIC"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="ExportPath" type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Read-only field.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="ReadOnly" type="xs:boolean"/>
                <xs:element name="Hidden" type="xs:boolean" minOccurs="0">
                  <xs:annotation>
                        <xs:documentation>For CIFS protocol only.</xs:documentation>
                  </xs:annotation>
                </xs:element>
                <xs:element name="ConvertToLowerCase" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>
                            For CIFS protocol only. Convert incoming client file/dir names to lower case before saving.
                            Note! Once share is created, this can only be changed to DEFAULT and is irreversible!
                        </xs:documentation>
                    </xs:annotation>
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="LOWER"/>
                            <xs:enumeration value="DEFAULT"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="Description" type="xs:string" minOccurs="0"/>
                <xs:element name="EnableDeduplication" type="xs:boolean">
                    <xs:annotation>
                        <xs:documentation>Read-only after resource is created.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="EnableReplication" type="xs:boolean"/>
                <xs:element name="SymbolicLinks" type="xs:boolean" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Read-Only field.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="MapClientUserToNobody" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>For NFS protocol only.</xs:documentation>
                    </xs:annotation>
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="ROOT">
                                <xs:annotation>
                                    <xs:documentation>
                                        The default. Map client root to nobody user (root_squash in effect).
                                    </xs:documentation>
                                </xs:annotation>
                            </xs:enumeration>
                            <xs:enumeration value="NONE">
                                <xs:annotation>
                                    <xs:documentation>
                                        Preserve all client users (no_root_squash in effect).
                                    </xs:documentation>
                                </xs:annotation>
                            </xs:enumeration>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="AnonUid" type="xs:long" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>For NFS protocol only.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="AnonGid" type="xs:long" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>For NFS protocol only.</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:element name="PluginConnections" type="PluginConnectionsType" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>
                          Since 1.2.4. Read only. Application specific protocol only.
                          Not supported for filtering or sorting.
                        </xs:documentation>
                    </xs:annotation>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="ShareColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Name"/>
            <xs:enumeration value="Protocol"/>
            <xs:enumeration value="ExportPath"/>
            <xs:enumeration value="ReadOnly"/>
            <xs:enumeration value="Hidden"/>
            <xs:enumeration value="Description"/>
            <xs:enumeration value="EnableDeduplication"/>
            <xs:enumeration value="EnableReplication"/>
            <xs:enumeration value="SymbolicLinks"/>
            <xs:enumeration value="SecureSnapshots"/>
            <xs:enumeration value="SnapshotRetention"/>
        </xs:restriction>
    </xs:simpleType>

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

    <xs:element name="PluginConnection">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Hostname" type="xs:string" />
                <xs:element name="IPAddress" type="xs:string" />
                <xs:element name="Port" type="xs:string" />
                <xs:element name="PluginVersion" type="xs:string" />
                <xs:element name="ClientOS" type="xs:string" />
            </xs:sequence>
        </xs:complexType>
    </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
Shares()

Method Summary

Modifier and Type	Method and Description
StringScalarType	actionOnShare(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String actionString, java.lang.String target, java.lang.String syncId, java.lang.String fileDirBase, 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)
javax.ws.rs.core.Response	addShare_1_1(javax.servlet.http.HttpServletRequest request, Share share, java.lang.String errorType) POST /rest/Shares
Share	addShare(javax.servlet.http.HttpServletRequest request, Share share, java.lang.String errorType) Deprecated. As of 1.1, replaced by addShare_1_1(HttpServletRequest, Share, String)
void	deleteShare(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String errorType) DELETE /rest/Shares/{name}
javax.ws.rs.core.Response	disableFileDirReplication(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String errorType) POST /rest/Shares/{name}/disableFileDirReplication
javax.ws.rs.core.Response	disableReplication(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String errorType) POST /rest/Shares/{name}/disableReplication
javax.ws.rs.core.Response	enableReplication(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String errorType) POST /rest/Shares/{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/Shares/{name}/enableReplication/{syncId}
Share	getShare(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String errorType) GET /rest/Shares/{name}
java.lang.Object	getShares(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/Shares
NumericScalarType	getSharesCount(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String filterString, java.lang.String errorType) GET /rest/Shares/getRowCount
StringScalarType	getSharesNames(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String filterString, java.lang.String errorType) GET /rest/Shares/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/Shares/{name}/replicate/{target}
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/Shares/{name}/synchronize/{target}
Share	updateShare(javax.servlet.http.HttpServletRequest request, java.lang.String name, Share share, java.lang.String errorType) PUT /rest/Shares/{name}

Methods inherited from class java.lang.Object

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

Constructor Detail

Shares

public Shares()

Method Detail

getSharesCount

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

GET /rest/Shares/getRowCount

Get the number of NAS shares on the system.

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

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

Since:

1.1

getSharesNames

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

GET /rest/Shares/getNames

Get the names of NAS shares on the system.

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

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

Since:

1.1

getShares

public java.lang.Object getShares(@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/Shares

Get the NAS shares on the system.

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

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

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

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

getShare

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

GET /rest/Shares/{name}

Get the NAS share on the system identified by {name}.

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

deleteShare

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

DELETE /rest/Shares/{name}

Delete the NAS share on the system identified by {name}.

updateShare

public Share updateShare(@Context
                         javax.servlet.http.HttpServletRequest request,
                         java.lang.String name,
                         Share share,
                         java.lang.String errorType)

PUT /rest/Shares/{name}

Update the NAS share on the system identified by {name}.

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

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

addShare_1_1

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

POST /rest/Shares

Create a new NAS share on the system.

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

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

Since:

1.1

addShare

public Share addShare(@Context
                      javax.servlet.http.HttpServletRequest request,
                      Share share,
                      java.lang.String errorType)

Deprecated. As of 1.1, replaced by addShare_1_1(HttpServletRequest, Share, String)

POST /rest/Shares

Create a new NAS share on the system.

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

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

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/Shares/{name}/synchronize/{target}

Initiate synchronization on the named share 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/Shares/{name}/replicate/{target}

Initiate replication on the named share 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/Shares/{name}/enableReplication

Enable replication on the named share.

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/Shares/{name}/enableReplication/{syncId}

Enable file/directory based replication on the named share 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/Shares/{name}/disableReplication

Disable all replication on the named share.

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/Shares/{name}/disableFileDirReplication

Disable file/directory based replication on the named share.

Since:

1.1

actionOnShare

public StringScalarType actionOnShare(@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 fileDirBase,
                                      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)

POST /rest/Shares/{name}

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

Supported actions are:

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

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