Resources

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

System Health
Disk Utilization
Index Management
Task Server

Purpose

The System Health page monitors system health metrics for Controller and CoPilot (system health) or Controller only (network health), views overall health status, services status, alerts, and creates alert configurations.

Elements

Monitor: Dropdown to select the monitored system (Controller or CoPilot, each listed with its IP address).
Time Period: Dropdown to select the time period (Live View, Last Hour, etc.). Selecting a custom range enables Start and End.
Start / End: Text fields for the custom time period’s start and end date and time (enabled only when Time Period is set to a custom range).
Apply button: Applies the selected time period filters.
Overall Health: Card showing the overall health status (Up, Degraded, or Down) and how long ago it was last checked; for Controller, also shows an uptime percentage.
Services: Heading with a View All Services button that opens a dialog listing every underlying service for the selected monitor.
Open Alerts / Alert Configurations: Counts of currently open alerts and configured alert rules; each count is a link to the alerts page.
System Health / Network Health: Sub-tabs under the health cards. Network Health only appears when Monitor is set to Controller (CoPilot has no network health view).
Metrics: Multiselect dropdown for selecting which metric charts to show. Options differ by sub-tab: System Health offers CPU Used (%), Disk Free (%), and Memory Used (%); Network Health offers Received Rate (PPS), Transmitted Rate (PPS), and Total Rate.
Create Alert button: Appears on each metric’s chart; opens a dialog to create an alert configuration for that specific metric.

Actions

View System Health

To view system health:

Go to Settings > Resources > System Health.
Select Monitor (Controller or CoPilot), set Time Period or Start/End, and click Apply. Review Overall Health, Services, Open Alerts, and Alert Configurations.
Under the System Health sub-tab, use Metrics to choose which charts to display, and review each metric’s chart.

The system health view shows health metrics for the selected monitor.

Parameter Details

CoPilot Parameter Name	Description
Monitor	Select the monitor to view health metrics for (Controller or CoPilot).
Time Period	Select the time period for viewing health metrics (Live View, Last Hour, Last 24 Hours, etc.).
Start	Specify the start date and time for the custom time period.
End	Specify the end date and time for the custom time period.
Overall Health	Displays the overall health status of the selected monitor (Up, Degraded, or Down).
Services	Provides a button to view the status of all underlying services.
Open Alerts	Displays the count of currently open alerts.
Alert Configurations	Displays the count of configured alert configurations.
Metrics	Select one or more metrics to display as charts.

View Network Health

To view network health (Controller only):

Go to Settings > Resources > System Health and set Monitor to Controller.
Click the Network Health sub-tab (only available for Controller).
Set Time Period or Start/End and click Apply. Use Metrics to choose which charts to display (Received Rate (PPS), Transmitted Rate (PPS), Total Rate).

The network health view shows network throughput metrics for the Controller.

View All Services

To view the status of all underlying services for a monitor:

Go to Settings > Resources > System Health.
Next to Services, click View All Services.
The dialog lists each service by name with its status (Up or Down), the total service count, and when the list was last refreshed. Click Close to dismiss the dialog.

Create a Metric Alert

To create an alert for a specific health metric:

Go to Settings > Resources > System Health.
On the chart for the metric you want to alert on (for example, CPU Used (%)), click Create Alert.
In the Create Alert Configuration dialog, enter a Name, choose Condition (Matches All or Matches Any), set the condition’s threshold, and set the Evaluation Period (in minutes). Under Send Alerts To, select the Recipients. Click Save.

Note: Minimum Count of Matching Entities is shown but disabled for Controller and CoPilot health alerts — Controller and CoPilot alerts do not support modifying this field.

A new alert configuration is created for the selected metric.

Parameter Details

CoPilot Parameter Name	Description
Name	Specify a name for the alert configuration.
Condition	Choose whether the alert triggers when all or any of the configured conditions are matched.
Condition threshold	Set the metric threshold (percentage) that triggers the alert.
Evaluation Period	Set how many minutes of data, in minutes, the condition is evaluated over.
Minimum Count of Matching Entities	Not editable for Controller or CoPilot alerts.
Send Alerts To / Recipients	Select who receives the alert notification.

Purpose

The Disk Utilization page displays disk usage information, estimated disk runway, and allows you to configure data retention policies for various data types.

Elements

Disk Usage & Projections: Legend showing which data categories currently account for the most disk usage.
Estimated Disk Runway: Heading shows the average daily growth rate (for example, “approx 5.42 GB/day”); the large number below it is the estimated number of days until disk capacity is reached. Includes the Attach Additional Disk button.
Disks table: Table displaying disk information with columns for Disks, Size, Used, Available, % Used, and Mount Point.
Data Retention Policy: Section for configuring data retention policies for individual Elasticsearch indices used by CoPilot.
Critical Capacity Management: Slider with 10%/20%/30%/40%/50% presets (plus an editable percentage field) for setting the critical capacity threshold.
Sort By: Dropdown to sort the data retention policy cards (for example, by Used Space).
Data type cards: One card per index or data category, each showing Used Space, Records, and Avg. Storage/Day. Most cards for user-facing data types (for example, Performance, CoPilot Performance, Security Audit, FlowIQ, System Messages) also include a retention control — either an Unlimited / 6 Months / 1 Year / custom Days slider, or (for Topology Replay) a record-count slider. Internal/diagnostic indices (for example, Filesystem Statistics, Index Statistics, and various netflow_* indices) show usage statistics only, with no retention control.

Actions

View Disk Utilization

To view disk utilization:

Go to Settings > Resources > Disk Utilization.
The page appears with Disk Usage & Projections, Estimated Disk Runway, the Disks table, Data Retention Policy, Critical Capacity Management, and per-data-type cards.
Optionally, use Attach Additional Disk, adjust retention policies, or Sort By to manage disk and retention.

The Disk Utilization page shows disk usage and retention configuration.

Parameter Details

CoPilot Parameter Name	Description
Disks	Shows the disk device name.
Size	Shows the total size of the disk.
Used	Shows the amount of disk space used.
Available	Shows the amount of disk space available.
% Used	Shows the percentage of disk space used.
Mount Point	Shows the mount point where the disk is mounted.
Estimated Disk Runway	Displays the average daily growth rate and the estimated number of days until disk capacity is reached based on the current usage rate.
Critical Capacity Management	Set the critical capacity threshold percentage (default: 10%).
Data Retention Policy	Configure retention for individual Elasticsearch indices used by CoPilot.
Retention Period	For most retained data types, select Unlimited, 6 Months, or 1 Year, or set a custom number of days. For Topology Replay, set a maximum number of records instead.
Used Space	Shows the amount of disk space used by the data type.
Records	Shows the number of records stored.
Avg. Storage/Day	Shows the average storage used per day.

Attach Additional Disk

To attach an additional disk:

Go to Settings > Resources > Disk Utilization.
Click Attach Additional Disk.
Select from the volumes already attached to the CoPilot instance and click Attach Disks.

Note: If no unattached volumes are available, the dialog shows “No available volumes were found. Attach a volume to CoPilot instance and try again.” Attach a volume to the CoPilot instance at the cloud provider first, then retry.

The selected volume is mounted and added to the Disks table.

Purpose

The Index Management page gives you control over Elasticsearch indices used by CoPilot. You can view index status, document count, and size; delete, filter, search, and download indices; and customize displayed columns.

Elements

Delete Indices: Button to delete the selected indices (disabled until at least one index is selected; consult Aviatrix support before deleting).
Show filters button: Button to show filter conditions for the indices list.
Select columns button: Button to select which columns to display.
Export button: Button to download the indices list.
Search box: Search indices by keywords.
Indices table: Lists CoPilot indices with a selection checkbox and columns for Index Name, Status, Doc Count, and Size.
Total indices count / Refresh: Footer showing the total number of indices, when the list was last refreshed, and a refresh button.

Actions

View and Manage Indices

To view and manage indices:

Go to Settings > Resources > Index Management.
The page appears with the indices table (Index Name, Status, Doc Count, Size). Use Search, Show filters, or Select columns to narrow or customize the list.
Optionally, select indices and use Delete Indices or Export (consult Aviatrix support before deleting).

The Index Management page shows Elasticsearch indices and supports filter, search, and export.

Parameter Details

CoPilot Parameter Name	Description
Index Name	Shows the name of the index.
Status	Shows the status of the index.
Doc Count	Shows the number of documents in the index.
Size	Shows the size of the index.

Overview
History

Purpose

The Overview tab displays current statistics for the Task Server’s scheduled tasks: runtime, failures, and last run.

Elements

Tasks table: Table displaying current task statistics: Name, Total Runtime, Avg. Runtime, Failures, Last Run, Last Duration, Frequency, and a per-row action button that edits the task’s frequency.
Show filters button: Button to show filters for the task table.
Select columns button: Button to select columns for the task table.
Export button: Button to export task data.
Search: Search box for filtering task table content.
Total tasks count / Refresh: Footer showing the total number of tasks, when the list was last refreshed, and a refresh button.

Actions

View Task Overview

To view task overview:

Go to Settings > Resources > Task Server.
Select the Overview tab.
The Tasks table appears with Name, Total Runtime, Avg. Runtime, Failures, Last Run, Last Duration, Frequency.
Optionally, use Show filters, Select columns, Export, or Search.

The task overview shows current task statistics and execution summary.

Parameter Details

CoPilot Parameter Name	Description
Name	Shows the name of the task.
Total Runtime	Shows the total runtime accumulated for the task.
Avg. Runtime	Shows the average runtime for task executions.
Failures	Shows the number of task execution failures.
Last Run	Shows the timestamp of the last task execution.
Last Duration	Shows the duration of the last task execution.
Frequency	Shows how often the task runs (e.g., 1m, 1h, 15m).

Edit a Task's Frequency

To edit how often a scheduled task runs:

Go to Settings > Resources > Task Server.
Select the Overview tab.
In the task’s row, click the actions button to open the Edit <Task Name> dialog.
Set Task Frequency (a number and a unit, such as minute, hour, or day). For units less frequent than minutes, also set At (the time of day).
Click Save.

Warning: Modifying a task’s frequency restarts the Task Server.

The task runs on the new schedule.

Purpose

The History tab displays historical execution details for the Task Server’s scheduled tasks: duration, start and end time, and status.

Elements

Tasks History table: Table displaying historical execution: Name, Duration, Start Time, End Time, Skipped, First Run, Status, Message.
Show filters button: Button to show filters for the task table.
Select columns button: Button to select columns for the task table.
Export button: Button to export task data.
Search: Search box for filtering task table content.
Oldest Record: Text displaying the oldest record timestamp.
Total tasks count / Refresh: Footer showing the total number of tasks, when the list was last refreshed, and a refresh button.

Actions

View Task History

To view task history:

Go to Settings > Resources > Task Server.
Select the History tab.
The Tasks History table appears with Name, Duration, Start Time, End Time, Skipped, First Run, Status, Message.
Optionally, use Show filters, Select columns, Export, or Search.

The task history shows past task executions and their status.

Parameter Details

CoPilot Parameter Name	Description
Name	Shows the name of the scheduled task.
Duration	Shows the duration of the task execution.
Start Time	Shows the start time of the task execution.
End Time	Shows the end time of the task execution.
Skipped	Shows if the task was skipped.
First Run	Shows if the task was run for the first time.
Status	Shows the status of the task execution.
Message	Shows the message of the task execution.

Concepts & Architecture

Guides

Reference

Purpose

Elements

Actions

Parameter Details

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

​Purpose

​Elements

​Actions

​Parameter Details

​Parameter Details

​Purpose

​Elements

​Actions

​Parameter Details

​Purpose

​Elements

​Actions

​Parameter Details

​Purpose

​Elements

​Actions

​Parameter Details

​Purpose

​Elements

​Actions

​Parameter Details

Purpose

Elements

Actions

Parameter Details

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details