Computer Move Tasks

Describe a Computer Move Task

get/computermovetasks/{computerMoveTaskID}

Describe a computer move task.

Related SDK Methods:
Java

ComputerMoveTasksApi.describeComputerMoveTask([param1, param2, ...])

Python

ComputerMoveTasksApi.describe_computer_move_task([param1, param2, ...])

JavaScript

ComputerMoveTasksApi.describeComputerMoveTask([param1, param2, ...])

Request
path Parameters
computerMoveTaskID
required
integer <int64> \d+

The ID number of the computer move task to describe.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200successful operation
403Not authorized to move computers.
Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.ComputerMoveTasksApi;
import com.trendmicro.deepsecurity.model.ComputerMoveTask;


public class DescribeComputerMoveTaskExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		ComputerMoveTasksApi instance = new ComputerMoveTasksApi();
		Long computerMoveTaskID = 1L;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			ComputerMoveTask result = instance.describeComputerMoveTask(computerMoveTaskID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling ComputerMoveTasksApi.describeComputerMoveTask");
			e.printStackTrace();
		}
	}
}

Response samples
application/json
{
  • "computerID": 0,
  • "workloadSecurityPolicyID": 0,
  • "workloadSecurityComputerGroupID": 0,
  • "workloadSecurityRelayGroupID": 0,
  • "workloadSecurityProxy": {
    },
  • "workloadSecurityRelayProxy": {
    },
  • "moveState": "move-requested",
  • "created": 0,
  • "ID": 0
}

List Computer Move Tasks

get/computermovetasks

Describe a computer move task.

Related SDK Methods:
Java

ComputerMoveTasksApi.listComputerMoveTasks([param1, param2, ...])

Python

ComputerMoveTasksApi.list_computer_move_tasks([param1, param2, ...])

JavaScript

ComputerMoveTasksApi.listComputerMoveTasks([param1, param2, ...])

Request
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200successful operation
403Not authorized to move computers.
Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.ComputerMoveTasksApi;
import com.trendmicro.deepsecurity.model.ComputerMoveTasks;


public class ListComputerMoveTasksExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		ComputerMoveTasksApi instance = new ComputerMoveTasksApi();
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			ComputerMoveTasks result = instance.listComputerMoveTasks(apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling ComputerMoveTasksApi.listComputerMoveTasks");
			e.printStackTrace();
		}
	}
}

Response samples
application/json
{
  • "computerMoveTasks": [
    ]
}

Create a Computer Move Task

post/computermovetasks

Create a new computer move task.

Related SDK Methods:
Java

ComputerMoveTasksApi.createComputerMoveTask([param1, param2, ...])

Python

ComputerMoveTasksApi.create_computer_move_task([param1, param2, ...])

JavaScript

ComputerMoveTasksApi.createComputerMoveTask([param1, param2, ...])

Request
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

The task to move the computers.

computerID
integer <int32>

Target computer to move. Searchable as Numeric.

created
integer <int64>

Timestamp when the ComputerMoveTask was created, in milliseconds since epoch. Searchable as Date.

moveState
string

Move status

Enum: "move-requested" "moving" "move-complete" "move-failed" "move-failed-no-response" "move-failed-activation-failed" "move-failed-unmanaged"
workloadSecurityComputerGroupID
integer <int64>

Computer Group ID on the Workload Security.

workloadSecurityPolicyID
integer <int64>

Policy ID on the Workload Security.

object (workloadSecurityProxy)

Details of a proxy for agent to connect to the Workload Security

workloadSecurityRelayGroupID
integer <int64>

Relay Group ID on the Workload Security.

object (workloadSecurityRelayProxy)

Details of a proxy for agent to connect to Workload Security relays

Responses
200successful operation
400Invalid parameters to create a computer move task
403Not authorized to move computers.
409A computer move task already exists
Request samples
application/json
{
  • "computerID": 0,
  • "workloadSecurityPolicyID": 0,
  • "workloadSecurityComputerGroupID": 0,
  • "workloadSecurityRelayGroupID": 0,
  • "workloadSecurityProxy": {
    },
  • "workloadSecurityRelayProxy": {
    },
  • "moveState": "move-requested",
  • "created": 0
}
Response samples
application/json
{
  • "computerID": 0,
  • "workloadSecurityPolicyID": 0,
  • "workloadSecurityComputerGroupID": 0,
  • "workloadSecurityRelayGroupID": 0,
  • "workloadSecurityProxy": {
    },
  • "workloadSecurityRelayProxy": {
    },
  • "moveState": "move-requested",
  • "created": 0,
  • "ID": 0
}

Search Computer Move Tasks

post/computermovetasks/search

Search for computer move task using optional filters.

Related SDK Methods:
Java

ComputerMoveTasksApi.searchComputerMoveTasks([param1, param2, ...])

Python

ComputerMoveTasksApi.search_computer_move_tasks([param1, param2, ...])

JavaScript

ComputerMoveTasksApi.searchComputerMoveTasks([param1, param2, ...])

Request
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

A collection of options used to filter the search results.

maxItems
integer <int32>

Limits the number of objects returned. Default 5000.

Array of objects (searchCriteria)

Array of search critiera used to filter objects. Searching with multiple criteria returns results that satisfy all of the criteria. Searching with no criteria returns all objects.

sortByObjectID
boolean

If true, forces the response objects to be sorted by ID, overriding the default sort order. Default "false".

Responses
200successful operation
403Not authorized to move computers.
Request samples
application/json
{
  • "maxItems": 0,
  • "searchCriteria": [
    ],
  • "sortByObjectID": true
}
Response samples
application/json
{
  • "computerMoveTasks": [
    ]
}