Configuration

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

General
License
Logging Services
Private Mode
Certificate Store

Purpose

The General tab displays and changes general CoPilot system settings, including security, feature, and advanced settings.

Elements

Associated Aviatrix Controller: Section for managing controller association with fields for Public IP/FQDN, Controller IP, and Service Account.
Reset Association button: Resets the controller association.
Reset button: Resets the service account.
Support for IPv6: Toggle switch to enable or disable IPv6 support.
Controller Session Timeout: Numeric input for session timeout in minutes.
Sharing Metrics with Aviatrix: Section with toggles for Health Metrics and Usage Analytics.
Security: CoPilot Security Group Management, Controller Security Group Management, Certificate Domain, Controller IP Access, CoPilot IP Access List Management, CoPilot Certificate, Controller Certificate.
Features: CoPilot UI Experiences (CostIQ, Billing Insights), Network Insights API, Topology (Legacy).
Advanced: Tunnel Down Detection Time, Tunnel TCP MSS, Tunnel Anti-Replay Window, Gateway to Controller Communication (Keep-Alive Speed), DNS Servers for CoPilot, DNS Server for Controller, FIPS 140-2.

Actions

Enable IPv6 on CoPilot

To enable Support for IPv6 on the CoPilot:

Go to Settings > Configuration > General.
Locate Support for IPv6. Turn On the Support for IPv6 toggle.
Click Save.

A notification appears to confirm that IPv6 is enabled.

Parameter Details

CoPilot Parameter Name	Description
Public IP/FQDN	Enter the public IP address or fully qualified domain name of the associated Aviatrix Controller.
Controller IP	Displays the IP address of the associated controller (read-only).
Service Account	Displays the service account name used for controller association (read-only).
Support for IPv6	Enable or disable IPv6 support for the CoPilot instance.
Session timeout (Minute)	Set the controller session timeout duration in minutes.
Health Metrics	Enable or disable sharing system health data (Controllers and Gateways) with Aviatrix.
Usage Analytics	Enable or disable sharing UI usage data with Aviatrix.

Configure Security Settings

To configure security settings:

Go to Settings > Configuration > General.
Adjust CoPilot Security Group Management, Controller Security Group Management, Certificate Domain, Controller IP Access, CoPilot IP Access List Management, or certificate sections as needed. Click Save where applicable.

Changes take effect per the selected options.

Parameter Details

CoPilot Parameter Name	Description
CoPilot Security Group Management	Enable or disable CoPilot security group management.
Controller Security Group Management	Enable or disable controller security group management.
Account	Select the cloud account for controller security group management.
Certificate Domain	Enter the certificate domain name.
Controller IP Access	Enable or disable controller IP access restrictions.
CoPilot IP Access List Management	Enable or disable CoPilot IP access list management.

Configure Feature Settings

To configure feature settings:

Go to Settings > Configuration > General.
Toggle CostIQ, Billing Insights, Network Insights API, or Topology (Legacy) as needed. Click Save.

The selected features are enabled or disabled for the CoPilot instance.

Parameter Details

CoPilot Parameter Name	Description
CostIQ	Enable or disable CostIQ UI experience.
Billing Insights	Enable or disable Billing Insights UI experience.
Network Insights API	Enable or disable Network Insights API access.
Topology (Legacy)	Enable or disable the legacy topology view.

Configure Advanced Settings

To configure advanced settings:

Go to Settings > Configuration > General.
Set Tunnel Down Detection Time, Tunnel TCP MSS, Tunnel Anti-Replay Window, Keep-Alive Speed, DNS options, or FIPS 140-2 as needed. Click Save.

Advanced settings are applied per the configuration.

Parameter Details

CoPilot Parameter Name	Description
Gateway	Select the gateway for tunnel configuration (Controller or specific gateway).
Detection Time	Set the tunnel down detection time in seconds (minimum: 20 seconds).
Maximum Segment Size (MSS)	Set the tunnel TCP maximum segment size in bytes (recommendation: < 1370 bytes).
Window	Set the tunnel anti-replay window in packets (range: 0-4096 packets).
Keep-Alive Speed	Select the keep-alive speed for gateway to controller communication.
DNS Servers for CoPilot	Select DNS server option for CoPilot (Cloud VPC/VNet DNS Server or Custom DNS Servers).
DNS Server for Controller	Select DNS server option for Controller (Aviatrix Default DNS Server or Cloud VPC/VNet DNS Server).
Federal Information Processing Standard (FIPS) 140-2	Enable or disable FIPS 140-2 compliance mode.

Support for IPv6 (Controller version 8.2) applies to: VPC/VNet and gateway creation/edit pages (AWS, Azure, AEP, Equinix Spoke), Network Segmentation, External connection to External Device, BGP over IPSec/LAN, FireNet pages, Diagnostics, Monitor, and Topology.

Purpose

The License page displays license information, including license type, license details, customer ID, and feature preview status.

Elements

License Type: Section displaying the license type (e.g., Universal).
License Details table: Table showing License ID, Controller ID, Issue Date, Allocated, and Total.
Customer ID: Text field displaying the masked customer ID with Reset button.
Feature Previews: Section with table showing Feature and Status columns, with Refresh button.

Actions

View License Information

To view license information:

Go to Settings > Configuration > License.
The page appears with License Type, License Details table, Customer ID, and Feature Previews. Optionally, click Refresh for Feature Previews.

The license and feature preview status are displayed.

Parameter Details

CoPilot Parameter Name	Description
License ID	Shows the unique identifier for the license.
Controller ID	Shows the unique identifier for the controller associated with the license.
Issue Date	Shows the date when the license was issued.
Allocated	Shows the number of licenses allocated.
Total	Shows the total number of licenses available.
Customer ID	Displays the masked customer ID associated with the license.
Feature	Shows the name of the feature preview.
Status	Shows the status of the feature preview (e.g., Preview, Early Access).

Purpose

The Logging Services page allows you to configure and manage various logging services including Remote Syslog, Datadog Agent, CloudWatch Agent, and NetFlow Agent.

Elements

Remote Syslog: Section for configuring remote syslog with Profile dropdown, server details, and Edit Profile button.
Datadog Agent: Section for configuring Datadog agent with Enable button.
CloudWatch Agent: Section for configuring CloudWatch agent with Enable button.
NetFlow Agent: Section for configuring NetFlow agent with configuration details and Edit Configuration button.

Actions

Configure Logging Services

To configure logging services:

Go to Settings > Configuration > Logging Services.
Configure Remote Syslog (Profile, Edit Profile), Datadog Agent, CloudWatch Agent, or NetFlow Agent as needed. Save or enable each section.

Logging services are configured per the selected options.

Parameter Details

CoPilot Parameter Name	Description
Profile	Select the syslog profile for remote syslog configuration.
Server	Displays the syslog server address.
Protocol / Port	Displays the protocol and port used for syslog (e.g., UDP / 5000).
TLS	Displays whether TLS is enabled or disabled for syslog.
Certificate	Displays the certificate status for syslog.
Gateways Included	Shows the number of gateways included in the syslog profile.
NetFlow Server	Displays the NetFlow server address.
NetFlow Version	Displays the NetFlow version (e.g., 9).
Mode	Displays the NetFlow mode (e.g., IPT).
Protocol / Port	Displays the protocol and port used for NetFlow (e.g., UDP / 31283).
TLS	Displays whether TLS is enabled or disabled for NetFlow.
Sampling Rate	Displays the NetFlow sampling rate percentage.

Purpose

The Private Mode page allows you to enable private data plane capability and configure proxy server settings for private mode operation.

Elements

Private Mode: Toggle switch to enable or disable private mode.
HTTP Proxy: Text field for entering HTTP proxy server address.
HTTPS Proxy: Text field for entering HTTPS proxy server address.
Proxy CA Certificate: File upload field for proxy CA certificate with Upload button.

Actions

Configure Private Mode

To configure private mode:

Go to Settings > Configuration > Private Mode.
Turn On Private Mode if needed. Enter HTTP Proxy and HTTPS Proxy. Optionally, upload Proxy CA Certificate. Click Save.

Private mode and proxy settings are applied.

Parameter Details

CoPilot Parameter Name	Description
Private Mode	Enable or disable private data plane capability that doesn’t require any Public IP association.
HTTP Proxy	Enter the HTTP proxy server address for private mode communication.
HTTPS Proxy	Enter the HTTPS proxy server address for private mode communication.
Proxy CA Certificate	Upload the CA certificate for the proxy server to enable secure communication.

Purpose

The Certificate Store page displays and manages certificates used by CoPilot, including certificate details such as name, subject, expiration, key type, and associated services. You can view certificates and add new ones.

Elements

Certificate button: Button to add a new certificate.
Show filters button: Button to show filters for the certificate table.
Select columns button: Button to select columns for the certificate table.
Export button: Export button to download certificate data.
Search: Search box for filtering certificate table content.
Certificates table: Table displaying certificate information with columns for Name, Subject, Expires, Key Type, Key Specification, and Services.

Actions

View Certificates

To view certificates:

Go to Settings > Configuration > Certificate Store.
The page appears with the certificates table (Name, Subject, Expires, Key Type, Key Specification, Services) and Certificate, Show filters, Select columns, Export, Search.
Optionally, use Search, Show filters, or Select columns to narrow the list.

The Certificate Store table shows all certificates and their details.

Parameter Details

Certificates table:

CoPilot Parameter Name	Description
Name	Shows the name of the certificate.
Subject	Shows the certificate subject (distinguished name).
Expires	Shows the certificate expiration date and time remaining.
Key Type	Shows the certificate key type (e.g., EC, RSA).
Key Specification	Shows the key specification details (e.g., prime256v1, 2048 bit).
Services	Shows the services associated with the certificate (e.g., Internal, Uservpn).

Create Certificate

To create a certificate:

Go to Settings > Configuration > Certificate Store.
Click Certificate.
In the dialog, enter Name, upload Certificate File and Private Key File (if required), select Key Type and Services. Click Save.

The new certificate is added to the Certificate Store.

Parameter Details

Create Certificate dialog:

CoPilot Parameter Name	Description
Name	Enter a name for the certificate.
Certificate File	Upload the certificate file.
Private Key File	Upload the private key file (if required).
Key Type	Select the certificate key type (EC or RSA).
Services	Select the services that will use this certificate.

Concepts & Architecture

Guides

Reference

Purpose

Elements

Actions

Parameter Details

Parameter Details

Parameter Details

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Parameter Details

Concepts & Architecture

Guides

Reference

​Purpose

​Elements

​Actions

​Parameter Details

​Parameter Details

​Parameter Details

​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

Parameter Details

Parameter Details

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Parameter Details