Get IP Sec VPN Session Summary

VPN session summary gets summary per vpn sessions and IKE session. Query parameter source supports only cached mode.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/vpn/ipsec/sessions/summary

COPY

Query Parameters

string

site_id

Optional

Peer site id

string

source

Optional

Data source type.

Possible values are : realtime, cached,

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns IPSecVPNSessionSummary of type(s) application/json

{
    "traffic_summary_per_session": [
        {
            "traffic_counters": {
                "packets_out": 0,
                "dropped_packets_out": 0,
                "bytes_in": 0,
                "bytes_out": 0,
                "dropped_packets_in": 0,
                "packets_in": 0
            },
            "ipsec_vpn_session": {
                "target_display_name": "string",
                "is_valid": false,
                "target_id": "string",
                "target_type": "string"
            }
        }
    ],
    "last_update_timestamp": 0,
    "session_summary": {
        "established_sessions": 0,
        "total_sessions": 0,
        "failed_sessions": 0,
        "degraded_sessions": 0
    },
    "aggregate_traffic_counters": {
        "packets_out": 0,
        "dropped_packets_out": 0,
        "bytes_in": 0,
        "bytes_out": 0,
        "dropped_packets_in": 0,
        "packets_in": 0
    }
}

array of IPSecVPNSessionTrafficSummary

traffic_summary_per_session

Optional

Traffic summary per session.

integer As int64 As int64

last_update_timestamp

Optional

Timestamp when the data was last updated.

IPsecVPNIKESessionSummary

session_summary

Optional

session_summary

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