com.quantum.dxi.rest.vtl

Class RemoteHosts

java.lang.Object

Base

com.quantum.dxi.rest.vtl.RemoteHosts

public class RemoteHosts
extends Base

The RemoteHosts resource represents the available remote hosts currently configured on the device. The RemoteHosts interface includes CRUD services for manipulating the list of available remote hosts.

The schema that defines the RemoteHosts resource is defined below.

 
    <xs:simpleType name="RemoteHostConnectionType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Active"/>
            <xs:enumeration value="Inactive"/>
        </xs:restriction>
    </xs:simpleType>

    <xs:element name="RemoteHost">
        <xs:complexType>
            <xs:all>
                <xs:element name="Wwpn" type="xs:string"/>
                <xs:element name="Alias" type="xs:string"/>
                <xs:element name="Connection" type="RemoteHostConnectionType" minOccurs="0"/>
            </xs:all>
        </xs:complexType>
    </xs:element>

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

    <xs:simpleType name="RemoteHostColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Wwpn"/>
            <xs:enumeration value="Alias"/>
            <xs:enumeration value="Connection"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
RemoteHosts()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addRemoteHost(javax.servlet.http.HttpServletRequest request, RemoteHost remoteHost, java.lang.String errorType) POST /rest/RemoteHosts
void	deleteRemoteHost(javax.servlet.http.HttpServletRequest request, java.lang.String wwpn, java.lang.String errorType) DELETE /rest/RemoteHosts/{wwpn}
RemoteHost	getRemoteHost(javax.servlet.http.HttpServletRequest request, java.lang.String wwpn, java.lang.String errorType) GET /rest/RemoteHosts/{wwpn}
com.quantum.dxi.dao.types.RemoteHosts	getRemoteHosts(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString, java.lang.String errorType) GET /rest/RemoteHosts
NumericScalarType	getRemoteHostsCount(javax.servlet.http.HttpServletRequest request, java.lang.String filterString, java.lang.String errorType) GET /rest/RemoteHosts/getRowCount
RemoteHost	updateRemoteHost(javax.servlet.http.HttpServletRequest request, java.lang.String wwpn, RemoteHost remoteHost, java.lang.String errorType) PUT /rest/RemoteHosts/{wwpn}

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteHosts

public RemoteHosts()

Method Detail

addRemoteHost

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

POST /rest/RemoteHosts

Add a new remote host to the available host list. Note: RemoteHost.Connection input field is ignored - no need to set it.

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

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

Since:

1.1

getRemoteHosts

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

GET /rest/RemoteHosts

Get a list of available remote hosts.

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

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

Since:

1.1

getRemoteHost

public RemoteHost getRemoteHost(@Context
                                javax.servlet.http.HttpServletRequest request,
                                java.lang.String wwpn,
                                java.lang.String errorType)

GET /rest/RemoteHosts/{wwpn}

Get a certain remote host, identified by {wwpn}.

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

Since:

1.1

getRemoteHostsCount

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

GET /rest/RemoteHosts/getRowCount

Get the number of available remote hosts.

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

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

Since:

1.1

updateRemoteHost

public RemoteHost updateRemoteHost(@Context
                                   javax.servlet.http.HttpServletRequest request,
                                   java.lang.String wwpn,
                                   RemoteHost remoteHost,
                                   java.lang.String errorType)

PUT /rest/RemoteHosts/{wwpn}

Change the alias of a remote host, identified by {wwpn}. Note: RemoteHost.Connection input field is ignored - no need to set it.

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

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

Since:

1.1

deleteRemoteHost

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

DELETE /rest/RemoteHosts/{wwpn}

Delete an existing inactive host, identified by {wwpn}, from available remote host list. Active host cannot be deleted.

Since:

1.1