com.quantum.dxi.rest.dataservices

Class FibreChannelPorts

java.lang.Object

Base

com.quantum.dxi.rest.dataservices.FibreChannelPorts

public class FibreChannelPorts
extends Base

The FibreChannelPorts resource represents the fibre channel ports on the system. The FibreChannelPorts interface includes services for getting information about the ports and updating the properties of the ports.

The schema that defines the FibreChannelPorts resource is defined below.

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

    <xs:element name="FibreChannelPort">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="WWPN" type="xs:string"/>
                <xs:element name="Alias" type="xs:string"/>
                <xs:element name="Updateable" type="xs:boolean"/>
                <xs:element name="FCPortType">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="Initiator"/>
                            <xs:enumeration value="Target"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="FibreChannelPortColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="WWPN"/>
            <xs:enumeration value="Alias"/>
            <xs:enumeration value="FCPortType"/>
            <xs:enumeration value="Updateable"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
FibreChannelPorts()

Method Summary

Modifier and Type	Method and Description
FibreChannelPort	getFibreChannelPort(javax.servlet.http.HttpServletRequest request, String alias) GET /rest/FibreChannelPorts/{alias}
Object	getFibreChannelPorts(javax.servlet.http.HttpServletRequest request, int start, int limit, String sortColumn, String sortDirection, String actionString, String filterString) GET /rest/FibreChannelPorts
NumericScalarType	getRowCount(javax.servlet.http.HttpServletRequest request, int start, int limit, String filterString) GET /rest/FibreChannelPorts/getRowCount
javax.ws.rs.core.Response	updateFibreChannelPort_1_1(javax.servlet.http.HttpServletRequest request, String alias, FibreChannelPort fibreChannelPort) PUT /rest/FibreChannelPorts/{alias}
NumericScalarType	updateFibreChannelPort(javax.servlet.http.HttpServletRequest request, String alias, FibreChannelPort fibreChannelPort) Deprecated. As of 1.1, @see #updateFibreChannelPort_1_1(HttpServletRequest, FibreChannelPort)

Methods inherited from class java.lang.Object

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

Constructor Detail

FibreChannelPorts

public FibreChannelPorts()

Method Detail

getRowCount

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

GET /rest/FibreChannelPorts/getRowCount

Get the number fibre channel ports on the system

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

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

Since:

1.1

getFibreChannelPorts

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

GET /rest/FibreChannelPorts

Get the fibre channel ports on the system

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

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

Deprecated as of 1.1:
The "action" query parameter is deprecated.
?action=getRowCount replaced by getRowCount(HttpServletRequest, int, int, String)

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

getFibreChannelPort

public FibreChannelPort getFibreChannelPort(@Context
                                            javax.servlet.http.HttpServletRequest request,
                                            String alias)

GET /rest/FibreChannelPorts/{alias}

Get the fibre channel port on the system identified by {alias}

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

updateFibreChannelPort_1_1

public javax.ws.rs.core.Response updateFibreChannelPort_1_1(@Context
                                                            javax.servlet.http.HttpServletRequest request,
                                                            String alias,
                                                            FibreChannelPort fibreChannelPort)

PUT /rest/FibreChannelPorts/{alias}

Start a background job to update the fibre channel port identified by {alias}

Request Entity type: <xs:element name="FibreChannelPort">
Response Entity type: <xs:element name="NumericScalarType"> containing the job id of a <xs:element name="BackgroundJob">

Since:

1.1

updateFibreChannelPort

public NumericScalarType updateFibreChannelPort(@Context
                                                javax.servlet.http.HttpServletRequest request,
                                                String alias,
                                                FibreChannelPort fibreChannelPort)

Deprecated. As of 1.1, @see #updateFibreChannelPort_1_1(HttpServletRequest, FibreChannelPort)

PUT /rest/FibreChannelPorts/{alias}

Start a background job to update the fibre channel port identified by {alias}

Request Entity type: <xs:element name="FibreChannelPort">
Response Entity type: <xs:element name="NumericScalarType"> containing the job id of a @see com.quantum.dxi.rest.system.BackgroundJobs <xs:element name="BackgroundJob">