VMWare ESXI Installation Guide: Difference between revisions

From Allegro Network Multimeter Manual
Jump to navigation Jump to search
Access restrictions were established for this page. If you see this message, you have no access to this page.
 
(54 intermediate revisions by 5 users not shown)
Line 1: Line 1:
This guide describes how the Allegro Network Multimeter Virtual Edition can be set up with VMWare ESXI. The Allegro Virtual Edition is designed for 2 use cases. It can analyze [[Parallel Packet processing|Pcap captures]] or [[Ring Buffer Configuration Guide|Packet Ring Buffers]] of unlimited size for forensic investigation or it can analyse live traffic from virtual machines by a virtual Mirror Port or [[ERSPAN Installation|ERSPAN]].
This guide describes how the Allegro Network Multimeter Virtual Edition can be set up with VMWare ESXI.
 
The Allegro Virtual Edition is designed for 2 use cases.
 
# It can analyze [[Parallel packet processing|pcap captures]] or [[Ring Buffer Configuration Guide|packet ring buffers]] of unlimited size for forensic investigation and/or
# it can analyze live traffic from virtual machines by a virtual Mirror Port or [[ERSPAN Installation|ERSPAN]].


== General ==
== General ==
Line 5: Line 10:
=== DISCLAIMER ===
=== DISCLAIMER ===


Be aware that an activated Ring Buffer can degrade the I/O performance for all VMs. It is recommended to use one or many dedicated HDDs or SSDs for the Ring Buffer to prevent side effects to other VMs.
Packet analysis is resource intensive. Running the Allegro Packets VM on your own hardware and its performance outcome is warranted “as is”. Our support will be limited.
 
Be aware that an activated ring buffer can (heavily) degrade the I/O performance for all VMs. It is strongly recommended to use one or more dedicated HDDs or SSDs for the ring buffer, to prevent side effects on other VMs.


=== System requirements ===
=== System requirements ===
Line 11: Line 18:
This guide requires a licensed VMWare ESXi 6.7.0 or newer.
This guide requires a licensed VMWare ESXi 6.7.0 or newer.


The system requirement of the virtual machine is
The system requirement of the virtual machine is:
* x86 64-Bit Intel/AMD CPU with SSE4.2 support ( since 2011 )
* x86 64-Bit Intel/AMD CPU with SSE4.2 support (since 2011)
* 4 CPU-Cores
* 4 CPU-Cores
* at least 2GB RAM for the In-Memory-DB, the larger the better
* at least 2GB RAM for the In-Memory-DB, the larger the better
Line 19: Line 26:
=== Virtual Machine image ===
=== Virtual Machine image ===


Please contact [https://allegro-packets.com/en/contact Allegro] or your reseller to retrieve the current Allegro Virtual Edition installation zip archive.
Please contact [https://allegro-packets.com/en/contact Allegro] or your reseller to download the current Allegro Virtual Edition installation zip archive.


== Installation ==
== Installation ==
Line 25: Line 32:
=== Zip file extraction ===
=== Zip file extraction ===


Please extract the the zip archive. It should contain the 3 files “allegro-multimeter.ovf”, “allegro-multimeter.vmdk” and “allegro-multimeter-virtualbox.ovf”. 
Please extract the zip archive. It should contain the 3 files “allegro-multimeter.ovf”, “allegro-multimeter.vmdk” and “allegro-multimeter-virtualbox.ovf”. 


=== OVF deployment to VMWare ESXi ===
=== OVF deployment to VMWare ESXi ===


Please log in to VMWare ESXi.
Log in to VMWare ESXi.


[[File:Esxi login.png|400px]]
[[File:Esxi login.png|400px]]
Line 41: Line 48:
[[File:Esxi create new vm.png|600px]]
[[File:Esxi create new vm.png|600px]]


Press “Next”, use a preferred name for the Allegro and drag/drop the 2 files into the Window and press “Next”.
Press “Next”, use a preferred name for the Allegro and drag/drop the ovf and vmdk files into the window (as seen in the picture below) and press “Next”.


[[File:Esxi create new vm step 2.png|600px]]
[[File:Esxi create new vm step 2.png|600px]]


Select your data storage for the Allegro. This storage will be used as the boot partition and to store the configuration of the Allegro Virtual Edition and does not require being a high-speed disk. It will not store the packet ring buffer.
Select your data storage (20 GB is enough) for the Allegro. This storage will be used as the boot partition and to store the configuration of the Allegro Virtual Edition.
 
This partition/disk will NOT facilitate the packet ring buffer functionality. This does not require a high-speed disk.


[[File:Esxi create new vm select storage.png|600px]]
[[File:Esxi create new vm select storage.png|600px]]
   
   
The Deployment options allow you to select the Network mapping for the MGT port and the disk provisioning.  
The deployment options allow you to select the network mapping for the MGT port and the disk provisioning.  


[[File:Esxi create new vm management.png|600px]]
[[File:Esxi create new vm management.png|600px]]
   
   
Please double-check all options in the next dialog and press finish if everything is fine.
Please double-check all options in the next dialogue and press finish if everything is fine.


[[File:Esxi create new vm finish.png|600px]]
[[File:Esxi create new vm finish.png|600px]]
   
   
The upload and the import of the Allegro Virtual Edition will start. Please be patient until it is finished.  
The upload and import of the Allegro Virtual Edition will start. Please be patient until it is finished.  


[[File:Esxi import.png|600px]]
[[File:Esxi import.png|600px]]


== Initial Startup ==
=== Packet ring buffer and pcap storage ===
 
For the ring buffer to work, you must add a "Hard disk 2" virtual disk (or more) to the Allegro Virtual Edition.
 
To do so, with a turned off VM, press “Edit” in the Vmware ESXi host and add a new (high speed) HDD.
 
[[File:Esxi add hdd.png]]
 
When done, power on the Allegro VM and go to menu '''Generic''' → '''Storage''', to check if the Allegro Network Multimeter has detected a storage device.
 
Here an example of 1 attached/configured disk:
 
[[File:Storage no device active.png|border|600px]]


Please power on the virtual machine when the import has been successful. The Allegro Virtual Edition will boot, prepare the installation and reboot once.
Here, on the '''Generic''' → '''Storage''' page, you can prepare the disks to be used by the Allegro by clicking the "Format" button.
The VM will try to get an IP Address via DHCP on the MGT port. Please check the screen output for an assigned IP address.
 
This will erase all content on the disk and create the filesystem for the Allegro. You can also activate and deactivate the storage device for pcap files here.
 
For more information on the ring buffer, please review the corresponding page here → [[Ring Buffer Configuration Guide]].
 
'''Disclaimer:''' Be aware that an activated ring buffer can (heavily) degrade the I/O performance for all VMs.
 
It is strongly recommended to use one or more dedicated HDDs or SSDs for the ring buffer, to prevent side effects on other VMs.
 
=== Install USB License dongle ===
 
If the Allegro Virtual Edition is shipped with an USB License dongle, plug the dongle into an unused USB port of the VM host. The dongle must be connected to the virtual machine. When powered off, press “Edit” in the Vmware ESXi host and click on “Add other device”. Choose “USB device”. A new entry on the bottom of the hardware list appears. Please select a “Feitian HID Dongle” or similar.
 
[[File:License dongle.png|600px]]
 
== Initial startup ==
 
=== Powering on ===
 
Power on the virtual machine when the import has been successful. The Allegro Virtual Edition will boot, prepare the installation and reboot once.
The VM will seek for an IP address via DHCP on the MGT port. Check the screen output for an assigned IP address.
   
   
[[File:Esxi allegro screen.png|600px]]
[[File:Esxi allegro screen.png|600px]]


You can connect now to the IP address with you browser, in our case https://10.54.0.220/ . The browser will show a certificate warning. Please accept it to get to the login screen.
You can now connect to the IP address with your browser, in our case https://10.54.0.220/ . The browser will show a certificate warning. Accept it to access the login screen.


[[File:Esxi allegro login.png|600px]]
[[File:Esxi allegro login.png|600px]]
    
    
Please use as credentials as user “admin” and as password “allegro”.
Please use the following login credentials; user “admin” and password “allegro”.
It will show a warning that the Allegro Virtual Edition does not have a license yet.
 
=== License ===
If the Allegro Virtual Edition was shipped with a USB License dongle and it has been correctly installed, the License is validated and the Allegro should activate.
 
The serial number of the Allegro Virtual Edition would be e.g. “dongle: 1234567890” and is displayed in the serial number box under “Settings” -> “License upload”. If it is not displayed even though the dongle has been correctly installed, please contact Allegro support.
 
If the Allegro Virtual Edition was shipped without an USB License dongle, please follow the following steps. In the web interface a warning is shown that the Allegro Virtual Edition does not yet have a License.


[[File:Esxi allegro license.png|400px]]
[[File:Esxi allegro license.png|400px]]


Please navigate to “Settings” -> “License upload” and send the System Serial to testlicense@allegro-packets.com.
Navigate to “Settings” -> “License upload” and send the system serial number to testlicense@allegro-packets.com.
Allegro Packets will issue a test license for you that can be installed by the “Upload new License button”.
 
Once the Test license is applied, it will show you the License details similar to this output:
Allegro Packets will issue a test License for you that can be installed by the “Upload new License button”.
 
Once the test License is applied, it will show you the License details similar to this output:


[[File:Esxi allegro license details.png|400px]]
[[File:Esxi allegro license details.png|400px]]
   
   
The Allegro Virtual Edition is now running and analyses all packets on the capture port.
The Allegro Virtual Edition is now running and analyzes all packets on the capture port.


== Mirroring virtual interface ==
== Mirroring virtual interface ==


The Allegro Virtual Edition has by default 2 network interfaces. The first port is used for Management, the second port is used as capture port. The Allegro Virtual Edition will analyse all traffic received by this network port.
The Allegro Virtual Edition has by default 2 network interfaces. The first port is used for Management, the second is used as capture port. The Allegro Virtual Edition will analyze all traffic received by this network port.


Please enable the promiscuous mode for the vwsitch to allow the Allegro Virtual Edition to monitor all packets from on a VMWare vswitch.
Please enable the promiscuous mode for the vwsitch to allow the Allegro Virtual Edition to monitor all packets from on a VMWare vswitch.
Line 93: Line 142:
[[File:Esxi switch allow promicuous mode.png|900px]]
[[File:Esxi switch allow promicuous mode.png|900px]]


== Storages for Ring Buffer and Pcaps ==
== Encapsulated remote mirroring (L3) source ==
 
You can add one or multiple virtual disks to the Allegro Virtual Edition. If done, you can enable the Packet Ring Buffer as described in [[Ring Buffer Configuration Guide]].
Please note that a real time capture of packets require high write rates to your storage. Please use dedicated disks for the ring buffer to avoid performance issues on other virtual machines.
 
== Encapsulated Remote Mirroring (L3) Source ==


The Allegro Virtual Edition supports the VMware '''Encapsulated Remote Mirroring (L3) Source''' with the [[ERSPAN Installation|ERSPAN Mode]]. You can set up an IP address on the capture port and send encapsulated packets to the Allegro. Please see the Vsphere documentation center for Encapsulated Remote Mirroring (L3) Source.
The Allegro Virtual Edition supports the VMware '''Encapsulated remote mirroring (L3) source''' with the [[ERSPAN Installation|ERSPAN Mode]]. You can set up an IP address on the capture port and send encapsulated packets to the Allegro. Please see the Vsphere documentation center for Encapsulated remote mirroring (L3) source.

Latest revision as of 08:38, 26 October 2021

This guide describes how the Allegro Network Multimeter Virtual Edition can be set up with VMWare ESXI.

The Allegro Virtual Edition is designed for 2 use cases.

  1. It can analyze pcap captures or packet ring buffers of unlimited size for forensic investigation and/or
  2. it can analyze live traffic from virtual machines by a virtual Mirror Port or ERSPAN.

General

DISCLAIMER

Packet analysis is resource intensive. Running the Allegro Packets VM on your own hardware and its performance outcome is warranted “as is”. Our support will be limited.

Be aware that an activated ring buffer can (heavily) degrade the I/O performance for all VMs. It is strongly recommended to use one or more dedicated HDDs or SSDs for the ring buffer, to prevent side effects on other VMs.

System requirements

This guide requires a licensed VMWare ESXi 6.7.0 or newer.

The system requirement of the virtual machine is:

  • x86 64-Bit Intel/AMD CPU with SSE4.2 support (since 2011)
  • 4 CPU-Cores
  • at least 2GB RAM for the In-Memory-DB, the larger the better
  • 20GB free disk space

Virtual Machine image

Please contact Allegro or your reseller to download the current Allegro Virtual Edition installation zip archive.

Installation

Zip file extraction

Please extract the zip archive. It should contain the 3 files “allegro-multimeter.ovf”, “allegro-multimeter.vmdk” and “allegro-multimeter-virtualbox.ovf”. 

OVF deployment to VMWare ESXi

Log in to VMWare ESXi.

Esxi login.png

Once you have logged in, navigate to “Virtual Machines”

Esxi dashboard.png

Create a new VM with “Create / Register VM” and select the option “Deploy a virtual machine from an OVF or OVA file”.

Esxi create new vm.png

Press “Next”, use a preferred name for the Allegro and drag/drop the ovf and vmdk files into the window (as seen in the picture below) and press “Next”.

Esxi create new vm step 2.png

Select your data storage (20 GB is enough) for the Allegro. This storage will be used as the boot partition and to store the configuration of the Allegro Virtual Edition.

This partition/disk will NOT facilitate the packet ring buffer functionality. This does not require a high-speed disk.

Esxi create new vm select storage.png

The deployment options allow you to select the network mapping for the MGT port and the disk provisioning.

Esxi create new vm management.png

Please double-check all options in the next dialogue and press finish if everything is fine.

Esxi create new vm finish.png

The upload and import of the Allegro Virtual Edition will start. Please be patient until it is finished.

Esxi import.png

Packet ring buffer and pcap storage

For the ring buffer to work, you must add a "Hard disk 2" virtual disk (or more) to the Allegro Virtual Edition.

To do so, with a turned off VM, press “Edit” in the Vmware ESXi host and add a new (high speed) HDD.

Esxi add hdd.png

When done, power on the Allegro VM and go to menu GenericStorage, to check if the Allegro Network Multimeter has detected a storage device.

Here an example of 1 attached/configured disk:

Storage no device active.png

Here, on the GenericStorage page, you can prepare the disks to be used by the Allegro by clicking the "Format" button.

This will erase all content on the disk and create the filesystem for the Allegro. You can also activate and deactivate the storage device for pcap files here.

For more information on the ring buffer, please review the corresponding page here → Ring Buffer Configuration Guide.

Disclaimer: Be aware that an activated ring buffer can (heavily) degrade the I/O performance for all VMs.

It is strongly recommended to use one or more dedicated HDDs or SSDs for the ring buffer, to prevent side effects on other VMs.

Install USB License dongle

If the Allegro Virtual Edition is shipped with an USB License dongle, plug the dongle into an unused USB port of the VM host. The dongle must be connected to the virtual machine. When powered off, press “Edit” in the Vmware ESXi host and click on “Add other device”. Choose “USB device”. A new entry on the bottom of the hardware list appears. Please select a “Feitian HID Dongle” or similar.

License dongle.png

Initial startup

Powering on

Power on the virtual machine when the import has been successful. The Allegro Virtual Edition will boot, prepare the installation and reboot once. The VM will seek for an IP address via DHCP on the MGT port. Check the screen output for an assigned IP address.

Esxi allegro screen.png

You can now connect to the IP address with your browser, in our case https://10.54.0.220/ . The browser will show a certificate warning. Accept it to access the login screen.

Esxi allegro login.png

Please use the following login credentials; user “admin” and password “allegro”.

License

If the Allegro Virtual Edition was shipped with a USB License dongle and it has been correctly installed, the License is validated and the Allegro should activate.

The serial number of the Allegro Virtual Edition would be e.g. “dongle: 1234567890” and is displayed in the serial number box under “Settings” -> “License upload”. If it is not displayed even though the dongle has been correctly installed, please contact Allegro support.

If the Allegro Virtual Edition was shipped without an USB License dongle, please follow the following steps. In the web interface a warning is shown that the Allegro Virtual Edition does not yet have a License.

Esxi allegro license.png

Navigate to “Settings” -> “License upload” and send the system serial number to testlicense@allegro-packets.com.

Allegro Packets will issue a test License for you that can be installed by the “Upload new License button”.

Once the test License is applied, it will show you the License details similar to this output:

Esxi allegro license details.png

The Allegro Virtual Edition is now running and analyzes all packets on the capture port.

Mirroring virtual interface

The Allegro Virtual Edition has by default 2 network interfaces. The first port is used for Management, the second is used as capture port. The Allegro Virtual Edition will analyze all traffic received by this network port.

Please enable the promiscuous mode for the vwsitch to allow the Allegro Virtual Edition to monitor all packets from on a VMWare vswitch.

Esxi switch allow promicuous mode.png

Encapsulated remote mirroring (L3) source

The Allegro Virtual Edition supports the VMware Encapsulated remote mirroring (L3) source with the ERSPAN Mode. You can set up an IP address on the capture port and send encapsulated packets to the Allegro. Please see the Vsphere documentation center for Encapsulated remote mirroring (L3) source.