Chat now with support
Chat with Support

Foglight for Hyper-V 5.7.0 - Installation Guide

Installing and enabling Foglight for Hyper-V

Foglight™ for Hyper-V is distributed in a CAR file, Virtual-HyperV-5_7_0.car. While most of Foglight for Hyper-V components are defined in this file, some of its browser interface elements are defined in two additional CAR files, DRP-5_7_0.car and Virtual-Hyper-V-Admin-5_7_0.car. The cartridge included in the Virtual-Hyper-V-Admin-5_7_0.car file provides access to Hyper-V administrative actions through the Hyper-V Explorer’s Administration tab, when your user account is granted the Hyper-V Automation User role. To enable the Administration tab, install this cartridge on the Management Server. For more information about the Hyper-V Explorer, see the Foglight for Hyper-V User and Reference Guide.
Installing and enabling these cartridges on the Management Server adds the Hyper-V capabilities to your Foglight environment and makes their components available for use. When a cartridge is installed and enabled, all of its components become part of the Management Server.
The following procedure describes the process of installing and enabling the available cartridges using the browser interface. Another way to install and enable cartridges is through the fglcmd command-line interface. For more information about the available fglcmd commands, see the Command-Line Reference Guide.
To install and enable a Foglight for Hyper-V cartridge:
1
On the navigation panel, under Dashboards, choose Administration > Cartridges > Cartridge Inventory.
2
On the Cartridge Inventory dashboard, click Install Cartridge.
The Install Cartridge dialog box appears.
Figure 1. Install Cartridge dialog box
3
In the Install Cartridge dialog box, click Browse and navigate to the Virtual-HyperV-5_7_0.car file that you want to install.
4
Ensure that the Enable on install check box is selected.
5
Click Install Cartridge.
A message box appears.
Figure 2. Processing message box
After a few moments, the Operation(s) Complete message box appears, indicating a success.
6
Click OK to close the Operation(s) Complete message box.
7
Repeat Step 2 through Step 6 to install the DRP cartridge, DRP-5_7_0.car, and Virtual-HyperV-Admin-5_7_0.car (if applicable).
8
Observe the list of installed cartridges.
The list of installed cartridges refreshes, showing the newly installed cartridges.
From here, you can proceed to deploying the Hyper-V Agent package.

Deploying agent packages to monitored hosts

Foglight™ for Hyper-V uses Hyper-V and SCVMM Agent instances to collect information from monitored hosts. Installing and enabling Foglight for Hyper-V on the Management Server makes its agent packagea available for deployment.
Hyper-V and SCVMM Agents use the Agent Manager for communication with the Management Server. Foglight for Hyper-V monitors host machines remotely using the WMI infrastructure. For that reason, the Agent Manager does not need to be installed on each individual host that you want to monitor. It is typically installed on one host; some scenarios may require multiple Agent Manager installations to balance the collection load.
After you have installed the Foglight for Hyper-V, you must deploy the Hyper-V and SCVMM Agent packages to the applicable Agent Manager instances. In some installations, the Management Server already has the Hyper-V Agent deployed to its embedded Agent Manager Instance. Deploying the package is only required if you plan to use additional Agent Manager instance.
The following procedure describes the deployment process using the Agent Status dashboard. This administrative dashboard is useful for deploying the agent package one host at a time. Alternatively, for deploying the Hyper-V Agent package to multiple hosts, you can use the Agent Hosts dashboard. For more information, see the Administration and Configuration Guide.
Another way to deploy agent packages is through the fglcmd command-line interface. For more information about the available fglcmd commands, see the Command-Line Reference Guide.
To deploy the Hyper-V and SCVMM agent packages:
1
Log in to the Foglight browser interface.
2
On the navigation panel, under Dashboards, click Administration > Agents > Agent Status.
The Agent Status dashboard appears in the display area.
Figure 3. Agent Status dashboard
3
On the Agent Status dashboard, click the Deploy Agent Package button in the lower-left corner.
The Deploy Agent Package wizard appears.
Figure 4. Deploy Agent Package wizard
 
* 
TIP: To have a monitored host available for selection, the Agent Manager must be up and running on that host, and connected to the Foglight Management Server.
4
Specify the monitored host to which you want to deploy the Hyper-V Agent package.
In the Deploy Agent Package wizard, on the Host Selector page, select the system on which the Agent Manager is running, and click Next.
If the system name does not appear in the list, check that its Agent Manager is active and connected to the Management Server.
The Deploy Agent Package wizard refreshes, showing the Agent Packages page.
Figure 5. Agent Packages page
5
In the Deploy Agent Package wizard, on the Agent Packages page, select the HyperVAgent and SCVMM packages, and click Next.
The Deploy Agent Package wizard refreshes, showing the Summary page.
Figure 6. Summary page
6
In the Deploy Agent Package wizard, on the Summary page, verify that the host name and package are correct, and click Finish.
The Deploy Agent Package wizard closes, and the Agent Status dashboard refreshes, showing in the Tasks area that the Deploy Agent Package task is in progress. After a few moments, a green icon appears in the Status column, indicating a successful deployment.
If agent deployment is not successful, there are several things you can do to troubleshoot the deployment failure. For more information, see the online help for the Agent Status dashboard.
From here, you can proceed to create Hyper-V and SCVMM Agent instances to monitor hosts. For more information, see Configuring monitoring agents for data collection.

Configuring monitoring agents for data collection

Foglight™ for Hyper-V uses the Hyper-V and SCVMM agents to collect information about your virtual environment:
•
Hyper-V Agents collect information from monitored Hyper-V servers. A Hyper-V server is a physical component required to begin building a virtual infrastructure. Hyper-V servers provide hypervisor-based architecture for controlling and managing resources for the virtual machines that run on it.
•
SCVMM Agents collect information from Virtual Machine Managers (VMM). A VMM allows you to manage host, networking and storage resources when creating and deploying virtual machines to virtual clouds.
When Hyper-V and SCVMM agent packages are successfully deployed, you can create agent instances, activate them and start their data collection. To perform these steps in a single operation for one or more monitored hosts, use the Agents area on the Administration tab.
When you add an agent instance, the agent process is created on the Agent Manager host. Activating the agent instance starts that agent process. When you start an agent’s data collection, the agent process starts collecting data from the monitored host and to sends it to Foglight.
To create, activate agent instances, and start their data collection:
1
Log in to the Foglight browser interface.
2
On the navigation panel, under Dashboards, choose Hyper-V > Hyper-V Environment.
3
On the Hyper-V Environment dashboard that appears in the display area, open the Administration tab.
Figure 7. Administration tab
4
On the Administration tab, under Agents, open the Hyper-V Agents or the SCVMM Agents tab, as required.
5
On the Administration tab, under Agents, click Add to launch the Agent Setup wizard.
The Agent Setup wizard appears, showing the Prepare page.
Figure 8. Agent Setup wizard
6
Review the information on this page. If you want to configure WinRM or DCOM settings automatically, download the appropriate script, and follow the instructions provided with the scripts. When done, click Next.
The Agent Setup wizard refreshes, showing the Select Fglam Client page. The page shows a list of all hosts that already have the Agent Manager installed and running, and to which you can deploy the Hyper-V Agent package.
Figure 9. Select Fglam Client page
7
Select the Agent Manager on which you want to create the Hyper-V Agent instance, and click Next.
8
Hyper-V Agents only. On the Discover or Manual page that appears, you can indicate if you want to manually specify the Hyper-V Server that you want to monitor, or to choose between the servers running in a given domain.
Figure 10. Discover or Manual page
Select one of the following options:
Discover. Select this option if you want to choose from the available Hyper-V Servers running in the desired domain. Click Next and proceed to Step a.
Manual. Select this option if you want to manually specify the name of the Hyper-V Server Click Next and proceed to Step b.
a
Discovering Hyper-V Servers only. On the Enter Domain Credentials page that appears, specify the information needed to search for the running Hyper-V Servers.
Figure 11. Enter Domain Credentials page
a
Provide the following information, and then click Next.
•
Domain: Type the fully qualified name of a domain to search for the Hyper-V Server. For example, myDomain.com.
•
User: Type the user name to be used by the agent to be used to query Active Directory on the selected domain using the syntax Domain\UserName. For example, myDomain\myUserName.
•
Password: Type the password associated with the above user name.
The Agent Setup wizard refreshes, showing the Select Servers page. The page shows a list of all Hyper-V servers that you have access to, based on the domain name and user credentials you provided in this step.
Figure 12. Select Servers page
b
Select one or more Hyper-V Servers that you want to monitor and click Next.
The Agent Setup wizard refreshes, showing the Agent Properties page.
Figure 13. Agent Properties page
c
By default, the options for collecting CPU, disk, memory, and network metrics are selected. Review these settings, and make any changes, if required. When done, click Next.
d
Proceed to Step c.
b
Manually specifying a Hyper-V Server only. On the Manual Agent Properties page that appears, specify the information needed to search for the running Hyper-V servers.
Figure 14. Manual Agent Properties page
Click Next.
c
On the Credential Verification page that appears, review the existing set of credentials. If the wizard determines that the selected Agent Manager has any credentials configured for the host on which the Hyper-V Server is running, they appear listed on this page.
 
* 
IMPORTANT: Credentials are security data that provide the Infrastructure agent with the permission to monitor system resources, such as a host or a range of hosts.
9
SCVMM Agents only. On the Input Agent Properties page that appears, type the name of the SCVMM server, and click Next.
Figure 15. Input Agent Properties page
10
On the Credentials Verification page, select one of the following options:
•
Do not configure a credential: Select this option if you want to configure the credential for this resource at a later time. Click Next and continue with Step 13.
•
Add host(s) to a new credential: Select this option if you want to add the host to a new credential. This option is suitable if none of the existing credentials have the connection details needed to access the new host. Click Next and continue with Step 11.
•
Add host(s) to an existing credential: Select this option if you want to add the host to an existing credential. This option is suitable if an existing credential has the security data needed to access the new host, but you need to edit its resource mappings to include this host. Click Next and continue with Step 12.
Figure 16. Credential Verification page
11
Create a new credential.
a
On the Credential Type page that appears, select the credential type from the available options.
Figure 17. Credential Type page
b
Click Next.
The Credential Properties page appears.
Figure 18. Credential Properties page
c
On the Credential Properties page, type the required properties, and click Next.
The Credential Name and Lockbox page appears.
Figure 19. Credential Name and Lockbox page
d
On the Credential Name and Lockbox page, provide a name to uniquely identify the credential, and select a lockbox in which you want to keep the credential. A lockbox can be used to group credentials for access and/or security. In smaller Foglight installations, using the default System lockbox should be sufficient.
 
* 
NOTE: If a lockbox is password protected and is not released to the target Foglight Agent Manager, you can provide the lockbox password on the last page of the wizard.
Click Next.
The Resource Mapping page appears.
Figure 20. Resource Mapping page
e
On the Resource Mapping page, indicate which hosts you want to associate with this credential. Click Next.
The Policies page appears.
Figure 21. Policies page
f
Optional—On the Policies page, define one or more policies for this credential. A policy defines the number of times a credential can be used, the number of allowed authentication failures, the time range during which the credential is valid, or the length of time the credential data can be cached on the client. For example, you can specify the number of times the credential can be used, or the time period during which it can be used. For complete information about the available credential policies, see the Administration and Configuration Help.
Click Next.
The Summary page appears.
Figure 22. Summary page
g
Proceed to Step 13.
12
Use an existing credential.
a
On the Credential page that appears, select an existing credential to contain this host.
Figure 23. Credential page
b
Click Next.
The Resource Mapping page appears.
Figure 24. Resource Mapping page
c
On the Resource Mapping page, indicate which hosts you want to associate with this credential. You can either select the host that you are about to start monitoring, all monitored hosts, or hosts whose name contains a specific text string.
Click Next.
The Summary page appears.
Figure 25. Summary page
d
Proceed to Step 13.
13
On the Summary page that appears, review the information provided about the host and the monitoring agent.
14
Click Finish.
The new host is added to the Hosts dashboard after a short delay. The monitoring agent is created. If the operation is successful, the Agent Setup message box appears. Review the information and close the message box.
Figure 26. Agent Setup message box
The agent instances created to monitor the new host appear on the Administration tab, in the Agents area.
Close the dialog box. The Hyper-V Agent Management dashboard refreshes, showing the newly created Hyper-V Agent in the list.
15
If required, reconfigure the agent properties or credentials. For example, you can specify the name of the monitored Hyper-V server or the authentication schema.
When a Hyper-V Agent, for example, connects to the Management Server, it is provided with sets of properties that it uses to configure its correct running state. Foglight stores agent properties on the Management Server.
a
Select an agent and click Edit Properties.
The Edit Agent Tab Manager dialog box appears, showing the Hyper-V Agent properties on the Agent Properties tab.
Figure 27. Edit Agent Tab Manager dialog box
 
* 
NOTE: When multiple agents are selected, you can only edit the properties that are common to all selected agents.
b
Review and edit the agent properties, as required.
The combination of properties you can configure in this step and the required values depend on the desired collection method (WinRM or DCOM) and the type of authentication required (local or domain-based). For complete information, about the possible configuration scenarios, see Setting the Hyper-V Agent Configuration properties .
c
Open the Credentials tab, and review the available credentials.
Figure 28. Credentials tab
d
If required, you can create a new credential for this agent, or associate it with an existing credential.
Creating a new credential. Click New Credential and use the Create Credential Wizard that appears to provide the required information. For more details, see Step 11.
Associating the agent with an existing credential. Click Add to Existing Credential and use the Create Credential Wizard that appears to provide the required information. For more details, see Step 12.
16
Activate one or more agents.
On the Agent Management dashboard, select the agents that you want to activate and click Activate.
17
Start the data collection for one or more agents.
On the Agent Management dashboard, select the agents whose data collection you want to start and click Start Data Collection.
18
Click Refresh.
If the agent configuration is successful, the Active and Data Collection columns show green check marks indicating that the agents are active and collecting data.
Figure 29. Agent Management dashboard
If the agent unexpectedly fails or stops, this is an indicator of an incorrect configuration. Unknown host names or invalid WinRM configuration can cause the agent to fail. Incorrect configuration causes the agent to stop. If this happens, the agent generates an observation containing a message with more information about the failure. You can view the message contents in the Data Browser. For example, to find out any massages related to the Hyper-V Agent, in the Data Browser, navigate to Hyper-V > Hyper-V Agents > <Hyper-V Agent instance> > Messages > History > <message>. For more information about the Data Browser, see the Data Model Guide.

Using an alternative method to create and activate agent Instances, and to start their data collection

The following procedure describes the process of creating and activating Hyper-V Agent instances and starting their data collection using the Agent Status dashboard. This dashboard is useful for creating agent instances one Agent Manager at a time.
Another way to create agent instances is using the fglcmd command-line interface. For more information about the available fglcmd commands, see the Command-Line Reference Guide.
To create, activate agent instances and start their data collection using the Agent Status dashboard:
1
Log in to the Foglight™ browser interface.
2
On the navigation panel, under Dashboards, choose Administration > Agents > Agent Status.
The Agent Status dashboard appears in the display area.
3
On the Agent Status dashboard, click Create Agent.
The Create Agent wizard appears with the Host Selector page open.
4
Specify the monitored host that you want to use to monitor with the Hyper-V Agent.
In the Create Agent wizard, on the Host Selector page, select the system on which the Agent Manager is running, and click Next.
If the system name does not appear in the list, check that its Agent Manager is active and connected to the Management Server.
The Create Agent wizard refreshes, showing the Agent Type and Instance Name page.
Figure 30. Agent Type and Instance Name page
 
* 
IMPORTANT: If the HyperVAgent or SCVMMAgent type is not listed, you need to deploy the Hyper-V or SCVMM Agent package to that host. For more information, see Deploying agent packages to monitored hosts.
5
On the Agent Type and Instance Name page, select HyperVAgent or SCVMMAgent, or both, as required.
6
Specify the name of the agent instance that you are about to create.
•
To have Foglight assign a generic name, ensure that Generic Name is selected.
•
To use a specific agent name, select Specify Name, and in the Name box that appears, type the agent name.
7
Click Next.
The Create Agent wizard refreshes, showing the Summary page.
8
In the Create Agent wizard, on the Summary page, verify that the host name and agent name are correct, and click Finish.
The Create Agent wizard closes, and the Agent Status dashboard refreshes, showing in the Tasks area that the Deploy Agent Package task is in progress. After a few moments, a green icon appears in the Status column, indicating a successful deployment.
9
Configure the properties of the newly created agent instance.
When an agent connects to the Management Server, it is provided with sets of properties that it uses to configure its correct running state. Foglight stores agent properties on the Management Server.
a
On the Agent Status dashboard, select the newly created Hyper-V or SCVMM agent instance, click Edit, and chose Edit Properties from the menu that appears.
The Agent Status dashboard refreshes, showing the agent properties in the display area.
Figure 31. Agent Properties
 
* 
NOTE: When multiple agents are selected, you can only edit the properties that are common to all selected agents.
b
Click Modify the private properties for this agent.
c
Edit the agent’s properties, as required.
For more information, see Setting the Hyper-V Agent Configuration properties and Setting the Hyper-V or SCVMM Agent Data Collection Scheduler properties .
d
When finished, click Save, then click the Back to Agent Status button.
10
Activate the newly created Hyper-V Agent instance.
On the Agent Status dashboard, select the row containing the agent instance that you want to activate, and click Activate.
The Activate Agent(s) message box appears, showing the status of the activation process. If the agent configuration is successful, after a few moments, the Activate Agent(s) message box closes, and the Agent Status dashboard refreshes, showing a green check mark in the Status column.
If the agent unexpectedly fails or stops, this is an indicator of an incorrect configuration. Unknown host names or invalid WinRM configuration can cause the agent to fail. Incorrect configuration causes the agent to stop. If this happens, the agent generates an observation containing a message with more information about the failure. You can view the message contents in the Data Browser. For example, to find out any massages related to the Hyper-V Agent, in the Data Browser, navigate to Hyper-V > Hyper-V Agents > <Hyper-V Agent instance> > Messages > History > <message>. For more information about the Data Browser, see the Data Model Guide.
 
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating