Introduction

In virtual infrastructures, especially in large data centers, ensuring high availability and eliminating single points of failure is crucial. Microsoft addresses this need with Failover Clustering technology, which can be implemented in a Hyper-V environment. This allows multiple Hyper-V hosts or nodes to take over the workload if one host fails, ensuring service continuity.

Although Hyper-V primarily manages resources at the physical machine level, Microsoft Failover Clustering provides protection for virtual machines by minimizing downtime during failures. Failover Clustering operates alongside Hyper-V, offering enhanced resilience. It uses its dedicated Failover Cluster Manager for administration, allowing streamlined management of clustered nodes and ensuring virtual machine availability in the event of host failure.

Key Use cases

Discovery Use cases

  • It discovers the Windows Hyper-V Cluster components.
  • Publishes relationships between resources to have a topological view and ease of maintenance.

Monitoring Use cases

  • Provides metrics related to job scheduling time and status etc.
  • Concern alerts will be generated for each metric to notify the administrator regarding the issue with the resource.

Supported Target Versions

Validated the application by executing powershell script against "Microsoft Windows Server 2019 Datacenter 10.0.17763 Build 17763.3770"

Prerequisites

On Gateway

  • OpsRamp Classic Gateway(Linux) 14.0.0 and above.
  • OpsRamp NextGen Gateway 14.0.0 and above.
  • It is recommended to use the latest Gateway version for full coverage of recent bug fixes, enhancements, and improvements.

On Target Cluster / Standalone Nodes

The following prerequisites are required for a non-admin user:

Add Windows Domain Permissions

  • The Windows domain user should be added to the Performance Monitor Users group to fetch performance counter metrics.
net localgroup "Performance Monitor Users" /add <user>

Grant Remote DCOM Rights

  • To grant users DCOM rights, log on to each monitored system and complete the following procedure:
    1. Go to command prompt and enter dcomcnfg.
    2. Navigate to Component Services > Computers > My Computer and then right click and select Properties. Then go to the COM Security tab.
    3. Under Access Permissions, go to edit limits and add the domain non-admin user and enable both local and remote access then click OK.
    4. In Launch and Activation permissions, go to edit limits, add the domain non-admin user and check all boxes, and click OK.

Grant Remote WMI Rights

  • To give the user remote WMI rights, log on to each system to be monitored and complete the following procedure:
    1. Go to computer management, under Services and Applications select WMI Control.
    2. Right-click WMI control and go to Properties. Select the Security tab.
    3. Select root and click Security.
    4. Add the domain non-admin user, and select execute methods, enable account, remote enable, and reas security checkboxes.
    5. Click Advanced, select added non-admin domain user and click Edit. Then for Applies, select namespace and sub namespaces from the dropdown.
    6. Click OK three times.
  • Windows domain user should be granted read-only access to cluster
    Grant-ClusterAccess -User <domain\user> -Readonly
  • Open ports and add user in all nodes and clusters.
    • OpsRamp Gateway should be able to access cluster and nodes.
    • Ports to be opened are 5985 and 5986.
  • Import Failover cluster module by running the following commands in nodes and cluster.
    • Install-WindowsFeature -Name FailOver-Clustering -IncludeManagementTools

    • Import-Module failovercluster
  • The following prerequisites enable monitoring of Hyper-V guest VM and virtual switch resources with a non-administrator user account.
    • Option 1: Using Computer Management (GUI)
      1. Click Start → Run, type lusrmgr.msc, and click OK.
      2. In Local Users and Groups, select Groups, then choose Hyper-V Administrators.
      3. Right-click Hyper-V Administrators and select Properties.
      4. Click Add, enter the local user account name, click Check Names, and then click OK.
      5. Click Apply, then OK. Close the Properties window and restart Windows to apply the changes.
    • Option 2: Using PowerShell (Recommended)

      Run PowerShell as Administrator.

      • To add a domain user:
        Add-LocalGroupMember -Group "Hyper-V Administrators" -Member "DOMAIN\username"
      • To add a local user:
        Add-LocalGroupMember -Group "Hyper-V Administrators" -Member "username"
      • Command to verify:
        Get-LocalGroupMember "Hyper-V Administrators"

      Connection Modes

      Starting from Windows HyperV Cluster version 9.1.0, you can select the connection mode. The options available are:

      1. PowerShell (existing)
      2. OpenSSH (new)

      If PowerShell is selected as ConnectionMode:

      The windows domain user should have following permissions and configurations to establish a successful connection between the Gateway and the target machine using PowerShell remoting.

      • Enable PowerShell Remoting on the target machine using the following command:
        
Enable-PSRemoting -Force
      • Add the user to the Remote Management Users group to allow remote management of the target machine.
        
net localgroup "Remote Management Users" /add
      • Add OpsRampGatewayIp to the TrustedHosts list on the target machine to allow the PowerShell connection from the Gateway to the target machine.
        • To add TrustedHosts, use the following command:
          • To allow any host:
            Set-Item WSMan:\localhost\Client\TrustedHosts -Force -Value *
          • To allow a specific host:
            Set-Item WSMan:\localhost\Client\TrustedHosts -Force -Concatenate -Value
        • Set up and restart the WinRM service for the changes to take effect.
          • To set up:
            
Set-Service WinRM -StartMode Automatic
          • To restart:
            
Restart-Service -Force WinRM
      • Ports 5985 and 5986 must be opened on all nodes and clusters for PowerShell remoting.
      • Verify connectivity from the Gateway to the target machine using the following command:
        
telnet  5985/5986
      • The user should be added on all nodes and clusters.
      • Ensure that the provided IP address/host name and credentials are valid and accessible for successful integration. Verify connectivity from the Gateway using the following steps:
        • Launch PowerShell using the following command:
          
pwsh
        • Run the following commands to establish the connection using the details of your end device:
          
$pw = ConvertTo-SecureString -AsPlainText -Force -String ""

$cred = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList "", $pw

$session = New-PSSession -ComputerName "" -Credential $cred -Authentication Negotiate -ErrorAction Stop
        • Check the session state:
          
$session.State

      If OpenSSH is selected as ConnectionMode:

      • OpenSSH must be installed and configured on the target Windows machine.

      • Password authentication must be enabled in SSH config: PasswordAuthentication yes

        • Edit sshd_config (run PowerShell as Administrator)
        • notepad C:\ProgramData\ssh\sshd_config (Note: If not at this location, locate the correct path for sshd_config and perform the following step)
          • Find the line #PasswordAuthentication yes (or PasswordAuthentication no), uncomment it and set it to yes, then click Save.
          • Find the line AllowUsers (or add it if missing) and set it to - AllowUsers <ssh-username>
          • Save the file.
        Restart-Service sshd`

      • Ensure the sshd service startup type is Automatic

        Set-Service -Name sshd -StartupType Automatic`

      • Set the OpenSSH default shell to powershell.exe using the following command on all the nodes

      Set-ItemProperty -Path "HKLM:\SOFTWARE\OpenSSH" -Name DefaultShell -Value "$PSHOME\powershell.exe"; Restart-Service sshd
      • Open default SSH port 22 on all the nodes and clusters for OpenSSH connection.
      • The user should be added in all the target nodes & cluster

      Hierarchy of Windows Hyper-V Cluster

        For Windows Hyper-V Cluster, Hierarchy is as follows
        • Windows HyperV Cluster
          • Windows HyperV Server
            • Windows HyperV Virtual Switch
            • Windows HyperV Host Disk
            • Windows HyperV Guest VM
          • Windows HyperV Cluster Role
          • Windows HyperV Cluster Shared Volume
          • Windows HyperV Cluster Disk
        For Windows Hyper-V Standalone Server, Hierarchy is as follows
        • Windows HyperV Server
          • Windows HyperV Virtual Switch
          • Windows HyperV Host Disk
          • Windows HyperV Guest VM

      Supported Metrics

      Click here to view the supported metrics
      Native TypeMetric NameDisplay NameMetric LabelUnitsApplication VersionDescription
      Windows HyperV Clusterwindows_hyperv_cluster_network_Statewindows HyperV Cluster Network StateAvailability-1.0.0HyperV cluster network state.Possible states are:Unavailable: 0, Down: 1, Partitioned: 2, Unknown: 3, Up: 4
      windows_hyperv_cluster_OnlineNodesCountWindows HyperV Cluster Online Nodes CountAvailabilitycount1.0.0HyperV cluster online nodes count
      windows_hyperv_cluster_NodeHealthWindows HyperV Cluster Node HealthAvailability%1.0.0HyperV cluster node health.
      Windows HyperV Serverwindows_hyperv_server_IdleCPUUtilizationWindows HyperV Server Idle CPU UtilizationUsage%1.0.0HyperV server idle cpu utilization
      windows_hyperv_server_NetworkAdaptersBytesTotalPerSecWindows HyperV Server Network Adapter Total BytesPerSecPerformanceBps4.0.0This metric measures how many bytes of data are transferred or processed per second.
      windows_hyperv_server_LegacyNetworkAdaptersBytesReceivedPerSecWindows HyperV Server Legacy Network Adapter Received BytesPerSecPerformanceBps4.0.0This metric measures the number of bytes received per second by a network adapter, particularly in older or legacy network hardware.
      windows_hyperv_server_LegacyNetworkAdaptersBytesSentPerSecWindows HyperV Server Legacy Network Adapter Bytes Sent PerSecPerformanceBps4.0.0This metric provides insight into how much data is being sent out by the network adapter over a period of one second.
      windows_hyperv_server_LegacyNetworkAdaptersBytesDroppedWindows HyperV Server Legacy Network Adapter Bytes DroppedPerformanceBps4.0.0The total amount of data (in bytes) that was sent to a network adapter but could not be processed or successfully transmitted due to various reasons, and therefore was "dropped".
      windows_hyperv_server_LegacyNetworkAdaptersFramesSentPerSecWindows HyperV Server Legacy Network Adapter Frames Sent PerSecPerformancepackets/sec4.0.0This metric refers to the rate at which network frames (packets) are transmitted by a legacy network adapter, measured in frames per second.
      windows_hyperv_server_SwapMemoryUsageInGBWindows HyperV Server Swap Memory Usage in GBUsageGB/sec4.0.0This metric measures the virtual memory that the operating system uses to extend physical RAM (Random Access Memory) when it is fully utilized.
      windows_hyperv_disk_LogicalDiskTransferPerSecWindows HyperV Server Logical Disk Bytes Per SecPerformanceBps4.0.0This metric measures the rate at which thedata byte is being transferred to or from a logical disk.
      windows_hyperv_disk_LogicalDiskQueueLengthWindows HyperV Server Logical Disk Queue LengthPerformance4.0.0This metric provides insight into how many read and write requests are queued up at any given time, waiting to be serviced by the disk.
      windows_hyperv_disk_UtilizationWindows HyperV Server Disk UtilizationUsage%4.0.0This metric provides insight into how much of the disk's capacity is being used for I/O operations.
      windows_hyperv_disk_LogicalDiskBytesPerSecWindows HyperV Server Logical DiskTransfer Per SecPerformanceIOPS4.0.0This metric measures the rate at which data is being transferred to or from a logical disk.
      windows_hyperv_server_PhysicalMemoryUtilizationWindows HyperV Server Physical Memory UtilizationUsage%5.0.0HyperV server physical memory utilization
      windows_hyperv_server_GuestCPUUtilizationWindows HyperV Server Guest CPU UtilizationUsage%1.0.0The percentage of time spent by the virtual processor in guest code.
      windows_hyperv_server_HypervisorCPUUtilizationWindows HyperV Server Hypervisor CPU UtilizationUsage%1.0.0The percentage of time spent by the virtual processor in hypervisor code.
      windows_hyperv_server_TotalCPUUtilizationWindows HyperV Total CPU UtilizationUsage%1.0.0The percentage of time spent by the virtual processor in guest and hypervisor code.
      windows_hyperv_server_system_services_HealthStateWindows HyperV System Services Health StateAvailability1.0.0HyperV system services health state.Possible values are - 0 : Unknown , 5 : OK , 10 : Degraded/Warning , 15 : Minor failure , 20 : Major failure , 25 : Critical failure , 30 : Non-recoverable error , 35 : DMTF Reserved
      windows_hyperv_server_AvailableMBytesWindows HyperV Server Available MBytesPerformanceMB1.0.0HyperV server available Mbytes.
      windows_hyperv_server_PageFileUsageWindows HyperV Server Page File UsageUsageGB1.0.0HyperV server page file usage.
      windows_hyperv_server_VirtualTLBPagesWindows HyperV Server Virtual TLB PagesPerformancecount1.0.0HyperV server virtual TLB pages.
      windows_hyperv_server_DepositedPagesWindows HyperV Server Deposited PagesPerformancecount1.0.0HyperV server deposited pages.
      windows_hyperv_server_TotalPhysicalMemoryWindows HyperV Server Total Physical MemoryPerformanceGB1.0.0HyperV server total physical memory.
      windows_hyperv_server_Virtual_MemoryWindows HyperV Server Virtual MemoryPerformanceGB1.0.0HyperV server virtual memory
      windows_hyperv_server_TotalRemotePhysicalPagesWindows HyperV Server Total Remote Physical PagesPerformancecount1.0.0HyperV server total remote physical pages.
      windows_hyperv_server_NetworkAdaptersBytesReceivedWindows HyperV Server Network Adapter BytesReceivedPerSecPerformanceBps1.0.0HyperV network adapter bytes received per second.
      windows_hyperv_server_NetworkAdaptersPacketsSentWindows HyperV Server Network Adapter Packets SentPerformanceBps1.0.0HyperV network adapter bytes received per second.
      windows_hyperv_server_NetworkAdaptersBytesSentWindows HyperV Server Network Adapter Bytes SentPerformanceBps1.0.0HyperV network adapter bytes sent.
      windows_hyperv_server_NetworkAdaptersPacketsReceivedWindows HyperV Server Network Adapter Packets ReceivedPerformancepackets/sec1.0.0HyperV network adapter packets received.
      windows_hyperv_server_NetworkAdaptersPacketsWindows HyperV Server Network Adapter PacketsPerformancepackets/sec1.0.0HyperV network adapter packets per second.
      Windows HyperV Virtual Switch
      windows_hyperv_server_VirtualSwitchStatusWindows HyperV Server Virtual Switch StatusAvailability8.0.0HyperV virtual switch status. Possible values are OK: 0, ERROR: 1, DEGRADED: 2, UNKNOWN: 3, PRED FAIL: 4, STARTING: 5, STOPPING: 6, SERVICE: 7, STRESSED: 8, NONRECOVER: 9, NO CONTACT: 10, LOST COMM: 11
      windows_hyperv_server_VirtualSwitchHealthStateWindows HyperV Server Virtual Switch Health StateAvailability8.0.0HyperV virtual switch health state. Possible values are OK : 5, MAJOR FAILURE : 20, CRITICAL FAILURE : 25 , OTHER : 1
      windows_hyperv_server_VirtualSwitchPacketsReceivedWindows HyperV Server Virtual Switch Packets ReceivedPerformancepackets/sec1.0.0HyperV virtual switch packets received per second.
      windows_hyperv_server_VirtualSwitchBytesReceivedWindows HyperV Server Virtual Switch Bytes ReceivedPerformanceBps1.0.0HyperV virtual switch bytes received per second.
      windows_hyperv_server_VirtualSwitchPacketsWindows HyperV Server Virtual Switch PacketsPerformancepackets/sec1.0.0HyperV virtual switch packets per second.
      windows_hyperv_server_VirtualSwitchBytesSentWindows HyperV Server Virtual Switch Bytes SentPerformanceBps1.0.0HyperV virtual switch bytes sent per second.
      windows_hyperv_server_VirtualSwitchBytesWindows HyperV Server Virtual Switch BytesPerformanceBps1.0.0HyperV virtual switch bytes per second.
      windows_hyperv_server_VirtualSwitchPacketsSentWindows HyperV Server Virtual Switch Packets SentPerformancepackets/sec1.0.0HyperV virtual switch packets sent per second.
      Windows HyperV Host Diskwindows_hyperv_disk_PhysicalDiskTransferPerSecWindows HyperV Disk Physical Disk Transfer Per SecPerformanceIOPS1.0.0HyperV physical disk transfers per second.
      windows_hyperv_disk_PhysicalDiskQueueLengthWindows HyperV Disk Physical Disk Queue LengthPerformance1.0.0HyperV physical disk queue length.
      windows_hyperv_disk_PhysicalDiskBytesPerSecWindows HyperV Disk Physical Disk Bytes Per SecPerformanceBps1.0.0HyperV physical disk bytes per second.
      windows_hyperv_disk_PhysicalDiskReadBytesPersecWindows HyperV Disk Physical Disk Read Bytes Per SecPerformanceBps1.0.0HyperV physical disk read bytes per second.
      windows_hyperv_disk_PhysicalDiskReadsPersecWindows HyperV Disk Physical Disk Reads Per SecPerformanceBps1.0.0HyperV physical disk reads per second.
      windows_hyperv_disk_PhysicalDiskWritesPersecWindows HyperV Disk Physical Disk Writes Per SecPerformanceBps1.0.0HyperV physical disk writes per second.
      windows_hyperv_disk_PhysicalDiskWriteBytesPersecWindows HyperV Disk Physical Disk Write Bytes Per SecPerformanceBps1.0.0HyperV physical disk write bytes per second.
      windows_hyperv_disk_HealthStatusWindows HyperV Disk Health StatusAvailability1.0.0HyperV disk health status. Possible states are: 'Unknown': 0 ,'Failing' : 1, 'Failed' : 2, 'Healthy' : 3
      windows_hyperv_disk_OperationalStatusWindows HyperV Disk Operational StatusAvailability1.0.0HyperV disk operational status. Possible statuses are: 'Unknown': 0, 'Not Ready': 1, 'No Media' : 2, 'Offline' : 3, 'Failed': 4, 'Missing' : 5, 'Online': 6
      Windows HyperV Guest VMwindows_hyperv_guestvm_SnapshotCountWindows HyperV GuestVM Snapshot CountAvailabilityCount7.0.0Windows HyperV GuestVM Snapshot Count
      windows_hyperv_guestvm_SnapshotAgeWindows HyperV GuestVM Snapshot AgeAvailabilityDays7.0.0Windows HyperV GuestVM Snapshot Age
      windows_hyperv_guestvm_CpuUtilizationWindows HyperV GuestVM CPU UtilizationUsage%1.0.0HyperV guest VM cpu utilization.
      windows_hyperv_guestvm_replicationStateWindows HyperV GuestVM Replication StateAvailability-6.0.0HyperV Guest VM Replication State.Possible values are ERROR : 0,FAILOVERWAITINGCOMPLETION : 1,FAILEDOVER : 2,NOTAPPLICABLE : 3,READYFORINITIALREPLICATION : 4,REPLICATING : 5,RESYNCHRONIZING : 6,RESYNCHRONIZESUSPENDED : 7,SUSPENDED : 8,SYNCEDREPLICATIONCOMPLETE : 9,WAITINGFORINITIALREPLICATION : 10,WAITINGFORSTARTRESYNCHRONIZE : 11
      windows_hyperv_guestvm_replicationHealthWindows HyperV GuestVM Replication HealthAvailability-6.0.0HyperV Guest VM Replication Health.Possible values are : NORMAL : 0,WARNING : 1,CRITICAL : 2
      windows_hyperv_guestvm_StateWindows HyperV GuestVM StateAvailability1.0.0HyperV guest VM state.Possible values are: Off : 0, Other: 1, Stopping: 2, Saved: 3, Paused: 4, Starting: 5, Reset: 6, Saving: 7, Pausing: 8, Resuming: 9, FastSaved: 10, FastSaving: 11, ForceShutdown: 12, ForceReboot: 13, Hibernated: 14, RunningCritical: 15, OffCritical: 16, StoppingCritical : 17, SavedCritical: 18 PausedCritical: 19, StartingCritical: 20, ResetCritical: 21, SavingCritical: 22, PausingCritical: 23, ResumingCritical: 24, FastSavedCritical: 25, FastSavingCritical: 26, Running: 27
      windows_hyperv_guestvm_diskUsageWindows HyperV GuestVM Disk UsageUsageMB1.0.0HyperV guest VM disk usage
      Windows HyperV Cluster Rolewindows_hyperv_role_RunningStatusWindows HyperV Role Running StatusAvailability1.0.0HyperV cluster role running status.Possible values: Online : 0, Offline : 1, Failed : 2, PartialOnline : 3, Pending : 4, Unknown : 5
      windows_hyperv_role_FailoverStatusWindows HyperV Role Failover StatusAvailability1.0.0HyperV cluster role failover status. Possible values - No Failover: 0, Failover: 1
      Windows HyperV Cluster Shared Volumewindows_hyperv_csv_UtilizationWindows HyperV CSV UtilizationUsage%1.0.0HyperV cluster shared volume utilization.
      windows_hyperv_csv_UsageWindows HyperV CSV UsageUsageGB1.0.0HyperV cluster shared volume usage.
      windows_hyperv_csv_OperationalStatusWindows HyperV CSV Operational StatusAvailability1.0.0HyperV cluster shared volume operational status. Possible values: Offline : 0, Failed : 1, Inherited : 2, Initializing : 3, Pending : 4, OnlinePending : 5, OfflinePending : 6, Unknown : 7, Online : 8.
      Windows HyperV Cluster Diskwindows_hyperv_clusterdisk_StateWindows HyperV Cluster Disk State1.0.0HyperV cluster disk state. Possible values: Offline : 0, Failed : 1, Inherited : 2, Initializing : 3, Pending : 4, OnlinePending : 5, OfflinePending : 6, Unknown : 7, Online : 8

      Default Monitoring Configurations

      Windows-hyper v-cluster has default Global Device Management Policies, Global Templates, Global Monitors and Global Metrics in OpsRamp. You can customize these default monitoring configurations as per your business use cases by cloning respective Global Templates and Global Device Management Policies. We recommend doing this activity before installing the application to avoid noise alerts and data.

      1. Default Global Device Management Policies

        You can find the Device Management Policy for each Native Type at Setup > Resources > Device Management Policies. Search with suggested name in global scope. Each Device Management Policy follows below naming convention:

        {appName nativeType - version - Mode}

        Ex: windows-hyperv-cluster Windows HyperV Cluster - 1 - Cluster(i.e, appName = windows-hyperv-cluster, nativeType =Windows HyperV Cluster, version = 1, Mode = Cluster)

      2. Default Global Templates

        You can find the Global Templates for each Native Type at Setup > Monitoring > Templates. Search with suggested names in global scope. Each template follows below naming convention:

        {appName Mode nativeType 'Template' - version}

        Ex: windows-hyperv-cluster Cluster Windows HyperV Cluster Template - 1 (i.e, appName = windows-hyperv-cluster , nativeType = Windows HyperV Cluster, version = 1, Mode = Cluster)

      3. Default Global Monitors

        You can find the Global Monitors for each Native Type at Setup > Monitoring > Monitors. Search with suggested name in global scope. Each Monitors follows below naming convention:

        {monitorKey appName nativeType - version}

        Ex: Windows HyperV Cluster Monitor windows-hyperv-cluster Windows HyperV Cluster 1 (i.e, monitorKey = Windows HyperV Cluster Monitor, appName = windows-hyperv-cluster , nativeType = Windows HyperV Cluster , version= 1)

      Configure and Install the Windows HyperV Cluster Integration

      1. To select your client, navigate to All Clients, and click the Client/Partner dropdown menu.
        Note: You may either type your client’s name in the search bar or select your client from the list.
      2. Navigate to Setup > Account. The Account Details screen is displayed.
      3. Click Integrations. The Installed Integrations screen is displayed with all the installed applications.
        Note: If you do not have any installed applications, you will be navigated to the Available Integrations and Apps page with all the available applications along with the newly created application with the version.
      4. Click + ADD on the Installed Integrations page. Note: Search for the integration either by entering the name of the integration in the search bar or by selecting the category of the integration from the All Categories dropdown list.
      5. Click ADD in the Windows HyperV Cluster application.
      6. In the Configuration page, click + ADD. The Add Configuration page appears.
      7. Enter the following BASIC INFORMATION:
      Field NameDescriptionField Type
      NameEnter the name for the configuration.String
      Modechoose Cluster or Standalone based the providing Windows HyperV configuration.
      • Cluster: If provided Windows HyperV is a cluster.
      • Standalone: If provided Windows HyperV is a standalone server
      		Dropdown
      IP Address/Host Name of Hyper-V clusterEnter the IP address/host name of the Hyper-V Cluster. It should be accessible from Gateway.String
      Is SecureSelect this checkbox if you want the communication between your system and the specified endpoint to be secured using protocols such as HTTPS (HTTP over SSL/TLS).
      Default Selection:7 When selected, it signifies that the connection is encrypted, providing an added layer of security to the data being transmitted.      		Checkbox
      Windows Cluster CredentialsSelect the credential associated with your account. If you want to use the existing credentials, select them from the Select Credentials dropdown. Else, click + Add to create credentials. The ADD CREDENTIAL window is displayed. Enter the following information.
      • Name: Credential name.
      • Description: Brief description of the credential.
      • User Name: User name.
      • Password: Password.
      • Confirm Password: Confirm password
      		Dropdown
      Connection ModeChoose PowerShell or Open SSH based on the connection type with target device.
      Note: PowerShell-based communication is planned for removal in upcoming releases due to security vulnerabilities. Migration to OpenSSH is recommended for continued support and improved security.      		Dropdown
      App Failure NotificationsWhen selected, you will be notified in case of an application failure such as Connectivity Exception, Authentication Exception.Checkbox
      Request TimeoutsSelect the checkbox to configure the timeout settings for NativeBridge connections and script execution requests made by the integration to the end device.Checkbox
      Connection TimeOut In MinsSelect the maximum time, in minutes, that the integration should wait while establishing a connection with the nativeBridge.

      Default value: 10 minutes

      		Dropdown
      Connection Request TimeOut In MinsSelect the maximum time, in minutes, required to process a NativeBridge HTTP call, from sending the request to receiving the response.

      Default value: 10 minutes

      		Dropdown
      Socket Timeout In MinsSelect the maximum allowable time of inactivity between two data packets during data exchange with the server.

      Default value: 10 minutes

      		Dropdown
      Script Execution TimeOut In MinsSelect the maximum time, in minutes, that the integration should wait while establishing a connection with the nativeBridge.

      Default value: 10 minutes

      		Dropdown
      1. CUSTOM ATTRIBUTES: Custom attributes are the user-defined data fields or properties that can be added to the preexisting attributes to configure the integration.
      Field NameDescriptionField Type
      Custom AttributeSelect the custom attribute from the dropdown. You can add attributes by clicking the Add icon (+).Dropdown
      ValueSelect the value from the dropdown.Dropdown

      Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).

      1. In the RESOURCE TYPE section, select:

        • ALL: All the existing and future resources will be discovered.
        • SELECT: You can select one or multiple resources to be discovered.

      2. In the DISCOVERY SCHEDULE section, select recurrence pattern to add one of the following patterns:

        • Minutes
        • Hourly
        • Daily
        • Weekly
        • Monthly

      3. Click ADD.

      4. Now the configuration is saved and displayed on the configurations page after you save it. From the same page, you may Edit and Remove the created configuration..

      5. Click NEXT.

      6. In the Installation page, select an existing registered profile, and click FINISH.

      Hpe3par

      The application is now installed and displayed on the Installed Integration page. Use the search field to find the installed application.

      Modify the Configuration

      View the Windows HyperV Cluster Details

      1. Navigate to Infrastructure > Search > Virtualization > Windows HyperV Cluster. The search result is displayed.
      2. Click anywhere in the row. A slide-out appears displaying the resource summary. It also has the Overview, Related Resources, and Custom Attributes tabs.
      Hyper V Cluster on Infrastructure screen
      1. Click the resource name. The resources details screen is displayed.
      2. Click the ATTRIBUTES tab to view the discovery details.
      Windows Hyper V cluster - resource details screen

      View resource metrics

      To confirm Windows HyperV Cluster monitoring, review the following:

      • Metric graphs: A graph is plotted for each metric that is enabled in the configuration.
      • Alerts: Alerts are generated for metrics that are configured as defined for integration.
      1. Click the METRICS tab to view the metric details for Windows HyperV Cluster.
      Windows Hyper V graph

      Resource Filter Input Keys

      Click here to view the Resource Filter Input Keys
      Resource TypeSupported Input Key
      All TypesresourceName
      hostName
      aliasName
      dnsName
      ipAddress
      macAddress
      os
      make
      model
      serialNumber
      Windows HyperV ClusterDomain
      SharedVolumesRoot
      Description
      Windows HyperV ServerRoot Resource UUID
      (Note: Only for "Cluster" persona)
      Root Resource IPAddress
      (Note: Only for “Cluster” persona)
      Root Resource Name
      (Note: Only for “Cluster” persona)
      Root Resource HostName
      (Note: Only for “Cluster” persona)
      Windows HyperV Virtual Switchdescription
      Root Resource UUID
      Root Resource IPAddress
      Root Resource Name
      Root Resource HostName
      Root Resource SerialNumber
      (Note: Only for “Standalone” persona)
      Windows HyperV Host DiskNumberOfPartitions
      ProvisioningType
      PartitionStyle
      DiskNumber
      Root Resource UUID
      Root Resource IPAddress
      Root Resource Name
      Root Resource HostName
      Root Resource SerialNumber
      (Note: Only for “Standalone” persona)
      Windows HyperV Guest VMPath
      CreationTime
      ProcessorCount
      IsClustered
      Root Resource UUID
      Root Resource IPAddress
      Root Resource Name
      Root Resource HostName
      Root Resource SerialNumber
      (Note: Only for “Standalone” persona)
      Windows HyperV Cluster RoleIsCoreGroup
      OwnerNode
      Root Resource UUID
      Root Resource IPAddress
      Root Resource Name
      Root Resource HostName
      Root Resource SerialNumber
      Windows HyperV Cluster DiskOwnerGroup
      OwnerNode
      ResourceType
      Root Resource UUID
      Root Resource IPAddress
      Root Resource Name
      Root Resource HostName
      Root Resource SerialNumber
      Windows HyperV Cluster Shared VolumeOwnerNode
      FriendlyVolumeName
      FileSystem
      Root Resource UUID
      Root Resource IPAddress
      Root Resource Name
      Root Resource HostName
      Root Resource SerialNumber

      Supported Alert Custom Macros

      Customise the alert subject and description with below macros then it will generate alert based on customisation.
      Supported macros keys:

      • ${resource.name}
      • ${resource.ip}
      • ${resource.mac}
      • ${resource.aliasname}
      • ${resource.os}
      • ${resource.type}
      • ${resource.dnsname}
      • ${resource.alternateip}
      • ${resource.make}
      • ${resource.model}
      • ${resource.serialnumber}
      • ${resource.systemId}
      • ${Custome Attributes in the resource}
      • ${parent.resource.name}

      Risks, Limitations & Assumptions

      • The integration can manage critical/recovery failure alerts for the following two scenarios when the user activates App Failure Notifications in the settings:
        • Connectivity Exception
        • Authentication Exception
      • Application will not send any duplicate/repeat failure alert notification until the already existing critical alert is recovered.
      • Using metrics for monitoring the resources and generating alerts when the threshold values are breached.
      • Application cannot control monitoring pause/resume actions based on above alerts.
      • This application supports both Classic Gateway and NextGen Gateway.
      • Not supported with Cluster Gateway.
      • The Template Applied Time will only be displayed if the collector profile (Classic and NextGen Gateway) is version 18.1.0 or higher.
      • For a Windows HyperV cluster, If Standalone Mode is selected part of configuration, only Windows HyperV Server will get created/updated. Windows HyperV Cluster wont be discovered and will get deleted if already exists.
      • Latest snapshot metric support from gateway version 14.0.0.
      • Component level thresholds can be configured on each resource level.
      • For successful discovery, the integration configuration must include an FQDN that the gateway can resolve.
      • In Windows Hyper-V Server, the following legacy network metrics are populated exclusively for Gen1 virtual machines that have a legacy NIC configured as the primary adapter:
        • windows_hyperv_server_LegacyNetworkAdaptersFramesSentPerSec
        • windows_hyperv_server_LegacyNetworkAdaptersBytesDropped
        • windows_hyperv_server_LegacyNetworkAdaptersBytesSentPerSec
        • windows_hyperv_server_LegacyNetworkAdaptersBytesReceivedPerSec

      Version History

      Application VersionBug fixes / Enhancements
      9.1.0Added OpenSSH support to the application to enable seamless and secure integration with target Microsoft SQL Server resources. This feature can be enabled from the Configuration page by selecting the appropriate option under the Connection Mode setting.
      Note: PowerShell-based communication is planned for removal in upcoming releases due to security vulnerabilities. Migration to OpenSSH is recommended for continued support and improved security.
      9.0.1Fixed an issue that caused unintended deletion of “Windows HyperV Guest VM” resources.
      9.0.0
      • Addressed an issue with IP address mapping for the "Standalone" persona when an FQDN is provided in the configuration.
      • Corrected parsing logic for the following legacy network metrics under NativeType: Windows HyperV Server.
        Note: These metrics will populate only for Gen1 VMs using a Legacy NIC as the primary adapter. They will not populate for Gen1 VMs using synthetic adapters or for Gen2 VMs.
        • windows_hyperv_server_LegacyNetworkAdaptersFramesSentPerSec
        • windows_hyperv_server_LegacyNetworkAdaptersBytesDropped
        • windows_hyperv_server_LegacyNetworkAdaptersBytesSentPerSec
        • windows_hyperv_server_LegacyNetworkAdaptersBytesReceivedPerSec
      • Corrected data conversion mapping and descriptions for the following metrics:
        • Under NativeType: Windows HyperV Cluster Role:
          windows_hyperv_role_RunningStatus
          windows_hyperv_role_FailoverStatus
        • Under NativeType: Windows HyperV Server
          windows_hyperv_server_system_services_HealthState
      8.0.1Enhanced the discovery and monitoring scripts to include more meaningful DEBUG logs. Additionally, added null checks and improved JSON parsing validations in the SDK application parsing logic.
      8.0.0
      • Added support for the following metrics under Windows HyperV Virtual Switch
        • windows_hyperv_server_VirtualSwitchHealthState
        • windows_hyperv_server_VirtualSwitchStatus
      • Node IP is set by filtering networks with the ClusterAndClient role.
      7.0.1Removed resourceName prefix from the attributes make & model for native type Windows HyperV Server.
      7.0.0
      • Snapshot Count , Aging Metrics Support for Hyper-V Guest VMs and Script Timeouts, NativeBridge Timeout Requests Support in the UI.
      • Support for Root Resource UUID Custom Attribute to the Child Resources.
      6.0.0
      • Support for monitoring replication health and status metrics for Hyper-V Guest VMs.
      • The app will set the MAC and IP Address if the end device provides them as part of the output from the following PowerShell cmdlet output: get-vm -ComputerName $Using:currentNodeName | Get-VMNetworkAdapter |
      5.0.0
      • Metric Calculation updated for the metric windows_hyperv_server_TotalPhysicalMemory
      • Support added for new metric windows_hyperv_server_PhysicalMemoryUtilization
      4.0.0
      • Added additional metric support for the nativeType - Windows HyperV Server
      3.0.1Code fix for latest snapshot metric.
      3.0.0Persona changes to support Cluster and Standalone Windows HyperV Cluster configurations.
      2.0.0
      • Code Enhancements - bulkOperations Support.
      • Metric label support.
      • Missing component alert support.
      • Display Order and Resource Grouping Support
      • subcategory Updated from Servers and VMs to Compute
      Click here to view the earlier version updates
      Application VersionBug fixes / Enhancements
      1.0.2Full discovery support.
      1.0.1Resource discovery and monitoring implementations.