VeloCloud Orchestrator Remote Diagnostics Client

A Python script for performing one-off remote diagnostic actions (e.g. ARP table dumps, route table dumps, speed tests) on a VeloCloud Edge via the VCO Live Mode API. Writes HTML-formatted output to a file called diag.html, which should be opened with a web browser.

This script also implements a general-purpose VCO JSON-RPC client which may be of interest for various other applications. This was written and tested with Python 2.7 but should be straightforward to adapt to Python 3.

Some general caveats regarding usage the Live Mode API:

  • The current incarnation of the Live Mode API is intended primary to satisfy a narrow set of UI-driven workflows limited to one-off troubleshooting tasks and ad-hoc monitoring of individual Edges. We don't advise using the Live Mode API for any type of large (or medium)-scale automation (e.g. running it on cron or keeping multiple Edges in live mode persistently).
  • Remote diagnostics actions currently produce only HTML-formatted response data (i.e. your client, like this one, must be capable of parsing HTML if you wish to use this data for anything other than display).
  • The Live Mode API is on track to be deprecated in a future release and replaced with an API that is better suited for use cases involving more extensive client-side automation.

Sign in to be able to add comments.

Comments 2

guayg 1 year ago
Hi, I am fairly new to Velocloud and just came across this very handy python script. With my limited knowledge on development, any chance to have a sample of command to use with TEST_PARAMS? Like the ARP_DUMP and CLIENTS_DUMP is working very well. But for other TEST Option like ROUTES_DUMP, PATHS_DUMP, VPN_TEST, etc it seems to require params in JSON encoded format. But I tried few params format without success. It keep writtng in the diag.html : "Error reading data for test" or "<i><b>Error:</b> Invalid segment</i>". Thx.
wroever 11 days ago
Since this API is considered unstable for use by third-party clients and is not publicly documented, your best bet is to reach out to VMware SD-WAN Support with those questions. As mentioned in the description, we're working on introducing a new remote diagnostics API where we fully expect all options will be documented.