Get IP Sec VPN Session Statistics

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

Please use below Policy APIs.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics

Request

URI

GET

https://nsxmanager.your.domain/api/v1/vpn/ipsec/sessions/{session-id}/statistics

COPY

Path Parameters

string

session-id

Required

session-id

Query Parameters

string

source

Optional

Data source type.

Possible values are : realtime, cached,

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns IPSecVPNSessionStatistics of type(s) application/json

{
    "aggregate_traffic_counters": {
        "bytes_in": 0,
        "bytes_out": 0,
        "dropped_packets_in": 0,
        "dropped_packets_out": 0,
        "packets_in": 0,
        "packets_out": 0
    },
    "display_name": "string",
    "ike_status": {
        "fail_reason": "string",
        "ike_session_state": "string",
        "transport_node_id": "string"
    },
    "ike_traffic_statistics": {
        "bytes_in": 0,
        "bytes_out": 0,
        "fail_count": 0,
        "packets_in": 0,
        "packets_out": 0
    },
    "ipsec_vpn_session_id": "string",
    "last_update_timestamp": 0,
    "partial_stats": false,
    "policy_statistics": [
        {
            "aggregate_traffic_counters": {
                "bytes_in": 0,
                "bytes_out": 0,
                "dropped_packets_in": 0,
                "dropped_packets_out": 0,
                "packets_in": 0,
                "packets_out": 0
            },
            "policy_id": "string",
            "tunnel_port_id": "string",
            "tunnel_statistics": [
                {
                    "bytes_in": 0,
                    "bytes_out": 0,
                    "decryption_failures": 0,
                    "dropped_packets_in": 0,
                    "dropped_packets_out": 0,
                    "encryption_failures": 0,
                    "integrity_failures": 0,
                    "local_subnet": "string",
                    "nomatching_policy_errors": 0,
                    "packets_in": 0,
                    "packets_out": 0,
                    "packets_receive_other_error": 0,
                    "packets_sent_other_error": 0,
                    "peer_subnet": "string",
                    "policy_id": "string",
                    "replay_errors": 0,
                    "sa_mismatch_errors_in": 0,
                    "sa_mismatch_errors_out": 0,
                    "seq_number_overflow_error": 0,
                    "tunnel_down_reason": "string",
                    "tunnel_status": "string"
                }
            ]
        }
    ]
}

object

aggregate_traffic_counters

Optional

Provides the following traffic statistics for IPSec VPN tunnels since the time the tunnels are UP:

Incoming packet count.
Outgoing packet count.
Dropped packet count.

string

display_name

Optional

Display name of vpn session.

object

ike_status

Optional

Status for IPSec VPN IKE session UP, DOWN, NEGOTIATING and fail reason if IKE session is down.

object

ike_traffic_statistics

Optional

Traffic statistics for IPSec VPN IKE session. Note - Not supported in this release.

string

ipsec_vpn_session_id

Optional

UUID of vpn session.

integer As int64 As int64

last_update_timestamp

Optional

Timestamp when the data was last updated.

boolean

partial_stats

Optional

Partial statistics if true specifies that the statistics are only from active node.

array of object

policy_statistics

Optional

Gives aggregate traffic statistics across all ipsec tunnels and individual tunnel statistics.

400

Returns BadRequest of type(s) application/json