Get All Interconnect Appliances
Get all appliances
Retrieves a comprehensive list of all HCX interconnect appliances deployed across all service meshes in the HCX environment. This includes appliances at both the local (source) and remote (destination) sites. The API returns complete appliance details including configuration, status, capacity, resource assignments, and health indicators for all deployed appliance types.
Request
URI
GET
https://{server}/hybridity/api/interconnect/appliances
COPY
Authentication
This operation uses the following authentication methods.
Responses
200
Accepted
Returns
SucessGetResponse
of type(s)
application/json
{
"items": [
{
"applianceId": "string",
"applianceType": "string",
"applianceName": "string",
"applianceCerts": {
"sgwdCert": "string"
},
"serviceMeshId": "string",
"computeProfileId": "string",
"location": "string",
"endpointId": "string",
"isInitiator": false,
"peerAppliances": [
{
"applianceId": "string",
"applianceType": "string",
"applianceName": "string",
"applianceCerts": {
"sgwdCert": "string"
},
"serviceMeshId": "string",
"computeProfileId": "string",
"location": "string",
"endpointId": "string",
"isInitiator": false,
"peerAppliances": [
"appliance Object"
],
"config": {
"uplinkIps": [
"string"
],
"trafficEnggCfg": {
"isAppPathResiliencyEnabled": false,
"isTcpFlowConditioningEnabled": false,
"isEncryptionlessTunnelEnabledForMigration": false,
"isEncryptionlessTunnelEnabledForNE": false,
"groEnabled": false
}
},
"applianceStatus": {
"state": "string",
"detailedMessage": "string"
},
"compute": {
"cmpId": "string",
"cmpName": "string",
"cmpType": "string",
"type": "string",
"id": "string",
"name": "string",
"status": {
"state": "string",
"errorMessage": "string"
}
},
"storage": {
"cmpId": "string",
"cmpName": "string",
"cmpType": "string",
"type": "string",
"id": "string",
"name": "string",
"status": {
"state": "string",
"errorMessage": "string"
}
},
"folder": {
"cmpId": "string",
"cmpName": "string",
"type": "string",
"id": "string",
"name": "string",
"status": {
"state": "string",
"errorMessage": "string"
}
},
"networks": [
{
"id": "string",
"interface": "string",
"backingId": "string",
"backingType": "string",
"backingName": "string",
"vCenterInstanceId": "string",
"prefixLength": 0,
"gateway": "string",
"mtu": 0,
"networkDescription": "string",
"scope": "string",
"ipPoolId": "string",
"type": "string",
"networkId": "string",
"provider": "string",
"tags": [
"string"
],
"dns": [
"string"
],
"ip": [
"string"
],
"resourcePoolId": "string",
"resourceId": "string",
"enableBridge": false,
"staticRoutes": [
{
"network": "string",
"nextHop": "string"
}
],
"stretchId": "string",
"ipAddress": "string",
"networkType": "string",
"dvpgMoref": "string",
"bridgeConfig": {
"id": "string",
"localAddress": "string",
"remoteAddress": "string",
"flapThreshold": 0,
"flapClearThreshold": 0
}
}
],
"dvsId": "string",
"networkExtensionCount": 0,
"dvsName": "string",
"dvsType": "string",
"moref": "string",
"cmpId": "string",
"applianceVersion": {
"major": 0,
"minor": 0,
"patch": 0,
"revision": "string",
"build": 0
},
"updateInfo": {
"updateAvailable": false,
"updateVersion": {
"major": 0,
"minor": 0,
"patch": 0,
"revision": "string",
"build": 0
}
},
"stretchCapacity": 0,
"isInServiceUpdateAvailable": false,
"haProperties": {
"enabled": false,
"groupId": "string",
"role": "string",
"partnerId": "string",
"groupName": "string"
},
"haEligibility": {
"isEligible": false,
"message": "string",
"reasonCode": "string"
},
"features": {
"proximityRouting": {
"enabled": false,
"version": "string"
}
},
"status": {
"summary": {
"overallStatus": "string",
"overallTransportStatus": "string",
"servicePipelineStatus": "string",
"overallEncryptionTunnelStatus": "string",
"transportSummary": [
{
"transportIp": "string",
"name": "string",
"totalTunnelCount": 0,
"totalActiveTunnelCount": 0,
"aggregatedTunnelStatus": "string"
}
],
"encryptionTunnelSummary": {
"totalActiveTunnelCount": 0,
"aggregatedTunnelStatus": "string",
"totalTunnelCount": 0
},
"wanOptStatus": "string",
"systemState": "string",
"reasons": [
"string"
]
},
"timestamp": 0,
"statistics": {
"Tunnels": [
{
"Id": "string",
"LocalAddress": "string",
"LocalPort": "string",
"RemoteAddress": "string",
"RemotePort": "string",
"Timestamp": "string",
"Summary": "string",
"Detail": "string",
"Ikev2Status": "string",
"Counters": {
"RxPackets": "number",
"RxPacketErrors": "number",
"RxPacketDropped": "number",
"RxPacketOverruns": "number",
"RxPacketFrame": "number",
"TxPackets": "number",
"TxPacketErrors": "number",
"TxPacketDropped": "number",
"TxPacketOverruns": "number",
"TxPacketCarrier": "number",
"Collisions": "number",
"TxQueuelen": "number",
"RxBytes": "number",
"TxBytes": "number",
"RxPacketRate": "number",
"TxPacketRate": "number",
"RxBitRate": "number",
"TxBitRate": "number"
},
"TunnelType": "string"
}
]
}
}
}
],
"config": {
"uplinkIps": [
"string"
],
"trafficEnggCfg": {
"isAppPathResiliencyEnabled": false,
"isTcpFlowConditioningEnabled": false,
"isEncryptionlessTunnelEnabledForMigration": false,
"isEncryptionlessTunnelEnabledForNE": false,
"groEnabled": false
}
},
"applianceStatus": {
"state": "string",
"detailedMessage": "string"
},
"compute": {
"cmpId": "string",
"cmpName": "string",
"cmpType": "string",
"type": "string",
"id": "string",
"name": "string",
"status": {
"state": "string",
"errorMessage": "string"
}
},
"storage": {
"cmpId": "string",
"cmpName": "string",
"cmpType": "string",
"type": "string",
"id": "string",
"name": "string",
"status": {
"state": "string",
"errorMessage": "string"
}
},
"folder": {
"cmpId": "string",
"cmpName": "string",
"type": "string",
"id": "string",
"name": "string",
"status": {
"state": "string",
"errorMessage": "string"
}
},
"networks": [
{
"id": "string",
"interface": "string",
"backingId": "string",
"backingType": "string",
"backingName": "string",
"vCenterInstanceId": "string",
"prefixLength": 0,
"gateway": "string",
"mtu": 0,
"networkDescription": "string",
"scope": "string",
"ipPoolId": "string",
"type": "string",
"networkId": "string",
"provider": "string",
"tags": [
"string"
],
"dns": [
"string"
],
"ip": [
"string"
],
"resourcePoolId": "string",
"resourceId": "string",
"enableBridge": false,
"staticRoutes": [
{
"network": "string",
"nextHop": "string"
}
],
"stretchId": "string",
"ipAddress": "string",
"networkType": "string",
"dvpgMoref": "string",
"bridgeConfig": {
"id": "string",
"localAddress": "string",
"remoteAddress": "string",
"flapThreshold": 0,
"flapClearThreshold": 0
}
}
],
"dvsId": "string",
"networkExtensionCount": 0,
"dvsName": "string",
"dvsType": "string",
"moref": "string",
"cmpId": "string",
"applianceVersion": {
"major": 0,
"minor": 0,
"patch": 0,
"revision": "string",
"build": 0
},
"updateInfo": {
"updateAvailable": false,
"updateVersion": {
"major": 0,
"minor": 0,
"patch": 0,
"revision": "string",
"build": 0
}
},
"stretchCapacity": 0,
"isInServiceUpdateAvailable": false,
"haProperties": {
"enabled": false,
"groupId": "string",
"role": "string",
"partnerId": "string",
"groupName": "string"
},
"haEligibility": {
"isEligible": false,
"message": "string",
"reasonCode": "string"
},
"features": {
"proximityRouting": {
"enabled": false,
"version": "string"
}
},
"status": {
"summary": {
"overallStatus": "string",
"overallTransportStatus": "string",
"servicePipelineStatus": "string",
"overallEncryptionTunnelStatus": "string",
"transportSummary": [
{
"transportIp": "string",
"name": "string",
"totalTunnelCount": 0,
"totalActiveTunnelCount": 0,
"aggregatedTunnelStatus": "string"
}
],
"encryptionTunnelSummary": {
"totalActiveTunnelCount": 0,
"aggregatedTunnelStatus": "string",
"totalTunnelCount": 0
},
"wanOptStatus": "string",
"systemState": "string",
"reasons": [
"string"
]
},
"timestamp": 0,
"statistics": {
"Tunnels": [
{
"Id": "string",
"LocalAddress": "string",
"LocalPort": "string",
"RemoteAddress": "string",
"RemotePort": "string",
"Timestamp": "string",
"Summary": "string",
"Detail": "string",
"Ikev2Status": "string",
"Counters": {
"RxPackets": "number",
"RxPacketErrors": "number",
"RxPacketDropped": "number",
"RxPacketOverruns": "number",
"RxPacketFrame": "number",
"TxPackets": "number",
"TxPacketErrors": "number",
"TxPacketDropped": "number",
"TxPacketOverruns": "number",
"TxPacketCarrier": "number",
"Collisions": "number",
"TxQueuelen": "number",
"RxBytes": "number",
"TxBytes": "number",
"RxPacketRate": "number",
"TxPacketRate": "number",
"RxBitRate": "number",
"TxBitRate": "number"
},
"TunnelType": "string"
}
]
}
}
}
]
}
array of
object
items
Optional
items
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
500
Internal Server Error
Returns
InternalServerError
of type(s)
application/json
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
array of
object
errors
Optional
errors
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/hybridity/api/interconnect/appliances
Appliances Operations
GET
Get All Interconnect Appliances
POST
Get Interconnect Appliances By Filter
PUT
Update Interconnect Appliance
GET
Get Statistics For Exteneded Network
POST
Redeploy Interconnect Appliance
POST
Force Sync Interconnect Appliance
POST
Diagnose Interconnect Appliance
POST
Upgrade Interconnect Appliance