rConfig Vector Agent Installation: Multi-Platform Network Device Management
rConfig Vector Agent Installation: Multi-Platform Network Device Management
Section titled “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
Section titled “Agent Capabilities and Limitations”Capabilities
Section titled “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. Containerized deployments via Docker or Kubernetes are supported.
-
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
Section titled “Current Limitations”- 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
Section titled “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
Section titled “Installation Procedures”Vector Agent Binary Download
Section titled “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
Section titled “rConfig Portal Access”- Navigate to the rConfig Vector Agent download page:
- Authenticate using authorized credentials. Valid licensing is required for download access.
- Following authentication, locate the current Linux binary version (e.g.,
vectoragent-linux-latest
orvectoragent-linux-v1.0.2
). - Download the binary to your local system, then transfer to the target server.
Vector Agent Installation by Operating System
Section titled “Vector Agent Installation by Operating System”Binary Installation to Target Directory
Following binary download:
-
Open a terminal and navigate to the download directory. To relocate to
/usr/local/bin/
, or select an alternative directory:Terminal window mkdir -p /usr/local/bin/rconfigmkdir -p /usr/local/bin/rconfig/activeagentmkdir -p /usr/local/bin/rconfig/data/logsmkdir -p /usr/local/bin/rconfig/data/dbmkdir -p /usr/local/bin/rconfig/data/filescd /usr/local/bin/rconfig -
Move the binary to
/usr/local/bin/rconfig
for system-wide access, and execute verification procedures:Terminal window sudo mv vectoragent-linux-latest /usr/local/bin/rconfig# Verify file sizels -lh /usr/local/bin/rconfig# Verify cryptographic hash (md5, sha1, or sha256)# Compare hash with value provided on download pagesha256sum /usr/local/bin/rconfig/vectoragent-linux-latestsha1sum /usr/local/bin/rconfig/vectoragent-linux-latestmd5sum /usr/local/bin/rconfig/vectoragent-linux-latest -
Copy the downloaded binary to the
/usr/local/bin/rconfig/activeagent
directory and rename:Terminal window sudo cp /usr/local/bin/rconfig/vectoragent-linux-latest /usr/local/bin/rconfig/activeagent/vectoragent -
Configure binary execute permissions:
Terminal window sudo chmod +x /usr/local/bin/rconfig/activeagent/vectoragent
Installation Verification
To verify binary functionality, execute:
cd /usr/local/bin/rconfig/activeagent./vectoragent --versionVector Agent Version: latest
Version information should display if installation completed successfully.
Systemd Service Configuration
-
Create a new systemd service file:
Terminal window sudo vim /etc/systemd/system/vectoragent.service -
Add the following service configuration:
[Unit]Description=Vector Agent ServiceAfter=network.target[Service]ExecStart=/usr/local/bin/rconfig/activeagent/vectoragentRestart=alwaysUser=rootGroup=rootEnvironmentFile=/usr/local/bin/rconfig/activeagent/.env[Install]WantedBy=multi-user.target -
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=falseAPI_URL=https://server.yourdomain.comAPI_KEY=1234-1234-1234-1234
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
-
Reload systemd to recognize the new service:
Terminal window sudo systemctl daemon-reload -
Enable the service for automatic startup:
Terminal window sudo systemctl enable vectoragent -
Start the service:
Terminal window sudo systemctl start vectoragent -
Verify service status:
Terminal window 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.
Vector Agent installation and configuration on Rocky Linux is complete.
Binary Installation to Target Directory
-
Open a terminal and navigate to the download location. Create required directories:
Terminal window mkdir -p /usr/local/bin/rconfigmkdir -p /usr/local/bin/rconfig/activeagentmkdir -p /usr/local/bin/rconfig/data/logsmkdir -p /usr/local/bin/rconfig/data/dbmkdir -p /usr/local/bin/rconfig/data/filescd /usr/local/bin/rconfig -
Move the binary to the target directory:
Terminal window sudo mv ~/Downloads/vectoragent-linux-latest /usr/local/bin/rconfig -
Copy the binary to the
activeagent
directory and rename:Terminal window sudo cp /usr/local/bin/rconfig/vectoragent-linux-latest /usr/local/bin/rconfig/activeagent/vectoragent -
Configure execute permissions:
Terminal window sudo chmod +x /usr/local/bin/rconfig/activeagent/vectoragent -
Verify installation:
Terminal window cd /usr/local/bin/rconfig/activeagent./vectoragent --version
Version information should display if installation completed successfully.
Systemd Service Configuration
-
Create a new systemd service file:
Terminal window sudo vim /etc/systemd/system/vectoragent.service -
Add the following configuration:
[Unit]Description=Vector Agent ServiceAfter=network.target[Service]ExecStart=/usr/local/bin/rconfig/activeagent/vectoragentRestart=alwaysUser=rootGroup=rootEnvironmentFile=/usr/local/bin/rconfig/activeagent/.env[Install]WantedBy=multi-user.target -
Save and exit editor.
Environment Configuration File
-
Create the environment file if required:
Terminal window sudo vim /usr/local/bin/rconfig/activeagent/.env -
Add necessary environment variables:
Terminal window AGENT_DEBUG=falseAPI_URL=https://server.yourdomain.comAPI_KEY=1234-1234-1234-1234Note: 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
-
Reload systemd to recognize the new service:
Terminal window sudo systemctl daemon-reload -
Enable the service for automatic startup:
Terminal window sudo systemctl enable vectoragent -
Start the service:
Terminal window sudo systemctl start vectoragent -
Verify service status:
Terminal window sudo systemctl status vectoragent
Agent Verification
Review logs to confirm successful initialization:
journalctl -u vectoragent.service -f
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 inC:\rconfig
. - NSSM Installation: Download and extract NSSM from https://nssm.cc/download.
Binary Preparation
-
Navigate to
C:\rconfig
. -
Create data directories:
Terminal window mkdir datamkdir data\logsmkdir data\dbmkdir data\files -
Create backup of the original binary:
Terminal window copy vectoragent-windows-latest.exe vectoragent-backup-latest.exe -
Rename the binary for simplified updates:
Terminal window rename vectoragent-windows-latest.exe vectoragent.exe
Service Configuration
-
Open Command Prompt with Administrator privileges.
-
Navigate to the directory containing
nssm.exe
. -
Execute the following command to create the service:
Terminal window nssm install vectoragent -
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.
- Path: Select the binary file, e.g.,
Environment Configuration File Creation
-
Create a new file in
C:\rconfig
named.env
. -
Add required environment variables:
Terminal window AGENT_DEBUG=falseAPI_URL=https://server.yourdomain.comAPI_KEY=1234-1234-1234-1234Note: 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.
-
Save the file.
Service Initialization
-
Execute the service using:
Terminal window nssm start vectoragent -
Verify service status:
Terminal window nssm status vectoragent
Restart Policy Configuration
For automatic service restart on failure:
- Execute:
Terminal window nssm edit vectoragent - 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:
Terminal window nssm log vectoragent -
Review for errors or confirmation messages indicating successful connectivity and operation.
Vector Agent Upgrade Procedures
Section titled “Vector Agent Upgrade Procedures”-
Download Current Version Access the rConfig Vector Agent download page and download the current agent version.
-
Stop the operational service:
Terminal window sudo systemctl stop vectoragent -
Replace Existing Binary
Terminal window sudo cp vectoragent-linux-latest /usr/local/bin/rconfig/activeagent/vectoragentsudo chmod +x /usr/local/bin/rconfig/activeagent/vectoragent -
Restart Service
Terminal window sudo systemctl start vectoragent -
Verify Update Completion
Terminal window /usr/local/bin/rconfig/activeagent/vectoragent --version
Updated version information should display.
-
Download Current Version Access the rConfig Vector Agent download page and download the current agent version.
-
Stop the operational service:
Terminal window sudo systemctl stop vectoragent -
Replace Existing Binary
Terminal window sudo cp ~/Downloads/vectoragent-linux-latest /usr/local/bin/rconfig/activeagent/vectoragentsudo chmod +x /usr/local/bin/rconfig/activeagent/vectoragent -
Restart the service:
Terminal window sudo systemctl start vectoragent -
Verify update completion:
Terminal window /usr/local/bin/rconfig/activeagent/vectoragent --version
Verify correct version information displays.
When upgrading to a new version:
- Stop the service:
Terminal window nssm stop vectoragent - Backup the current binary:
Terminal window copy vectoragent.exe vectoragent-backup-previous.exe - Copy the new version to
C:\rconfigvector
and rename:Terminal window copy vectoragent-windows-v1.1.0.exe vectoragent.exe - Start the service:
Terminal window nssm start vectoragent
Rollback Procedures (if required)
- Stop the service:
Terminal window nssm stop vectoragent - Replace
vectoragent.exe
with the previous version:Terminal window copy vectoragent-backup-latest.exe vectoragent.exe - Start the service:
Terminal window nssm start vectoragent
Environment Configuration Update and Service Restart
Section titled “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