Get IPSec VPN session statistics

Get statistics of a vpn session across all tunnels and IKE session. Query parameter "source=realtime" is the only supported source.

Request:

Method:

GET

URI Path(s):

/api/v1/vpn/ipsec/sessions/<session-id>/statistics

Request Headers:

n/a

Query Parameters:

DataSourceParameters+

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/vpn/ipsec/sessions/f962173f-ac03-4d08-8366-56a41779f61d/statistics?source=realtime

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IPSecVPNSessionStatistics+

IPSecVPNSessionStatistics (schema)

Name	Description	Type	Notes
aggregate_traffic_counters	Traffic summary Aggregate traffic statistics across all ipsec tunnels.	IPSecVPNTrafficCounters	Readonly
display_name	Display name Display name of vpn session.	string	Readonly
ike_status	IKE status summary Status for IPSec VPN IKE session UP/DOWN and fail reason if IKE session is down.	IPSecVPNIKESessionStatus	Readonly
ike_traffic_statistics	IKE traffic statistics Traffic statistics for IPSec VPN IKE session. Note - Not supported in this release.	IPSecVPNIKETrafficStatistics	Readonly
ipsec_vpn_session_id	Session identifier UUID of vpn session.	string	Readonly
last_update_timestamp	Last updated timestamp Timestamp when the data was last updated.	EpochMsTimestamp	Readonly
partial_stats	Partial Statistics Partial statistics if true specifies that the statistics are only from active node.	boolean	Readonly
policy_statistics	IPSec policy statistics Gives aggregate traffic statistics across all ipsec tunnels and individual tunnel statistics.	array of IPSecVPNPolicyTrafficStatistics	Readonly

Example Response:

{ "ipsec_vpn_session_id": "f962173f-ac03-4d08-8366-56a41779f61d", "display_name": "VPN Session", "ike_status": "{ "ike_session_state": "UP", "fail_reason": "" }", "ike_traffic_statistics": "{ "packets_in": "100", "packets_out": "77", "bytes_in": "1000", "bytes_out": "830", "fail_count": "23" }", "policy_statistics": "[{ "tunnel_statistics": "{ "tunnel_status": "UP", "tunnel_down_reason": "", "packets_in": "100", "packets_out": "77", "bytes_in": "1000", "bytes_out": "830", "packets_recieve_other_error": "23", "replay_errors": "1", "integrity_failures": "2", "decryption_failures": "1", "sa_expired_errors": "1", "packets_sent_other_error": "1", "seq_number_overflow_error": "1", "encryption_failures": "1" }", "policy_id": "f962173f-ac03-4d08-8366-56a41779f61d", "tunnel_port_id": "efd962173f-ac03-4d08-8366-56a41779f61d" }]", "aggregate_traffic_counters": "{ "packets_in": "100", "packets_out": "77", "bytes_in": "1000", "bytes_out": "830", "dropped_packets": "23" }", "last_update_timestamp": "1000", "partial_stats": false }

Get IPSec VPN session statistics

Request:

DataSourceParameters (schema)

Example Request:

Successful Response:

IPSecVPNSessionStatistics (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: