Connect Transporter

Product version: 11.00

Last modified: 30 September 2024

Connects 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

Copy

{
  "action": "TransporterManagement",
  "method": "connect",
  "data": [{
    "id": null,
    "host": "10.10.15.107",
    "port": 9446,
    "dataPortRangeStart": 0,
    "dataPortRangeEnd": 0,
    "masterPassword": "123123"
  }],
  "type": "rpc",
  "tid": 1
}

Request Fields

Field	Type	Value(s)	Description
`action`	string	`TransporterManagement`	The action that is invoked
`method`	string	`connect`	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
`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
`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

Response Sample

curl

Copy

{
   "action":"TransporterManagement",
   "method":"connect",
   "tid":"1",
   "type":"rpc",
   "message":null,
   "where":null,
   "cause":null,
   "data":{
      "versionNumber":"10.12.0.r82229",
"preSharedKey":"116c172b77b009d418ef57e4fc2cb2d96187fa2c86e3c7df652a72e85bac741cd404b1c0f602550050ee987fa2134305f020c85671aa3a3417f093a49a3c1252",
      "acceptTransCert":false,
      "host":null,
      "uuid":"1C49D5ED-5DA0-3AD2-A688-79D1F15DEC73",
      ....
    }
}

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

Data

Field	Type	Description
`versionNumber`	string	Transporter version number
`preSharedKey`	string	Pre-shared key of the transporter to be passed to the Add Transporter method
`acceptTransCert`	boolean	`true` to accept the Transporter certificate
`host`	string	IP address or host name of the machine where the Transporter is installed
`uuid`	integer	Transporter UUID