NSX-T Data Center REST API

Perform ping reachability test

Perform ping reachability test from individual manager node,
where this API is executed for the requested destination.
By default ping test is performed for 4 counts,
which can be changed as per the request body.

Request:

Method:
POST
URI Path(s):
/api/v1/administration/network-diagnosis/ping-reachability-test
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
PingReachabilityRequest+

Example Request:

Request 1- POST https://<nsx-mgr>/api/v1/administration/network-diagnosis/ping-reachability-test { "destination": "target-hostname.com" } Request 2- POST https://<nsx-mgr>/api/v1/administration/network-diagnosis/ping-reachability-test { "destination": "unreachable-destination.com" } Request 3- POST https://<nsx-mgr>/api/v1/administration/network-diagnosis/ping-reachability-test { "destination": "does-not-exists.com" } Request 4- POST https://<nsx-mgr>/api/v1/administration/network-diagnosis/ping-reachability-test { "destination": "host-partially-responding.com" }

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
PingReachabilityResult+

Example Response:

Response 1- Status: 200 ok { "status_code": 0, "resolved_ip_address": "10.10.10.10", "statistics": { "packets_transmitted": 4, "packets_received": 4, "packet_loss": 0.0, "total_time": 3005, "round_trip_time": { "minimum": 6.495, "maximum": 6.999, "average": 6.713, "mean_deviation": 0.219 } } } Response 2- Status: 200 ok { "status_code": 1, "resolved_ip_address": "unreachable-destination.com", "statistics": { "packets_transmitted": 4, "packets_received": 0, "packet_loss": 100.0, "total_time": 3005, "round_trip_time": { "minimum": 6.495, "maximum": 6.999, "average": 6.713, "mean_deviation": 0.219 } } } Response 3- Status: 404 not found { "error_code": 37180, "message": "Ping reachability failed" } Response 4- Status: 200 ok { "status_code": 0, "resolved_ip_address": "10.10.10.10", "statistics": { "packets_transmitted": 4, "packets_received": 3, "packet_loss": 25.0, "total_time": 3005, "round_trip_time": { "minimum": 6.495, "maximum": 6.999, "average": 6.713, "mean_deviation": 0.219 } } }

Required Permissions:

crud

Feature:

system_administration

Additional Errors: