rConfig Vector Agent Installation: Multi-Platform Network Device Management

rConfig Vector Agent Installation: Multi-Platform Network Device Management

The rConfig Vector Agent represents a critical component of the Vector product suite, responsible for command execution, configuration collection, and data transmission to Vector Servers. This guide provides comprehensive installation procedures, prerequisite requirements, and post-installation tasks to ensure successful deployment.

Unlike passive remote proxies that connect and gather data through intermediary channels, the rConfig Vector Agent operates as an active agent deployed directly on devices to continuously monitor, collect, and transmit real-time data securely, ensuring enhanced accuracy, reliability, and comprehensive network insights. Complete the Vector Server installation first so agents can register successfully.

Prerequisites:

• rConfig Vector Server must be installed and operational
• Review Security Hardening Guidelines for agent deployment security
• Understand Vector Architecture and Capabilities before deployment

Agent Capabilities and Limitations

Capabilities

• Real-Time Data Collection: The Vector Agent continuously collects data at scheduled intervals, ensuring current network visibility and insights.
• Secure Communication: Data is encrypted both in transit and at rest, protecting sensitive information from unauthorized access.
• Comprehensive Device Monitoring: Monitor diverse device types including switches, routers, firewalls, and servers. (Note: Version 1.0.0 supports SSH connections exclusively.)
• Scalable Architecture: Deploy Vector Agents across multiple devices, servers, or datacenters to accommodate network growth. Load balancing and redundancy features are planned for late 2025.
• Streamlined Deployment: Deploy efficiently using installation scripts or configuration management platforms including Ansible, Puppet, or Chef.
• Ephemeral Design: The Vector Agent supports flexible lifecycle management—agents can be removed or reinstalled during scheduled maintenance, server migrations, or following unexpected disruptions.
• Cross-Platform Support: Compatible with Linux and Windows operating systems, the Vector Agent operates on physical servers, virtual machines, cloud instances, and containers.
• Enhanced Security Controls: The Vector Agent connects exclusively to designated Vector Servers, eliminating unauthorized access risks. Secure communication protocols including SSH and layered security restrictions ensure complete data encryption.
• Unidirectional Communication Model: The Vector Agent transmits data to the Vector Server exclusively, requiring no inbound connections. This approach minimizes firewall configuration complexity and significantly reduces attack surface.

Current Limitations

Telnet Protocol Security Notice

Telnet represents an inherently insecure protocol transmitting data in clear text without encryption. The Vector Agent does not support Telnet, consistent with modern security standards. In 2025, utilizing Telnet is analogous to securing sensitive systems with weak authentication—a significant security risk. While our mission emphasizes flexibility and avoiding rigid system constraints, we maintain firm security standards. Telnet represents an obsolete, insecure protocol comparable to using unencrypted HTTP in contemporary encrypted web environments. Consider this when planning Vector Agent deployments. We advocate for secure, modern protocols exclusively.

• SSH Protocol Exclusive: Version 1.0.0 supports SSH connections exclusively. Future releases will incorporate additional protocols including SNMP and REST APIs.
• Telnet Protocol Unsupported: The Vector Agent does not support Telnet protocol. Telnet represents an obsolete, insecure protocol inappropriate for modern network environments. Configure devices for SSH-based secure communication.
• Operating System Support: The Vector Agent currently supports Linux and Windows operating systems exclusively.
• Manual Update Process: Vector Servers do not automatically update Vector Agents. Manual agent updates are required when new versions release. Automated update functionality is planned for 2025.
• Snippet Support: Version 1.x does not support snippets. Future releases will incorporate snippet functionality enabling complex configuration templates and command sequences.
• SNMP Protocol Support: Version 1.x does not include SNMP support. SNMP functionality will be added in future releases enabling monitoring of SNMP-capable devices.
• API Backup Functionality: Version 1.x does not currently support API-based backup operations. This capability will be incorporated in future releases enabling automated device configuration backups.

Prerequisites

Prior to commencing installation, verify the following requirements:

• Supported Operating Systems:
  • Linux: Ubuntu, CentOS, Red Hat (LTS versions recommended)
  • Windows Server (2019 or later recommended)
• System Requirements:
  • Minimum 2 GB RAM (in addition to OS requirements)
  • 10 GB available storage for installation and logging
  • Network connectivity to Vector Server (outbound HTTPS/443 or configured port)
• Administrative Access: Root or administrator privileges required for installation.
• License Key: Valid license key required for Vector Agent installation and activation.
• Dependencies: No additional dependencies required for Vector Agent installation.

---

Installation Procedures

Vector Agent Binary Download

Current Vector Agent binaries for Linux and Windows are available through the rConfig portal. Authenticate to your account and navigate to the Downloads section to access current Vector Agent versions.

rConfig Portal Access

1. Navigate to the rConfig Vector Agent download page:
   • https://portal.rconfig.com/vector-agent-download
2. Authenticate using authorized credentials. Valid licensing is required for download access.
3. Following authentication, locate the current Linux binary version (e.g., vectoragent-linux-latest or vectoragent-linux-v1.0.2).
4. Download the binary to your local system, then transfer to the target server.

Vector Agent Install Script (Linux)

If you prefer the automated install script, generate an install command from the Agents screen in rConfig, then run:

curl -fsSL "https://<server>/vector/install.sh?bootstrap_token=..." | sudo bash

This is a secure process, and the script is signed and verified during execution. The key lasts only 15 minutes for security. And will expire after first use or after 15 minutes.

This script will:

• Download the active latest binary from the Vector Server.
• Bootstrap the agent with the provided token.
• Create the required directories and config files.

Download Process from Vector Server

The Vector Server hosts the active binary at:

/vector/downloads/vectoragent-latest

You can also request platform-specific downloads:

/vector/downloads/vectoragent-latest?platform=linux_amd64
/vector/downloads/vectoragent-latest?platform=windows_amd64

Use these endpoints to download the binary directly from the Vector Server (for example, from a browser or automation script).

Manual Addition to the Vector Binary Store (if required)

If the Vector Server cannot reach the portal to download the binary, you can manually add the binary files to the server’s storage directory.

1. On the Vector Server, locate the binaries directory:

# create the directory if it does not exist
mkdir -p storage/app/public/agent_binaries

# upload the binary file into this directory:
storage/app/public/agent_binaries

# It maybe necessary to reset permissions on the storage directory to allow the web server to read the files afterwards
sudo chown -R apache:apache /var/www/html/rconfig8/current/storage
# or for ubuntu
sudo chown -R www-data:www-data /var/www/html/rconfig8/current/storage

2. Upload the binary file into this directory.

3. Run the Side Load command to scan the directory and add the binary to the Vector Server:

php artisan vector:agent-binary:side-load

3. On the Vector Server, mark the binary as active in the Binary Admin page:

/settings/agents/binaries

This allows the Vector Server to serve the binary and generate install scripts.

---

Vector Agent Installation by Operating System

CentOS, Rocky, Rhel, Alma, / AWS

---

Binary Installation to Target Directory

Following binary download:

1. Open a terminal and navigate to the download directory. To relocate to /usr/local/bin/, or select an alternative directory:

mkdir -p /usr/local/bin/rconfig
mkdir -p /usr/local/bin/rconfig/activeagent
mkdir -p /usr/local/bin/rconfig/data/logs
mkdir -p /usr/local/bin/rconfig/data/db
mkdir -p /usr/local/bin/rconfig/data/files
cd /usr/local/bin/rconfig

2. Move the binary to /usr/local/bin/rconfig for system-wide access, and execute verification procedures:

sudo mv vectoragent-linux-latest /usr/local/bin/rconfig
# Verify file size
ls -lh /usr/local/bin/rconfig
# Verify cryptographic hash (md5, sha1, or sha256)
# Compare hash with value provided on download page
sha256sum /usr/local/bin/rconfig/vectoragent-linux-latest
sha1sum /usr/local/bin/rconfig/vectoragent-linux-latest
md5sum /usr/local/bin/rconfig/vectoragent-linux-latest

3. Copy the downloaded binary to the /usr/local/bin/rconfig/activeagent directory and rename:

sudo cp /usr/local/bin/rconfig/vectoragent-linux-latest /usr/local/bin/rconfig/activeagent/vectoragent

4. Configure binary execute permissions:

sudo chmod +x /usr/local/bin/rconfig/activeagent/vectoragent

Installation Verification

To verify binary functionality, execute:

cd /usr/local/bin/rconfig/activeagent
./vectoragent --version
Vector Agent Version: latest

Version information should display if installation completed successfully.

---

Systemd Service Configuration

1. Create a new systemd service file:

sudo vim /etc/systemd/system/vectoragent.service

2. Add the following service configuration:

[Unit]
Description=Vector Agent Service
After=network.target

[Service]
ExecStart=/usr/local/bin/rconfig/activeagent/vectoragent
Restart=always
User=root
Group=root
EnvironmentFile=/usr/local/bin/rconfig/activeagent/.env

[Install]
WantedBy=multi-user.target

3. Save and exit editor

---

Environment Configuration File

If the binary requires environment variables, define them in:

sudo vim /usr/local/bin/rconfig/activeagent/.env

Add required environment variables:

AGENT_DEBUG=false
API_URL=https://server.yourdomain.com
API_KEY=1234-1234-1234-1234
SSL_VERIFY=true

Note: An .env file can be generated from your Vector server following agent creation on the Vector Server. Utilize the generated .env file values to create the agent .env file. The file downloads as a .txt file requiring renaming to .env.

---

Service Initialization

1. Reload systemd to recognize the new service:

sudo systemctl daemon-reload

2. Enable the service for automatic startup:

sudo systemctl enable vectoragent

3. Start the service:

sudo systemctl start vectoragent

4. Verify service status:

sudo systemctl status vectoragent

Service status should display active (running).

---

Agent Verification

To confirm agent operational status, review logs:

journalctl -u vectoragent.service -f

Review for errors or confirmation messages indicating successful connectivity and operation.

---

Troubleshooting Guidance

• Log Review: If the agent fails to initialize, review logs for error messages. Logs are located in /usr/local/bin/rconfig/data/logs.
• Firewall Configuration: Verify the server has outbound access to the Vector Server on the configured port.
• Environment Variables: Verify environment variables are correctly configured in the .env file.
• File Permissions: Verify the binary has appropriate execute permissions. Use chmod +x to configure execute permissions.
• Systemd Service: Review the service file for configuration errors. Use systemctl status vectoragent to verify service status.
• System and Service Logs: Review system and service logs for additional diagnostic information. Use journalctl -u vectoragent.service to view service logs.
• Network Connectivity: Verify the server has network connectivity to the Vector Server.

---

Vector Agent installation and configuration on Rocky Linux is complete.

Ubuntu

Binary Installation to Target Directory

1. Open a terminal and navigate to the download location. Create required directories:

mkdir -p /usr/local/bin/rconfig
mkdir -p /usr/local/bin/rconfig/activeagent
mkdir -p /usr/local/bin/rconfig/data/logs
mkdir -p /usr/local/bin/rconfig/data/db
mkdir -p /usr/local/bin/rconfig/data/files
cd /usr/local/bin/rconfig

2. Move the binary to the target directory:

sudo mv ~/Downloads/vectoragent-linux-latest /usr/local/bin/rconfig

3. Copy the binary to the activeagent directory and rename:

sudo cp /usr/local/bin/rconfig/vectoragent-linux-latest /usr/local/bin/rconfig/activeagent/vectoragent

4. Configure execute permissions:

sudo chmod +x /usr/local/bin/rconfig/activeagent/vectoragent

5. Verify installation:

cd /usr/local/bin/rconfig/activeagent
./vectoragent --version

Version information should display if installation completed successfully.

---

Systemd Service Configuration

1. Create a new systemd service file:

sudo vim /etc/systemd/system/vectoragent.service

2. Add the following configuration:

[Unit]
Description=Vector Agent Service
After=network.target

[Service]
ExecStart=/usr/local/bin/rconfig/activeagent/vectoragent
Restart=always
User=root
Group=root
EnvironmentFile=/usr/local/bin/rconfig/activeagent/.env

[Install]
WantedBy=multi-user.target

3. Save and exit editor.

---

Environment Configuration File

1. Create the environment file if required:

sudo vim /usr/local/bin/rconfig/activeagent/.env

2. Add necessary environment variables:

AGENT_DEBUG=false
API_URL=https://server.yourdomain.com
API_KEY=1234-1234-1234-1234
SSL_VERIFY=true

Note: An .env file can be generated from your Vector server following agent creation on the Vector Server. Utilize the generated .env file values to create the agent .env file. The file downloads as a .txt file requiring renaming to .env.

---

Service Initialization

1. Reload systemd to recognize the new service:

sudo systemctl daemon-reload

2. Enable the service for automatic startup:

sudo systemctl enable vectoragent

3. Start the service:

sudo systemctl start vectoragent

4. Verify service status:

sudo systemctl status vectoragent

---

Agent Verification

Review logs to confirm successful initialization:

journalctl -u vectoragent.service -f

Windows

This guide provides procedures for operating the Go binary as a Windows service using NSSM. To streamline updates, the binary will be renamed to vectoragent.exe for deployment, while retaining the original version (vectoragent-windows-latest.exe) as a rollback backup.

---

Prerequisites

• Go Binary: Verify vectoragent-windows-latest.exe exists in C:\rconfig.
• NSSM Installation: Download and extract NSSM from https://nssm.cc/download.

---

Binary Preparation

1. Navigate to C:\rconfig.

2. Create data directories:

mkdir data
mkdir data\logs
mkdir data\db
mkdir data\files

3. Create backup of the original binary:

copy vectoragent-windows-latest.exe vectoragent-backup-latest.exe

4. Rename the binary for simplified updates:

rename vectoragent-windows-latest.exe vectoragent.exe

---

Service Configuration

1. Open Command Prompt with Administrator privileges.
2. Navigate to the directory containing nssm.exe.
3. Execute the following command to create the service:

nssm install vectoragent

4. In the configuration window:
   • Path: Select the binary file, e.g., C:\rconfig\vectoragent.exe.
   • Startup Directory: Configure to C:\rconfig.
   • Options:
     • Configure stdout and stderr log file paths if required.

---

Environment Configuration File Creation

1. Create a new file in C:\rconfig named .env.
2. Add required environment variables:

AGENT_DEBUG=false
API_URL=https://server.yourdomain.com
API_KEY=1234-1234-1234-1234
SSL_VERIFY=true

Note: An .env file can be generated from your Vector server following agent creation on the Vector Server. Utilize the generated .env file values to create the agent .env file. The file downloads as a .txt file requiring renaming to .env.

3. Save the file.

Service Initialization

• Execute the service using:

nssm start vectoragent

• Verify service status:

nssm status vectoragent

• Antivirus Software Considerations

  If the application fails to execute, Windows Defender or third-party antivirus software may be blocking execution. To ensure proper operation, manually exclude the application path from antivirus scanning.

Restart Policy Configuration

For automatic service restart on failure:

1. Execute:

nssm edit vectoragent

2. Navigate to the Exit Actions tab and configure:
   • Configure Restart delay as required.

---

Agent Verification and Log Review

• To verify agent operational status, review logs:

nssm log vectoragent

• Review for errors or confirmation messages indicating successful connectivity and operation.

---

Vector Agent Upgrade Procedures

CentOS, Rocky, Rhel, Alma

1. Download Current Version Access the rConfig Vector Agent download page and download the current agent version.

2. Stop the operational service:

sudo systemctl stop vectoragent

3. Replace Existing Binary

sudo cp vectoragent-linux-latest /usr/local/bin/rconfig/activeagent/vectoragent
sudo chmod +x /usr/local/bin/rconfig/activeagent/vectoragent

4. Restart Service

sudo systemctl start vectoragent

5. Verify Update Completion

/usr/local/bin/rconfig/activeagent/vectoragent --version

Updated version information should display.

Ubuntu

1. Download Current Version Access the rConfig Vector Agent download page and download the current agent version.
2. Stop the operational service:

sudo systemctl stop vectoragent

3. Replace Existing Binary

sudo cp ~/Downloads/vectoragent-linux-latest /usr/local/bin/rconfig/activeagent/vectoragent
sudo chmod +x /usr/local/bin/rconfig/activeagent/vectoragent

4. Restart the service:

sudo systemctl start vectoragent

5. Verify update completion:

/usr/local/bin/rconfig/activeagent/vectoragent --version

Verify correct version information displays.

Windows

When upgrading to a new version:

1. Stop the service:

   nssm stop vectoragent

2. Backup the current binary:

   copy vectoragent.exe vectoragent-backup-previous.exe

3. Copy the new version to C:\rconfigvector and rename:

   copy vectoragent-windows-v1.1.0.exe vectoragent.exe

4. Start the service:

   nssm start vectoragent

Rollback Procedures (if required)

1. Stop the service:

   nssm stop vectoragent

2. Replace vectoragent.exe with the previous version:

   copy vectoragent-backup-latest.exe vectoragent.exe

3. Start the service:

   nssm start vectoragent

Environment Configuration Update and Service Restart

Environment File Modification

sudo vim /usr/local/bin/rconfig/activeagent/.env

Implement required modifications, including API key updates, URL changes, or other configuration variable updates.

Save and Exit

Save the file and exit the editor.

Vector Agent Service Restart

sudo systemctl restart vectoragent

Service Verification

Verify the service operates correctly following configuration updates.

sudo systemctl status vectoragent

Status should display active (running). If issues occur, review logs using:

journalctl -u vectoragent.service -f