VeloCloud

 View Only

 VeloCloud API Bandwidth Report

Jump to  Best Answer
Eric Martin's profile image
Eric Martin posted Feb 04, 2025 12:42 PM

I’ve been asked to provide a report on Edge bandwidth capacity via API or CLI.  I see that information on the Orchestrator’s webpage, but I cannot find that info via the API.

 I have also tried doing this from the edge CLI via SSH.  This command looks promising, but I do not know where the report gets posted to.

debug --debug_bw_test GE3

{

  "GE3": "Bandwidth test request is being processed"

}

Ameya Oke's profile image
Broadcom Employee Ameya Oke  Best Answer

Hi Eric,

Thanks for your questions.

You can reach out to me at ameya.oke@broadcom.com and we can jump on a zoom call to go over the various ways if you prefer.

For now, you have following options:
1. debug command


2.Monitor>Edges>Link>BW

3. API call:
API call: metrics/getEdgeLinkMetrics
payload:
{
  "edgeId": xxx,
  "enterpriseId": yyy,
  "interval": {
    "start": start epoh ms,
    "end": end epoch in ms
  },
  "metrics": [
    "bpsOfBestPathRx",
    "bpsOfBestPathTx",
    "totalBytes"
  ]
}

APIv1 docs: https://developer.broadcom.com/xapis/vmware-sd-wan-orchestrator-api-v1/latest/


Regards

Ameya

Ameya Oke's profile image
Broadcom Employee Ameya Oke

Hi Eric,

Thanks for posting the question.
You can get the link BW in following ways:

1. Edge CLI command: debug.py --path

2. FRom UI: Monitor > Edge > Link > BW

3. API call:

APIv1 docs: https://developer.broadcom.com/xapis/vmware-sd-wan-orchestrator-api-v1/latest/

API call: metrics/getEdgeLinkMetrics

Let me know if you need further information.

Regards

Ameya