Get Transporter List

Product version: 10.11

Last modified: 31 July 2024

Returns the complete list of Transporters.

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

curl --request POST \
    --url https://<Director_IP_address>:4443/c/router \
    --header "content-type: application/json" \
    --cookie @cookies.txt \
    --data '{
            "action": "TransporterManagement",
            "method": "getTransporters",
            "data": null,
            "type": "rpc",
            "tid": 1}'

Request Fields

Field	Type	Value(s)
`action`	string	`TransporterManagement`
`method`	string	`getTransporters`
`data`	`null`
`type`	string	`rpc`
`tid`	integer	`1`

Response Sample

curl

Copy

 {
  "action": "TransporterManagement",
  "method": "getTransporters",
  "tid": "1",
  "type": "rpc",
  "message": null,
  "where": null,
  "cause": null,
  "data": {
    "children": [
      {
       {
        "id": 3,
        "name": "EC2 Transporter",
        "state": "OK",
        "status": "NONE",
        "changeStatus": "NONE",
        "type": "AWS",
        "loggingLevel": "AUTO",
        "local": false,
        "host": "5awsEc2Support4.93.236.11",
        "port": 9446,
        "dataPortRangeStart": 9448,
        "dataPortRangeEnd": 10000,
        "loadFactor": 6,
        "description": "",
        "preventModification": false,
        "lockReasons": [],
        "outOfDate": false,
        "wasEdited": false,
        "wasDiscoveredOnce": true,
        "wasDeployed": false,
        "progress": 0,
        "version": "7.2.0.e18265",
        "fingerprint": "52:BE:24:83:7D:E4:C1:13:DE:6C:04:F9:38:DA:B8:1F:C6:90:42:17:92:CD:19:FC:6B:CD:00:0C:7C:0B:31:6A",
        "awsAccountId": 1,
        "regionId": 6,
        "ec2InstanceId": 65,
        "virtualizationType": "hvm",
        "vpcId": 14,
        "subnetId": 22,
        "availabilityZoneId": null,
        "inboundFilter": "0.0.0.0/0",
        "instanceType": "t2.small",
        "operationMode": "ALWAYS_RUNNING",
        "wasInfoDownloaded": true,
        "autoConfigureVpc": true,
        "isWindowsPlatform": false,
        "wasAutoPoweredOff": false,
        "accountName": "AWS",
        "regionName": "EU (Frankfurt)",
        "vpcName": "Nakivo vpc (10.0.0.0/16)",
        "subnetName": "Nakivo subnet (10.0.0.0/16)",
        "availabilityZoneName": null,
        "securityGroupName": "EC2 Transporter_41853ead-8930-40f9-8dfc-fa79835f796b",
        "os": "Linux",
        "vmwarevSphereSupport": false,
        "msHypervSupport": false,
        "awsEc2Support": true,
        "nutanixSupport": true,
        "repositoryManagementSupport": true,
        "cifsShareSupport": true,
        "nfsShareSupport": true,
        "repositoryEncryptionSupport": true,
        "windowsGuestsRecoverySupport": true,
        "linuxGuestsRecoverySupport": true,
        "flashVmBootSupport": true,
        "assignedAmazonEbsRepositoryId": null,
        "awsLocal": false,
        "hasAssignedBackupRepositories": false,
        "alertErrorCode": null,
        "alertTitle": null,
        "alertDescription": null
      },
      {
        "id": 1,
        "name": "Onboard transporter",
        "state": "OK",
        "status": "NONE",
        "changeStatus": "NONE",
        "type": "TRANSPORTER",
        "loggingLevel": "AUTO",
        "local": true,
        "host": "192.168.77.64",
        "port": 9446,
        "dataPortRangeStart": 9448,
        "dataPortRangeEnd": 10000,
        "loadFactor": 6,
        "description": "This is the built-in Transporter of NAKIVO Backup & Replication. It is installed on the same machine where the main part of the product resides. For better scalability, you can deploy more Transporters. It is recommended to have at least one Transporter per each Source and Target site.",
        "preventModification": false,
        "lockReasons": [],
        "outOfDate": false,
        "wasEdited": false,
        "wasDiscoveredOnce": true,
        "wasDeployed": false,
        "progress": 0,
        "version": "7.2.0.r18265",
        "fingerprint": "5F:69:0C:87:4F:1D:13:51:38:82:C4:99:38:91:A0:3D:2A:54:84:63:53:ED:C9:91:68:BF:72:69:6A:F2:3D:63",
        "awsAccountId": null,
        "regionId": null,
        "ec2InstanceId": null,
        "virtualizationType": null,
        "vpcId": null,
        "subnetId": null,
        "availabilityZoneId": null,
        "inboundFilter": null,
        "instanceType": null,
        "operationMode": null,
        "wasInfoDownloaded": null,
        "autoConfigureVpc": null,
        "isWindowsPlatform": null,
        "wasAutoPoweredOff": false,
        "accountName": null,
        "regionName": null,
        "vpcName": null,
        "subnetName": null,
        "availabilityZoneName": null,
        "securityGroupName": null,
        "os": "Linux",
        "vmwarevSphereSupport": true,
        "msHypervSupport": false,
        "awsEc2Support": false,
        "nutanixSupport": true,
        "repositoryManagementSupport": true,
        "cifsShareSupport": true,
        "nfsShareSupport": true,
        "repositoryEncryptionSupport": true,
        "windowsGuestsRecoverySupport": true,
        "linuxGuestsRecoverySupport": true,
        "flashVmBootSupport": true,
        "assignedAmazonEbsRepositoryId": null,
        "awsLocal": false,
        "hasAssignedBackupRepositories": true,
        "alertErrorCode": null,
        "alertTitle": null,
        "alertDescription": null
      }
    ],
    "totalCount": 3
  }
}

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
`id`	`long`	Transporter ID
`vid`	string	Transporter VID
`name`	string	Transporter display name
state	string	The current state of the transporter. Possible values: `OK, WARNING, INACCESSIBLE, ERROR`
`status`	string	The current status of the transporter's operations. Possible values: `NONE, UPDATING`
`changeStatus`	string	NONE `CREATE_PENDING`: New item, discovery is needed CHANGE_PENDING: Some attributes have changed, discovery is needed `IMPORT_PENDING`: Import item `RECREATE_PENDING`: The item was destroyed and needs to be re-created
`type`	string	The type of the transporter. Possible values: `GENERIC, AWS, HYPERV, VMWARE, PHYSICAL, NUTANIX`
`loggingLevel`	string	Logging level. Possible values: `AUTO, DEBUG`
`hvType`	string	Platform type. Possible values for this field: `VMWARE, AWS, HYPERV, NONE, PHYSICAL, NUTANIX`
`local`	boolean	Checks if the Transporter is an onboard one
`host`	string	The host where the Transporter is installed
`port`	int	Transporter port
`dataPortRangeStart`	int	The start of the data transfer port range
`dataPortRangeEnd`	int	The end of the data transfer port range
`loadFactor`	int	The maximum number of the concurrent jobs
`description`	string	Description (optional)
`preventModification`	boolean	Checks if the Transporter is locked for manual modification
`lockReasons`	array	Lock reasons
`outOfDate`	boolean	Checks if the Transporter has an outdated version
`wasEdited`	boolean	Checks if the Transporter settings were edited
`wasDiscoveredOnce`	boolean	Checks if the Transporter was discovered for the first time
`wasDeployed`	boolean	`true` if the transporter was already deployed to the remote Hyper-V/AWS host
`progress`	int	Current operation progress
`version`	string	The version of the Transporter
`fingerprint`	string	Transporter certificate fingerprint
`wasAutoPoweredOff`	boolean	`true` if the EC2 instance was powered off automatically due to idle. See operation mode
`os`	string	Operating system where the Transporter is installed
`vmwarevSphereSupport`	boolean	Checks if the Transporter supports VMware
`msHypervSupport`	boolean	Checks if the Transporter supports Hyper-V
`awsEc2Support`	boolean	Checks if the Transporter supports AWS
`nutanixSupport`	boolean	Checks if the Transporter supports Nutanix AHW
`repositoryManagementSupport`	boolean	Checks if the Transporter can manage a repository
`cifsShareSupport`	boolean	Checks if the Transporter supports CIFS shares
`nfsShareSupport`	boolean	Checks if the Transporter supports NFS shares
`repositoryEncryptionSupport`	boolean	Checks if the Transporter supports repository encryption
`windowsGuestsRecoverySupport`	boolean	Checks if the Transporter supports Windows guest OS
`linuxGuestsRecoverySupport`	boolean	Checks if the Transporter supports Linux guest OS
`flashVmBootSupport`	boolean	Checks if the Transporter supports Flash VM Boot
`hasAssignedBackupRepositories`	boolean	Checks if the transporter has assigned backup repositories
`vmwareDeploymentInfo`	Json	VMware transporter deployment info. See the `vmwareDeploymentInfo` table below
`nutanixDeploymentInfo`	Json	Nutanix transporter deployment info. See the `nutanixDeploymentInfo` table below
`awsDeploymentInfo`	Json	AWS transporter deployment info. See the `awsDeploymentInfo` table below
`alertErrorCode`	`long`	The error code of the alert (if any)
`alertTitle`	string	The title of the alert (if any)
`alertDescription`	string	The description of the alert (if any)

awsDeploymentInfo

Field	Value	Description
`awsAccountId`	`long`	Internal ID of the AWS account where transporter is installed
`regionID`	`long`	Internal ID of the region where transporter is installed
`es2InstanceID`	`long`	Internal ID of the EC2 instance where transporter is installed
`virtualizationType`	string	Virtualization type
`vpcID`	`long`	VPC ID
`subnetID`	`long`	Subnet ID
`availabilityZoneId`	`long`	Availability zone ID
`inboundFilter`	string	IP filter for new EC2 instance where transporter will be deployed
`instanceType`	string	Type of the instance where transporter is installed
`operationMode`	string	Mode of operation. Possible values: `RUNNING_WHILE_REQUIRED, ALWAYS_RUNNING`
`wasInfoDownloaded`	boolean	When the transporter is deployed, an EC2 instance is created with a keypair necessary to access this instance. `true` if you downloaded it once using the product
`autoconfigureVpc`	boolean	Checks if the VPC is auto-configured
`isWindowsPlatform`	boolean	Checks if the transporter installed on Windows
`support64BitAmazonEbsRepository`	boolean	`true` if 64-bit Amazon EBS repository is supported
`accountName`	string	AWS account display name
`regionName`	string	Region display name
`vpcName`	string	VPC display name
`subnetName`	string	Subnet display name
`availabilityZoneName`	string	Availability zone display name
`securityGroupName`	string	Security group display name
`assignedAmazonEbsRepositoryId`	`long`	ID of the assigned Amazon EBS Repository
`hasMultipleVolumes`	boolean	`true` if there are multiple volumes

nutanixDeploymentInfo

Field	Value	Description
`clusterId`	`long`	Nutanix cluster ID
`storageContainerId`	`long`	ID of the storage container
`networkId`	`long`	Network ID
`ipConfigurationMode`	string	IP configuration mode. Possible values: `DHCP, STATIC`
`ipAddress`	string	IP address
`subnetMask`	string	Subnet mask
`defaultGateway`	string	Default gateway
`dnsConfigurationMode`	string	DNS configuration mode. Possible values: `DHCP, STATIC`
`primaryDns`	string	Primary DNS server
`secondaryDns`	string	Secondary DNS server
`vmId`	`long`	VM ID
`username`	string	User name
`password`	string	User password
`clusterName`	string	Cluster name
`storageContainerName`	string	Name of storage container
`networkName`	string	Network name
`vmName`	string	VM name
`vmPowerState`	string	VM power state. Possible values: `ON, OFF, SUSPENDED, UNKNOWN`

vmwareDeploymentInfo

Field	Value	Description
`clusterId`	`long`	Cluster ID
`esxHostId`	`long`	ESXi host ID
`datastoreId`	`long`	Datastore ID
`networkId`	`long`	Network ID
`ipConfigurationMode`	string	IP configuration mode. Possible values: `DHCP, STATIC`
`ipAddress`	string	IP address
`subnetMask`	string	Subnet mask
`defaultGateway`	string	Default gateway
`dnsConfigurationMode`	string	DNS configuration mode. Possible values: `DHCP, STATIC`
`primaryDns`	string	Primary DNS server
`secondaryDns`	string	Secondary DNS server
`vmId`	`long`	VM ID
`username`	string	User name
`password`	string	User password
`clusterName`	string	Cluster name
`esxHostName`	string	ESXi host name
`datastoreName`	string	Datastore name
`networkName`	string	Network name
`vmName`	string	VM name
`vmPowerState`	string	VM power state. Possible values: `ON, OFF, SUSPENDED, UNKNOWN`
`wasInfoDownloaded`	boolean	`true` if the transporter info was downloaded