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.

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

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

IPSecVPNIKETrafficStatistics

ike_traffic_statistics

Optional

ike_traffic_statistics

string

display_name

Optional

Display name of vpn session.

array of IPSecVPNPolicyTrafficStatistics

policy_statistics

Optional

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

boolean

partial_stats

Optional

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

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.

IPSecVPNIKESessionStatus

ike_status

Optional

ike_status

IPSecVPNTrafficCounters

aggregate_traffic_counters

Optional

aggregate_traffic_counters

400

Returns BadRequest of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

403

Returns Forbidden of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

404

Returns NotFound of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

412

Returns PreconditionFailed of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

500

Returns InternalServerError of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

503

Returns ServiceUnavailable of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error