VMware Developer Documentation
API Reference PowerCLI Reference
[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform
VMware Sase Platform API VMware SD-WAN Orchestration API v2 Monitor Edges

Get Edge Path Metrics

Description

Fetch path stats metrics from an edge

Request

Request

URL

URL

get
https://{api_host}//api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/pathStats
Copy
Path Parameters

Path Parameters

string
enterpriseLogicalId Required

The logicalId GUID for the target enterprise
string
edgeLogicalId Required

The logicalId GUID for the target edge

Query Parameters

Query Parameters

integer
end Optional

Query interval end time represented as a 13-digit, millisecond-precision epoch timestamp.
string
include Optional

A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.
integer
limit Optional

Limits the maximum size of the result set.
string
metrics Optional

metrics supported for querying pathStats

Possible values are: bytesRx , bytesTx , totalBytes , packetsRx , packetsTx , totalPackets , p1BytesRx , p1BytesTx , p1PacketsRx , p1PacketsTx , p2BytesRx , p2BytesTx , p2PacketsRx , p2PacketsTx , p3BytesRx , p3BytesTx , p3PacketsRx , p3PacketsTx , controlBytesRx , controlBytesTx , controlPacketsRx , controlPacketsTx , bpsRx , bpsRxMin , bpsRxMax , bpsTx , bpsTxMin , bpsTxMax , latencyRx , latencyRxMin , latencyRxMax , latencyTx , latencyTxMin , latencyTxMax , jitterRx , jitterRxMin , jitterRxMax , jitterTx , jitterTxMin , jitterTxMax , packetLossRx , packetLossRxMin , packetLossRxMax , packetLossTx , packetLossTxMin , packetLossTxMax , scoreBeforeVoice , scoreBeforeVideo , scoreBeforeTrans , scoreAfterVoice , scoreAfterVideo , scoreAfterTrans

string
peerLogicalId Required

The logicalId GUID for the path stats peer
integer
start Optional

Query interval start time represented as a 13-digit, millisecond-precision epoch timestamp.

Response

Response

Response Body

Response Body

200 OK

Returns array of EdgePathStatsMetricsResource of type application/json

Request successfully processed

{
	"destination": {},
	"metrics": {
		"bpsRx": 0,
		"bpsRxMax": 0,
		"bpsRxMin": 0,
		"bpsTx": 0,
		"bpsTxMax": 0,
		"bpsTxMin": 0,
		"bytesRx": 0,
		"bytesTx": 0,
		"controlBytesRx": 0,
		"controlBytesTx": 0,
		"controlPacketsRx": 0,
		"controlPacketsTx": 0,
		"jitterRx": 0,
		"jitterRxMax": 0,
		"jitterRxMin": 0,
		"jitterTx": 0,
		"jitterTxMax": 0,
		"jitterTxMin": 0,
		"latencyRx": 0,
		"latencyRxMax": 0,
		"latencyRxMin": 0,
		"latencyTx": 0,
		"latencyTxMax": 0,
		"latencyTxMin": 0,
		"p1BytesRx": 0,
		"p1BytesTx": 0,
		"p1PacketsRx": 0,
		"p1PacketsTx": 0,
		"p2BytesRx": 0,
		"p2BytesTx": 0,
		"p2PacketsRx": 0,
		"p2PacketsTx": 0,
		"p3BytesRx": 0,
		"p3BytesTx": 0,
		"p3PacketsRx": 0,
		"p3PacketsTx": 0,
		"packetLossRx": 0,
		"packetLossRxMax": 0,
		"packetLossRxMin": 0,
		"packetLossTx": 0,
		"packetLossTxMax": 0,
		"packetLossTxMin": 0,
		"packetsRx": 0,
		"packetsTx": 0,
		"scoreAfterTrans": 0,
		"scoreAfterVideo": 0,
		"scoreAfterVoice": 0,
		"scoreBeforeTrans": 0,
		"scoreBeforeVideo": 0,
		"scoreBeforeVoice": 0,
		"totalBytes": 0,
		"totalPackets": 0
	},
	"source": {
		"edge": {
			"_href": "string",
			"activationKey": "string",
			"activationKeyExpires": "string",
			"activationState": "UNASSIGNED",
			"activationTime": "string",
			"alertsEnabled": false,
			"bastionState": "UNCONFIGURED",
			"buildNumber": "string",
			"created": "string",
			"customInfo": "string",
			"description": "string",
			"deviceFamily": "string",
			"deviceId": "string",
			"dnsName": "string",
			"edgeState": "NEVER_ACTIVATED",
			"edgeStateTime": "string",
			"endpointPkiMode": "CERTIFICATE_DISABLED",
			"enterprise": {
				"_href": "string",
				"accountNumber": "string",
				"alertsEnabled": false,
				"bastionState": "UNCONFIGURED",
				"city": "string",
				"contactEmail": "string",
				"contactMobile": "string",
				"contactName": "string",
				"contactPhone": "string",
				"country": "string",
				"created": "string",
				"description": "string",
				"domain": "string",
				"endpointPkiMode": "CERTIFICATE_DISABLED",
				"gatewayPool": {
					"_href": "string"
				},
				"lat": 0,
				"locale": "string",
				"logicalId": "string",
				"lon": 0,
				"modified": "string",
				"name": "string",
				"operatorAlertsEnabled": false,
				"postalCode": "string",
				"prefix": "string",
				"state": "string",
				"streetAddress": "string",
				"streetAddress2": "string",
				"timezone": "string"
			},
			"factoryBuildNumber": "string",
			"factorySoftwareVersion": "string",
			"haLastContact": "string",
			"haPreviousState": "UNCONFIGURED",
			"haSerialNumber": "string",
			"haState": "UNCONFIGURED",
			"isLive": false,
			"lastContact": "string",
			"links": [
				{
					"_href": "string"
				}
			],
			"logicalId": "string",
			"lteRegion": "string",
			"modelNumber": "string",
			"modemBuildNumber": "string",
			"modemFirmwareVersion": "string",
			"modified": "string",
			"name": "string",
			"operatorAlertsEnabled": false,
			"platformBuildNumber": "string",
			"platformFirmwareVersion": "string",
			"selfMacAddress": "string",
			"serialNumber": "string",
			"serviceState": "IN_SERVICE",
			"serviceUpSince": "string",
			"site": {
				"_href": "string",
				"city": "string",
				"contactEmail": "string",
				"contactMobile": "string",
				"contactName": "string",
				"contactPhone": "string",
				"country": "string",
				"created": "string",
				"lat": 0,
				"locale": "string",
				"lon": 0,
				"modified": "string",
				"name": "string",
				"postalCode": "string",
				"shippingAddress": "string",
				"shippingAddress2": "string",
				"shippingCity": "string",
				"shippingContactName": "string",
				"shippingCountry": "string",
				"shippingPostalCode": "string",
				"shippingSameAsLocation": false,
				"shippingState": "string",
				"state": "string",
				"streetAddress": "string",
				"streetAddress2": "string",
				"timezone": "string"
			},
			"softwareUpdated": "string",
			"softwareVersion": "string",
			"systemUpSince": "string"
		},
		"link": {
			"_href": "string",
			"alertsEnabled": false,
			"backupState": "UNCONFIGURED",
			"created": "string",
			"displayName": "string",
			"edge": {
				"_href": "string",
				"activationKey": "string",
				"activationKeyExpires": "string",
				"activationState": "UNASSIGNED",
				"activationTime": "string",
				"alertsEnabled": false,
				"bastionState": "UNCONFIGURED",
				"buildNumber": "string",
				"created": "string",
				"customInfo": "string",
				"description": "string",
				"deviceFamily": "string",
				"deviceId": "string",
				"dnsName": "string",
				"edgeState": "NEVER_ACTIVATED",
				"edgeStateTime": "string",
				"endpointPkiMode": "CERTIFICATE_DISABLED",
				"enterprise": {
					"_href": "string",
					"accountNumber": "string",
					"alertsEnabled": false,
					"bastionState": "UNCONFIGURED",
					"city": "string",
					"contactEmail": "string",
					"contactMobile": "string",
					"contactName": "string",
					"contactPhone": "string",
					"country": "string",
					"created": "string",
					"description": "string",
					"domain": "string",
					"endpointPkiMode": "CERTIFICATE_DISABLED",
					"gatewayPool": {
						"_href": "string"
					},
					"lat": 0,
					"locale": "string",
					"logicalId": "string",
					"lon": 0,
					"modified": "string",
					"name": "string",
					"operatorAlertsEnabled": false,
					"postalCode": "string",
					"prefix": "string",
					"state": "string",
					"streetAddress": "string",
					"streetAddress2": "string",
					"timezone": "string"
				},
				"factoryBuildNumber": "string",
				"factorySoftwareVersion": "string",
				"haLastContact": "string",
				"haPreviousState": "UNCONFIGURED",
				"haSerialNumber": "string",
				"haState": "UNCONFIGURED",
				"isLive": false,
				"lastContact": "string",
				"links": [
					{
						"_href": "string"
					}
				],
				"logicalId": "string",
				"lteRegion": "string",
				"modelNumber": "string",
				"modemBuildNumber": "string",
				"modemFirmwareVersion": "string",
				"modified": "string",
				"name": "string",
				"operatorAlertsEnabled": false,
				"platformBuildNumber": "string",
				"platformFirmwareVersion": "string",
				"selfMacAddress": "string",
				"serialNumber": "string",
				"serviceState": "IN_SERVICE",
				"serviceUpSince": "string",
				"site": {
					"_href": "string",
					"city": "string",
					"contactEmail": "string",
					"contactMobile": "string",
					"contactName": "string",
					"contactPhone": "string",
					"country": "string",
					"created": "string",
					"lat": 0,
					"locale": "string",
					"lon": 0,
					"modified": "string",
					"name": "string",
					"postalCode": "string",
					"shippingAddress": "string",
					"shippingAddress2": "string",
					"shippingCity": "string",
					"shippingContactName": "string",
					"shippingCountry": "string",
					"shippingPostalCode": "string",
					"shippingSameAsLocation": false,
					"shippingState": "string",
					"state": "string",
					"streetAddress": "string",
					"streetAddress2": "string",
					"timezone": "string"
				},
				"softwareUpdated": "string",
				"softwareVersion": "string",
				"systemUpSince": "string"
			},
			"interface": "string",
			"internalId": "string",
			"ipAddress": "string",
			"ipV6Address": "string",
			"isp": "string",
			"lastActive": "string",
			"lastEvent": "string",
			"lastEventState": "UNKNOWN",
			"lat": 0,
			"linkMode": "ACTIVE",
			"logicalId": "string",
			"lon": 0,
			"macAddress": "string",
			"modified": "string",
			"netmask": "string",
			"networkSide": "UNKOWN",
			"networkType": "UNKNOWN",
			"operatorAlertsEnabled": false,
			"org": "string",
			"serviceState": "IN_SERVICE",
			"state": "UNKNOWN",
			"userOverride": false
		}
	},
	"status": "string"
}
SDWANPeerPathDestNode
destination Optional
PathStatsMetrics
metrics Optional
SDWANPeerPathSourceNode
source Optional
string
status Optional
Errors

Errors

ValidationError
400

ValidationError
UnAuthorized
401

Unauthorized
ResourceNotFoundError
404

Resource not found
RateLimitExceededError
429

Rate Limit Exceeded
InternalServerError
500

Internal server error
Code Samples

Code Samples

cURL Command

curl https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/pathStats?peerLogicalId=string

Generated on: 27 Jan 23 16:16 UTC
[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform
On This Page
Monitor Operations
get
Get Edge Application
get
Get Edge Applications
get
Get Edge Flow Metrics
get
Get Edge Flow Series
get
Get Edge Health Metrics
get
Get Edge Health Series
get
Get Edge Link Metrics
get
Get Edge Link Quality Events
get
Get Edge Link Quality Series
get
Get Edge Link Series
get
Get Edge Path Metrics
get
Get Edge Path Series
get
Get Enterprise Edge
get
Get Enterprise Edges
Feedback

Was this page helpful?

© 2023 VMware Inc. Terms of Use Privacy Your California Privacy Rights Accessibility Trademarks Glossary Help Contact Us