Page tree

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

curl
curl --request POST \
    --url https://<Director_IP_address>:4443/c/router \
    --header "content-type: application/json" \
    --cookie @cookies.txt \
    --data {
		"action": "TransporterManagement",
		"method": "add",
		"data": [{ 
			"name": "10.30.30.1", 
			"host": "10.30.30.1", 
			"port": 9446, 
			"loadFactor": 6, 
			"loggingLevel": "AUTO", 
			"dataPortRangeStart": 9448, 
			"dataPortRangeEnd": 10000, 
			"description": "" }], 
		"type": "rpc", 
		"tid": 3756 }

Request Fields

Field
Type
Value(s)
Description
actionstring

TransporterManagement

The action that is invoked
methodstring

add

The method that is invoked
dataarray
Data of a Transporter to be added
typestringrpcType of communication protocol
tidinteger1Transaction ID. Used to identify the request by both the client and the server

Data

Field
Type
Description

name

stringDisplay name of the Transporter

host

stringIP address or host name of the machine where the Transporter is installed

port

integerPort number that will be used to connect to the Transporter

loadFactor

integerMaximum number of tasks that the Transporter should process simultaneously

loggingLevel

stringLogging level to be enabled for this Transporter

dataPortRangeStart

integerStart number of the port range to be used for transferring data

dataPortRangeEnd

integerEnd number of the port range to be used for transferring data

description

stringDescription of the Transporter

Response Sample

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

Response Fields

Field
Value
Description
messagestringMessage if the request failed
wherestringReference to the method where the problem occurred
causestringCause of failure

data

integerID of the added Transporter
  • No labels