Documentation Videos View Site

# Hyper-V Satellite Overview

The CMDB-360 Hyper-V Satellite provides visibility into the virtual machines managed by Microsoft Hyper-V hosts. Hyper-V is Microsoft’s hardware virtualization platform for virtual machines deployed in customer data centers and private clouds. The Hyper-V Satellite supports standalone Hyper-V hosts as well as clustered (highly available) deployments.

Important

The Hyper-V Satellite does not directly access any virtual machine running on your Hyper-V hosts, instead only accessing the Hyper-V host management interface (WS-Management / WinRM) to gather discovery and other details.

No proprietary asset information is stored on the CMDB-360 Base Station database…only simple rosters of discovered Hyper-V resources are recorded. CMDB-360 users (with proper permissions) may obtain additional details about a discovered resource via the CMDB-360 portal that is streamed from the Satellite to the Base Station and viewed on-demand.

The Hyper-V Satellite only requires read-only permissions to Hyper-V to gather all required CMDB details within the deployment.

Important

You must allow access to the Hyper-V host management interface over WinRM (typically port 5985/tcp for HTTP or 5986/tcp for HTTPS).

# Main Functions

The Hyper-V Satellite performs two core functions:

  • Discovers Hyper-V virtual machines and regularly sends non-sensitive resource details to the CMDB-360 Base Station for asset management.
  • Provides the CMDB-360 Base Station on-demand access to asset information without storing sensitive information outside the Hyper-V deployment.

# Managed Resources

The following Hyper-V resources are accessed:

  • Virtual Machines

For each discovered virtual machine, the Satellite captures attributes including:

  • Identity — the virtual machine name and its unique identifier
  • State & status — the current run state, status and detailed status, whether the VM is clustered (highly available), and whether it has been deleted
  • Uptime & lifecycle — current uptime and the date the VM was created
  • Compute — the number of virtual CPUs
  • Memory — startup, minimum, maximum, assigned and demand memory, and whether Dynamic Memory is enabled
  • Storage — the virtual disks attached to the VM
  • Networking — the virtual network interface cards (NICs) attached to the VM

Important

Please note that you may disable the discovery and access of any of these resource objects from the Satellite scheduler. You may also disable the ability to access additional details about a resource by disabling the Channel communication websocket as described below.

# Deployment / Installation

The Hyper-V Satellite may be installed or deployed in a number of different ways:

# 1) By Installing a Docker Image from Dockerhub

If you have a compute instance with Docker installed, you may install the Hyper-V Satellite using a container image from Dockerhub. Pull the Hyper-V Satellite Docker image and run the image as a container according to the instructions provided.

All updates to the Hyper-V Satellite will be delivered using the internal satellite update mechanism (used by all satellites), but you may also use Docker to pull the latest version (in which case you will have to re-configure it).

To learn more about installing the Hyper-V Satellite (or any Satellite) on a Docker host, see https://www.cmdb360.com/docs/?uri=Docker/Satellites/Install.html

# 2) By Using Universal Installer On Any Linux VM

You may provision any Linux compute instance running Oracle Linux 8+, Oracle Linux 9, Ubuntu 20.04, or Ubuntu 22.04 on ARM or x86_64 architecture and install the Hyper-V Satellite software using the Installer graphical utility or the AutoInstaller non-interactive utility (for scripts). The provisioned compute instance must have at least 1 OCPU and 4GB RAM along with at least 10GB Disk.

Warning

Please note that if you install any additional software (such as security tools), you must designate at least the required minimal resources to the Satellite for optimal performance.

You may obtain a link to the current Installer or AutoInstaller utilities (and documentation) from your CMDB-360 portal under the deployed Hyper-V Satellite details screen.

Note

The Installer/AutoInstaller utilities also perform the configuration described in the following section, so you may skip that step.

# Additional Notes On Deployment

CMDB-360 recommends that the Hyper-V Satellite be deployed and reside within the same IP space as your Hyper-V host(s) in order to keep all sensitive data within the customer’s network boundary. You may however install the Hyper-V Satellite in any other location that can reach the Hyper-V hosts.

# Configuration

The Hyper-V Satellite has a 2-step configuration process. First, as with any satellite, you must configure the Hyper-V Satellite to communicate with the CMDB-360 Base Station deployed for your company. Second, you must configure the Hyper-V Satellite to access the Hyper-V host(s) of your deployment.

# 1) Connection To Base Station

All satellites are connected to their respective CMDB-360 Base Station by the URL and Token values defined in the encrypted config.yml configuration file found in the base config directory of the satellite (/opt/satellite/etc by default). This configuration file is managed by the AdminTool utility which is found in the base of the satellite install directory (/opt/satellite by default).

Please see https://www.cmdb360.com/docs/?uri=OCI-satellite/OciSatelliteSetup/OciSatelliteSetup.html for instructions about setting up the Hyper-V Satellite to its respective Base Station.

Note

The Installer/AutoInstaller utilities perform this configuration step as part of the installation process, so you may skip this step.

# 2) Configure Connection To Hyper-V

The Hyper-V Satellite queries your Hyper-V host(s) for the CMDB details exposed by the Hyper-V management interface.

Enter the details of your Hyper-V host using the ConfigTool utility:

cd /opt/satellite/bin

./ConfigTool

Enter the Hyper-V Host IP or FQDN, Hyper-V User and User Password:

Click Save to save the changes. The Hyper-V Satellite will now automatically begin the discovery process and connect to your CMDB Base Station.