Supported Versions
REST API version using 4.2.1


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:

Configure the integration

  1. From All Clients, select a client.

  2. Go to Setup > Integrations and Apps. If there are already installed apps, it will redirect to the INSTALLED APPS page where all the installed apps are displayed. Click +ADD and search for the App on the Available apps page.

If there are no installed apps, it will navigate to the AVAILABLE APPS page.

Use the search option available to search for VMware SD-WAN (VeloCloud) application. Alternatively, use All Categories dropdown to search. In this case, select Saas Application. All SAAS apps are displayed.
Note: The search option is used to search for apps on a page.

  1. Click ADD under VMware SD-WAN (VeloCloud):

  2. In Add VELOCLOUD page, enter account information:

    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
  3. 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.
  4. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:

    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  5. Click Finish.
    The application is now installed and displayed on the Installed Integration page. Use the search field to find the installed application.

  6. 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 NameMetric Display NameUnits

Shows the status of the VMware SD-WAN Edge. Possible values: 0-Down 1-Connected 2-Degraded
VMware SD-WAN Edge Status

Shows the HA status of the VMware SD-WAN Edge.
Possible values: 0-Unconfigured 1-Ready
VMware SD-WAN Edge HA Status

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

Shows the QOE scores for voice
VMware SD-WAN Edge Voice QOE Scorecount

Shows the QOE scores for video
VMware SD-WAN Edge Video QOE Scorecount

Shows the QOE scores for transactional
VMware SD-WAN Edge Transactional QOE Scorecount

Shows the Edge Flow Count
VMware SD-WAN Edge Flow Countcount

Shows the Edge Tunnel Count
VMware SD-WAN Edge Tunnel Countcount

VMware SD-WAN Edge HandOff QueueDrops

Shows the Edge CPU utilization
VMware SD-WAN Edge CPU Utilization%

Shows the Edge Memory utilization
VMware SD-WAN Edge Memory Utilizationcount

shows the status of the VMware SD-WAN Gateway.
Possible values: 0-Offline 1-Connected 2-Degraded
VMware SD-WAN Gateway Status

Shows the Gateway Flow Count
VMware SD-WAN Gateway Flow Countcount

Shows the Gateway Tunnel Count
VMware SD-WAN Gateway Tunnel Countcount

Shows the Gateway HandOff QueueDrops
VMware SD-WAN Gateway HandOff QueueDropscount

Shows the Gateway CPU utilization
VMware SD-WAN Gateway CPU Utilization%

Shows the Gateway Memory utilization
VMware SD-WAN Gateway Memory Utilization%

Shows the Link packet loss
VMware SD-WAN Link Packet Loss%

Shows the Link Bandwidth
VMware SD-WAN Link BandwidthMbps

Shows the Link Signal strength
VMware SD-WAN Link Signal StrengthdBm

Shows the Link Packet Received
VMware SD-WAN Link Packets Receivedcount

Shows the Link Packets sent
VMware SD-WAN Link Packets Sentcount

Shows the Link Latency
VMware SD-WAN Link Latencyms

Shows the Link Jitter
VMware SD-WAN Link Jitterms

Shows the Link Bytes Received
VMware SD-WAN Link Bytes ReceivedMB

Shows the Link Bytes Sent
VMware SD-WAN Link Bytes SentMB

Shows the Link Status.
Possible values: 0-Disconnected 1-Stable 2-StandBY
VMware SD-WAN Link Status

Shows the Link VPN State.
Possible values: 0-Status Empty 1-Stable 2-Other
VMware SD-WAN Link VPN State

Shows the Link Effective State.
Possible Values: 0-Disconnected 1-Stable 2-StandBY
VMware SD-WAN Link Effective State