Add Transporter

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
`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
`name`	string	Display name 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
`loggingLevel`	string	Logging level to be enabled for this 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
`description`	string	Description 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
`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

Page tree