Maintenance

This section provides the purpose, elements, and actions performed on the Administration > Maintenance pages.

Major Upgrade Paths

Use these paths when planning multi-version upgrades:

If your Controller is 6.9 or earlier, you must first upgrade to 7.0.
If your Controller is 7.0, upgrade to 7.1.
If your Controller is 7.1, upgrade to 7.2.
For 7.2 and later, see Upgrade your Controller to the Latest Aviatrix Supported Images (AWS and Azure Only).

Overview
Controller Upgrade
Gateway Upgrade
Back Up & Migrate

Purpose

The Overview page summarizes gateway health and the recommended upgrade path for your Controller and gateways. Use it to see which gateways are down or on a different software version than the Controller, and to follow the guided upgrade timeline before you start Controller or gateway upgrades.

Elements

Guided Upgrade alert: Reminds you to upgrade incrementally when several versions behind, to upgrade gateways only after the Controller reaches the target version, and to review Release Notes before upgrading.
Gateway State and Health: Section showing health and version status by gateway role.
Transit Gateway card: Status badge and message when one or more Transit Gateways run a different version than the Controller.
Spoke Gateway card: Status badge and message when Spoke Gateways are down or not on the Controller version.
Specialty Gateway card: Status badge and message when Specialty Gateways are down or not on the Controller version.
External Connections card: Status badge for Site-to-Cloud external connection health.
View Down Gateways and External Connections: Button that opens a dialog listing down gateways and external connections.
Upgrade Path: Timeline of the recommended upgrade sequence.
Current Version: Controller version at the start of the timeline (or Current Controller Version and Current Gateway Versions when gateways run a mixed version).
Upgrade Controller to <version> (<upgrade type>): Controller upgrade step on the timeline, showing the source and target version and the upgrade type (Software or Image). Appears once per required Controller upgrade.
Go to Controller Upgrade: Button on the active Controller upgrade step when the Controller is the next recommended action.
Upgrade All Gateways to <version> (<upgrade type>) or Upgrade Selective Gateways to <version> (<upgrade type>): Gateway upgrade step on the timeline, showing the source and target version(s) and upgrade type. Uses Selective Gateways when only some gateways need upgrading.
Go to Gateway Upgrade: Button on the active gateway upgrade step when gateway upgrades are the next recommended action.
Target Version: Marker on the timeline for the target version at the end of the current path segment (when shown).
<N> intermediate version(s): Italic timeline entry when additional Controller upgrade steps remain after the visible segment.
Latest Version: Latest available Controller version in the upgrade catalog.

When the Controller and gateways are already on the latest version, the Upgrade Path pane instead shows a message that you are already on the latest version.

Actions

View Down Gateways and External Connections

To view gateways and external connections that are down:

Go to Administration > Maintenance > Overview.
In Gateway State and Health, click View Down Gateways and External Connections.

The Down Gateways and External Connections dialog lists each entity with Name and Type columns. Use the reload control in the table footer to refresh the list.

Parameter Details

CoPilot Parameter Name	Description
Name	Name of the down gateway or external connection. Gateway names link to the gateway details page when available.
Type	Gateway role (for example, Transit Gateway or Spoke Gateway) or External Connection (S2C).

Go to Controller Upgrade from Overview

When the upgrade path shows a pending Controller upgrade:

Go to Administration > Maintenance > Overview.
In Upgrade Path, on the Upgrade Controller step, click Go to Controller Upgrade.

CoPilot opens the Controller Upgrade tab so you can run a Readiness Check and start the upgrade.

Go to Gateway Upgrade from Overview

When the upgrade path shows gateway upgrades as the next step:

Go to Administration > Maintenance > Overview.
In Upgrade Path, on the Upgrade All Gateways step, click Go to Gateway Upgrade.

CoPilot opens the Gateway Upgrade tab so you can manage upgrade groups and prepare gateways for upgrade.

Purpose

The Controller Upgrade page runs a Readiness Check against a target version before you upgrade the Controller, and lets you start the upgrade once blocking issues are resolved.

Elements

Target Version: Dropdown to select the version to check readiness against and upgrade to.
Settings: Opens the Readiness Check Scheduler dialog to enable recurring automatic Readiness Checks.
Run Readiness Check / Re-Run Readiness Check: Button to start a Readiness Check for the selected target version.
More Options: Menu with Force Upgrade Controller, to start the upgrade despite blocking Readiness Check results.
Last Run: Timestamp of the most recent Readiness Check.
Failed (Blocker), Failed (Non-Blocker), Could Not Run, Passed: Result counts for the most recent Readiness Check.
Issue list: For each failed or skipped check, shows severity, a description, and a Support link.

Actions

Run a Readiness Check

To run a Readiness Check:

Go to Administration > Maintenance > Controller Upgrade.
Select the Target Version.
Click Run Readiness Check (or Re-Run Readiness Check).

Readiness Checks run in the background. The result counts and issue list appear when the check completes.

Enable Auto Readiness Checks

To enable a recurring Readiness Check schedule:

Go to Administration > Maintenance > Controller Upgrade.
Click Settings.
In the Readiness Check Scheduler dialog, select the Check Frequency and click Enable Auto Readiness Checks.

Parameter Details

CoPilot Parameter Name	Description
Check Frequency	How often the automatic Readiness Check runs (for example, every 24 hours).

Purpose

The Gateway Upgrade page helps you keep gateways up to date with a rolling selective upgrade process. View the last upgrade or manage upgrade groups so you can upgrade gateways in logical groups and minimize disruption.

Elements

Last Upgrade / Upgrade Groups: Toggle between the last upgrade summary and the upgrade groups table.
Upgrade groups table: Columns are Order, Name, Gateway Type, Gateway Instance (click to view the list of instances), Software Version, Image Version, Kernel Version, Account, Cloud, Region, and Upgrade Group Status.
+ Upgrade Group: Button to create a new upgrade group.
Filter: Button to show filters for the upgrade groups table.
Columns: Button to select columns for the upgrade groups table.
Download: Button to download upgrade groups data.
Search: Search box for filtering table content.
Show Gateways in More Than One Group: Toggle to include gateways matched by more than one upgrade group.
Prepare For Upgrade: Button to prepare the selected upgrade groups for upgrade.
Review and Roll Back: Row action (when the group’s gateways support rollback) that opens the Review and Roll Back: <group name> dialog.

Before any upgrade groups exist, the page instead shows onboarding guidance and a Recommended Upgrade Groups card:

No Upgrade Groups configured yet alert: Prompt to create upgrade groups to control gateway upgrade order and grouping.
Upgrade Groups section: Explains how to create upgrade groups (by cloud, account, region, or other criteria) and how the upgrade sequencing works.
Recommended Upgrade Groups: Cards showing suggested groups, grouped by gateway role and cloud provider, each with a gateway count.
Define Groups Manually: Button that opens the Create Upgrade Groups wizard to generate groups from grouping criteria, instead of using the recommendations (distinct from + Upgrade Group, which creates one group at a time).
Accept Recommended Groups: Button to create all of the recommended groups in one step.

Actions

View Upgrade Groups

To view upgrade groups:

Go to Administration > Maintenance > Gateway Upgrade > Groups.
Optionally, use Filter, Columns, Download, or Search to inspect groups.

The upgrade groups table shows gateway upgrade status by group.

Accept Recommended Upgrade Groups

When no upgrade groups exist yet:

Go to Administration > Maintenance > Gateway Upgrade.
Review the suggested groups on the Recommended Upgrade Groups card.
Click Accept Recommended Groups.

The recommended groups are created and added to the upgrade plan. Alternatively, click Define Groups Manually to create groups from scratch.

Create Upgrade Group

To create an upgrade group:

Go to Administration > Maintenance > Gateway Upgrade > Groups.
Click + Upgrade Group.
In the dialog, enter a group Name, select matching conditions (Gateway type, cloud, region, account, gateway name, current image version, kernel version; combine with AND or OR), and set group order (e.g., Place Upgrade Group: Above, Below, Top, or Bottom). Click Save.

A notification appears and the new upgrade group is added to the upgrade plan.

Parameter Details

CoPilot Parameter Name	Description
Name	Enter a name for the upgrade group.
Matching conditions	Select criteria: Gateway type, cloud, region, account, gateway name, current image version, kernel version. Combine with AND or OR. Enable Preview to view matching gateways.
Place Upgrade Group (group order)	Select where to place the group: Above, Below, Top, or Bottom relative to existing groups; or set order number.

Prepare Upgrade Groups For Upgrade

To prepare selected upgrade groups for upgrade:

Go to Administration > Maintenance > Gateway Upgrade > Groups.
Select one or more upgrade groups in the table.
Click Prepare For Upgrade.

The selected gateways are prepared for the upgrade.

Roll Back an Upgrade Group

To roll back gateways in an upgrade group after an upgrade:

Go to Administration > Maintenance > Gateway Upgrade > Groups.
On the upgrade group row, open the row actions menu and click Review and Roll Back.
In the Review and Roll Back: <group name> dialog, select one or more eligible gateway instances, then click Roll Back.
In the confirmation dialog, click Roll Back again to start rollback.

Rollback is available only for gateway instances the Controller marks as rollback-eligible. During an active upgrade, you can also roll back an individual gateway from that gateway’s row actions menu (Roll Back).

Purpose

The Back Up & Migrate page configures external storage and automated backups for the Controller and CoPilot, restores from those backups, migrates data from an older CoPilot instance, and manages stored backups.

Elements

A warning banner appears at the top of the Back Up section until automated backup schedules for both CoPilot configuration and CoPilot data are enabled (the banner text adjusts to name only the item still missing).

Back Up

Back Up Controller: Once a backup schedule exists, shows the Frequency and Backups Retained, with a Backup Now button and a More Options button (Edit Configuration) to trigger an immediate backup or change the schedule.
Back Up CoPilot Configuration: Before it is enabled, shows an Enable button. Once enabled, shows Frequency (fixed at every 15 minutes) and a Disable button.
Back Up CoPilot Data: Before automated backup is set up, shows a Back Up Selective Data text button and an Enable button side by side. Once set up, the two actions collapse into a single Backup Now split button whose dropdown offers Back Up Selective Data and Edit Configuration.

Restore

Restore Controller: Restores the Controller configuration from a backup in external storage. Restore button opens a dialog to select the backup Location (cloud) and enter the File Name.
Restore CoPilot Configuration: Restores CoPilot configuration from the most recent configuration backup. Shows a warning if no configuration backup exists yet. The Restore button is disabled until a backup exists.
Restore CoPilot Data: Restores CoPilot data and index data from external storage. Restore button opens a dialog with a Restore from Backup dropdown listing available data backups.

Migration

Migrate to Appliance v3 (AWS Only): Shows the appliance version CoPilot is currently running on. Migrate button opens a 2-step (CoPilot App, CoPilot Data) migration wizard. A View Progress button also appears once a migration is in progress, done, or failed.
Migrate Data from Old CoPilot: Migrates configuration and index data from an old CoPilot instance to the current CoPilot. Migrate button opens a dialog for the old CoPilot’s IP, prerequisites, and the data time range to restore.

Manage Backups

Manage CoPilot Backups: Manage button opens a dialog listing CoPilot data backups stored in external storage (Created On, Backup Name, Copilot UUID, Size, and a per-row actions column).
External Storage: Shows the configured storage Account (cloud) and Name (bucket/container). Edit Configuration button (labeled Configure before storage is set up) opens the external storage dialog.

Actions

Back Up Controller and CoPilot

Back Up Controller Now or Edit Its Schedule

To trigger an immediate Controller backup:

Go to Administration > Maintenance > Back Up & Migrate.
Under Back Up, on Back Up Controller, click Backup Now.

A backup starts immediately, outside the configured schedule. To change the schedule instead, click More Options > Edit Configuration, which opens the Modify Automatic Backup Schedule for Controller dialog.

Parameter Details

CoPilot Parameter Name	Description
Repeat	Select how often the backup runs: Daily, Weekly, or Monthly.
Every	Select the day of the week (Weekly) or day of the month (Monthly) to run the backup. Not shown for Daily.
At	Set the hour and AM/PM the backup runs (specified in UTC).
Backups Retained	Enter the number of past backups to keep in external storage. Older backups are deleted automatically.

Enable or Disable Back Up CoPilot Configuration

To turn automated CoPilot configuration backup on or off:

Go to Administration > Maintenance > Back Up & Migrate.
Under Back Up, on Back Up CoPilot Configuration, click Enable (or Disable to turn it off).

Enabling immediately starts backing up the CoPilot configuration to the Controller every 15 minutes. There is no schedule to configure for this backup.

Back Up CoPilot Data

To set up automated backup for CoPilot data, or to back up data on demand:

Go to Administration > Maintenance > Back Up & Migrate.
Under Back Up, on Back Up CoPilot Data:
- If automated backup is not yet set up, click Enable to open the Enable Automated Backup Schedule for CoPilot dialog, or click Back Up Selective Data to back up a specific time range on demand.
- If automated backup is already set up, click Backup Now to trigger an immediate backup, or use the button’s dropdown to select Back Up Selective Data or Edit Configuration.

Back Up Selective Data opens a dialog to choose a Time Period (for example, Last 7 Days) or a custom Start / End range, then shows the Available Data, Estimated Size, and Estimated Time for the backup before you click Begin Backup.

Parameter Details

CoPilot Parameter Name	Description
Repeat	Select how often the backup runs: Daily, Weekly, or Monthly.
Every	Select the day of the week (Weekly) or day of the month (Monthly) to run the backup. Not shown for Daily.
At	Set the hour and AM/PM the backup runs (specified in UTC).
Backups Retained	Enter the number of past backups to keep in external storage. Older backups are deleted automatically.
Time Period	(Back Up Selective Data dialog) Select a preset range, such as Last 7 Days, or a custom range.

Restore Controller and CoPilot

Restore Controller

To restore the Controller configuration:

Go to Administration > Maintenance > Back Up & Migrate.
Under Restore, on Restore Controller, click Restore.
In the Restore Controller dialog, select the Location (cloud), enter the storage connection details and File Name, then click Save.

The Controller is restored from the backup in external storage. File Name can be obtained from the external storage configured to store backups for the old Controller instance; it typically appears as CloudN_<Controller Private IP>_save_cloudx_config.enc.

Parameter Details

CoPilot Parameter Name	Description
Location	Select the cloud where the backup is stored: AWS, GCP, Azure ARM, OCI, Azure Government, AWS GovCloud, AWS China, or ARM China.
Use Existing Account	Toggle to reuse an existing cloud account instead of entering credentials manually. Shown for AWS, GCP, and OCI.
Account	Select the existing cloud account to use. Shown when Use Existing Account is on.
Access Key / Secret Key	Enter the AWS access key and secret key. Shown for AWS when Use Existing Account is off.
Subscription ID / Directory ID	Enter the Azure subscription ID and directory (tenant) ID. Shown for Azure ARM.
Application Client ID / Application Client Secret	Enter the Azure application client credentials, or the OCI application client credentials when Use Existing Account is off.
Storage / Container	Enter the Azure storage account name and container name. Shown for Azure ARM.
Bucket	Enter the bucket name. Shown for all clouds other than Azure ARM.
Gcloud Project Credentials	Upload the GCP service account credentials JSON file. Shown for GCP when Use Existing Account is off.
Tenancy OCID / Compartment OCID	Enter the OCI tenancy OCID and compartment OCID. Shown for OCI when Use Existing Account is off.
API Private Key	Upload the OCI API private key file. Shown for OCI when Use Existing Account is off.
Region	Select the region. Shown for OCI.
File Name	Enter the backup file name, obtained from the external storage that stored backups of the old Controller.

Restore CoPilot Configuration

To restore the CoPilot configuration:

Go to Administration > Maintenance > Back Up & Migrate.
Under Restore, on Restore CoPilot Configuration, click Restore. This requires an existing configuration backup; the button stays disabled and a warning appears until one exists.

CoPilot configuration is restored from the most recent backup.

Restore CoPilot Data

To restore CoPilot data and index data from external storage:

Go to Administration > Maintenance > Back Up & Migrate.
Under Restore, on Restore CoPilot Data, click Restore.
In the Restore Data dialog, select a backup from the Restore from Backup dropdown, then click Restore.

Migrate CoPilot

Migrate to Appliance v3

To migrate CoPilot to an Appliance v3 instance (AWS only):

Go to Administration > Maintenance > Back Up & Migrate.
Under Migration, on Migrate to Appliance v3 (AWS Only), click Migrate.
In the Migrate to Appliance v3 dialog, review the region, VPC/VNet, and sizing defaults (based on the Controller’s deployment), or turn on Customize Deployment to edit the Cloud Provider, Access Account, Region, VPC/VNet, Subnet, CoPilot VM Size, and Data Disk Size. Click Next to proceed through the CoPilot App and CoPilot Data steps, then click Start Migration.

Migration currently supports only same-region migration; the new CoPilot must be deployed in the same region as the current one. After migration is complete, CoPilot reloads and the Elastic IP switches to the new instance. While a migration is in progress, done, or failed, a View Progress button also appears next to Migrate.The Migrate button is disabled for users without Admin permissions, in clouds other than AWS, or when migration from a CoPilot v1 appliance is not supported.

Migrate Data from Old CoPilot

To migrate data from an old CoPilot instance:

Go to Administration > Maintenance > Back Up & Migrate.
Under Migration, on Migrate Data from Old CoPilot, click Migrate.
In the Migrate Data from old CoPilot dialog, enter the Old CoPilot IP (the New CoPilot IP (Public IP) field is prefilled and read-only).
Review the Prerequisites accordion, then select the Time Period (or custom Start / End range) of data to restore from the old CoPilot.
Select I acknowledge that I have completed all the prerequisites, then click Begin.

Data from the old CoPilot instance is migrated to the current CoPilot.

Parameter Details

CoPilot Parameter Name	Description
Old CoPilot IP	Enter the IP address of the old CoPilot instance to migrate data from.
New CoPilot IP (Public IP)	Read-only. Shows the current CoPilot’s public IP address.
Time Period	Select a preset range, such as Last 7 Days, or a custom Start / End range, of data to migrate.

The Prerequisites accordion lists required firewall rules (port 9200 and 443 on the old CoPilot VM; port 443 on the new CoPilot VM) and requirements that both CoPilots run the same software version (v2.0 or later), point to the same Controller, and use the same Performance feature version (both v1 or both v2).

Manage Backups and External Storage

Manage CoPilot Backups

To view and manage CoPilot data backups:

Go to Administration > Maintenance > Back Up & Migrate.
Under Manage Backups, on Manage CoPilot Backups, click Manage.

The Manage CoPilot Backups dialog lists CoPilot data backups stored in external storage, with columns for Created On, Backup Name, Copilot UUID, Size, and a per-row actions column, along with a Search field and a total backup count.

Configure External Storage

To configure external storage:

Go to Administration > Maintenance > Back Up & Migrate.
Under Manage Backups, on External Storage, click Configure (or Edit Configuration if storage is already set up).
In the Configure External Storage dialog, select the Location (cloud) and an existing Account, enter the storage details for that cloud, then click Save.

Once external storage is configured, Back Up CoPilot Data, Restore CoPilot Data, and Manage CoPilot Backups become available. To remove the association, click Edit Configuration, then Remove Association.

Parameter Details

CoPilot Parameter Name	Description
Location	Select the cloud where the storage is located: AWS, GCP, Azure ARM, OCI, Azure Government, AWS GovCloud, AWS China, or ARM China.
Account	Select an existing cloud account to use for storage access. Options are filtered to accounts matching the selected Location.
Region	Select the cloud region for the storage. Shown for Azure ARM and OCI.
Storage	Select the Azure storage account. Shown for Azure ARM.
Container	Enter the container name. Shown for Azure ARM.
Bucket	Enter the bucket name. Shown for all clouds other than Azure ARM.

Concepts & Architecture

Guides

Reference

Major Upgrade Paths

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Back Up

Restore

Migration

Manage Backups

Actions

Parameter Details

Parameter Details

Parameter Details

Parameter Details

Parameter Details

​Major Upgrade Paths

​Purpose

​Elements

​Actions

​Parameter Details

​Purpose

​Elements

​Actions

​Parameter Details

​Purpose

​Elements

​Actions

​Parameter Details

​Purpose

​Elements

​Back Up

​Restore

​Migration

​Manage Backups

​Actions

​Parameter Details

​Parameter Details

​Parameter Details

​Parameter Details

​Parameter Details

Major Upgrade Paths

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Back Up

Restore

Migration

Manage Backups

Actions

Parameter Details

Parameter Details

Parameter Details

Parameter Details

Parameter Details