User Documentation
  • Product Information
    • Overview
    • Architecture
    • Security
    • Key Features
    • Supported Systems
    • Comparison
  • Installation
    • Download VirtualMetric
    • Install a VirtualMetric Server
    • Activate Product
    • Update From Previous Versions
    • Uninstall VirtualMetric
  • Releases
    • Version 8.0.3
  • Server Pre-Configuration
    • Windows
    • VMware
    • Linux
    • Bare Metal Hardware
  • Settings
    • Users
      • User Operations
        • Add New User
        • Edit User
        • Device Permissions
        • Login as Other User
        • Remove User
      • User Group Operations
        • Add New User Group
        • Assign Member
        • Device Permission
        • Edit User Group
        • Remove User Group
      • API Users Operations
        • Add New API User
        • Edit API User
        • Device Permission
        • Remove API User
      • Organization Operations
        • Add New Organization
        • Edit Organization
        • Device Permission
        • Login as Other Organization
        • Remove Organization
      • Credential Store
        • Add New Credential Store
        • Edit Credential Store
        • Remove Credential Store
      • Group Based AD Authentication
    • Devices
      • Server Operations
        • Add New Server
        • Assign Module
        • Edit Server
        • Remove Server
        • Restore Server
        • Connectivity Issues
        • Bulk Update
      • Cluster Operations
        • Add New Cluster
        • Assign Module
        • Sync a Cluster
        • Edit Cluster
        • Remove Cluster
        • Connectivity Issues
        • Bulk Update
      • Workstation Operations
        • Add New Workstation
        • Edit Workstation
        • Remove Workstation
      • Manager Operations
        • Add New Manager
        • Assign Module
        • Sync Manager
        • Edit Manager
        • Remove Manager
        • Connectivity Issues
        • Bulk Update
      • Network Devices Operations
        • Add Network Device
        • Edit Network Device
        • Remove Network Device
        • Connectivity Issues
        • Bulk Update
      • Trigger Operations
        • Add New Trigger
        • Assign Server
        • Edit Trigger
        • Change API User
        • Change Service User
        • Remove Trigger
        • Enable Debug
      • Device Group Operations
        • Add New Device Group
        • Assign Member
        • Edit Device Group
        • Remove Device Group
      • Datacenter Operations
        • Add New Datacenter
        • Assign Member
        • Edit Datacenter
        • Remove Datacenter
      • Permission Operations
        • Add/Remove Permission
    • Listeners
      • Listener Operations
        • Add a New Listener
          • Add a Syslog Listener
          • Add a Flow Endpoints
          • Add a eStreamer
          • Add a TFTP Listener
          • Add a TCP Listener
          • Add a UDP Listener
          • Add a HTTP Listener
          • Add a SMTP Listener
          • Add a SNMP Trap Listener
          • Add a Redis Consumer
          • Add a Kafka Consumer
          • Add a RabbitMQ Consumer
          • Add a NATS Consumer
        • Edit Listener
        • Remove Listener
    • Services
      • Location Operations
        • Add new Location
        • Edit Location
        • Remove Location
      • Web Sites Operations
        • Add new Website
        • Assign Location
        • Edit Web Sites
        • Remove Web Sites
      • DNS Operations
        • Add new DNS
        • Edit DNS
        • Remove DNS
      • ICMP Operations
        • Add new ICMP
        • Edit ICMP
        • Remove ICMP
      • IPAM Operations
        • Add new IPAM
        • Edit IPAM
        • Remove IPAM
      • TCP Operations
        • Add new TCP
        • Edit TCP
        • Remove TCP
      • Database Operations
        • Add new Database
        • Edit Database
        • Remove Database
    • Notifications
      • Rules Operations
        • Add new Rules
        • Edit Rule
        • Adding Dependency
        • Filtering Rules
        • Assign Action
        • Remove Rule
      • Knowledge Base Operations
        • Add new Knowledge Base
        • Edit Knowledge Base
        • Remove Knowledge Base
      • Action Operations
        • Add new Action
        • Testing Action
        • Edit Action
        • Remove Action
      • Scheduled Report Operation
        • Edit Scheduled Report
        • Remove Scheduled Report
      • STMP Settings
      • SMS Settings
    • Collectors
      • Definitions Operations
      • Module Defaults Operations
      • Device Bindings Operations
    • Logs
      • Definitions Operations
        • Understand Definition Fields
        • Edit Definition
        • Bulk Update
        • Reset Definition
      • Custom Definition Operations
        • Add Custom Definition
        • Edit Custom Definition
        • Remove Custom Definition
      • Module Defaults
        • Assign Definition
        • Reset Module Defaults
      • Device Bindings
        • Assign Definition
        • Reset Device Bindings
    • Statistics
      • Logging Types
        • Understanding Logging Types
        • Edit Logging Type
        • Reset Logging Type
      • System Counters
        • Understanding System Counter
        • Edit System Counter
        • Reset System Counter
      • Custom Counters
        • Understanding Custom Counter
        • Edit Custom Counter
        • Reset Custom Counter
    • Systems
      • System Logs
      • System Health
      • Advanced Settings
    • Azure Active Directory Integration
  • Dashboard
    • Main Page
    • Login
    • Layout and Common Functions
    • Calculation of Recommendations
    • Add New Widget
    • Edit Widget
    • Charts
    • White Labeling
  • Devices
    • Layout and Common Functions
  • Analytics
    • Layout and Common Functions
  • Modules and Audit
    • VirtualMetric Modules
      • Bare Metal
      • Microsoft Hyper-V
      • VMware
      • Microsoft IIS
      • Microsoft SQL
      • Microsoft Storage Spaces
      • Active Directory User Permissions
    • Audit Configuration
Powered by GitBook
On this page
  • Hardware Requirements
  • Software Requirements
  • Running The Setup Application
  • First Time Login
  1. Installation

Install a VirtualMetric Server

To install the VirtualMetric software, the following requirements must be met:

  • A virtual machine with at least 4 vCPU and minimum 8 GB RAM.

  • Windows Server 2019, 2022, or later.

  • A 100 GB Hard Disk Drive

  • Microsoft Edge or Google Chrome (Internet Explorer is not supported)

To host a VirtualMetric Database, you need to meet the following requirements:

  • A virtual machine with at least 8 vCPU and minimum 16 GB RAM memory.

  • Operating System: Ubuntu 22.04 or later / Red Hat Enterprise Linux (RHEL) 7 or later / Debian 9 or later

  • System Drive: 100 GB Hard Disk Drive for OS and Database Software

  • Data Drive: 100 GB Hard Disk Drive minimum for basic data retention

On the Linux machine, the following CPU flags must be enabled for the Clickhouse database to operate properly:

  • adx

  • avx

  • avx2

  • bmi1

  • bmi2

  • clmul

  • fma

  • pclmulqdq

    You can get the list of enabled CPU flags by running this command: sudo cat /proc/cpuinfo | grep flags | head -n 1 | tr ' ' '\n' | sort

When running VirtualMetric on a virtual machine, do not use dynamic resource allocation, but make sure that full resources are available to the virtual machine at any time.

Hardware Requirements

Hardware requirements for VirtualMetric mainly depend on the modules, intervals, and history ranges. The following should serve as reference points for the minimum requirements of VirtualMetric:

  • Dual Core CPU

  • 4096 MB Memory

  • 100 GB Hard Disk Drive

When running VirtualMetric on a virtual machine, do not use dynamic resource allocation, but make sure that full resources are available to the virtual machine at any time.


Software Requirements

Before installing VirtualMetric on Windows Server, make sure that you have following components on Windows Server:

  • Microsoft PowerShell v4 or later

  • .NET Framework 2.0 or later


Running The Setup Application

Installing VirtualMetric is easy since it is like any other Windows-based application. To install VirtualMetric, all you have to do is to run the setup program you have downloaded.

1. You first need to allow the setup process to run with User Account Control:

Confirm the question with Yes. VirtualMetric Setup Wizard will guide you through the process.

2. You will see the Welcome Screen.

Click Next to continue.

3. You will see the License Agreement.

Accept the terms to continue and click Next.

4. In this step, you will configure the settings required by VirtualMetric's API.

  • You can use either an IP address or FQDN for API connectivity. All servers will use this address for inventory and performance statistics collection. If you use FQDN, the domain should be resolved by all servers.

  • By default, VirtualMetric's API listens on TCP 8080. You can change the configuration if you want to use a different one. VirtualMetric will configure its REST API with this port.

  • Setup will add a firewall rule to Windows Firewall as part of the installation.

The VirtualMetric API address should be reachable by all servers. For details, please see the Firewall Configuration section.

After filling the required fields, click Next.

5. In this step, you will configure the VirtualMetric Dashboard.

  • Setup will enter the VirtualMetric API address automatically. Clients will use this VirtualMetric API address when they connect to VirtualMetric Dashboard. If VirtualMetric API is in a private network, you should type the external VirtualMetric API address here. Otherwise, clients will not be able to login to the dashboard due to failure to reach the network.

  • Setup will require you to type a username and a password, and confirm the password by retyping. You will use this username and password to login to the dashboard for the first time. The password must be at least 6 characters long.

Do not forget to write down your username and password. Setup will not remind you these values after it completes.

After filling the required fields, click Next.

6. In this step, you will configure the VirtualMetric Clickhouse Database.

  • Enter your Server IP Adress, and the your username and password you have configured previously.

  • After filling the fields, check that the database connection works by clicking the Test Clickhouse Connection button.

When you verify the connection, click Next.

7. In this step, you will configure the destination location.

Review the location you have entered, and click Next.

8. Once these settings are made, a prompt dialog will appear stating that setup is ready to install.

Click Install to start the process.

9. A dialog showing the process will appear.

You can monitor the progress of the installation process here to see whether it completes smoothly.

10. When the installation process completes without any errors, you should see the closing dialog.

Click Finish to exit the Setup Wizard.


First Time Login

Once the VirtualMetric is installed, you can log in to the web interface in your browser and enter the IP address or DNS name of the computer where VirtualMetric is installed. If you are logged in to the VirtualMetric server, you can use following address.

http://localhost

After loading the VirtualMetric Dashboard, you will see the login screen below.

You can log in using the username and password that you have provided on Setup Wizard. After you have typed them, click the Login button to log in.

When you log in for the first time, you will see a Welcome Screen.

Click the Go to Settings button to navigate to the Settings page. Here, you can activate your product and start monitoring your data right away.

PreviousDownload VirtualMetricNextActivate Product

Last updated 6 months ago

If you want to secure the VirtualMetric Dashboard and VirtualMetric API connections with an SSL certificate, please visit the section.

VirtualMetric Welcome Screen
Setup SSL Certificate