> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aviatrix.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Diagnostic tools

> This section provides the purpose, elements, and actions performed on the Diagnostic tools pages.

This section provides the purpose, elements, and actions performed on the
**Diagnostic tools** pages.

<Tabs>
  <Tab title="Gateway Diagnostics">
    ## Purpose

    The **Gateway Diagnostics** section provides tools to test gateway reachability,
    capture packets, trace paths, check connectivity, view active sessions and
    interface stats, manage services, run built-in diagnostics, and download
    tracelogs.

    ## Elements

    <img
      src={
"/images/reference/ui/diagnostics/diagnostics-gateway-diagnostics.png"
}
      alt="Gateway Diagnostics"
      width="60%"
    />

    * **Ping**, **Packet Capture**, **Traceroute**, **Tracepath**, **Connectivity**,
      **Active Sessions**, **Interface Stats**, **Services**, **Diagnostics**, and
      **Tracelog** sub-tabs or tools, each with run/refresh controls and results
      panels.

    ## Actions

    <AccordionGroup>
      <Accordion title="Run Ping">
        To test gateway reachability with ping:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Gateway Diagnostics**.<br />Select the **Ping** tab.
        2. Select **Interface** (default: Use Route Table) and enter **Destination (IP / Host Name)**.
        3. Click **Run** to start the ping test. Use **Reset** to clear the form.
        4. Review the **Results panel** for reachability and round-trip time.

        The Results panel shows ping output and time details.

        ### Parameter Details

        | CoPilot Parameter Name       | Description                                                               |
        | ---------------------------- | ------------------------------------------------------------------------- |
        | Interface                    | Selects interface for ping, traceroute, tracepath, or capture.            |
        | Destination (IP / Host Name) | Target IP or hostname for ping, traceroute, tracepath.                    |
        | Results                      | Shows reachability, hop details, path/MTU, or test results.               |
        | Packet table                 | Time, Interface, Source IP, Destination, Protocol, etc. (Packet Capture). |
        | Active Sessions              | Orig S-IP, Orig D-IP, Proto, State, Reply fields.                         |
        | Service Name / Status        | Gateway service and running state.                                        |
        | Check Name / Status          | Diagnostic test name and result.                                          |
        | Log Type / Download          | Trace log type and download option.                                       |
      </Accordion>

      <Accordion title="Run Packet Capture">
        To capture packets on a gateway interface:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Gateway Diagnostics**.<br />Select the **Packet Capture** tab.
        2. Set **Interface**, **IP / Host Name**, **Port**, **Duration**, and **Packet Length** as needed. Click **Run**.
        3. Use **Download PCAP File** to save captured packets. Optionally, use **Filter**, **Columns**, **Export**, or **Search** on the packet table.

        The packet table shows Time, Interface, Source IP, Destination, Protocol, and
        other fields.
      </Accordion>

      <Accordion title="Run Traceroute">
        To trace the path from the gateway to a target:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Gateway Diagnostics**.<br />Select the **Traceroute** tab.
        2. Select **Interface** and enter **Destination (IP/Host Name)**. Click **Run**.
        3. Review the **Results panel** for hop details (IP, hostname, time). Use **Reset** to clear.

        The Results panel shows hop-by-hop path details.
      </Accordion>

      <Accordion title="Run Tracepath">
        To check path and MTU to a target:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Gateway Diagnostics**.<br />Select the **Tracepath** tab.
        2. Select **Interface** and enter **Destination (IP/Host Name)**. Click **Run**.
        3. Review the **Results panel** for path and MTU details. Use **Reset** to clear.

        The Results panel shows path and MTU information.
      </Accordion>

      <Accordion title="Run Connectivity Test">
        To check reachability for common services:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Gateway Diagnostics**.<br />Select the **Connectivity** tab.
        2. Enter **HostName**, **Port**, and select **Protocol** (TCP/UDP). Click **Run**.
        3. Review the **Results panel** for DNS, HTTPS, and IP reachability. Use **Reset** to clear.

        The Results panel shows test results for the target.
      </Accordion>

      <Accordion title="View Active Sessions">
        To view live traffic sessions on the gateway:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Gateway Diagnostics**.<br />Select the **Active Sessions** tab.
        2. Click **Run** to retrieve the latest active session data for the selected gateway.

        The Active Sessions table displays current traffic sessions (Orig S-IP, Orig
        D-IP, Proto, State, etc.).
      </Accordion>

      <Accordion title="View Interface Stats">
        To view real-time interface counters:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Gateway Diagnostics**.<br />Select the **Interface Stats** tab.
        2. Review the **Interface table** (packets, errors) and **Graph view** (bandwidth).

        The page shows interface counters and bandwidth use.
      </Accordion>

      <Accordion title="View Gateway Services">
        To view gateway service status:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Gateway Diagnostics**.<br />Select the **Services** tab.
        2. Review the **Service list**. Use **Restart** for a service if supported.

        The Service list shows each service and its status.
      </Accordion>

      <Accordion title="Run Gateway Diagnostics">
        To run built-in gateway diagnostic checks:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Gateway Diagnostics**.<br />Select the **Diagnostics** tab.
        2. Click **Run diagnostics** to start tests.
        3. Review the **Results panel** for findings.

        The Results panel shows diagnostic check names and status.
      </Accordion>

      <Accordion title="Download Tracelog">
        To collect and download gateway logs:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Gateway Diagnostics**.<br />Select the **Tracelog** tab.
        2. Review the **Log list** and click **Download** to save the selected log file.

        The Log list shows available trace log files.
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Connectivity Diagnostics">
    ## Purpose

    The **Connectivity Diagnostics** section provides tools to view connection logs,
    IPsec Security Association details, IPsec service status, configuration,
    security policy details, run connectivity analysis, and reset connections.

    ## Elements

    <img
      src={
"/images/reference/ui/diagnostics/diagnostics-connectivity-diagnostics.png"
}
      alt="Connectivity Diagnostics"
      width="60%"
    />

    * **Logs**, **Security Association Details**, **IPsec Service**,
      **Configuration**, **Security Policy Details**, **Analysis**, and **Reset
      Connections** sub-tabs or panels, each with viewer/run controls and results.

    ## Actions

    <AccordionGroup>
      <Accordion title="View Connection Logs">
        To view connection logs:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Connectivity Diagnostics**.<br />Select the **Logs** tab.
        2. Review the **Log viewer**. Use **Search** to filter by keywords.

        The log viewer shows log entries and timestamps.

        ### Parameter Details

        | CoPilot Parameter Name             | Description                                         |
        | ---------------------------------- | --------------------------------------------------- |
        | Log Entry / Timestamp              | Log message and time (Logs).                        |
        | Peer IP / SPI / Status             | SA peer, SPI, state (Security Association Details). |
        | Status / Restart                   | IPsec service state and restart option.             |
        | Tunnel Settings / Local and Remote | IPsec and network settings.                         |
        | Source / Destination / Action      | Policy rules.                                       |
        | Issue Type / Recommendation        | Analysis result and suggested fix.                  |
        | Reset Option / Result              | Reset action and status.                            |
      </Accordion>

      <Accordion title="View Security Association Details">
        To view IPsec SA details:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Connectivity Diagnostics**.<br />Select the **Security Association Details** tab.
        2. Review the **SA table** (Peer IP, SPI, Status). Click **Refresh** to reload SA status.
      </Accordion>

      <Accordion title="View or Restart IPsec Service">
        To view or restart the IPsec service:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Connectivity Diagnostics**.<br />Select the **IPsec Service** tab.
        2. Review **Service status**. Use **Restart** if supported.
      </Accordion>

      <Accordion title="View Configuration">
        To view IPsec and tunnel settings:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Connectivity Diagnostics**.<br />Select the **Configuration** tab.
        2. Review the **Configuration list** (tunnel parameters, local and remote settings).
      </Accordion>

      <Accordion title="View Security Policy Details">
        To view policies applied to the gateway:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Connectivity Diagnostics**.<br />Select the **Security Policy Details** tab.
        2. Review the **Policy table** (Source, Destination, Action).
      </Accordion>

      <Accordion title="Run Connectivity Analysis">
        To run automated connectivity analysis:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Connectivity Diagnostics**.<br />Select the **Analysis** tab.
        2. Click **Run analysis** to start tests. Review **Results** for issue type and recommendation.
      </Accordion>

      <Accordion title="Reset Connections">
        To reset tunnels or sessions:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Connectivity Diagnostics**.<br />Select the **Reset Connections** tab.
        2. Click **Reset** to clear connections. Review **Status** for the reset result.
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="BGP Diagnostics">
    ## Purpose

    The **BGP Diagnostics** section allows you to run BGP commands and view output.

    ## Elements

    <img
      src={
"/images/reference/ui/diagnostics/diagnostics-bgp-diagnostics.png"
}
      alt="BGP Diagnostics"
      width="60%"
    />

    * **BGP Command** tool with command field, **Run** button, and **Output** panel.

    ## Actions

    <AccordionGroup>
      <Accordion title="Run BGP Command">
        To run a BGP command:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **BGP Diagnostics**.
        2. Enter the BGP command in the **Command** field. Click **Run** to execute.
        3. Review **Output** for the command result.

        The Output panel shows the BGP command result.

        ### Parameter Details

        | CoPilot Parameter Name | Description         |
        | ---------------------- | ------------------- |
        | Command                | BGP command to run. |
        | Output                 | Command output.     |
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Controller Diagnostics">
    ## Purpose

    The **Controller Diagnostics** section provides tools to ping from the
    Controller, view services, command log, event log, run Controller diagnostics,
    and generate or download a configuration bundle.

    ## Elements

    <img
      src={
"/images/reference/ui/diagnostics/diagnostics-controller-diagnostics.png"
}
      alt="Controller Diagnostics"
      width="60%"
    />

    * **Ping**, **Services**, **Command Log**, **Event Log**, **Diagnostics**, and
      **Configuration Bundle** sub-tabs or tools, each with run/view and results
      panels.

    ## Actions

    <AccordionGroup>
      <Accordion title="Run Controller Ping">
        To test reachability from the Controller:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Controller Diagnostics**.<br />Select the **Ping** tab.
        2. Enter **Target** (IP or hostname). Click **Run ping**.
        3. Review **Results** for reachability data.

        ### Parameter Details

        | CoPilot Parameter Name     | Description                         |
        | -------------------------- | ----------------------------------- |
        | Target Address / Results   | Ping target and reachability data.  |
        | Service Name / Status      | Controller service and state.       |
        | Command / Timestamp        | Command text and run time.          |
        | Event Type / Timestamp     | Event name and time.                |
        | Check Name / Result        | Diagnostic test and outcome.        |
        | Generate Bundle / Download | Create and save diagnostics bundle. |
      </Accordion>

      <Accordion title="View Controller Services">
        To view Controller service status:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Controller Diagnostics**.<br />Select the **Services** tab.
        2. Review the **Service list** (service name, status).
      </Accordion>

      <Accordion title="View Command Log">
        To view recent Controller commands:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Controller Diagnostics**.<br />Select the **Command Log** tab.
        2. Review the **Command table** (command, timestamp).
      </Accordion>

      <Accordion title="View Event Log">
        To view Controller events:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Controller Diagnostics**.<br />Select the **Event Log** tab.
        2. Review the **Event table** (event type, timestamp).
      </Accordion>

      <Accordion title="Run Controller Diagnostics">
        To run Controller diagnostic checks:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Controller Diagnostics**.<br />Select the **Diagnostics** tab.
        2. Click **Run diagnostics** to start tests. Review **Results** (check name, result).
      </Accordion>

      <Accordion title="Generate and Download Configuration Bundle">
        To create and download a diagnostics bundle:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **Controller Diagnostics**.<br />Select the **Configuration Bundle** tab.
        2. Click **Generate bundle** to create the file. Click **Download** to save the bundle.

        The bundle contains logs and system info.
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="UserVPN Diagnostics">
    ## Purpose

    The **UserVPN Diagnostics** section provides tools to run UserVPN diagnostics,
    view session history, and view ELB status.

    ## Elements

    <img
      src={
"/images/reference/ui/diagnostics/diagnostics-uservpn-diagnostics.png"
}
      alt="UserVPN Diagnostics"
      width="60%"
    />

    * **Diagnostics**, **Session History**, and **ELB Status** sub-tabs or panels,
      each with run/view controls and results.

    ## Actions

    <AccordionGroup>
      <Accordion title="Run UserVPN Diagnostics">
        To run UserVPN diagnostic checks:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **UserVPN Diagnostics**.<br />Select the **Diagnostics** tab.
        2. Click **Run diagnostics** to start checks. Review **Results** (diagnostic test, result).

        ### Parameter Details

        | CoPilot Parameter Name       | Description                     |
        | ---------------------------- | ------------------------------- |
        | Diagnostic Test / Result     | Type of check and outcome.      |
        | User / IP Address / Duration | Session user, IP, and length.   |
        | ELB Name / Status            | Load balancer and health state. |
      </Accordion>

      <Accordion title="View Session History">
        To view UserVPN session history:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **UserVPN Diagnostics**.<br />Select the **Session History** tab.
        2. Review the **Session table** (user, IP address, duration).
      </Accordion>

      <Accordion title="View ELB Status">
        To view load balancer health for UserVPN:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **UserVPN Diagnostics**.<br />Select the **ELB Status** tab.
        2. Review the **ELB table** (ELB name, status).
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="FireNet Diagnostics">
    ## Purpose

    The **FireNet Diagnostics** section runs FireNet diagnostic checks and displays
    results.

    ## Elements

    <img
      src={
"/images/reference/ui/diagnostics/diagnostics-firenet-diagnostics.png"
}
      alt="FireNet Diagnostics"
      width="60%"
    />

    * **Diagnostics** tool with **Run diagnostics** and **Results** panel.

    ## Actions

    <AccordionGroup>
      <Accordion title="Run FireNet Diagnostics">
        To run FireNet diagnostic checks:

        1. Go to **Diagnostics** > **Diagnostic Tools** > **FireNet Diagnostics**.
        2. Click **Run diagnostics** to start tests. Review **Results** (diagnostic test, result).

        The Results panel shows FireNet check output.

        ### Parameter Details

        | CoPilot Parameter Name | Description            |
        | ---------------------- | ---------------------- |
        | Diagnostic Test        | Type of FireNet check. |
        | Result                 | Outcome.               |
      </Accordion>
    </AccordionGroup>
  </Tab>
</Tabs>