Support

This section provides the purpose, elements, and actions performed on the Support pages.

Remote Access & Logs
Debugging Tools

Purpose

The Remote Access & Logs page manages remote support access for Aviatrix Virtual Machines, uploads log bundles to cloud storage, and displays recent log bundle activities.

Elements

Upload Log Bundles button: Opens a dialog to upload log bundles for selected Aviatrix Virtual Machines and gateways to cloud storage.
Aviatrix Virtual Machines table: Table with Type (Controller / CoPilot App Instance), Remote Support (Enable / Disable), and Log Bundle row actions (Upload to Cloud on both rows; Download on the CoPilot App Instance row only).
Recent Activities table: Table with Timestamp, Entity, and Log Bundle Name columns, plus a Total N Log Bundles footer and Refresh status control.

Actions

View Remote Access & Logs

To view remote access and logs:

Go to Settings > Support > Remote Access & Logs.
The page appears with the Aviatrix Virtual Machines table and Recent Activities. Use Remote Support (Enable / Disable) or the Log Bundle column actions (Upload to Cloud, Download) per row.
Optionally, use the Recent Activities grid footer Refresh status control to update the table.

The Remote Access & Logs page shows VMs and log bundle options.

Upload Log Bundles

To upload log bundles:

Go to Settings > Support > Remote Access & Logs.
Click Upload Log Bundles (or use a row’s Log Bundle Upload to Cloud action).
In the dialog, select one or more Aviatrix Virtual Machines (Controller, CoPilot App Instance) and/or Gateways.
Click Upload.

Log bundles are uploaded to cloud storage for the selected VMs and gateways.

Purpose

The Debugging Tools page provides internal database and certificate debugging tools — MongoDB, etcd, and mTLS — selected from a Tools list.

Warning: The MongoDB tool can modify or delete data directly in the database backing Controller and CoPilot. Use it only when directed by Aviatrix Support.

Elements

Tools list: Left-side list to select the active tool (MongoDB, etcd, mTLS); collapsible.
MongoDB: Database and Collection dropdowns, an optional Document JSON-query textbox, and a Drop Database button. Once a collection is selected, the button becomes a split Dump control whose More Options menu contains Update Document, Delete Document, Delete Collection, and Drop Database.
etcd: Prefix textbox and a Download button for etcd data.
mTLS: Gateway table (includes the Controller) with row selection, Filter / Search, and a Re-Attest button; footer Total N row count and Refresh status control.

Actions

View Debugging Tools

To view debugging tools:

Go to Settings > Support > Debugging Tools.
In the Tools list, select MongoDB, etcd, or mTLS.

The selected tool’s controls appear on the right.

Dump a MongoDB Collection

To dump a MongoDB collection:

Go to Settings > Support > Debugging Tools and select MongoDB.
Select Database, then Collection. Optionally, enter a Document JSON query to filter the dump.
Click Dump.

The selected collection (or matching documents) is dumped for troubleshooting.

Parameter Details

MongoDB tool:

CoPilot Parameter Name	Description
Database	Select the MongoDB database.
Collection	Select the MongoDB collection (enabled after selecting a database).
Document	Enter an optional document filter in JSON format (enabled after selecting a collection).
Dump	Dump the selected database or collection.

Modify or Delete MongoDB Data

Warning: Update Document, Delete Document, Delete Collection, and Drop Database make irreversible changes to Controller or CoPilot data. Use these only when directed by Aviatrix Support.

To update or delete MongoDB data:

Go to Settings > Support > Debugging Tools and select MongoDB.
Select Database and Collection (and, for a document-level action, enter a Document JSON query).
Click the split button’s More Options arrow and select Update Document, Delete Document, Delete Collection, or Drop Database.
Confirm the action.

The selected data is updated or deleted.

Use etcd Debugging Tool

To use the etcd tool:

Go to Settings > Support > Debugging Tools and select etcd.
Enter Prefix and click Download to download etcd data matching the prefix.

etcd data is downloaded for the specified prefix.

Use mTLS Debugging Tool

To use the mTLS tool:

Go to Settings > Support > Debugging Tools and select mTLS.
In the Gateway table, select the checkbox for the Controller and/or the gateways you want to re-attest. Use Filter or Search to narrow the list.
Click Re-Attest.

The mTLS certificate is re-attested for the selected Controller or gateways.

⌘I

Concepts & Architecture

Guides

Reference

Purpose

Elements

Actions

Purpose

Elements

Actions

Parameter Details

​Purpose

​Elements

​Actions

​Purpose

​Elements

​Actions

​Parameter Details

Purpose

Elements

Actions

Purpose

Elements

Actions

Parameter Details