Hyper-V-Datacollector-Sheet
Introduction
The integration of hardware/software - hereinafter referred to as "system" - into the CIO Cockpit not only requires the registration of the systems themselves
but also the configuration of the data collection.
Data collection is set up centrally via the Data Collection Management (DCM).
Compatibility
Supported system versions
Windows systems from version 2012 R2 onwards are supported.
Requirements in the CIO Cockpit
In order to set up the data collection, all required elements must first be created in the administrative area of the CIO Cockpit web frontend:
- Create all nodes of the cluster (including the cluster node) as Windows servers (“Configuration -> Assets -> Add” and select as asset type in the following window “Microsoft -> Compute Hardware -> Windows”).
- Create the Hyper-V cluster as a VCluster (Configuration -> Virtualization -> vCluster -> Add) and under "Storage System" select all associated nodes (including cluster node) from the previous step.
- Create a hypervisor for the Hyper-V cluster (Configuration -> Virtualization -> Instances -> Add) and under "VCluster" add the VCluster created in the previous step.
Then the data collection for the Hyper-V cluster can be configured in the Data Collection Management.
Configuration notes for data collection management
| Feldname |
Erforderlicher Inhalt |
| IP |
IP address of the cluster node (e.g. "192.168.178.21") |
| Username |
Domain\Username of the CIO Cockpit user (e.g. "company\cockpit") |
| Password |
Password of the CIO Cockpit user for login |
| Cockpit Reference |
The entry created in the CIO Cockpit web frontend for the vCluster (is set automatically) |
| Description |
A short description of the created asset (free text field) |
| Cluster |
Hyper-V operating mode: cluster or standalone host |
| Script Output Path |
UNC-Path to the output file of the PowerShell script (e.g. \output$\cc-output.csv). Node- or Host-Name are not required in the path. |
System access
To access Windows hosts via powershell, both the cluster node and the nodes must be configured as described in
Configuration of Windows-Hosts via domain controller. All nodes must be in the same domain as the cluster.
System access
Network and Firewall
The following settings on the cluster node and all nodes are required for the data collector to communicate with the system:
| Source |
Destination |
Port (default) |
Protocol |
Direction |
Comment |
| datacollector-vm |
Hyper-V-Cluster-IP |
5985 (HTTP) / 5986 (HTTPS) |
TCP |
Outbound |
|
PowerShell Script
To execute the corresponding script, it must be created as a scheduled task via an additional Windows user.
The Windows user needs administrative Hyper-V permissions or administrator permissions. The login data of this Windows user remains unknown to the data collector.
The script for the standalone operating mode can be downloaded here (right click - "Save link as").
The script for the standalone operating mode can be downloaded here (right click - "Save link as").
Hint: Please do not rename the scripts because they are used in other scripts!
Create directory with share permissions
In order for the Hyper-V data collector to be able to retrieve the generated CSV file from the PowerShell scripts, the save path for this output file must be set as described in
Creation of shared directories for Windows Server with Hyper-V.
The shared directory can be specified by path when creating the datacollector in Datacollection Management.
The following scheme is used for this purpose: \SHAREDDIRECTORIES$\OUTPUTFILE.csv
Customize output path in script
In the downloaded script the variable "$filepath=" is changed to the file path that was created in the previous step
and the name of the output file is set.
An example of this is "C:\scripts\cc-collector\output\cc-output.csv".
Apply Scheduled Task
For the planned and regular execution of the scripts, a scheduled task as described in
Creation of a Scheduled Task for Windows Server with Hyper-V
must be created and configured.
Automated configuration via script
The steps above can be automated by the configuration script for Hyper-V as described in
Automatic configuration of windows servers with Hyper-V.
The prerequisite for this is the download of the Hyper-V scripts.
KPI scope of data collection
VMInventory
| KPI |
Details |
| timestamp |
Time stamp with microsecond accuracy of the host OS on which the data collector is running (UTC) |
| clusterID |
The CIO Cockpit ID of the virtualization cluster. Visible in the vCluster Overview in the CIO Cockpit Web Frontend |
| vCenterInstanceUUID |
The unique ID of the Hyper-V cluster (or the MAC-address of the host in standalone-mode) |
| vms |
A list of the unique IDs of all VMs within this cluster |
VMUsage
This data set is collected per VM.
| KPI |
Details |
| timestamp |
Time stamp with microsecond accuracy of the host OS on which the data collector is running (UTC) |
| clusterID |
The ID of the virtualization cluster. Visible in the vCluster Overview in the CIO Cockpit Web Frontend |
| vCenterInstanceUUID |
The unique ID of the Hyper-V cluster (or the MAC-address of the host in standalone-mode) |
| externalID |
The unique ID of the VM within this cluster |
| name |
The name of the VM defined by the user |
| cpuClockProvisioned |
The sum of the clock frequencies of the assigned vCPUs |
| ramProvisioned |
The allocated working memory (RAM) |
| storageProvisioned |
The allocated storage capacity |
| threads |
The number of assigned vCPUs |
| powerState |
„poweredOn“, „poweredOff“ |
| isTemplate |
false |
| List of usages |
see below |
List of usages
| KPI |
Details |
| storageUsed |
The currently used storage capacity (if fixed: equal to storageProvisioned) |
| ramUsed |
The currently used working memory (Ram) |
| cpuClockUsed |
The sum of the currently used clock frequencies of the assigned vCPUs |
| timestamp |
Time stamp with microsecond accuracy of the time of measurement for exactly this usage measurement (UTC) |
hostInventory
| KPI |
Details |
| hostName |
FQDN of host (e.g. myserver23.company.local) |
| hostType |
"computeHardware" |
| List of Partitionen |
No content |
| List of Disks |
No content |
| List of RAM-Modules |
Records describing the RAM modules installed in the host (see below) |
| List of CPUs |
Records describing the CPUs installed in the host (see below) |
List of RAM-Modules
| KPI |
Details |
| ramType |
Type of storage (e.g. „DRAM“) |
| ramClock |
Nominal clock frequency of the RAM module |
| ramSize |
Size of the installed RAM module |
List of CPUs
| KPI |
Details |
| cpuType |
Identifier defined by the manufacturer (e.g. "Intel Xeon E5-2609 @ 2.50 GHz") |
| cpuThreads |
Number of threads of the CPU |
| cpuCores |
Number of CPU cores in the CPU |
| cpuClock |
The nominal clock frequency of the CPU |
hostUsage
| KPI |
Details |
| timestamp |
Time stamp with microsecond accuracy of the host OS on which the data collector is running (UTC) |
| hostName |
FQDN of the host (e.g. gibson23.company.local) |
| cpuClockCapacity |
Total capacity of the clock frequencies of all cores of all CPUs installed in the asset |
| ramCapacity |
Total capacity of all RAM modules installed in the asset |
| threads |
Total number of threads of all CPUs built into the asset (including hyperthreading) |
| List of usages |
Resources used on the host at the time of measurement (see below) |
| uptime* |
Time since the last reboot in seconds |
| version |
Operating system version, (e.g. Windows Server 2016) |
| model |
Model name of the server, e.g. "Cisco Systems Inc UCSB-B200-M3 |
List of usages
| KPI |
Details |
| cpuClockUsed |
Clock frequencies used at this time for all cores of all CPUs installed in the Asset |
| ramUsed |
The amount of memory used by all RAM modules installed in the asset at that time |
| timestamp |
Time stamp with microsecond accuracy of the time of measurement for exactly this usage measurement (UTC) |
clusterUsage
| KPI |
Details |
| clusterID |
The ID of the virtualization cluster. Visible in the vCluster Overview in the CIO Cockpit Web Frontend |
| cpuClockCapacity |
Net computer resources of the cluster available to virtual machines. This is calculated by adding up the clock rates of all available CPUs multiplied by the number of threads they provide |
| ramCapacity |
Net available memory (RAM) of the cluster available to virtual machines |
| List of usages |
List of the resources used on the cluster at the time of measurement (see below) |
| timestamp |
Time stamp of the measurement time with microsecond accuracy (UTC) |
List of usages
| KPI |
Details |
| cpuClockUsed |
Use of available computer resources at the time of measurement |
| ramUsed |
Use of the available RAM resources at the time of measurement |
| timestamp |
Time stamp of the time of measurement with microsecond accuracy (UTC) |
StorageInventory
| KPI |
Details |
| assetID |
The CIO Cockpit ID of the asset. Visible in the asset overview of the CIO Cockpit Web Frontend |
| timestamp |
Time stamp with microsecond accuracy of the host OS on which the data collector is running (UTC) |
| List of disks |
All discs of the asset (see below) |
| List of Pools |
All Storage Pools of this asset. |
List of pools
| KPI |
Details |
| poolName |
Pool name |
| List of disks |
All Discs of the asset (see below) |
| List of StorageExports |
All storage exports of the asset |
List of disks
| KPI |
Details |
| type |
SAS, NL-SAS, EFD |
| capacity |
Total capacity of the entire memory of this disc type |
| count |
Number of all discs with exactly this combination of properties (type & capacity) |
List of storage exports
| KPI |
Details |
| uid |
Unique identifier of the export |
| sizeCommissioned |
Storage capacity exclusively allocated to the export and usable by one user |
| sizeUsed |
Use of the export on the asset including overhead |