com.quantum.dxi.rest.ost

Class TargetIPMappings

java.lang.Object

Base

com.quantum.dxi.rest.ost.TargetIPMappings

public class TargetIPMappings
extends Base

The TargetIPMappings resource represents IP address mapping to allow OST AIR data to be routed to the replication network rather than the data network. The TargetIPMappings service provides interfaces to get, add, update, and delete IP address mappings.

The schema that defines the TargetIPMappings resource is defined below.

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

    <xs:element name="TargetIPMapping">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="DataIP" type="xs:string"/>
                <xs:element name="ReplicationIP" type="xs:string"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="TargetIPMappingColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="DataIP"/>
            <xs:enumeration value="ReplicationIP"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
TargetIPMappings()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addTargetIPMappingDataIP_1_1(javax.servlet.http.HttpServletRequest request, TargetIPMapping targetIPMapping) POST /rest/TargetIPMappings
TargetIPMapping	addTargetIPMappingDataIP(javax.servlet.http.HttpServletRequest request, TargetIPMapping targetIPMapping) Deprecated. As of 1.1, replaced by addTargetIPMappingDataIP_1_1(HttpServletRequest, TargetIPMapping)
void	deleteTargetIPMapping(javax.servlet.http.HttpServletRequest request, java.lang.String dataip) DELETE /rest/TargetIPMappings/{dataIP}
java.lang.Object	getTargetIPMappings(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) GET /rest/TargetIPMappings
NumericScalarType	getTargetIPMappingsCount(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String filterString) GET /rest/TargetIPMappings/getRowCount
StringListScalarType	getTargetIPMappingsDataIps(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String filterString) GET /rest/TargetIPMappings/getDataIps
TargetIPMapping	updateTargetIPMappingDataIp(javax.servlet.http.HttpServletRequest request, java.lang.String dataIP, TargetIPMapping targetIPMapping) PUT /rest/TargetIPMappings/{dataIP}

Methods inherited from class java.lang.Object

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

Constructor Detail

TargetIPMappings

public TargetIPMappings()

Method Detail

getTargetIPMappingsCount

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

GET /rest/TargetIPMappings/getRowCount

Get the number of target IP address data-to-replication network mappings on the system.

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

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

Since:

1.1

getTargetIPMappingsDataIps

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

GET /rest/TargetIPMappings/getDataIps

Get target IP address data-to-replication network mappings on the system.

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

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

Since:

1.1

getTargetIPMappings

public java.lang.Object getTargetIPMappings(@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)

GET /rest/TargetIPMappings

Get the list of target IP address data-to-replication network mappings on the system.

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

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

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

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

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

deleteTargetIPMapping

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

DELETE /rest/TargetIPMappings/{dataIP}

Delete the target IP address mapping on the system for the target data IP address identified by {dataIP}.

updateTargetIPMappingDataIp

public TargetIPMapping updateTargetIPMappingDataIp(@Context
                                                   javax.servlet.http.HttpServletRequest request,
                                                   java.lang.String dataIP,
                                                   TargetIPMapping targetIPMapping)

PUT /rest/TargetIPMappings/{dataIP}

Update the target IP address mapping on the system for the target data IP address identified by {dataIP}.

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

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

addTargetIPMappingDataIP_1_1

public javax.ws.rs.core.Response addTargetIPMappingDataIP_1_1(@Context
                                                              javax.servlet.http.HttpServletRequest request,
                                                              TargetIPMapping targetIPMapping)

POST /rest/TargetIPMappings

Add a new data-to-replication network IP address mapping for a replication target on this system.

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

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

Since:

1.1

addTargetIPMappingDataIP

public TargetIPMapping addTargetIPMappingDataIP(@Context
                                                javax.servlet.http.HttpServletRequest request,
                                                TargetIPMapping targetIPMapping)

Deprecated. As of 1.1, replaced by addTargetIPMappingDataIP_1_1(HttpServletRequest, TargetIPMapping)

POST /rest/TargetIPMappings

Add a new data-to-replication network IP address mapping for a replication target on this system.

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

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