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, Wi-Fi 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 centres 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 centres, 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.
Navigate to Setup > Account.
Select the Integrations and Apps tab.
The Installed Integrations page, where all the installed applications are displayed.
Note: If there are no installed applications, it will navigate to the Available Integrations and Apps page.Click + ADD on the Installed Integrations page. The Available Integrations and Apps page displays all the available applications along with the newly created application with the version.
Note: You can even search for the application using the search option available. Also you can use the All Categories option to search.Click ADD in the VMware SD-WAN(VeloCloud) application.
In ADD VMWARE SD-WAN(VELOCLOUD) page, enter account information:
Property Description Name (required) Enter integration name. Account Number (required) Enter the VeloCloud account number. Host Name (required) Enter the hostname. User Name (required) Enter the username. Password (required) Enter the password. Confirm Password (required) Re-enter the password. Click Next.
In the RESOURCE TYPE section, select:
- ALL: All the existing and future resources will be discovered.
- SELECT: You can select one or multiple resources to be discovered.
In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:
- Minutes
- Hourly
- Daily
- Weekly
- Monthly
- Click FINISH.
The application is now installed and displayed on the Installed Integration page. Use the search field to find the installed application.
- You can either create a copy of global templates or use existing global templates for metric collection. But you cannot edit the global templates.Below is the list of global templates G1 and G2 for VeloCloud.
G1 templates:
- VMware SD-WAN (VeloCloud) VMware SD-WAN Edge - for VeloCloud Edges.
- VMware SD-WAN (VeloCloud) VMware SD-WAN Edge Link - For VeloCloud edge links.
- VMware SD-WAN (VeloCloud) VMware SD-WAN Gateway - For VeloCloud gateways.
G2 templates:
- VMware SD-WAN (VeloCloud) VMware SD-WAN Edge G2 Template - for VeloCloud Edges.
- VMware SD-WAN (VeloCloud) VMware SD-WAN Edge Link G2 Template - For VeloCloud edge links.
- VMware SD-WAN (VeloCloud) VMware SD-WAN Gateway G2 Template - For VeloCloud gateways.
Use DMP (Device Management Policies) to assign a template against a resource. You can create a new DMP or copy the existing DMP. See Device Management Policies for more details.
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
Resource | Metric Name | Metric Display Name | Unit | Description |
---|---|---|---|---|
VMware SD-WAN Edge | vmware_sdwan_Edge_CPU_Utilization | VMware SD-WAN Edge CPU Utilization | Percentage | Shows the edge CPU utilization. |
vmware_sdwan_Edge_FlowCount | VMware SD-WAN Edge Flow Count | Count | Shows the edge flow count. | |
vmware_sdwan_Edge_HandOff_QueueDrops | VMware SD-WAN Edge HandOff QueueDrops | Count | Show the edge handOff queue drops. | |
vmware_sdwan_Edge_HA_Status | VMware SD-WAN Edge HA Status | Shows the HA status of the Edge. Possible values 0-Unconfigured 1-Ready. | ||
vmware_sdwan_Edge_Memory_Utilization | VMware SD-WAN Edge Memory Utilization | Percentage | Shows the edge memory utilization. | |
vmware_sdwan_Edge_Neighbor_BGP_State | VMware SD-WAN Edge Neighbor BGP State | Shows the edge neighbor BGP state. Possible values 0-Idle 1-Connect 2-Active 3-Established 4-Removed 5-Unconfigured. | ||
vmware_sdwan_Edge_Status | VMware SD-WAN Edge Status | Shows the status of the VMware SD-WAN edge. Possible values 0-Down 1-Connected 2-Degraded 3-Never Activated 4-offline 5-online. | ||
vmware_sdwan_Edge_Transactional_QOE_Score | VMware SD-WAN Edge Transactional QOE Score | Count | Shows the transactional QOE scores. | |
vmware_sdwan_Edge_TunnelCount | VMware SD-WAN Edge Tunnel Count | Count | Shows the edge tunnel count. | |
vmware_sdwan_Edge_Video_QOE_Score | VMware SD-WAN Edge Video QOE Score | Count | Shows the video QOE scores. | |
vmware_sdwan_Edge_Voice_QOE_Score | VMware SD-WAN Edge Voice QOE Score | Count | Shows the voice QOE scores. | |
VMware SD-WAN Edge Link | vmware_sdwan_Link_Bandwidth | VMware SD-WAN Link Bandwidth | BPS | Shows the Link bandwidth. |
vmware_sdwan_Link_Bytes_Received | VMware SD-WAN Link Bytes Received | Bytes | Shows the bytes count received by a link. | |
vmware_sdwan_Link_Bytes_Sent | VMware SD-WAN Link Bytes Sent | Bytes | Shows the bytes count sent by a link. | |
vmware_sdwan_Link_Effective_State | VMware SD-WAN Link Effective State | Shows the link effective state. Possible values 0-Disconnected 1-Stable 2-Standby. | ||
vmware_sdwan_Link_Jitter | VMware SD-WAN Link Jitter | MS | Shows the link jitter. | |
vmware_sdwan_Link_Latency | VMware SD-WAN Link Latency | MS | Shows the link latency. | |
vmware_sdwan_Link_Packets_Received | VMware SD-WAN Link Packets Received | Count | Shows the count of link packets. | |
vmware_sdwan_Link_Packets_Sent | VMware SD-WAN Link Packets Sent | Count | Shows the count of link packet sent. | |
vmware_sdwan_Link_Packet_Loss | VMware SD-WAN Link Packet Loss | Percentage | Shows the link packet loss. | |
vmware_sdwan_Link_SignalStrength | VMware SD-WAN Link Signal Strength | dBm | Shows the link signal strength. | |
vmware_sdwan_Link_Status | VMware SD-WAN Link Status | Shows the link status. Possible values 0-Disconnected 1-Stable 2-Standby. | ||
vmware_sdwan_Link_VPN_State | VMware SD-WAN Link VPN State | Shows the link VPN state. Possible Values 0-StatusEmpty 1-Stable 2-Other. | ||
vmware_sdwan_Link_BandwidthPercentage | VMware SD-WAN Link Bandwidth Percentage | Percentage | Shows the link bandwidth percentage based on the amount of bytes received and bytes sent. | |
vmware_sdwan_Link_Throughput | VMware SD-WAN Link Throughput | Mbps | Shows the link speed based on the amount of bytes received and bytes sent. | |
VMwaVMware SD-WAN Gateway | vmware_sdwan_Gateway_CPU_Utilization | VMware SD-WAN Gateway CPU Utilization | Percentage | Shows the gateway CPU utilization. |
vmware_sdwan_Gateway_FlowCount | VMware SD-WAN Gateway Flow Count | Count | Shows the gateway flow count. | |
vmware_sdwan_Gateway_HandOff_QueueDrops | VMware SD-WAN Gateway HandOff QueueDrops | Count | Show the gateway handOff queue drops. | |
vmware_sdwan_Gateway_Memory_Utilization | VMware SD-WAN Gateway Memory Utilization | Percentage | Shows the gateway memory utilization. | |
vmware_sdwan_Gateway_TunnelCount | VMware SD-WAN Gateway Tunnel Count | Count | Shows the gateway tunnel count. | |
vmware_sdwan_Gateway_Status | VMware SD-WAN Gateway Status | Shows the status of the VMware SD-WAN gateway. Possible values 0-Offline 1-Connected 2-Never Activated. |
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/