com.quantum.dxi.rest.ost

Class StorageServers

java.lang.Object

Base

com.quantum.dxi.rest.ost.StorageServers

public class StorageServers
extends Base

The StorageServers resource represents OST storage servers configured on the system. The StorageServers service includes interfaces for getting, adding, updating, and deleting storage servers.

The schema that defines the StorageServers resource is defined below.

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

    <xs:element name="StorageServer">
      <xs:complexType>
        <xs:sequence>
          <xs:element name="Name" type="xs:string" />
          <xs:element name="MaxConnect" type="xs:int" />
          <xs:element name="Target" type="xs:string" minOccurs="0" />
          <xs:element name="Description" type="xs:string" minOccurs="0" />
          <xs:element name="EnableConcurrentOpDup" type="xs:boolean" minOccurs="0" />
          <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:sequence>
      </xs:complexType>
    </xs:element>

    <xs:simpleType name="StorageServerColumnNameType">
        <xs:restriction base="xs:string">
          <xs:enumeration value="Name" />
          <xs:enumeration value="MaxConnect" />
          <xs:enumeration value="Target" />
          <xs:enumeration value="Description" />
          <xs:enumeration value="EnableConcurrentOpDup" />
        </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
StorageServers()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addStorageServer(javax.servlet.http.HttpServletRequest request, StorageServer storageServer) POST /rest/StorageServers
void	deleteStorageServer(javax.servlet.http.HttpServletRequest request, java.lang.String name) DELETE /rest/StorageServers/{name}
StorageServer	getStorageServer(javax.servlet.http.HttpServletRequest request, java.lang.String name) GET /rest/StorageServers/{name}
com.quantum.dxi.dao.types.StorageServers	getStorageServers(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString) GET /rest/StorageServers
NumericScalarType	getStorageServersCount(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String filterString) GET /rest/StorageServers/getRowCount
StorageServer	updateStorageServer(javax.servlet.http.HttpServletRequest request, java.lang.String name, StorageServer storageServer) PUT /rest/StorageServers/{name}

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageServers

public StorageServers()

Method Detail

getStorageServersCount

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

GET /rest/StorageServers/getRowCount

Get the number of storage servers on the system.

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

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

Since:

1.1

getStorageServers

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

GET /rest/StorageServers

Get the list of OST storage servers on the system.

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

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

Since:

1.1

getStorageServer

public StorageServer getStorageServer(@Context
                                      javax.servlet.http.HttpServletRequest request,
                                      java.lang.String name)

GET /rest/StorageServers/{name}

Get the OST storage server identified by {name}.

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

Since:

1.2

deleteStorageServer

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

DELETE /rest/StorageServers/{name}

Delete the storage server on the system identified by {name}.

Since:

1.1

updateStorageServer

public StorageServer updateStorageServer(@Context
                                         javax.servlet.http.HttpServletRequest request,
                                         java.lang.String name,
                                         StorageServer storageServer)

PUT /rest/StorageServers/{name}

Update the storage server on the system identified by {name} on the system.

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

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

Since:

1.1

addStorageServer

public javax.ws.rs.core.Response addStorageServer(@Context
                                                  javax.servlet.http.HttpServletRequest request,
                                                  StorageServer storageServer)

POST /rest/StorageServers

Add a storage server for the system.

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

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

Since:

1.1