NSX-T Data Center REST API

Cumulative statistics for one IKE service instance (Deprecated)

Cumulative statistics for one IKE service instance. Query parameter source supports only cached mode. Deprecated:
Please use below Policy APIs.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/summary
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/summary

Request:

Method:
GET
URI Path(s):
/api/v1/vpn/services/<service-id>/summary
Request Headers:
n/a
Query Parameters:
DataSourceParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/vpn/services/f962173f-ac03-4d08-8366-56a41779f61d/summary?source=cached

Successful Response:

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

Example Response:

{ "ipsec_vpn_service_id": "f962173f-ac03-4d08-8366-56a41779f61d", "display_name": "VPN Service", "logical_router_id": "efe62173f-ac03-4d08-8366-56a41779f61d", "ike_summary": "{ "established_ike_sessions": "100", "failed_ike_sessions": "["401","404"]", "total_ike_sessions": "200" }", "traffic_summary_per_session": "[{ "traffic_stats": "{ "packets_in": "100", "packets_out": "77", "bytes_in": "1000", "bytes_out": "830", "dropped_packets": "23" }", "ipsec_vpn_session": "{ "target_display_name": "4630aadd-25d7-4c73-b03c-227ac314dfc4", "is_valid": true, "target_type": "LogicalRouter", "target_id": "4630aadd-25d7-4c73-b03c-227ac314dfc4" }", }]", "aggregate_traffic_counters": "{ "packets_in": "100", "packets_out": "77", "bytes_in": "1000", "bytes_out": "830", "dropped_packets": "23" }", "last_update_timestamp": "1000" }

Required Permissions:

read

Feature:

vpn

Additional Errors: