Get Transporter Info

Product version: 10.11

Last modified: 31 July 2024

Gets the Transporter info by its ID.

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": "get",
            "data": [1],
            "type": "rpc",
            "tid": 1}'

Request Fields

Field	Type	Value(s)
`action`	string	`TransporterManagement`
`method`	string	`getTransporters`
`data`	`array of int`	The ID of Transporter
`type`	string	`rpc`
`tid`	integer	1

Response Sample

curl

Copy

 {
  "action": "TransporterManagement",
  "method": "get",
  "tid": "1",
  "type": "rpc",
  "message": null,
  "where": null,
  "cause": null,
  "data": {
    "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,
    "monitorAddressChanges": true,
    "locked": 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": false,
    "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    
  }
}

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	Json	Transporter parameters (see below)

data

Field	Value	Description
`id`	int	Transporter ID
`name`	string	Transporter display name
state	string	The current state of the Transporter
`status`	string	The current status of the Transporter's operations
`vid`	string	Transporter VID
`hvType`	string	Platform type
`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
`loggingLevel`	string	Logging level
`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 concurrent jobs
`description`	string	Description (optional)
`preventModification`	boolean	Checks if the Transporter is locked for manual modification
`monitorAddressChanges`	boolean	If `true`, the onboard Transporter IP-address will be changed automatically if local IP settings change
`locked`	boolean	Checks if the Transporter is currently locked by current tasks
`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
`awsAccountId`	int	For AWS Transporters: the internal ID of the AWS account where Transporter is installed
`regionID`	int	For AWS Transporters: the internal ID of the region where Transporter is installed
`es2InstanceID`	int	For AWS Transporters: the internal ID of the EC2 instance where Transporter is installed
`virtualizationType`	string	For AWS Transporters: virtualization type
`vpcID`	int	For AWS Transporters: VPC ID
`subnetID`	int	For AWS Transporters: subnet ID
`availabilityZoneId`	int	For AWS Transporters: availability zone ID
`inboundFilter`	string	AWS-specific: IP filter for new EC2 instance where the Transporter will be deployed
`instanceType`	string	For AWS Transporters: the type of an instance where Transporter is installed
`operationMode`	string	The mode of operation
`wasInfoDownloaded`	boolean	AWS-specific: when the Transporter is deployed, an EC2 instance is created with a keypair necessary to access this instance. `true` if the user has downloaded it once from the NAKIVO Backup & Replication interface
`autoconfigureVpc`	boolean	Checks if the VPC is auto-configured
`isWindowsPlatform`	boolean	Checks if the Transporter installed on Windows
`wasAutoPoweredOff`	boolean	`true` if the EC2 instance was powered off automatically due to idle. See operation mode
`accountName`	string	For AWS Transporters: AWS account display name
`regionName`	string	For AWS Transporters: region display name
`vpcName`	string	For AWS Transporters: VPC display name
`subnetName`	string	For AWS Transporters: subnet display name
`availabilityZoneName`	string	For AWS Transporters: availability zone display name
`securityGroupName`	string	For AWS Transporters: security group display name
`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 AHV
`repositoryManagementSupport`	boolean	Checks if the Transporter can manage Backup 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 backup 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
`assignedAmazonEbsRepositoryId`	int	ID of assigned Amazon EBS Repository
`awsLocal`	boolean	`true` if the Transporter is an onboard one for AWS
`hasAssignedBackupRepositories`	boolean	Checks if the Transporter has Backup Repositories assigned
`alertErrorCode`	int	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)

Permissions Access

Make sure you have at least one of the following permissions:

Permission type	Access Level
Transporters	View only or higher
Repositories	Full access
Tape	Full access
File recovery	Full access
Microsoft SQL server objects	Full access
Microsoft Active Directory objects	Full access
Microsoft Exchange & Exchange Online objects	Full access
Universal Object Recovery	Full access
Site recovery	Full access
Edit job actions	Full access
Microsoft 365 objects	Full access