How to install the Auvik collector from a bash script

Important: These instructions are intended for advanced users.

If you prefer a simpler deployment method, install the Auvik Collector using the VMware OVA appliance.

The Linux installer can be used to deploy the Auvik Collector on a dedicated Ubuntu Server virtual machine, physical Linux host, cloud instance, or supported Raspberry Pi device.

For Raspberry Pi deployments, if the device is already running a supported 64-bit Ubuntu Server operating system or Raspberry Pi OS, you can proceed directly to the installation section.

Before You Begin

The Linux installer is intended for dedicated collector deployments only.

Do not install the collector on an existing production server, workstation, desktop operating system, or any system running other applications.

The collector installation converts the host into a dedicated collector platform and should only be deployed on a system reserved for Auvik.

Before starting:

• Create or access the Auvik site where the collector will be installed.
• Ensure you have a valid Auvik user account with access to the target site.
• Generate an API key for that user account.
• Confirm outbound Internet access and DNS resolution are working.
• Verify that the collector host can communicate with the monitored network.

Supported Deployment Platforms

The Auvik Collector can be deployed on:

Note: Desktop virtualization products such as VMware Workstation, VMware Fusion, and Oracle VirtualBox may be used to host the Ubuntu virtual machine for testing purposes but are not recommended or supported for production deployments.

The Auvik Collector must be installed on a supported Ubuntu Server operating system or supported Raspberry Pi deployment. Direct installation on macOS is not supported.

System Requirements

Minimum recommended resources:

• 4 vCPUs
• 8 GB RAM
• Up to 32 GB storage

Storage usage is dynamic and may not consume the full allocation.

For larger environments, follow current Auvik sizing recommendations.

Step 1: Download Ubuntu Server

The Auvik Collector installer is designed for Ubuntu Server.

Download the latest Ubuntu 24.04 LTS Server image from:

https://releases.ubuntu.com/24.04/

Use the most recent Ubuntu Server installation image available.

Step 2: Create the Ubuntu Virtual Machine

Create a new Ubuntu Server virtual machine using your preferred supported virtualization platform.

Allocate the recommended CPU, memory, and storage resources.

If deploying in AWS, Azure, or another cloud provider, create a new Ubuntu Server instance using Ubuntu 24.04 LTS.

Once the virtual machine or cloud instance is created, continue with the operating system installation.

Step 3: Install and Configure Ubuntu

Install Ubuntu Server normally.

During installation:

• Configure networking.
• Configure DNS.
• Create an administrative user account.

IP Address Configuration

The collector should ultimately use either:

• A DHCP reservation, or
• A static IP address

If DHCP is used initially, a reservation can be created after installation.

If you need to identify the assigned IP address after installation:

ip addr

Install OpenSSH

OpenSSH Server must be installed.

This can be selected during installation or installed afterwards:

sudo apt update
sudo apt install openssh-server openssh-client

Verify Connectivity

Before proceeding, confirm the server can:

• Resolve DNS names
• Reach the Internet
• Access Auvik cloud services over HTTPS

Step 4: Gather Required Information

You will need:

Auvik User Email Address

The user account must have access to the site where the collector will be installed.

API Key

Generate an API key from your Auvik user profile.

Site Domain Prefix

For example:

sample.my.auvik.com

The domain prefix is:

sample

Step 5: Connect to Ubuntu

Connect to the Ubuntu server using SSH.

Example:

ssh username@ipaddress

Accept the SSH key when prompted and log in using your Ubuntu credentials.

Optional: Configure Proxy Access

If your environment uses a proxy server, configure proxy settings before running the installer.

Create the Proxy Configuration File

Create a file:

sudo nano /etc/apt/apt.conf.d/proxy.conf

Add:

Acquire::http::Proxy "http://user:pass@1.2.3.4:12345";
Acquire::https::Proxy "https://user:pass@1.2.3.4:12345";

Replace:

• user:pass
• 1.2.3.4
• 12345

with your proxy information.

Configure Environment Variables

Run:

export HTTP_PROXY=http://user:pass@1.2.3.4:12345
export HTTPS_PROXY=http://user:pass@1.2.3.4:12345

Note: Do not include spaces around the equals sign.

Step 6: Run the Collector Installer

Run the following command:

sudo bash -c "rm -rf ./auvik_installer install.sh && umask 0022 && curl --verbose --location-trusted --header \"Accept: text/plain\" --user EMAIL https://DOMAINPREFIX.my.auvik.com/agents/installer > install.sh && grep -wq __ARCHIVE_BELOW__ install.sh && chmod 0755 install.sh && bash -x ./install.sh 2>&1 | tee /tmp/install.log"

Replace:

• EMAIL with your Auvik user email address
• DOMAINPREFIX with your site's domain prefix

When prompted:

1. Enter the Ubuntu user password.
2. Enter the Auvik API key when prompted for the Auvik account password.

The installation process typically takes approximately 10 minutes.

Step 7: Reboot the Collector

After the installation completes:

sudo reboot

Allow the server to restart.

Step 8: Verify Collector Registration

After rebooting:

1. Log in to Auvik.
2. Navigate to Auvik Collectors.
3. Verify the collector appears in the collector list.
4. Approve the collector if required.
5. Confirm the collector status changes to Connected.

Once connected, network discovery begins automatically.

Step 9: Configure a Static IP Address

The collector should maintain a consistent IP address.

Choose one of the following options:

DHCP Reservation

Create a DHCP reservation for the collector's MAC address.

Static IP Address

Assign a static IP address outside the DHCP scope.

The collector console can be used to configure a static address:

1. Open the collector console.
2. Select Option 1.
3. Configure the desired network settings.

Optional: Configure Proxy Settings in the Collector

If proxy settings were configured during installation:

1. Open the collector console.
2. Select Option 8.
3. Enter:
   • Proxy address
   • Proxy port
   • Authentication type
   • Username
   • Password

The collector automatically reboots after the settings are saved.

Troubleshooting

Collector Does Not Appear in Auvik

Verify:

• The correct domain prefix was used.
• The API key belongs to a user with access to the target site.
• DNS resolution is functioning correctly.
• Outbound HTTPS access is available.

Collector Appears but Does Not Connect

Verify:

• Internet access is available.
• Firewall rules allow outbound HTTPS traffic.
• Proxy settings are correct.
• The collector can resolve external DNS records.

Installation Fails

Review the installation log:

cat /tmp/install.log

for installation errors.

Proxy Environments

Verify:

• Proxy credentials are correct.
• The proxy server permits outbound HTTPS traffic.
• HTTP_PROXY and HTTPS_PROXY variables are configured correctly.
• Proxy settings entered in the collector console match the environment.

DNS Resolution Failures

DNS resolution issues are one of the most common causes of collector connectivity problems.

Verify:

• DNS servers are configured correctly.
• The server can resolve public hostnames.
• Firewalls are not blocking DNS traffic.

If installation or connectivity issues persist, contact Auvik Support and provide the installation log for further investigation.