Add Transporter

Product version: 11.00

Last modified: 30 September 2024

Adds an installed Transporter to your NAKIVO Backup & Replication configuration.

Endpoint

https://<Director_IP_address>:4443/c/router

Tenant Endpoint

For tenants of the multi-tenant product the endpoint must be:
https://<Director_IP_address>:4443/t/<tenant_UUID>/c/router

Request Example

Copy 
{
  "action": "TransporterManagement",
  "method": "add",
  "data": [{
      "id": null,
      "loggingLevel": "AUTO",
      "name": "10.10.15.107",
      "description": "",
      "host": "10.10.15.107",
      "port": 9446,
      "dataPortRangeStart": "9448",
      "dataPortRangeEnd": "10000",
      "loadFactor": 6,
      "additionalLoadFactor": 2,
      "isProxyTransporter": false,
      "masterPassword": "123123",
      "preSharedKey": "116c172b77b009d418ef57e4fc2cb2d96187fa2c86e3c7df652a72e85bac741cd404b1c0f602550050ee987fa2134305f020c85671aa3a3417f093a49a3c1252"
  }],
  "type": "rpc",
  "tid": 1
}

Request Fields

Field
Type
Value(s)
 Description
action string

TransporterManagement

The action that is invoked
method string

add

The method that is invoked
data array
Data of a Transporter to be added
type string rpc Type of communication protocol
tid integer 1 Transaction ID. Used to identify the request by both the client and the server

Data

Field
Type
Description
id integer Transporter ID
loggingLevel string Logging level to be enabled for this Transporter

name

string Display name of the Transporter
description string Description of the Transporter

host

string IP address or host name of the machine where the Transporter is installed

port

integer Port number that will be used to connect to the Transporter

loadFactor

integer Maximum number of tasks that the Transporter should process simultaneously
additionalLoadFactor integer Additional maximum number of simultaneous tasks that the Transporter should process

isProxyTransporter

boolean true if the Transporter is to be used as a proxy Transporter

dataPortRangeStart

integer Start number of the port range to be used for transferring data

dataPortRangeEnd

integer End number of the port range to be used for transferring data

masterPassword

string User master password
preSharedKey string Pre-shared key of the transporter received from the Connect Transporter method

Response Sample

Copy 
{
   "action":"TransporterManagement",
   "method":"add",
   "tid":"1",
   "type":"rpc",
   "message":null,
   "where":null,
   "cause":null,
   "data":17
}

Response Fields

Field
Value
Description
message string Message if the request failed
where string Reference to the method where the problem occurred
cause string Cause of failure

data

integer ID of the added Transporter