Computer Move Tasks

Create a Batch Computer Move Task

post/batchcomputermovetasks

Create a new batch computer move task.

Related SDK Methods:
Java

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

Python

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

JavaScript

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

Request
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

Tasks to move the computers.

computerIDs
required
Array of integers <int32>

Target computers to move.

includeComputerDescription
boolean

Controls whether the Computer Move Task moves the hostname, display name, and description. Defaults to true.

includeComputerOverrides
boolean

Controls whether the Computer Move Task moves setting is overridden at the computer level. Defaults to true.

proxyIDToContactWorkloadSecurity
integer <int32>

Deep Security proxy ID for the computer to contact to Workload Security.

proxyIDToContactWorkloadSecurityRelay
integer <int32>

Deep Security proxy ID for the computer to contact to Workload Security relays.

referToLatestMigratedPolicy
boolean

Controls whether the last successfully migrated policies are assigned to the computers.

workloadSecurityComputerGroupID
integer <int64>

Computer Group ID in Workload Security.

workloadSecurityPolicyID
integer <int64>

Policy ID in Workload Security.

object (workloadSecurityProxy)

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

workloadSecurityRelayGroupID
integer <int64>

Relay Group ID in Workload Security.

object (workloadSecurityRelayProxy)

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

Responses
200

successful operation

400

Invalid parameters to create computer move tasks

403

Not authorized to move computers.

409

Batch computer move task already exists

429

Too many computer IDs

Request samples
application/json
{
  • "workloadSecurityPolicyID": 0,
  • "workloadSecurityComputerGroupID": 0,
  • "workloadSecurityRelayGroupID": 0,
  • "workloadSecurityProxy": {
    },
  • "proxyIDToContactWorkloadSecurity": 0,
  • "workloadSecurityRelayProxy": {
    },
  • "proxyIDToContactWorkloadSecurityRelay": 0,
  • "includeComputerOverrides": true,
  • "includeComputerDescription": true,
  • "referToLatestMigratedPolicy": true,
  • "computerIDs": [
    ]
}
Response samples
application/json
{
  • "createdComputerMoveTasks": [
    ],
  • "computersUnableToMove": [
    ]
}

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
200

successful operation

403

Not 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
{
  • "workloadSecurityPolicyID": 0,
  • "workloadSecurityComputerGroupID": 0,
  • "workloadSecurityRelayGroupID": 0,
  • "workloadSecurityProxy": {
    },
  • "proxyIDToContactWorkloadSecurity": 0,
  • "workloadSecurityRelayProxy": {
    },
  • "proxyIDToContactWorkloadSecurityRelay": 0,
  • "includeComputerOverrides": true,
  • "includeComputerDescription": true,
  • "referToLatestMigratedPolicy": true,
  • "computerID": 0,
  • "moveState": "move-requested",
  • "created": 0,
  • "lastUpdated": 0,
  • "ID": 0
}

List Computer Move Tasks

get/computermovetasks

List all computer move tasks.

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
200

successful operation

403

Not 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
required
integer <int32>

Target computer to move. Searchable as Numeric.

includeComputerDescription
boolean

Controls whether the Computer Move Task moves the hostname, display name, and description. Defaults to true.

includeComputerOverrides
boolean

Controls whether the Computer Move Task moves setting is overridden at the computer level. Defaults to true.

proxyIDToContactWorkloadSecurity
integer <int32>

Deep Security proxy ID for the computer to contact to Workload Security.

proxyIDToContactWorkloadSecurityRelay
integer <int32>

Deep Security proxy ID for the computer to contact to Workload Security relays.

referToLatestMigratedPolicy
boolean

Controls whether the last successfully migrated policies are assigned to the computers.

workloadSecurityComputerGroupID
integer <int64>

Computer Group ID in Workload Security.

workloadSecurityPolicyID
integer <int64>

Policy ID in Workload Security.

object (workloadSecurityProxy)

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

workloadSecurityRelayGroupID
integer <int64>

Relay Group ID in Workload Security.

object (workloadSecurityRelayProxy)

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

Responses
200

successful operation

400

Invalid parameters to create a computer move task

403

Not authorized to move computers.

409

A computer move task already exists

502

Failed to connect to Workload Security.

Request samples
application/json
{
  • "workloadSecurityPolicyID": 0,
  • "workloadSecurityComputerGroupID": 0,
  • "workloadSecurityRelayGroupID": 0,
  • "workloadSecurityProxy": {
    },
  • "proxyIDToContactWorkloadSecurity": 0,
  • "workloadSecurityRelayProxy": {
    },
  • "proxyIDToContactWorkloadSecurityRelay": 0,
  • "includeComputerOverrides": true,
  • "includeComputerDescription": true,
  • "referToLatestMigratedPolicy": true,
  • "computerID": 0
}
Response samples
application/json
{
  • "workloadSecurityPolicyID": 0,
  • "workloadSecurityComputerGroupID": 0,
  • "workloadSecurityRelayGroupID": 0,
  • "workloadSecurityProxy": {
    },
  • "proxyIDToContactWorkloadSecurity": 0,
  • "workloadSecurityRelayProxy": {
    },
  • "proxyIDToContactWorkloadSecurityRelay": 0,
  • "includeComputerOverrides": true,
  • "includeComputerDescription": true,
  • "referToLatestMigratedPolicy": true,
  • "computerID": 0,
  • "moveState": "move-requested",
  • "created": 0,
  • "lastUpdated": 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
200

successful operation

403

Not authorized to move computers.

Request samples
application/json
{
  • "maxItems": 0,
  • "searchCriteria": [
    ],
  • "sortByObjectID": true
}
Response samples
application/json
{
  • "computerMoveTasks": [
    ]
}