Agent Installation via CSV

Prev Next

This guide provides a step-by-step walkthrough for installing the Lucidity agent across multiple virtual machines (VMs) using a CSV-based bulk upload process. This feature is ideal for enterprises that manage large VM fleets across Azure, AWS or GCP environments and want a scalable way to install agents.

Pre-requisites

Before you begin the agent installation process, ensure the following requirements are met:

  1. Your AWS, Azure or GCP cloud account must be linked to your Lucidity workspace. Navigate to the Accounts section via the Dashboard sidebar to complete this step.

  2. You will need to populate a CSV template with essential VM details. The following fields are mandatory:

    Field

    Description

    Instance ID/Name

    Unique identifier or name of the virtual machine

    Subscription/Project/Account ID

    Cloud identifier under which the VM is registered (depending on provider)

    Region (for AWS only)

    AWS region where the VM is located (required only for AWS)

Bulk Agent Installation via CSV Process

1. Open the Agent Installation Page

  • Go to the Dashboard and click on Install Agent from the left-hand navigation panel.

  • Click on the Install Agent via CSV button to begin.

2. Choose Cloud Provider & Download Template

  • Select your cloud provider (Azure or AWS or GCP).

  • Click Download Template to receive a pre-formatted CSV file based on your selected provider.

The downloaded template ensures proper formatting and required fields.

3. Fill in VM Details

  • Open the downloaded CSV file.

  • Enter the Instance ID/Name, Subscription ID / Project ID / Account ID and Region (required only for AWS) for each VM you wish to install the agent on.

  • Save the file once completed.

⚠️ Do not modify or delete column headers in the template.

⚠️ Make sure all required fields are filled accurately to avoid errors during upload.

Note

The CSV must not exceed 50 records. Only .csv format is supported.

4. Upload the CSV File

  • Use the upload interface to submit your CSV file (you can drag and drop or use the file selector).

  • The system will validate and categorize your entries into:

    • Running Instances – VMs eligible for installation

    • Stopped Instances – VMs currently offline

    • Invalid Entries – VMs with missing or incorrect data

    You may go back and re-upload the CSV file if necessary.

5. Review & Select Instances

  • In the Running Instances tab, review the list of eligible VMs.

  • Use the checkboxes to select which instances you wish to install the agent on.

    • All instances are selected by default.

6. Schedule Installation

  • Click Schedule Installation.

  • A confirmation modal will appear. Once confirmed, the installation job is created.

Monitoring Installation Progress

Once you schedule the agent installation, Lucidity will begin processing the job in the background. You can monitor the entire installation lifecycle directly from the dashboard.

  • You can redirect to the Jobs page.

  • Installations initiated via CSV will be marked with a CSV badge.

  • Locate the installation job you just created.

Installation progress is updated in real-time. You may refresh the page to view the latest status.

Each job will display the following status indicators:

  • In Progress – Lucidity is currently installing agents on the selected instances.

  • Agent Installed – The installation has been successfully completed on all applicable instances.

  • Failure – One or more instances encountered errors during installation.

Lucidity’s bulk agent installation via CSV is designed to streamline large-scale operations and eliminate tedious manual steps. After agent installation, remember to check the Scaler > Unmanaged VMs section to continue with disk onboarding.