server Integration
microsoft-hyper-v (en)


ServicePilot server-microsoft-hyper-v


# Microsoft Hyper-V

Overview

This package is designed to monitor a Microsoft Hyper-V Server using Windows Management Instrumentation (WMI).

Description

This package automatically configures the ServicePilot Agent in order to monitor Microsoft Hyper-V Server by using WMI counters. The statistics gathered in this way include:

  • System: CPU and Memory utilization
  • Storage: Physical Disk utilization
  • Network: Interface status and utilization

Host and guest machines are monitored.

##Requirements

  • It is preferable to install the ServicePilot Agent directly on the target server than using remote WMI collection.

    • ServicePilot Agent installed on target machine: The ServicePilot Agent needs to run under an account with local administrative privileges. The ServicePilot Agent uses the local system account by default which has these privileges.
    • ServicePilot Agent installed remote to the target machine: An account with WMI Remote Access privileges on the machine to be monitored is required. See Authorize WMI users and set permissions.
  • Network Flows - It is necessary to ensure network connectivity between ServicePilot and the monitored device. In case of a network infrastructure with a firewall, all of the following flows must be opened:

    • ServicePilot Agent installed on target machine:

      • ServicePilot Manager Web server access (by default TCP/80 when using HTTP or TCP/443 when using HTTPS although this port is configurable): Between ServicePilot Agent and ServicePilot Manager
    • ServicePilot Agent installed remote to the target machine:

      • TCP/135, TCP/445, and additional dynamically-assigned ports (1024-1034): Between ServicePilot Agent and Microsoft AD server
      • Authentication access for a domain account from server on which ServicePilot Agent is running to the domain controllers
      • ServicePilot Manager Web server access (by default TCP/80 when using HTTP or TCP/443 when using HTTPS although this port is configurable): Between ServicePilot Agent and ServicePilot Manager
  • ServicePilot Requirements

    • ServicePilot Manager minimum version: 8.5
    • ServicePilot Agent minimum version: 8.5 installed and configured

Installation

Before adding a resource to monitor, make certain that all pre-requisites are in place and if a ServicePilot Agent is required, that it is communicating correctly with the ServicePilot Manager. Resources can be added to ServicePilot configuration in a number of ways:

Add resource using Views Configuration web interface

  1. As an administrative user of ServicePilot, open the ServicePilot web interface.
  2. Navigate to Administration. The Configuration > Views web page will open.
  3. Click on the view in which to place the new resource in the Views hierarchy on the left of the interface. The View editor section will show the existing view contents.
  4. From the Packages list on the right of the interface, click and drag the server-microsoft-hyper-v package into the View editor and let go.
  5. The Package properties dialog box will open to allow resource configuration.
  6. Click OK to close the Package properties dialog box. Note that the dialog box will not close if required parameters are not set.
  7. Click Save to apply the new resource to ServicePilot configuration.

Add resource by changing servicepilot.conf configuration file

Resources can be added to ServicePilot configuration by directly editing the servicepilot.conf or other included YAML configuration files. The ServicePilot web interface can be used to make these changes and apply them to the running configuration.

  1. As an administrative user of ServicePilot, open the ServicePilot web interface.
  2. Navigate to Administration.
  3. Navigate to Configuration > Edit configuration.
  4. Expand the configuration to find the provisioning: and then packages: section of the view in which the new resource will be placed.
  5. Add the example package configuration line below.
  6. Click on the green - package: word to open then Package properties dialog box to allow resource configuration.
  7. Click OK to close the Package properties dialog box. Note that the dialog box will not close if required parameters are not set.
  8. Click Save to apply the new resource to ServicePilot configuration.

Example:

- package: "server-microsoft-hyper-v;;;;;;;;server-microsoft-hyper-v;;127.0.0.1;WMIlogin;WMIpassword"

Key field notes

  1. In the Monitoring Policies tab, specify the policy or policies to apply to the package

  2. Parameters tab:

    1. IP address/FQDN: Specify the IP address, host name or FQDN for the Microsoft Hyper-V Server, as resolvable by the machine on which the ServicePilot Agent is running

      The next 2 fields only need to be filled in if the ServicePilot Agent is remote to the target machine.

    2. WMI Login: Specify the username of the WMI Logon Account

    3. WMI Password: Specify the password of the WMI Login Account
server microsoft-hyper-v 0

server microsoft-hyper-v 1

server microsoft-hyper-v 2

server microsoft-hyper-v 3

server microsoft-hyper-v 4

server microsoft-hyper-v 5

server microsoft-hyper-v 6