Print

VeloCloud SD-WAN 7.0 - Administration Guide - Testing and Troubleshooting Print

Testing and Troubleshooting

The Orchestrator Test and Troubleshoot functionality provides tools to test the status of the Arista services, perform remote Edge actions, and gather debugging information for an Edge.

In the SD-WAN service of the Enterprise portal, select the Diagnostics tab to access and perform the testing and troubleshooting options.

Starting with the 5.1.0 release, all troubleshooting and diagnostics-related information for Edges and Gateways is documented and published as a standalone guide titled Arista SD-WAN Troubleshooting Guide.

Run Remote Diagnostics

Arista VeloCloud SD-WAN supports bi-directional communication with the VeloCloud Edge by using WebSockets. A WebSocket is a full-duplex communication protocol over a single TCP connection. WebSockets easily enable communication between a Web browser (or other client applications) and a Web server with much lower overhead than HTTP polling. Remote Diagnostics utilizes a bi-directional WebSocket connection instead of the live-mode heartbeat mechanism to enhance the responsiveness of Remote Diagnostics in the Arista VeloCloud Orchestrator.
The WebSocket communication involves the following two WebSocket connections for passing WebSocket messages from a Web browser to a VeloCloud Edge and vice versa:
  • A WebSocket connection between a Web browser (Orchestrator UI portal) and an Orchestrator. This connection is responsible for all communications with the Web browser and for setting up the system properties needed for establishing a WebSocket connection.
  • Another WebSocket connection between an Orchestrator and an Edge. This connection is persistent and set up upon Edge activation for processing heartbeats from the Edge and sending responses back to the Orchestrator.

When establishing WebSocket connections between a Web browser and an Edge, to ensure Web security against Distributed Denial-of-Service (DDoS) and Cross-Site Request Forgery (CSRF) attacks, the browser origin address used to access the Orchestrator UI is validated for incoming requests.

In most Orchestrators, the browser origin address/DNS hostname is the same as the value of the network.public.address system property. To support scenarios where the address used to access the Orchestrator UI from the browser is different from the value of the network.public.address system property, the following system properties are added for WebSocket connections:

  • network.portal.websocket.address - Allows setting an alternate address/DNS hostname to access the UI from a browser if the browser address is not the same as the value of network.public.address system property. By default, the network.portal.websocket.address system property is not set.
  • session.options.websocket.portal.idle.timeout - Allows setting the total amount of time (in seconds) the browser WebSocket connection is active in an idle state. By default, the browser WebSocket connection is active for 300 seconds in an idle state.

Arista VeloCloud Orchestrator enables users to run various Remote Diagnostic tests on a selected Edge. To run Remote Diagnostics on an Edge, perform the following steps:

  1. In the SD-WAN service of the Enterprise portal, select the Diagnostics tab.
  2. The Remote Diagnostics page displays the existing Edges.
    Figure 1. Remote Diagnostics
  3. Select the link to an Edge.
  4. The Orchestrator establishes a connection to the Edge, and the Remote Diagnostics window displays all possible diagnostic tests for the Edge.
  5. Select an appropriate Remote Diagnostics test to run on the Edge then select Run. The diagnostic information is fetched from the Edge and displayed on the screen.
For additional information about all the supported Remote Diagnostics tests, see the Remote Diagnostic Tests on Edges section in the Arista VeloCloud SD-WAN Troubleshooting Guide.

Perform Remote Actions

Users can perform actions such as restarting services, rebooting, or deactivating an Edge device remotely from the Enterprise portal.

Users can perform the remote actions only on the Edge that is in the Connected state.

To perform the remote actions:

  1. In the Enterprise portal, perform the remote actions for an Edge using the Shortcuts option available in the Configure > Edges or Monitor > Edges pages.
    See Configure Device Settings for Edges and Monitor Edges.
  2. Select the Shortcuts > Remote Actions to open the Remote Actions dialog.
    Figure 2. Remote Actions
  3. Users can perform the following actions:
    Table 1. Remote Actions
    Action Description
    Identify Randomly flash the lights on the selected Edge to identify the device.
    Restart Service Restarts the VeloCloud SD-WAN services on the selected Edge.
    Reboot Reboots the selected Edge.
    Shutdown Powers off the selected Edge. To restore the Edge, users must first remove the power cable and then reinsert it into the Edge.
    Deactivate Resets the device configuration to its factory default state.
    Force HA Failover Forces High-Availability (HA) Failover. This option appears only when the Edge utilizes High Availability and maintains an HA Ready state.
Note: The actions may take up to a minute to run on the device.

Diagnostic Bundles for Edges

Diagnostic bundles enable Operator users to collect all configuration files and log files into a consolidated Zip file. Support teams utilize the data in the diagnostic bundles for debugging purposes.

To generate and download Diagnostic Bundles using the new Orchestrator UI:

  1. In the Enterprise portal, select the Diagnostics tab.
  2. Select Diagnostic Bundles to request the following bundles:
    1. Request PCAP Bundle: The Packet Capture bundle is a collection of the packet data of the network. Operators, Standard Admins and Customer Support can request PCAP bundles. For more information, see Request Packet Capture Bundle.
    2. Request Diagnostic Bundle: The Diagnostic bundle is a collection of all the configuration and logs from a specific Edge. Only Operators can request Diagnostic bundles. For additional information, see Request Diagnostic Bundle with New Orchestrator UI.
    Note: The Request Diagnostic Bundle option is available only to Operator users. A Partner user or an Enterprise user can request for a PCAP Bundle.
The generated bundles are displayed in the Diagnostic Bundles window.
Figure 3. Diagnostic Bundles
To download the details of generated bundles, select More > Download CSV . The system downloads the details into a CSV file.

Requesting a Packet Capture Bundle

The Packet Capture Bundle collects packet data from a network. Use these files to analyze the network characteristics and data for debugging an Edge device.

To generate a PCAP bundle, perform the following steps:

  1. In the SD-WAN service of the Enterprise portal, select the Diagnostics tab.
  2. Select Diagnostic Bundles Request PCAP Bundle.
  3. In the Request PCAP Bundle window, configure the following:
    Figure 4. Requesting a PCAP Bundle

     

    Table 2. PCAP Bundle Option Descriptions
    Option Description
    Target Select the target Edge from the list. The system collects packets from the selected Edge.
    Interface Select an Interface or a VLAN from the list. The system collects packets from the selected Interface.
    Duration Select the time in seconds. The system collects packets for the selected duration.
    Reason for Generation Optionally, users can enter the reason for generating the bundle.
    PCAP Filters Optionally, for an Edge, users can define PCAP filters for the generated PCAP data by selecting the following options:
    • IP1- Type an IPv4 address, or an IPv6 address, or a Subnet mask.
    • IP2- Type an IPv4 address, or an IPv6 address, or a Subnet mask.
    • IP1:Port1- Type a Port ID associated with IP1.
    • IP2:Port2- Type a Port ID associated with IP2.
    • Protocol- Select a protocol from the list.
    If users choose the PCAP filtering capability, then users must define at least one filter.
    Advanced Filters Optionally, the administrator defines free-form filters to control the generated PCAP data for an Edge.

    The window displays the details of the generated bundle along with the status.

    Packet Capture for Edges Configured for High Availability

    In Release 5.2.0 and later, a user can request a packet capture for the Standby Edge HA interface, which connects the Standby Edge to the Active Edge.
    Figure 5. Configuring a Request for a Standby Edge HA Interface

Request Diagnostic Bundle

A Diagnostic bundle is a collection of configuration files, logs, and related events from a specific Edge.

To generate a Diagnostic bundle:

  1. In the SD-WAN service of the Enterprise portal, select the Diagnostics tab.
  2. Select Diagnostic Bundles > Request Diagnostic Bundle .
  3. In the Request Diagnostic Bundle window, configure the following:
    Figure 6. Request Diagnostic Bundle

     

    Table 3. Request Diagnostic Bundle - Options and Descriptions
    Option Description
    Target Select the target Edge from the drop-down list. The data is collected from the selected Edge.
    Reason for Generation Optionally, users can enter the reason for generating the bundle.
    Core Limit Select a Core Limit value from the drop-down menu to reduce the size of the uploaded bundle when the Internet connectivity is experiencing issues.

    The Diagnostic Bundles window displays the details of the bundle being generated, along with the status.

Download Diagnostic Bundle- To download the generated Diagnostic bundles:
  • In the Diagnostic Bundles window, select the Complete link or select the bundle then select Download Bundle. The system downloads the bundle as a ZIP file.
  • For troubleshooting purposes, users can send the downloaded bundle to a support representative for debugging the data.
Delete Diagnostic Bundle: The completed bundles delete automatically on the date displayed in the Cleanup Date column.
  • To change the cleanup date, select the link to the cleanup date or select the bundle then select More > Update > Cleanup Date .
  • In the Update Cleanup Date window, select the date by which the system will delete the selected bundle.
  • If users want to retain the bundle, select the Keep Forever option, so that the bundle does not delete automatically.
  • To delete a bundle manually, select the bundle then select Delete.
..