Management Plane API >
Networking
>
Logical Switching
>
Inter-Site-Forwarder
Get L2 forwarder status
(Experimental)
Returns status per transport node of the l2 forwarder on logical switch.
Request:
Method:
GET
URI Path(s):
/api/v1/logical-switches/<logical-switch-id>/inter-site-forwarder/status
Request Headers:
n/a
Query Parameters:
DataSourceParameters
+
DataSourceParameters
(
schema
)
Name
Description
Type
Notes
source
The data source, either realtime or cached. If not provided, cached data is returned.
DataSourceType
Request Body:
n/a
Example Request:
GET https://<nsx-mgr>/api/v1/logical-switches/7a62a0c5-1ea1-4b25-9d43-dce1c0fa4b8c/inter-site-forwarder/status
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
L2ForwarderStatus
+
L2ForwarderStatus
(
schema
)
Name
Description
Type
Notes
last_update_timestamp
Last updated timestamp
Timestamp when the service router status was last updated.
EpochMsTimestamp
Required
Readonly
logical_switch_id
Logical switch id of L2 forwarder
Logical switch id on which the L2 forwarder is created.
string
Required
Readonly
status_per_node
L2 forwarder status per node
L2 forwarder status per node.
array of
L2ForwarderStatusPerNode
Readonly
Example Response:
{ "logical_switch_id": "7a62a0c5-1ea1-4b25-9d43-dce1c0fa4b8c", "status_per_node": [ { "transport_node": { "target_id": "258c50b4-c960-4005-9023-f7946e302162", "target_display_name": "Edge node 1", "is_valid": true }, "high_availability_status": "STANDBY" }, { "transport_node": { "target_id": "56eead22-3bb9-4586-8de3-9412941f9116", "target_display_name": "Edge node 2", "is_valid": true }, "high_availability_status": "ACTIVE" } ] "last_update_timestamp": 1457117071089 }
Required Permissions:
read
Feature:
aggregation_service_health_monitoring
Additional Errors:
404 Not Found
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable