[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Get L2 VPN Tunnel Statistics

Description

Retrieves connection statistics for a given L2 VPN Tunnel configured on an Edge Gateway.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/l2vpn/tunnels/{tunnelId}/metrics
Copy

Path Parameters

Path Parameters

string
gatewayId Required

string
tunnelId Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns EdgeL2VpnTunnelStatistics of type(s) application/json;version=36.3
{
	"bumBytesIn": 0,
	"bumBytesOut": 0,
	"bumPacketsIn": 0,
	"bumPacketsOut": 0,
	"bytesIn": 0,
	"bytesOut": 0,
	"packetsIn": 0,
	"packetsOut": 0,
	"packetsReceiveError": 0,
	"packetsSentError": 0,
	"segmentPath": "string"
}
integer as int64
bumBytesIn Optional

Broadcast, Unknown unicast, and Multicast (BUM) bytes in.


integer as int64
bumBytesOut Optional

Broadcast, Unknown unicast, and Multicast (BUM) bytes out.


integer as int64
bumPacketsIn Optional

Broadcast, Unknown unicast, and Multicast (BUM) packets in.


integer as int64
bumPacketsOut Optional

Broadcast, Unknown unicast, and Multicast (BUM) packets out.


integer as int64
bytesIn Optional

Total number of incoming bytes.


integer as int64
bytesOut Optional

Total number of outgoing bytes.


integer as int64
packetsIn Optional

Total number of incoming packets.


integer as int64
packetsOut Optional

Total number of outgoing packets.


integer as int64
packetsReceiveError Optional

Total number of incoming packets dropped.


integer as int64
packetsSentError Optional

Total number of packets dropped while sending for any reason.


string
segmentPath Optional

Policy path referencing the segment on which stats are gathered.

Errors

Errors

404

The specified resource was not found

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/l2vpn/tunnels/{tunnelId}/metrics


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 35.0
Edge Gateway L2 VPN Tunnel Operations
Feedback

Was this page helpful?