Returns the complete list of Transporters.
Endpoint
https://<Director_IP_address>:4443/c/router
Request Example
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 |
|
method | string |
|
data | null |
|
type | string |
|
tid | integer |
|
Response Sample
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 |
| 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 neededCHANGE_PENDING Some attributes have changed, discovery is neededIMPORT_PENDING Import itemRECREATE_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 |
| string | Platform type. Possible values for this field: |
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 |
| 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 |
| Json | VMware transporter deployment info. See the |
| Json | Nutanix transporter deployment info. See the |
| Json | AWS transporter deployment info. See the |
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. |
autoconfigureVpc | boolean | Checks if the VPC is auto-configured |
isWindowsPlatform | boolean | Checks if the transporter installed on Windows |
| boolean |
|
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 |
| long | ID of the assigned Amazon EBS Repository |
| boolean |
|
nutanixDeploymentInfo
Field | Value | Description |
| long | Nutanix cluster ID |
| long | ID of the storage container |
| long | Network ID |
| string | IP configuration mode. Possible values: |
| string | IP address |
| string | Subnet mask |
| string | Default gateway |
| string | DNS configuration mode. Possible values: |
| string | Primary DNS server |
| string | Secondary DNS server |
| long | VM ID |
| string | User name |
| string | User password |
| string | Cluster name |
| string | Name of storage container |
| string | Network name |
| string | VM name |
| string | VM power state. Possible values: |
vmwareDeploymentInfo
Field | Value | Description |
| long | Cluster ID |
| long | ESXi host ID |
| long | Datastore ID |
| long | Network ID |
| string | IP configuration mode. Possible values: |
| string | IP address |
| string | Subnet mask |
| string | Default gateway |
| string | DNS configuration mode. Possible values: |
| string | Primary DNS server |
| string | Secondary DNS server |
| long | VM ID |
| string | User name |
| string | User password |
| string | Cluster name |
| string | ESXi host name |
| string | Datastore name |
| string | Network name |
| string | VM name |
| string | VM power state. Possible values: |
| boolean |
|