monitoring_get_aggregate_edge_link_metrics_result_item

JSON Example

{
    "linkId": 11498,
    "bytesTx": 173934999,
    "bytesRx": 236354143,
    "packetsTx": 912902,
    "packetsRx": 905328,
    "totalBytes": 410289142,
    "totalPackets": 1818230,
    "p1BytesRx": 16703121,
    "p1BytesTx": 10514739,
    "p1PacketsRx": 29456,
    "p1PacketsTx": 34343,
    "p2BytesRx": 138233115,
    "p2BytesTx": 99403633,
    "p2PacketsRx": 307414,
    "p2PacketsTx": 302256,
    "p3BytesRx": 44737943,
    "p3BytesTx": 13679788,
    "p3PacketsRx": 43957,
    "p3PacketsTx": 39294,
    "controlBytesRx": 36679964,
    "controlBytesTx": 50336839,
    "controlPacketsRx": 524501,
    "controlPacketsTx": 537009,
    "bpsOfBestPathRx": 357688000,
    "bpsOfBestPathTx": 22490000,
    "bestJitterMsRx": 0,
    "bestJitterMsTx": 1.2211,
    "bestLatencyMsRx": 11.5789,
    "bestLatencyMsTx": 5.9474,
    "bestLossPctRx": 0,
    "bestLossPctTx": 0,
    "scoreTx": 4.400000095367432,
    "scoreRx": 4.398631642994128,
    "signalStrength": 0,
    "state": 0,
    "name": "GE4",
    "link": {
        "enterpriseName": "VMware SD-WAN by VeloCloud",
        "enterpriseId": 4,
        "enterpriseProxyId": 177,
        "enterpriseProxyName": "VMware",
        "edgeName": "Palo Alto Edge",
        "edgeState": "CONNECTED",
        "edgeSystemUpSince": "2019-01-01T00:00:00.000Z",
        "edgeServiceUpSince": "2019-01-01T00:00:00.000Z",
        "edgeLastContact": "2019-01-01T00:00:00.000Z",
        "edgeId": 146,
        "edgeSerialNumber": "VC00000000122",
        "edgeHASerialNumber": null,
        "edgeModelNumber": "edge500",
        "edgeLatitude": 37.3773,
        "edgeLongitude": -122.019402,
        "displayName": "VMware",
        "isp": "VMware",
        "interface": "GE4",
        "internalId": "00000004-76dd-4e97-9cba-73b2cf4c4e9b",
        "linkState": "STABLE",
        "linkLastActive": "2019-01-01T00:00:00.000Z",
        "linkVpnState": "STABLE",
        "linkId": 11498,
        "linkIpAddress": "66.170.99.1"
    }
}

integer

bestJitterMsRx

Optional

Best Rx (download) jitter observed on a link, among paths to all SD-WAN peers (gateways & hubs)

integer

bestJitterMsTx

Optional

Best Tx (upload) jitter observed on a link, among paths to all SD-WAN peers (gateways & hubs)

integer

bestLatencyMsRx

Optional

Best Rx (download) latency observed on a link, among paths to all SD-WAN peers (gateways & hubs)

integer

bestLatencyMsTx

Optional

Best Tx (upload) latency observed on a link, among paths to all SD-WAN peers (gateways & hubs)

number As float As float

bestLossPctRx

Optional

Best Rx (download) loss observed on a link, among paths to all SD-WAN peers (gateways & hubs)

number As float As float

bestLossPctTx

Optional

Best Tx (upload) loss observed on a link, among paths to all SD-WAN peers (gateways & hubs)

integer

bpsOfBestPathRx

Optional

Speedtest-measured Rx bandwidth in bits per second (measured on Edge service startup)

integer

bpsOfBestPathTx

Optional

Speedtest-measured Tx bandwidth in bits per second (measured on Edge service startup)

integer As int64 As int64

bytesRx

Optional

bytesRx

integer As int64 As int64

bytesTx

Optional

bytesTx

integer As int64 As int64

controlBytesRx

Optional

Control plane bytes transferred in Rx direction

integer As int64 As int64

controlBytesTx

Optional

Control plane bytes transferred in Tx direction

integer As int64 As int64

controlPacketsRx

Optional

Control plane packets transferred in Rx direction

integer As int64 As int64

controlPacketsTx

Optional

Control plane packets transferred in Tx direction

monitored_link

link

Required

link

integer

linkId

Required

linkId

string

name

Required

name

integer As int64 As int64

p1BytesRx

Optional

Bytes transferred in Rx direction via priority queue reserved for high-priority traffic (e.g. voice)

integer As int64 As int64

p1BytesTx

Optional

Bytes transferred in Tx direction via priority queue reserved for high-priority traffic (e.g. voice)

integer As int64 As int64

p1PacketsRx

Optional

Packets transferred in Rx direction via priority queue reserved for high-priority traffic (e.g. voice)

integer As int64 As int64

p1PacketsTx

Optional

Packets transferred in Tx direction via priority queue reserved for high-priority traffic (e.g. voice)

integer As int64 As int64

p2BytesRx

Optional

Bytes transferred in Rx direction via priority queue reserved for medium-priority traffic (e.g. video)

integer As int64 As int64

p2BytesTx

Optional

Bytes transferred in Tx direction via priority queue reserved for medium-priority traffic (e.g. video)

integer As int64 As int64

p2PacketsRx

Optional

Packets transferred in Rx direction via priority queue reserved for medium-priority traffic (e.g. video)

integer As int64 As int64

p2PacketsTx

Optional

Packets transferred in Tx direction via priority queue reserved for medium-priority traffic (e.g. video)

integer As int64 As int64

p3BytesRx

Optional

Bytes transferred in Rx direction via priority queue reserved for low-priority traffic (e.g. transactional)

integer As int64 As int64

p3BytesTx

Optional

Bytes transferred in Tx direction via priority queue reserved for low-priority traffic (e.g. transactional)

integer As int64 As int64

p3PacketsRx

Optional

Packets transferred in Rx direction via priority queue reserved for low-priority traffic (e.g. transactional)

integer As int64 As int64

p3PacketsTx

Optional

Packets transferred in Tx direction via priority queue reserved for low-priority traffic (e.g. transactional)

number As float As float

scoreRx

Optional

Deprecated MOS score based on Edge-reported latency, jitter, and loss.

number As float As float

scoreTx

Optional

Deprecated MOS score based on Edge-reported latency, jitter, and loss.

number As float As float

signalStrength

Optional

Signal strength reported by wireless modems (only applicable for wireless links). Subject to variable reporting standards depending on the make/model of the modem.

integer

state

Optional

Deprecated - Do not use