Get L2VPN Session Summary

Get L2VPN Session Summary

Load all the existing L2VPN sessions and return the status summary of all L2VPN sessions.

Request
URI
GET
https://nsxmanager.your.domain/api/v1/vpn/l2vpn/sessions/summary
COPY
Query Parameters
string
source
Optional

Data source type.

Possible values are : realtime, cached,
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns L2VPNSessionSummary of type(s) application/json 
{
    "total_l2vpn_sessions": 0,
    "established_l2vpn_sessions": 0,
    "failed_l2vpn_sessions": 0
}
integer As int64 As int64
total_l2vpn_sessions
Optional

Total L2VPN sessions configured.

integer As int64 As int64
established_l2vpn_sessions
Optional

Number of established L2VPN sessions. L2VPN session is established when all the tunnels are up.

integer As int64 As int64
failed_l2vpn_sessions
Optional

Number of failed L2VPN sessions. L2VPN session is failed when all the tunnels are down.


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

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


On This Page
Vpn Operations
POST
Create IP Sec VPNDPD Profile
POST
Create IP Sec VPNIKE Profile
POST
Create IP Sec VPN Local Endpoint
POST
Create IP Sec VPN Peer End Point
POST
Create IP Sec VPN Service
POST
Create IP Sec VPN Session
POST
Create IP Sec VPN Tunnel Profile
POST
Create L2 Vpn Service
POST
Create L2 Vpn Session
DELETE
Delete IP Sec VPNDPD Profile
DELETE
Delete IP Sec VPNIKE Profile
DELETE
Delete IP Sec VPN Local Endpoint
DELETE
Delete IP Sec VPN Peer Endpoint
DELETE
Delete IP Sec VPN Service
DELETE
Delete IP Sec VPN Session
DELETE
Delete IP Sec VPN Tunnel Profile
DELETE
Delete L2 Vpn Service
DELETE
Delete L2 Vpn Session
GET
Get IP Sec VPNDPD Profile
GET
Get IP Sec VPNIKE Profile
GET
Get IP Sec VPNIKE Service
GET
Get IP Sec VPNIKE Session Status
GET
Get IP Sec VPN Local Endpoint
GET
Get IP Sec VPN Peer Endpoint
GET
Get IP Sec VPN Peer Endpoint With PSK Show Sensitive Data
GET
Get IP Sec VPN Service
GET
Get IP Sec VPN Session
GET
Get IP Sec VPN Session Statistics
GET
Get IP Sec VPN Session Summary
GET
Get IP Sec VPN Tunnel Profile
GET
Get L2 Vpn Service
GET
Get L2 Vpn Session
GET
Get L2 Vpn Session Peer Codes
GET
Get L2VPN Session Remote Macs For LS
GET
Get L2VPN Session Statistics
GET
Get L2VPN Session Status
GET
Get L2VPN Session Summary
GET
Get Peer Config
GET
List IP Sec VPNDPD Profiles
GET
List IP Sec VPNIKE Profiles
GET
List IP Sec VPN Local Endpoints
GET
List IP Sec VPN Peer Endpoints
GET
List IP Sec VPN Services
GET
List IP Sec VPN Sessions
GET
List IP Sec VPN Tunnel Profiles
GET
List L2 Vpn Services
GET
List L2 Vpn Sessions
PUT
Update IP Sec VPNDPD Profile
PUT
Update IP Sec VPNIKE Profile
PUT
Update IP Sec VPN Local Endpoint
PUT
Update IP Sec VPN Peer Endpoint
PUT
Update IP Sec VPN Service
PUT
Update IP Sec VPN Session
PUT
Update IP Sec VPN Tunnel Profile
PUT
Update L2 Vpn Service
PUT
Update L2 Vpn Session