com.quantum.dxi.rest.vtl

Class HostAccessGroups

java.lang.Object

Base

com.quantum.dxi.rest.vtl.HostAccessGroups

public class HostAccessGroups
extends Base

The HostAccessGroups resource represents the currently configured host access groups. The HostAccessGroups interface includes CRUD services for manipulating the list of available host access groups.

The schema that defines the HostAccessGroups resource is defined below.

 
    <xs:simpleType name="PartitionDeviceType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="VMC"/>
            <xs:enumeration value="VTD"/>
            <xs:enumeration value="CCL">
                <xs:annotation>
                    <xs:documentation>Only applicable to devices in HostAccessGroup (read-only).</xs:documentation>
                </xs:annotation>
            </xs:enumeration>
        </xs:restriction>
    </xs:simpleType>

    <xs:element name="PartitionDevice">
        <xs:complexType>
            <xs:all>
                <xs:element name="Type" type="PartitionDeviceType" minOccurs="0"/>
                <xs:element name="SerialNumber" type="xs:string"/>
                <xs:element name="Lun" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Only applicable to devices in HostAccessGroup.</xs:documentation>
                    </xs:annotation>
                    <xs:simpleType>
                        <xs:restriction base="xs:int">
                            <xs:minInclusive value="0"/>
                            <xs:maxInclusive value="255"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>

    <xs:element name="HostAccessGroup">
        <xs:complexType>
            <xs:all>
                <xs:element name="Partition" type="xs:string"/>
                <xs:element name="Name" type="xs:string"/>
                <xs:element name="HostWwpn" type="xs:string"/>
                <xs:element name="TargetWwpn" type="xs:string"/>
                <xs:element name="CclInUse" type="xs:boolean" minOccurs="0"/>
                <xs:element name="PartitionDevices" minOccurs="0">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element ref="PartitionDevice" minOccurs="0" maxOccurs="255"/>
                        </xs:sequence>
                    </xs:complexType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>

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

    <xs:simpleType name="HostAccessGroupColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Partition"/>
            <xs:enumeration value="Name"/>
            <xs:enumeration value="HostWwpn"/>
            <xs:enumeration value="TargetWwpn"/>
            <xs:enumeration value="CclInUse"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
HostAccessGroups()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addHostAccessGroup(javax.servlet.http.HttpServletRequest request, HostAccessGroup hostAccessGroup, java.lang.String errorType) POST /rest/HostAccessGroups
void	deleteHostAccessGroup(javax.servlet.http.HttpServletRequest request, java.lang.String partition, java.lang.String name, java.lang.String errorType) DELETE /rest/HostAccessGroups/{partition}/{name}
HostAccessGroup	getHostAccessGroup(javax.servlet.http.HttpServletRequest request, java.lang.String partition, java.lang.String name, java.lang.String errorType) GET /rest/HostAccessGroups/{partition}/{name}
com.quantum.dxi.dao.types.HostAccessGroups	getHostAccessGroups(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/HostAccessGroups
com.quantum.dxi.dao.types.HostAccessGroups	getHostAccessGroups(javax.servlet.http.HttpServletRequest request, java.lang.String partition, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString, java.lang.String errorType) GET /rest/HostAccessGroups/{partition}
NumericScalarType	getHostAccessGroupsCount(javax.servlet.http.HttpServletRequest request, java.lang.String filterString, java.lang.String errorType) GET /rest/HostAccessGroups/getRowCount
NumericScalarType	getHostAccessGroupsCount(javax.servlet.http.HttpServletRequest request, java.lang.String partition, java.lang.String filterString, java.lang.String errorType) GET /rest/HostAccessGroups/getRowCount/{partition}
HostAccessGroup	updateHostAccessGroup(javax.servlet.http.HttpServletRequest request, java.lang.String partition, java.lang.String name, HostAccessGroup hostAccessGroup, java.lang.String errorType) PUT /rest/HostAccessGroups/{partition}/{name}

Methods inherited from class java.lang.Object

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

Constructor Detail

HostAccessGroups

public HostAccessGroups()

Method Detail

addHostAccessGroup

public javax.ws.rs.core.Response addHostAccessGroup(@Context
                                                    javax.servlet.http.HttpServletRequest request,
                                                    HostAccessGroup hostAccessGroup,
                                                    java.lang.String errorType)

POST /rest/HostAccessGroups

Add a new host access group.

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

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

Since:

1.1

getHostAccessGroups

public com.quantum.dxi.dao.types.HostAccessGroups getHostAccessGroups(@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/HostAccessGroups

Get a list of host access groups.

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

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

Since:

1.1

getHostAccessGroups

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

GET /rest/HostAccessGroups/{partition}

Get host access groups, associated with {partition}.

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

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

Since:

1.1

getHostAccessGroup

public HostAccessGroup getHostAccessGroup(@Context
                                          javax.servlet.http.HttpServletRequest request,
                                          java.lang.String partition,
                                          java.lang.String name,
                                          java.lang.String errorType)

GET /rest/HostAccessGroups/{partition}/{name}

Get a certain host access group, identified by {name} and {partition} it is associated with.

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

Since:

1.1

getHostAccessGroupsCount

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

GET /rest/HostAccessGroups/getRowCount

Get the number of available host access groups.

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

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

Since:

1.1

getHostAccessGroupsCount

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

GET /rest/HostAccessGroups/getRowCount/{partition}

Get the number of available host access groups, associated with {partition}.

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

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

Since:

1.1

updateHostAccessGroup

public HostAccessGroup updateHostAccessGroup(@Context
                                             javax.servlet.http.HttpServletRequest request,
                                             java.lang.String partition,
                                             java.lang.String name,
                                             HostAccessGroup hostAccessGroup,
                                             java.lang.String errorType)

PUT /rest/HostAccessGroups/{partition}/{name}

Update ccl and device mappings of the host access group, identified by {name} and {partition} it is associated with. Note: HostWwpn and TargetWwpn input fields is ignored - no need to set them.

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

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

Since:

1.1

deleteHostAccessGroup

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

DELETE /rest/HostAccessGroups/{partition}/{name}

Delete host access group, identified by {name} and {partition} it is associated with.

Since:

1.1