Targets (DXi RESTful Services 6.0-SNAPSHOT API)

java.lang.Object
- Base
- - com.quantum.dxi.rest.replication.Targets

public class Targets
extends Base

The Targets resource represents systems that are configured as replication targets for this system. The Targets resource includes services for getting the list of configured targets, and for adding and deleting targets.

The schema that defines the Targets resource is defined below.

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

    <xs:element name="Target">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="HostName" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>IPv4, IPv6, domain name</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Encryption" type="EncryptionType"/>
                <xs:element name="ReplicationType">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="OLD"/>
                            <xs:enumeration value="NEW"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="SourceIP" type="xs:string" minOccurs="0"/>
                <xs:element name="State" minOccurs="0">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="READY"/>
                            <xs:enumeration value="MANUALLY_PAUSED"/>
                            <xs:enumeration value="SYSTEM_PAUSED"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="EncryptionType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="NONE"/>
            <xs:enumeration value="128-BIT"/>
            <xs:enumeration value="256-BIT"/>
            <xs:enumeration value="TLS-256"/>
        </xs:restriction>
    </xs:simpleType>

    <xs:simpleType name="TargetColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="HostName"/>
            <xs:enumeration value="Encryption"/>
            <xs:enumeration value="ReplicationType"/>
            <xs:enumeration value="SourceIP"/>
            <xs:enumeration value="State"/>
        </xs:restriction>
    </xs:simpleType>

Constructor Summary

Constructors
Constructor and Description

Targets()

Constructors
Constructor and Description
`Targets()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`addTarget(javax.servlet.http.HttpServletRequest request, Target target)` POST /rest/Targets
`void`	`callActionOnItem(javax.servlet.http.HttpServletRequest request, String actionString, String hostName)` Deprecated. As of 1.1 ?action=pause replaced by `pauseReplication(HttpServletRequest, String)` ?action=resume replaced by `resumeReplication(HttpServletRequest, String)`
`Object`	`callActionOnItems(javax.servlet.http.HttpServletRequest request, String actionString, Target target)` Deprecated. As of 1.1 ?action=pauseReplication replaced by `pauseReplication(HttpServletRequest)` ?action=pauseReplication replaced by `resumeReplication(HttpServletRequest)`
`void`	`deleteTarget(javax.servlet.http.HttpServletRequest request, String hostName)` DELETE /rest/Targets/{hostName}
`Target`	`getTarget(javax.servlet.http.HttpServletRequest request, String hostName)` GET /rest/Targets/{hostName}
`com.quantum.dxi.dao.types.Targets`	`getTargets(javax.servlet.http.HttpServletRequest request, int start, int limit, String sortColumn, String sortDirection, String filterString)` GET /rest/Targets
`javax.ws.rs.core.Response`	`pauseReplication(javax.servlet.http.HttpServletRequest request)` POST /rest/Targets/pauseReplication
`javax.ws.rs.core.Response`	`pauseReplication(javax.servlet.http.HttpServletRequest request, String hostName)` POST /rest/Targets/{hostName}/pauseReplication
`javax.ws.rs.core.Response`	`resumeReplication(javax.servlet.http.HttpServletRequest request)` POST /rest/Targets/resumeReplication
`javax.ws.rs.core.Response`	`resumeReplication(javax.servlet.http.HttpServletRequest request, String hostName)` POST /rest/Targets/{hostName}/resumeReplication
`Target`	`updateTarget(javax.servlet.http.HttpServletRequest request, String hostName, Target target)` PUT /rest/Targets/{hostName}

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- Targets
```
public Targets()
```

Method Detail

getTargets

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

GET /rest/Targets

Get the list of systems configured as targets on the system.

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

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

getTarget

public Target getTarget(@Context
                        javax.servlet.http.HttpServletRequest request,
                        String hostName)

GET /rest/Targets/{hostName}

Get the system identified by {hostName} that is configured as a target on the system.

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

updateTarget
```
public Target updateTarget(@Context
                           javax.servlet.http.HttpServletRequest request,
                           String hostName,
                           Target target)
```
PUT /rest/Targets/{hostName}
Update a system identified by {hostName} from the list of systems configured as sources on the system.
Request Entity type: <xs:element name="Target">
Response Entity type: <xs:element name="Target">

pauseReplication

public javax.ws.rs.core.Response pauseReplication(@Context
                                                  javax.servlet.http.HttpServletRequest request)

POST /rest/Targets/pauseReplication

Pause replication for all targets on this system.

Since:: 1.1

resumeReplication

public javax.ws.rs.core.Response resumeReplication(@Context
                                                   javax.servlet.http.HttpServletRequest request)

POST /rest/Targets/resumeReplication

Resume replication for all targets on this system.

Since:: 1.1

addTarget

public javax.ws.rs.core.Response addTarget(@Context
                                           javax.servlet.http.HttpServletRequest request,
                                           Target target)

POST /rest/Targets

Add a replication target to this system.

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

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

Since:: 1.1

callActionOnItems
```
public Object callActionOnItems(@Context
                                javax.servlet.http.HttpServletRequest request,
                                String actionString,
                                Target target)
```
Deprecated. As of 1.1
?action=pauseReplication replaced by pauseReplication(HttpServletRequest)
?action=pauseReplication replaced by resumeReplication(HttpServletRequest)
POST /rest/Targets
Add a replication target to this system; or, if the action query parameter is present, Perform the requested action on all replication targets.
Supported actions are:
- ?action=pause pause replication for all targets on this system
- ?action=resume resume replication for all targets on this system
When adding a replication target, a Request Entity body is required.
Request Entity type: <xs:element name="Target">
Response Entity type: <xs:element name="Target">
When performing an action, no request body is required.
Response Entity type: <xs:element name="StringScalarType">

pauseReplication

public javax.ws.rs.core.Response pauseReplication(@Context
                                                  javax.servlet.http.HttpServletRequest request,
                                                  String hostName)

POST /rest/Targets/{hostName}/pauseReplication

Pause all replications on this system for the specified target.

Since:: 1.1

resumeReplication

public javax.ws.rs.core.Response resumeReplication(@Context
                                                   javax.servlet.http.HttpServletRequest request,
                                                   String hostName)

POST /rest/Targets/{hostName}/resumeReplication

Resume all replications on this system for the specified target.

Since:: 1.1

callActionOnItem
```
public void callActionOnItem(@Context
                             javax.servlet.http.HttpServletRequest request,
                             String actionString,
                             String hostName)
```
Deprecated. As of 1.1
?action=pause replaced by pauseReplication(HttpServletRequest, String)
?action=resume replaced by resumeReplication(HttpServletRequest, String)
POST /rest/Targets/{hostName}
Perform the request action for a replication target identified by {hostName}.
The action query parameter is required.
Supported actions are:
- ?action=pause pause replication for the specified target on this system
- ?action=resume resume replication for the specified target on this system

deleteTarget

public void deleteTarget(@Context
                         javax.servlet.http.HttpServletRequest request,
                         String hostName)

DELETE /rest/Targets/{hostName}

Delete a system identified by {hostName} from the list of systems configured as targets on the system.

Class Targets

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Targets

Method Detail

getTargets

getTarget

updateTarget

pauseReplication

resumeReplication

addTarget

callActionOnItems

pauseReplication

resumeReplication

callActionOnItem

deleteTarget