Print

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

Testing and Troubleshooting

The Orchestrator Test & 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, click the Diagnostics tab to access and perform the testing and troubleshooting options.

Note: Starting with the 5.1.0 release, all the 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. 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 uses a bi-directional WebSocket connection instead of the live-mode heartbeat mechanism to improve the responsiveness of the Remote Diagnostics in the 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 setup on Edge activation for processing heartbeats from the Edge and sending back responses to the Orchestrator.

While establishing WebSocket connections between a Web browser and an Edge, in order to ensure Web security against Distributed Denial-of-Service (DDoS) and Cross site request forgery (CSRF) attacks, the browser origin address that is 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 newly for WebSocket connections:
  • network.portal.websocket.address- Allows to set 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 to set 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.

VeloCloud Orchestrator enables you 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.
    The Remote Diagnostics page displays the existing Edges.
    Figure 1. Remote Diagnostics
  2. Select the link to an Edge.
  3. A connection is established to the Edge and the Remote Diagnostics window displays all the possible Remote Diagnostics tests than you can run on the Edge.
  4. Choose an appropriate Remote Diagnostics test to run on the Edge and select Run.
    The diagnostic information is fetched from the Edge and displayed in 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.

Remote Actions

You can perform actions like Restarting services, Rebooting, or deactivating an Edge remotely, from the Enterprise portal.

Note: You can perform the remote actions only on Edge that are in Connected state.
  1. In the SD-WAN service of the Enterprise portal, you can perform remote actions from the Diagnostics > Remote Actions > Edges navigation path.
    Figure 2. Remote Actions
  2. Select an Edge and perform any of the following remote actions:
    Table 1. Remote Actions- Actions and Descriptions
    Action Description
    Restart Service Restarts the VeloCloud SD-WAN services on the selected Edge.
    Reboot Reboots the selected Edge.
    Identify Randomly flashlights on the selected Edge to identify the device.
    Shutdown Powers off the selected Edge. To restore the Edge, you must remove the power cable, and then plug it back into the Edge.
    Deactivate Resets the device configuration to its factory default state.
    Force HA Failover Forces HA Failover. This option is available only when the Edge is configured with High Availability and the state is HA ready.
  3. You can also perform the remote actions for an Edge using the Shortcuts option available in the Configure > Edges or Monitor > Edges pages. Select the Shortcuts > Remote Actions and perform any of the actions listed in the above table.
    For more information, see Configure Edges with New Orchestrator UI and Monitor Edges.
    Note: The actions may take up to a minute to run on the device.

Diagnostic Bundles for Edges

Diagnostic bundles allow Operator users to collect all the configuration files and log files into a consolidated Zipped file. The data available in the diagnostic bundles can be used for debugging purposes.

To generate and download Diagnostic Bundles:

  1. In the SD-WAN service of the Enterprise portal, select the Diagnostics tab.
  2. Select Diagnostic Bundles to request the following bundles:
    • 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 additional information, see Request Packet Capture Bundle.
    • 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.
    Note: The Request Diagnostic Bundle option is available only for an Operator user. If you are a Partner user or an Enterprise user, you can request for a PCAP Bundle.
  3. The generated bundles are displayed in the Diagnostic Bundles window.
    Figure 3. Diagnostic Bundles
  4. To download the details of generated bundles, select More > Download CSV .
    The details are downloaded in a CSV file.

Request Packet Capture Bundle

The Packet Capture bundle collects the packets data of a network. These files are used in analyzing the network characteristics. You can use the data for debugging an Edge device.

To generate a PCAP bundle:

  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 that appears, configure the following:
    Figure 4. Request PCAP Bundle

     

    Table 2. Request PCAP Bundle- Options and Descriptions
    Option Description
    Target Choose the target Edge from the drop-down list. The packets are collected from the selected Edge.
    Interface Choose an Interface or a VLAN from the drop-down list. The packets are collected on the selected Interface.
    Duration Choose the time in seconds. The packets are collected for the selected duration.
    Reason for Generation Optionally, you can enter your reason for generating the bundle.
    PCAP Filters Optionally for an Edge, you can define PCAP filters by which you want to control the PCAP data to be generated by choosing the following options:
    • IP1- Enter an IPv4 address, or IPv6 address, or Subnet mask.
    • IP2- Enter an IPv4 address, or IPv6 address, or Subnet mask.
    • IP1:Port1- Enter a Port ID associated with IP1.
    • IP2:Port2- Enter a Port ID associated with IP2.
    • Protocol- Select a protocol from the list.
    Note:

    If you choose to use the PCAP filtering capability then you must define at least one filter.
    Advanced Filters Optionally for an Edge, you can define free form filters by which you want to control the PCAP data to be generated.
    The window displays the details of the bundle being generated, 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's HA interface, the interface that connects the Standby Edge to the Active Edge. This option appears at the bottom of the menu and reads: Standby Edge, and then lists the HA interface.
Figure 5. Request PCAP Bundle for HA Edges

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, you can enter your reason for generating the bundle.
    Core Limit Select a Core Limit value from the drop-down, which is used 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.
  4. Download Diagnostic Bundle- To download the generated Diagnostic bundles:
    1. In the Diagnostic Bundles window, select the Complete link or select the bundle and select Download Bundle. The bundle is downloaded as a ZIP file.
    2. For troubleshooting purpose, you can send the downloaded bundle to a Arista Support representative for debugging the data.
  5. Delete Diagnostic Bundle- The completed bundles get deleted automatically on the date displayed in the Cleanup Date column.
    1. To change the cleanup date, select the link to the cleanup date or choose the bundle and select More > Update Cleanup Date .
    2. In the Update Cleanup Date window, choose the date on which the selected bundle should be deleted.
    3. If you want to retain the bundle, select the Keep Forever option, so that the bundle does not get deleted automatically.
    4. To delete a bundle manually, select the bundle and select Delete.
..