VeloCloud SD-WAN Remote Diagnostics WebSocket API
The VMware SD-WAN Orchestrator allows Customers, Partners, and authorized support representatives to invoke diagnostic functions and collect relevant data for troubleshooting purposes remotely via a WebSocket API.
General Considerations:
- It is only possible to invoke diagnostic actions using this API for Edges running software running software versioned 5.0.0 or newer.
- All messages sent and received via WebSockets are encoded in JSON format.
- By default, the browser WebSocket connection is active for 300 seconds in an idle state.
- Please use the VMware SD-WAN Product Documentation for more details about Remote Diagnostics.
- In the case of VMware SD-WAN Websocket API we have just one endpoint: 'ws'.
- As of the 5.0.0 release, JSON-formatted responses are not yet supported for IPv6-specific commands and DSL_STATUS, GPON_STATUS, RADIUS_TEST, AP_SCAN_DUMP, FIREWALL_DUMP, CLUSTER_REBALANCE, EVDSL_MODEM_STATUS, USB_PORTS_STATUS.
Servers
- example.comwssserver
Authentication:
When making the initial Websocket handshake request, the API client must authenticate as explained in the VMware SASE Platform API documentation .
Once the socket is open, you will receive a noop ('#/components/messages/noop') message from the server with a websocket connection token. You will need to send this token with every websocket message. Example runDiagnostics request:
The resulting token must be provided in the "token" field:
{ "action": "runDiagnostics", "data": { "logicalId": "edgeLogicalId", "test": "testName" "parameters": { ... } }, "token": "WW91ciBhdXRoZW50aWNhdGlvbiB0b2tlbiBnb2VzIGhlcmUu" }Response format
With release 5.0.0, we have introduced a new field (
resformat) to allow clients to choose the response format for Websocket messages. Refer to '#/components/schemas/resformat' for allowed resformat values.Example runDiagnostics request with resformat:
{ "action": "runDiagnostics", "data": { "logicalId": "edgeLogicalId", "test": "testName" "parameters": { ... }, "resformat": "JSON" }, "token": "WW91ciBhdXRoZW50aWNhdGlvbiB0b2tlbiBnb2VzIGhlcmUu" }
Operations
PUB ws/
Operation IDsendMessageAccepts one of the following messages:
- #0List DiagnosticslistDiagnosticsRequest
Lists all supported commands/actions for a given edge
objectExamples
{ "action": "listDiagnostics", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON" }, "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh" }This example has been generated automatically.
- #1ARP Table DumparpDump
View the Contents of the ARP Table. This output is limited to display 1000 ARP entries.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "ARP_DUMP", "parameters": { "count": "100" } } }This example has been generated automatically.
- #2Clear ARP CacheclearArp
Clear the ARP cache for a given interface.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "CLEAR_ARP", "parameters": { "interface": "G101" } } }This example has been generated automatically.
- #3DNS TestdnsTest
Perform a DNS lookup of the name specified.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "DNS_TEST", "parameters": { "name": "www.example.com" } } }This example has been generated automatically.
- #4DNS/DHCP Service RestartrestartDnsmasq
Restart the DNS/DHCP service. This can serve as a troubleshooting step if DHCP or DNS requests are failing for clients.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "RESTART_DNSMASQ" } }This example has been generated automatically.
- #5Flush FlowsflushFlows
Flush the flow table, causing user traffic to be re-classified. Use source and destination IPv4 or IPv6 address filters to flush specific flows.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "FLUSH_FLOWS", "parameters": { "src_ip": "10.1.0.0", "dst_ip": "10.2.0.0" } } }This example has been generated automatically.
- #6Flush NATflushNat
Flush the NAT table. (This may cause existing TCP/UDP sessions to fail!)
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "FLUSH_NAT" } }This example has been generated automatically.
- #7GatewayrouteSelect
Choose whether cloud traffic should or should not use the Gateway Service. Note - This does not affect the routing of VPN traffic.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "ROUTE_SELECT", "parameters": { "route": "gateway" } } }This example has been generated automatically.
- #8HA InfohaInfo
Show basic and interface information of active and standby edges when HA is enabled
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "HA_INFO" } }This example has been generated automatically.
- #9Interface StatusinterfaceStatus
View the MAC address and connection status of physical interfaces.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "INTERFACE_STATUS" } }This example has been generated automatically.
- #10List Active FlowsflowDump
List active flows in the system. Use source and destination IPv4 or IPv6 address filters to view the exact flows you want to see. This output is limited to a maximum of 1000 flows.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "FLOW_DUMP", "parameters": { "segment": "string", "count": "100", "src_ip": "10.1.0.0", "src_port": "28", "dst_ip": "10.2.0.0", "dest_port": "30" } } }This example has been generated automatically.
- #11List ClientsclientsDump
View the full list of clients.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "CLIENTS_DUMP" } }This example has been generated automatically.
- #12List PathspathsDump
View the list of active paths between local WAN links and each peer.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "PATHS_DUMP", "parameters": { "peer": "Gateway", "subpath": true } } }This example has been generated automatically.
- #13List current IKE Child SAsikeChildSa
Use filters to view the exact Child SAs you want to see. This output is limited to a maximum of 1000 Child SAs.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "IKE_CHILDSA", "parameters": { "peer_ip": "10.3.0.0", "ikeSaSpi": "" } } }This example has been generated automatically.
- #14List current IKE SAsikeSa
Use filters to view the exact SAs you want to see. This output is limited to a maximum of 1000 SAs.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "IKE_SA", "parameters": { "peer_ip": "10.3.0.0" } } }This example has been generated automatically.
- #15MIBs for EdgemibDump
Dump Edge MIBs. VELOCLOUD-MIB: the root MIB of all VeloCloud specified MIBs and required for installing VELOCLOUD-EDGE-MIB. VELOCLOUD-MIB-EDGE: the MIB specified for Edge device.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "MIB_DUMP", "parameters": { "mib": "VELOCLOUD-MIB" } } }This example has been generated automatically.
- #16NAT Table DumpnatDump
View the contents of the NAT Table. Use the destination IP address filter to view the exact entries you want to see. This output is limited to a maximum of 1000 entries.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "NAT_DUMP", "parameters": { "dst_ip": "10.2.0.0", "count": "100" } } }This example has been generated automatically.
- #17NTP DumpntpDump
Current date/time on Edge and NTP information
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "NTP_DUMP" } }This example has been generated automatically.
- #18Ping TestbasicPing
Run a ping test to the destination specified.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "BASIC_PING", "parameters": { "segment": "0", "destination": "8.8.8.8", "source": "172.20.2.1" } } }This example has been generated automatically.
- #19Reset USB ModemresetUsbModem
This will attempt to reset an unworking USB modem connected to the given interface. Note that not all USB modems support this type of remote reset.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "RESET_USB_MODEM", "parameters": { "interface": "G101" } } }This example has been generated automatically.
- #20Route Table DumprouteDump
View the contents of the Route Table.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "ROUTE_DUMP", "parameters": { "segment": "all" } } }This example has been generated automatically.
- #21Source Interface DumpsrcIfaceDump
View the Source Interfaces selected by services
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "SRC_IFACE_DUMP", "parameters": { "segment": "all" } } }This example has been generated automatically.
- #22System InformationsystemInformation
View system information such as system load, recent WAN stability statistics, Monitoring Services. WAN stability statistics include the number of times individual VPN tunnels and WAN links lost connectivity for at least 700 milliseconds.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "SYSTEM_INFORMATION" } }This example has been generated automatically.
- #23Traceroutetraceroute
Run a traceroute via the Gateway or directly out any of the WAN interfaces to the destination specified.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "TRACEROUTE", "parameters": { "destination": "8.8.8.8", "source": "eth2" } } }This example has been generated automatically.
- #24Troubleshoot BFD - Show BFD Peer StatusbfdPeerStatus
Show all the status of BFD peers
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "BFD_PEER_STATUS", "parameters": { "segment": "0", "peer_ip": "10.3.0.0", "local_ip": "10.4.0.0" } } }This example has been generated automatically.
- #25Troubleshoot BFD - Show BFD Peer countersbfdPeerCounters
Show all the counters of BFD peers
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "BFD_PEER_COUNTERS", "parameters": { "segment": "0", "peer_ip": "10.3.0.0", "local_ip": "10.4.0.0" } } }This example has been generated automatically.
- #26Troubleshoot BFD - Show BFD SettingbfdInfo
Show BFD setting and neighbor status
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "BFD_INFO" } }This example has been generated automatically.
- #27Troubleshoot BGP - List BGP Redistributed RoutesbgpRedisDump
See routes redistributed to BGP neighbors
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "BGP_REDIS_DUMP", "parameters": { "segment": "all" } } }This example has been generated automatically.
- #28Troubleshoot BGP - List BGP RoutesbgpView
Show the specific BGP routes from neighbors, leave prefix empty to see all
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "BGP_VIEW", "parameters": { "segment": 0, "prefix": "198.51.100.0/24" } } }This example has been generated automatically.
- #29Troubleshoot BGP - List Routes per PrefixroutesDetail
Show all the Overlay and Underlay routes for a prefix and the details
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "ROUTES_DETAIL", "parameters": { "segment": "all", "prefix": "198.51.100.0/24" } } }This example has been generated automatically.
- #30Troubleshoot BGP - Show BGP Neighbor Advertised RoutesfrrBgpNbrAd
Show the BGP routes advertised to a neighbor
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "FRR_BGP_NBR_AD", "parameters": { "segment": "0", "nbr_ip": "10.5.0.0" } } }This example has been generated automatically.
- #31Troubleshoot BGP - Show BGP Neighbor Learned RoutesfrrBgpNbrRoutes
Show all the accepted BGP routes learned from a neighbor after filters
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "FRR_BGP_NBR_ROUTES", "parameters": { "nbr_ip": "10.5.0.0" } } }This example has been generated automatically.
- #32Troubleshoot BGP - Show BGP Neighbor Received RoutesfrrBgpNbrRcv
Show all the BGP routes received from a neighbor before filters
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "FRR_BGP_NBR_RCV", "parameters": { "segment": "0", "nbr_ip": "10.5.0.0" } } }This example has been generated automatically.
- #33Troubleshoot BGP - Show BGP Neighbor detailsbgpNbr
Show the details of BGP neighbor
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "BGP_NBR", "parameters": { "segment": "all", "nbr_ip": "10.5.0.0" } } }This example has been generated automatically.
- #34Troubleshoot BGP - Show BGP Routes per PrefixfrrBgpRoutes
Show all the BGP routes for the prefix and their attributes
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "FRR_BGP_ROUTES", "parameters": { "prefix": "198.51.100.0/24" } } }This example has been generated automatically.
- #35Troubleshoot BGP - Show BGP SummaryfrrBgpSum
Show the existing BGP neighbor and received routes
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "FRR_BGP_SUM" } }This example has been generated automatically.
- #36Troubleshoot BGP - Show BGP TablefrrBgpTbl
Show the BGP table
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "FRR_BGP_TBL", "parameters": { "segment": "all" } } }This example has been generated automatically.
- #37Troubleshoot OSPF - List OSPF Redistributed RoutesospfRedisDump
Show all the routes redistributed to OSPF neighbor
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "OSPF_REDIS_DUMP" } }This example has been generated automatically.
- #38Troubleshoot OSPF - List OSPF RoutesospfView
Show the specific OSPF routes from neighbors, leave prefix empty to see all
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "OSPF_VIEW", "parameters": { "prefix": "198.51.100.0/24" } } }This example has been generated automatically.
- #39Troubleshoot OSPF - Show OSPF DatabasequaggaOspfDb
Show the OSPF link state database summary
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "QUAGGA_OSPF_DB" } }This example has been generated automatically.
- #40Troubleshoot OSPF - Show OSPF Database for E1 Self-Originate RoutesquaggaOspfDbSo
Show the E1 LSAs self-originated by the VCE that are advertised to OSPF
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "QUAGGA_OSPF_DB_SO" } }This example has been generated automatically.
- #41Troubleshoot OSPF - Show OSPF NeighborsquaggaOspfTbl
Show all the OSPF neighbors and associated info
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "QUAGGA_OSPF_TBL" } }This example has been generated automatically.
- #42Troubleshoot OSPF - Show OSPF Database for E1 Self-Originate RoutesquaggaOspfDbSo
Show the E1 LSAs self-originated by the VCE that are advertised to OSPF
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "QUAGGA_OSPF_DB_SO" } }This example has been generated automatically.
- #43Troubleshoot OSPF - Show OSPF Route TablequaggaOspfRoutes
Show the existing OSPF route table
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "QUAGGA_OSPF_ROUTES" } }This example has been generated automatically.
- #44Troubleshoot OSPF - Show OSPF SettingospfInfo
Show OSPF setting and neighbor status
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "OSPF_INFO" } }This example has been generated automatically.
- #45VPN TestvpnTest
Use ping to test VPN connectivity to each peer.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "VPN_TEST", "parameters": { "segment": "0" } } }This example has been generated automatically.
- #46WAN Link Bandwidth TestbwTest
Force a re-test the bandwidth of a WAN link.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "BW_TEST", "parameters": { "link": "e9a9b161-b432-4db1-a6d2-d90e7ca1f6eb" } } }This example has been generated automatically.
- #47Reset SFP Firmware configurationsfpFwConfigReset
Few SFP allows to reset firmware configuration parameter , for other SFPs it will be no-op
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "SFP_FW_CONFIG_RESET", "parameters": { "interface": "G101" } } }This example has been generated automatically.
- #48Flush Firewall SessionsflushFirewall
Flush established sessions from the firewall, which will actively end those sessions (i.e. send a TCP RST for TCP sessions). Use source and destination IP address filters to flush specific flows.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "FLUSH_FIREWALL", "parameters": { "src_ip": "10.1.0.0", "dst_ip": "10.2.0.0" } } }This example has been generated automatically.
- #49LTE Modem InformationlteModemInfo
This will fetch diagnostic information for the internal LTE modem.
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "LTE_MODEM_INFO", "parameters": { "interface": "G101" } } }This example has been generated automatically.
- #50LTE Switch SIM SlotlteSimSwitch
Switch Active SIM. Note:Both SIM should be inserted and works only in 610 LTE
objectExamples
{ "action": "runDiagnostics", "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "resformat": "JSON", "test": "LTE_SIM_SWITCH" } }This example has been generated automatically.
SUB ws/
Operation IDprocessMessageAccepts one of the following messages:
- #0noopobject
Examples
{ "action": "noop", "actionId": "string", "data": {}, "token": "eyJjb250ZW50IjoiNDllYWRjNGRkMjFhYjZh" }This example has been generated automatically.
- #1listDiagnosticsResponseobject
Examples
{ "action": "listDiagnostics", "actionId": "string", "data": {} }This example has been generated automatically.
- #2runDiagnosticsResponseobject
Examples
{ "action": "runDiagnostics", "actionId": "string", "data": { "logicalId": "ac8f5120-8eba-46ec-af6f-be6dc65da66d", "name": "ARP_DUMP", "results": { "startTime": 0, "endTime": 0, "output": "string", "processStatus": 0 } } }This example has been generated automatically.
Messages
- #1noopobject
- #2List DiagnosticslistDiagnosticsRequest
Lists all supported commands/actions for a given edge
object - #3listDiagnosticsResponseobject
- #4ARP Table DumparpDump
View the Contents of the ARP Table. This output is limited to display 1000 ARP entries.
object - #5Clear ARP CacheclearArp
Clear the ARP cache for a given interface.
object - #6DNS TestdnsTest
Perform a DNS lookup of the name specified.
object - #7DNS/DHCP Service RestartrestartDnsmasq
Restart the DNS/DHCP service. This can serve as a troubleshooting step if DHCP or DNS requests are failing for clients.
object - #8Flush FlowsflushFlows
Flush the flow table, causing user traffic to be re-classified. Use source and destination IPv4 or IPv6 address filters to flush specific flows.
object - #9Flush NATflushNat
Flush the NAT table. (This may cause existing TCP/UDP sessions to fail!)
object - #10GatewayrouteSelect
Choose whether cloud traffic should or should not use the Gateway Service. Note - This does not affect the routing of VPN traffic.
object - #11HA InfohaInfo
Show basic and interface information of active and standby edges when HA is enabled
object - #12Interface StatusinterfaceStatus
View the MAC address and connection status of physical interfaces.
object - #13List Active FlowsflowDump
List active flows in the system. Use source and destination IPv4 or IPv6 address filters to view the exact flows you want to see. This output is limited to a maximum of 1000 flows.
object - #14List ClientsclientsDump
View the full list of clients.
object - #15List PathspathsDump
View the list of active paths between local WAN links and each peer.
object - #16List current IKE Child SAsikeChildSa
Use filters to view the exact Child SAs you want to see. This output is limited to a maximum of 1000 Child SAs.
object - #17List current IKE SAsikeSa
Use filters to view the exact SAs you want to see. This output is limited to a maximum of 1000 SAs.
object - #18MIBs for EdgemibDump
Dump Edge MIBs. VELOCLOUD-MIB: the root MIB of all VeloCloud specified MIBs and required for installing VELOCLOUD-EDGE-MIB. VELOCLOUD-MIB-EDGE: the MIB specified for Edge device.
object - #19NAT Table DumpnatDump
View the contents of the NAT Table. Use the destination IP address filter to view the exact entries you want to see. This output is limited to a maximum of 1000 entries.
object - #20NTP DumpntpDump
Current date/time on Edge and NTP information
object - #21Ping TestbasicPing
Run a ping test to the destination specified.
object - #22Reset USB ModemresetUsbModem
This will attempt to reset an unworking USB modem connected to the given interface. Note that not all USB modems support this type of remote reset.
object - #23Route Table DumprouteDump
View the contents of the Route Table.
object - #24Source Interface DumpsrcIfaceDump
View the Source Interfaces selected by services
object - #25System InformationsystemInformation
View system information such as system load, recent WAN stability statistics, Monitoring Services. WAN stability statistics include the number of times individual VPN tunnels and WAN links lost connectivity for at least 700 milliseconds.
object - #26Traceroutetraceroute
Run a traceroute via the Gateway or directly out any of the WAN interfaces to the destination specified.
object - #27Troubleshoot BFD - Show BFD Peer StatusbfdPeerStatus
Show all the status of BFD peers
object - #28Troubleshoot BFD - Show BFD Peer countersbfdPeerCounters
Show all the counters of BFD peers
object - #29Troubleshoot BFD - Show BFD SettingbfdInfo
Show BFD setting and neighbor status
object - #30Troubleshoot BGP - List BGP Redistributed RoutesbgpRedisDump
See routes redistributed to BGP neighbors
object - #31Troubleshoot BGP - List BGP RoutesbgpView
Show the specific BGP routes from neighbors, leave prefix empty to see all
object - #32Troubleshoot BGP - List Routes per PrefixroutesDetail
Show all the Overlay and Underlay routes for a prefix and the details
object - #33Troubleshoot BGP - Show BGP Neighbor Advertised RoutesfrrBgpNbrAd
Show the BGP routes advertised to a neighbor
object - #34Troubleshoot BGP - Show BGP Neighbor Learned RoutesfrrBgpNbrRoutes
Show all the accepted BGP routes learned from a neighbor after filters
object - #35Troubleshoot BGP - Show BGP Neighbor Received RoutesfrrBgpNbrRcv
Show all the BGP routes received from a neighbor before filters
object - #36Troubleshoot BGP - Show BGP Neighbor detailsbgpNbr
Show the details of BGP neighbor
object - #37Troubleshoot BGP - Show BGP SummaryfrrBgpSum
Show the existing BGP neighbor and received routes
object - #38Troubleshoot BGP - Show BGP Routes per PrefixfrrBgpRoutes
Show all the BGP routes for the prefix and their attributes
object - #39Troubleshoot BGP - Show BGP TablefrrBgpTbl
Show the BGP table
object - #40Troubleshoot OSPF - List OSPF Redistributed RoutesospfRedisDump
Show all the routes redistributed to OSPF neighbor
object - #41Troubleshoot OSPF - List OSPF RoutesospfView
Show the specific OSPF routes from neighbors, leave prefix empty to see all
object - #42Troubleshoot OSPF - Show OSPF DatabasequaggaOspfDb
Show the OSPF link state database summary
object - #43Troubleshoot OSPF - Show OSPF Database for E1 Self-Originate RoutesquaggaOspfDbSo
Show the E1 LSAs self-originated by the VCE that are advertised to OSPF
object - #44Troubleshoot OSPF - Show OSPF NeighborsquaggaOspfTbl
Show all the OSPF neighbors and associated info
object - #45Troubleshoot OSPF - Show OSPF Route TablequaggaOspfRoutes
Show the existing OSPF route table
object - #46Troubleshoot OSPF - Show OSPF SettingospfInfo
Show OSPF setting and neighbor status
object - #47VPN TestvpnTest
Use ping to test VPN connectivity to each peer.
object - #48WAN Link Bandwidth TestbwTest
Force a re-test the bandwidth of a WAN link.
object - #49Reset SFP Firmware configurationsfpFwConfigReset
Few SFP allows to reset firmware configuration parameter , for other SFPs it will be no-op
object - #50Flush Firewall SessionsflushFirewall
Flush established sessions from the firewall, which will actively end those sessions (i.e. send a TCP RST for TCP sessions). Use source and destination IP address filters to flush specific flows.
object - #51LTE Modem InformationlteModemInfo
This will fetch diagnostic information for the internal LTE modem.
object - #52LTE Switch SIM SlotlteSimSwitch
Switch Active SIM. Note:Both SIM should be inserted and works only in 610 LTE
object - #53runDiagnosticsResponseobject
Schemas
- actionIdstringuid: actionId
- logicalIdstringuid: logicalId
Logical Id of the edge
- runDiagnosticsActionstringuid: runDiagnosticsActionConst:"runDiagnostics"
- listDiagnosticsActionstringuid: listDiagnosticsActionConst:"listDiagnostics"
- tokenstringuid: token
- resformatstringuid: resformat
Determines the type (HTML/JSON) of response to be returned
- Allowed values:
- "HTML"
- "JSON"
- countintegeruid: count
Max Entries
- interfacestringuid: interface
- src_ipstringuid: src_ip
Source IP
- src_portnumberuid: src_port
Source Port
- dst_ipstringuid: dst_ip
Destination IP
- dest_portnumberuid: dest_port
Destination Port
- peer_ipstringuid: peer_ip
Peer IP
- local_ipstringuid: local_ip
Local IP
- nbr_ipstringuid: nbr_ip
Neighbor IP
- prefixstringuid: prefix
- ikeSaSpistringuid: ikeSaSpi
Spi
- destinationstringuid: destination
Destination
- sourcestringuid: source
Ping From
- traceroute_sourcestringuid: traceroute_source
Traceroute Using
- linkstringuid: link
WAN Link