Deploy a New Transporter as VMware vSphere Appliance

Product version: 10.11

Last modified: 31 July 2024

Deploys a new transporter as a VMware vSphere appliance. Requires ESXi host, datastore, and virtual network IDs (identifier parameter) obtained in previous steps.

To check deployment status after running this API request below, refer to Get Transporter Info.

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": "VmwareTransporterManagement",
    "method": "deploy",
    "data": [{
            "id": null,
            "host": "VA transporter",
            "name": "VA transporter",
            "port": 9446,
            "loadFactor": 6,
            "additionalLoadFactor": 2,
            "loggingLevel": "AUTO",
            "dataPortRangeStart": 9448,
            "dataPortRangeEnd": 10000,
            "isProxyTransporter": false,            
            "vmwareDeploymentInfo": {
                "clusterId": null,
                "esxHostId": 6,
                "datastoreId": 16,
                "networkId": 4,
                "ipConfigurationMode": "DHCP",
                "ipAddress": "",
                "subnetMask": "",
                "defaultGateway": "",
                "dnsConfigurationMode": "DHCP",
                "primaryDns": "",
                "secondaryDns": "",
                "vmId": null,
                "username": null,
                "password": null,
                "clusterName": null,
                "esxHostName": null,
                "datastoreName": null,
                "networkName": null,
                "vmPowerState": null,
                "wasInfoDownloaded": null
            },
            "vid": null,
            "description": "",
            "type": null,
            "hvType": null,
            "state": null,
            "status": null,
            "changeStatus": null,
            "version": null,
            "fingerprint": null,
            "os": null,
            "vmwarevSphereSupport": null,
            "vmwarevSpherePre55Support": null,
            "msHypervSupport": null,
            "awsEc2Support": null,
            "repositoryManagementSupport": null,
            "cifsShareSupport": null,
            "nfsShareSupport": null,
            "awsS3Support": null,
            "hpeStoreOnceCatalystSupport": null,
            "repositoryEncryptionSupport": null,
            "windowsGuestsRecoverySupport": null,
            "linuxGuestsRecoverySupport": null,
            "flashVmBootSupport": null,
            "saaSRepositorySupport": null,
            "local": null,
            "outOfDate": null,
            "preventModification": null,
            "lockedExclusive": null,
            "lockedShared": null,
            "lockReasons": null,
            "lockedByJobRun": false,
            "wasEdited": null,
            "wasDiscoveredOnce": null,
            "wasDeployed": null,
            "progress": null,
            "wasAutoPoweredOff": null,
            "hasAssignedBackupRepositories": null,
            "awsDeploymentInfo": null,
            "nutanixDeploymentInfo": null,
            "alertErrorCode": null,
            "alertTitle": null,
            "alertDescription": null
        }
    ],
    "type": "rpc",
    "tid": 114}'

Request Fields

Field	Type	Value(s)
`action`	string	`VmwareTransporterManagement`
`method`	string	`deploy`
`data`	array	See parameters below
`type`	string	`rpc`
`tid`	integer	`114`

data

Field	Type	Value(s)
`id`	`long`
`host`	string	IP address or host name of the machine used for Transporter installation
`name`	string	Display name of the Transporter
`port`	integer	Port number that will be used to connect to the Transporter
`loadFactor`	integer	The number of disks (tasks) the Transporter can process in parallel
`additionalLoadFactor`	integer	Additional tasks for high priority jobs (such as recovery)
`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
`isProxyTransporter`	boolean	true if the Transporter is to be used as a proxy Transporter.
`vmwareDeploymentInfo`	array	See parameters below

vmwareDeploymentInfo

Field	Type	Value(s)
`clusterId`	`long`	Cluster ID (optional). The identifier for a cluster can be obtained by following the same steps as with the network and datastore cases, but with `[“VMWARE_CLUSTER”]` as the `includeTypes` parameter.
`esxHostId`	`long`	Target ESXi host ID
`datastoreId`	`long`	Target datastore ID
`networkId`	`long`	Target network ID
`ipConfigurationMode`	string	IP configuration mode; can be “DHCP” or “STATIC”
`ipAddress`	string	IP address
`subnetMask`	string	Subnet mask
`defaultGateway`	string	Default gateway
`dnsConfigurationMode`	string	DNS configuration mode; can be “DHCP” or “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
`vmPowerState`	string	VM power state. Possible values: “ON”, “OFF”, “SUSPENDED”, “UNKNOWN”
`wasInfoDownloaded`	boolean	`true` if the transporter info was downloaded

data (continued)

Field	Type	Value(s)
`vid`	string	Transporter VID
`description`	string	Description (optional)
`type`	string	The type of the Transporter
`hvType`	string	Platform type
`state`	string	The current state of the Transporter
`status`	string	The current status of the Transporter's operations
`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
`version`	string	The version of the Transporter
`fingerprint`	string	Transporter certificate fingerprint
`os`	string	Operating system where the Transporter is installed
`vmwarevSphereSupport`	boolean	`true` if the Transporter supports VMware
`vmwarevSpherePre55Support`	boolean	`true` if the Transporter supports VMware version 5.5 or below
`msHypervSupport`	boolean	`true` if the Transporter supports Hyper-V
`awsEc2Support`	boolean	`true` if the Transporter supports AWS EC2
`repositoryManagementSupport`	boolean	`true` if the Transporter can manage Backup Repository
`cifsShareSupport`	boolean	`true` if the Transporter supports CIFS shares
`nfsShareSupport`	boolean	`true` if the Transporter supports NFS shares
`awsS3Support`	boolean	`true` if the Transporter supports AWS S3
`hpeStoreOnceCatalystSupport`	boolean	`true` if the Transporter supports HPE StoreOnce Catalyst
`repositoryEncryptionSupport`	boolean	`true` if the Transporter supports backup repository encryption
`windowsGuestsRecoverySupport`	boolean	`true` if the Transporter supports Windows guest OS
`linuxGuestsRecoverySupport`	boolean	`true` if the Transporter supports Linux guest OS
`flashVmBootSupport`	boolean	`true` if the Transporter supports Flash VM Boot
`saaSRepositorySupport`	boolean	`true` if the Transporter supports SaaS repositories
`local`	boolean	`true` if the Transporter is an onboard one
`outOfDate`	boolean	`true` if the Transporter has an outdated version
`preventModification`	boolean	`true` if the Transporter is locked for manual modification
`lockedExclusive`	boolean	`true` if multiple updates cannot be made to the repository at the same time
`lockedShared`	boolean	`true` if multiple read operations cannot run on the same repository at the same time
`lockReasons`	array	Lock reasons
`lockedByJobRun`	boolean	`true` if locked by a job run
`wasEdited`	boolean	`true` if the Transporter settings were edited
`wasDiscoveredOnce`	boolean	`true` if the Transporter was discovered for the first time
`wasDeployed`	boolean	`true` if the transporter was already deployed to host
`progress`	int	Current operation progress
`wasAutoPoweredOff`	boolean	`true` if the EC2 instance was powered off automatically due to idle. See operation mode
`hasAssignedBackupRepositories`	boolean	`true` if the Transporter has Backup Repositories assigned
`awsDeploymentInfo`	Json	AWS transporter deployment info.
`nutanixDeploymentInfo`	Json	Nutanix transporter deployment info.
`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)

Response Sample

curl

Copy

 {
    "action": "VmwareTransporterManagement",
    "method": "deploy",
    "tid": "114",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": 2
}

Response Fields

Field	Value	Description
`message`	string	Message if the request failed
`where`	string	Reference to the method where a problem occurred
`cause`	string	Cause of failure
`data`	integer	Newly assigned Transporter ID