| Supported Versions |
|---|
| REST API version using 4.2.1 |
Introduction
VMware SD-WAN (Software-defined Wide Area Network) by VeloCloud is a cloud-delivered solution for network operators and application owners who want to ensure high application performance and availability for their end users while lowering networking costs.
VMware SD-WAN ensures a reliable and resilient wide area network (WAN), with a choice of connection types, including: Multiprotocol Label Switching (MPLS), LTE, WiFi and broadband. VMware SD-WAN combines multiple links and uses traffic steering technology to select the best path for each application to ensure consistent performance and overcome quality issues and outages.
Available resources under VMware SD-WAN are as follows:
- Orchestrator: A web-based central management tool that provides simplified configuration, provisioning, monitoring, fault management, logging, and reporting.
- VMware SD-WAN Gateways: VMware SD-WAN Gateways optimize data paths to all applications, branches, and data centers along with the ability to deliver network services to and from the cloud.
- Edges: A Zero-touch enterprise-class appliance that provides secure optimized connectivity to applications in any location, including private data centers, public clouds and hybrid deployments.
- Links: Connectivity between edge and other end devices.
VMware SD-WAN Architecture diagram:
Diagram Reference:
https://sase.vmware.com/content/dam/digitalmarketing/velocloud/en/documents/brief-solution-overview.pdf
Configure the integration
From All Clients, select a client.
Go to Setup > Integrations > Integrations.
In the Saas Application section, select VMware SD-WAN (VeloCloud):
Enter your account information:
Property Description Name (required) Enter integration name. Account Number (required) Enter the VeloCloud account number Host Name (required) Enter the host name User Name (required) Enter the user name Password (required) Enter the password Confirm Password (required) Re-enter the password Click Next.
Choose the discovery schedule period:
Click Finish.
After configuring the integration, VMware SD-WAN metrics can be viewed from the Infrastructure page.
Hierarchy of VMware SD-WAN - VeloCloud resources:
VMware SD-WAN Orchestrator
— VMware SD-WAN Gateways
— VMware SD-WAN Edges
— VMware SD-WAN Edge Links
Supported metrics
| Metric Name | Metric Display Name | Units |
|---|---|---|
| vmware_sdwan_edge_Status Shows the status of the VMware SD-WAN Edge. Possible values: 0-Down 1-Connected 2-Degraded | VMware SD-WAN Edge Status | |
| vmware_sdwan_edge_HAStatus Shows the HA status of the VMware SD-WAN Edge. Possible values: 0-Unconfigured 1-Ready | VMware SD-WAN Edge HA Status | |
| vmware_sdwan_edge_NeighborBGPState Shows the Edge Neighbor BGP state. Possible values: 0-Unconfigured 0-Idle 1-Connect 2-Active 3-Established | VMware SD-WAN Edge Neighbor BGP State | |
| vmware_sdwan_edge_VoiceQOEScore Shows the QOE scores for voice | VMware SD-WAN Edge Voice QOE Score | count |
| vmware_sdwan_edge_VideoQOEScore Shows the QOE scores for video | VMware SD-WAN Edge Video QOE Score | count |
| vmware_sdwan_edge_TransactionalQOEScore Shows the QOE scores for transactional | VMware SD-WAN Edge Transactional QOE Score | count |
| vmware_sdwan_edge_FlowCount Shows the Edge Flow Count | VMware SD-WAN Edge Flow Count | count |
| vmware_sdwan_edge_TunnelCount Shows the Edge Tunnel Count | VMware SD-WAN Edge Tunnel Count | count |
| vmware_sdwan_edge_HandOffQueueDrops VMware SD-WAN Edge HandOff QueueDrops | ClientSatisfactionPercent | count |
| vmware_sdwan_edge_CPUUtilization Shows the Edge CPU utilization | VMware SD-WAN Edge CPU Utilization | % |
| vmware_sdwan_edge_MemoryUtilization Shows the Edge Memory utilization | VMware SD-WAN Edge Memory Utilization | count |
| vmware_sdwan_gateway_Status shows the status of the VMware SD-WAN Gateway. Possible values: 0-Offline 1-Connected 2-Degraded | VMware SD-WAN Gateway Status | |
| vmware_sdwan_gateway_FlowCount Shows the Gateway Flow Count | VMware SD-WAN Gateway Flow Count | count |
| vmware_sdwan_gateway_TunnelCount Shows the Gateway Tunnel Count | VMware SD-WAN Gateway Tunnel Count | count |
| vmware_sdwan_gateway_HandOffQueueDrops Shows the Gateway HandOff QueueDrops | VMware SD-WAN Gateway HandOff QueueDrops | count |
| vmware_sdwan_gateway_CPUUtilization Shows the Gateway CPU utilization | VMware SD-WAN Gateway CPU Utilization | % |
| vmware_sdwan_gateway_MemoryUtilization Shows the Gateway Memory utilization | VMware SD-WAN Gateway Memory Utilization | % |
| vmware_sdwan_link_PacketLoss Shows the Link packet loss | VMware SD-WAN Link Packet Loss | % |
| vmware_sdwan_link_Bandwidth Shows the Link Bandwidth | VMware SD-WAN Link Bandwidth | Mbps |
| vmware_sdwan_link_SignalStrength Shows the Link Signal strength | VMware SD-WAN Link Signal Strength | dBm |
| vmware_sdwan_link_PacketsReceived Shows the Link Packet Received | VMware SD-WAN Link Packets Received | count |
| vmware_sdwan_link_PacketsSent Shows the Link Packets sent | VMware SD-WAN Link Packets Sent | count |
| vmware_sdwan_link_Latency Shows the Link Latency | VMware SD-WAN Link Latency | ms |
| vmware_sdwan_link_Jitter Shows the Link Jitter | VMware SD-WAN Link Jitter | ms |
| vmware_sdwan_link_BytesReceived Shows the Link Bytes Received | VMware SD-WAN Link Bytes Received | MB |
| vmware_sdwan_link_BytesSent Shows the Link Bytes Sent | VMware SD-WAN Link Bytes Sent | MB |
| vmware_sdwan_link_Status Shows the Link Status. Possible values: 0-Disconnected 1-Stable 2-StandBY | VMware SD-WAN Link Status | |
| vmware_sdwan_link_VPNState Shows the Link VPN State. Possible values: 0-Status Empty 1-Stable 2-Other | VMware SD-WAN Link VPN State | |
| vmware_sdwan_link_EffectiveState Shows the Link Effective State. Possible Values: 0-Disconnected 1-Stable 2-StandBY | VMware SD-WAN Link Effective State |
References
REST API Doc:
https://code.vmware.com/apis/1115/velocloud-sdwan-vco-api
Related documents:
https://github.com/iddocohen/vcoclient/blob/master/vcoclient.py
https://github.com/Wax-Trax/beginner-scraps/blob/master/VeloCloud/vc.py
https://neckercube.com/posts/2019-02-28-using-python-with-the-velocloud-orchestrator/