HYCU OMS Solution for Nutanix User Guide · HYCU OMS Solution for Nutanix (OMS Solution for Nutanix) is an availability, performance management, and analysis solution that extends

HYCU OMS Solution for Nutanix

Product version: 2.0

Product release date: May 2018

Document edition: First

USER GUIDE

2

Legal noticesCopyright notice© 2017-2018 HYCU. All rights reserved.

This document contains proprietary information, which is protected by copyright. No part of this document may be photocopied, reproduced, distributed, transmitted, stored in a retrieval system, modified or translated to another language in any form by any means, without the prior written consent of HYCU.

TrademarksHYCU logos, names, trademarks and/or service marks and combinations thereof are the property of HYCU or its affiliates. Other product names are the property of their respective trademark or service mark holders and are hereby acknowledged.

Azure, Microsoft, and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

Enterprise Cloud Platform, Nutanix, and Prism are trademarks of Nutanix, Inc. in the United States and/or other jurisdictions.

Redfish® is a registered trademark of Distributed Management Task Force, Inc. (DTMF).

DisclaimerThe details and descriptions contained in this document are believed to have been accurate and up to date at the time the document was written. The information contained in this document is subject to change without notice.

HYCU provides this material "as is" and makes no warranty of any kind, expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. HYCU shall not be liable for errors and omissions contained herein. In no event shall HYCU be liable for any direct, indirect, consequential, punitive, special or incidental damages, including, without limitation, damages for loss and profits, loss of anticipated savings, business interruption, or loss of information arising out of the use or inability to use this document, or any action taken based on the information contained herein, even if it has been advised of the possibility of such damages, whether based on warranty, contract, or any other legal theory.

The only warranties for HYCU products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty.

3

NoticeThis document is provided in connection with HYCU products. HYCU may have copyright, patents, patent applications, trademark, or other intellectual property rights covering the subject matter of this document.

Except as expressly provided in any written license agreement from HYCU, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property on HYCU products. Use of underlying HYCU product(s) is governed by their respective Software License and Support Terms.

Important: Please read Software License and Support Terms before using the accompanying software product(s).

HYCUwww.hycu.com

http://www.hycu.com/

4

ContentsIntroduction 6

About HYCU OMS Solution for Nutanix 6

Product architecture 8

About Nutanix 8

About Microsoft Operations Management Suite 9

Installation and configuration 10

Installation prerequisites 10

Installing OMS Data Collector for Nutanix 12

Configuring OMS Data Collector for Nutanix 13

Configuring OMS settings 14

Configuring Nutanix Prism settings 15

Performing product licensing tasks 16

Configuring custom ports for inbound traffic 19

Configuring the product to use a proxy server 20

Configuring cluster node-specific Redfish credentials 21

Enabling Nutanix system log forwarding (optional) 21

Enabling system log forwarding by using GUI 22

Enabling system log forwarding by using CLI 24

Deploying OMS Solution for Nutanix 26

Uninstallation 27

Uninstalling OMS Data Collector for Nutanix 27

Removing solutions from the OMS workspace 27

Usage 28

Data Collector 28

Configuration GUI: the Dashboard page 28

Configuration GUI: configuration wizard 29

Solutions 30

General solution information 30

5

Nutanix Clusters 31

Nutanix Hardware 31

Nutanix Hardware Sensors 32

Nutanix Log and Event Analytics 32

Nutanix Storage 32

Nutanix Virtual Machines 33

Troubleshooting 34

General troubleshooting guidelines 34

OMS Data Collector for Nutanix log files 34

Problems and solutions 35

You cannot reach OMS Data Collector for Nutanix configuration GUI 35

Microsoft OMS settings do not appear to be saved 36

An error related to local time configuration is reported when saving Microsoft OMS settings 36

Before contacting HYCU Customer Support 37

HYCU Customer Support and information 38

Customer Support 38

Company website and video channel 38

General information 39

Feedback 39

6

IntroductionThis chapter introduces HYCU OMS Solution for Nutanix and explains how it interacts with Nutanix Enterprise Cloud Platform and Microsoft Operations Management Suite.

About HYCU OMS Solution for NutanixHYCU OMS Solution for Nutanix (OMS Solution for Nutanix) is an availability, performance management, and analysis solution that extends end-to-end service monitoring capabilities of OMS to include on-premises Nutanix appliances. It includes multiple solutions (also referred to as OMS Solution for Nutanix functional areas) with a predefined set of views to fully integrate Nutanix data, events, and logs into the OMS portal. This way, it provides the operation overview and log analytics across the Nutanix infrastructure and enables delivery of effective business service management. OMS Solution for Nutanix also provides possibility to generate alerts according to availability, performance, configuration, or security conditions that are identified. It enables you to monitor, detect, troubleshoot, remediate, and prevent problems from occurring in your Nutanix appliance.

OMS Solution for Nutanix provides the following major features:

l Discovery and visualization:

o Automatic discovery and visualization of Nutanix clusters, hosts, storage, and virtual machines (VMs) by using historical charts and predefined queries. It also includes predefined queries for Nutanix log and event analytics.

o Centralized monitoring of the discovered Nutanix environment, log and event analytics over the OMS portal.

l Health, availability, and performance monitoring:

o Monitoring of the Nutanix infrastructure health state from performance issues to utilization, latency, load, and availability.

o Detection of performance degradation before it affects end users

l Monitoring of Nutanix infrastructural components and tasks:

o Automatic detection of Nutanix infrastructural components, such as:

n Clusters: Storage, CPU, and memory capacity and utilization, I/O latency, IOPS, I/O bandwidth, blocks, hosts, number of VMs.

n Virtual machines: Number of VMs (per cluster, powered on/powered

Chapter 1

Introduction

7

off/suspended/paused VMs), total CPU and memory utilization, total VM I/O latency, IOPS.

n Hardware: Host CPU and memory utilization, number of hosted VMs, host I/O latency and IOPS, blocks per cluster, Nutanix hardware editions, and number of SSD drives, number of HDD drives.

n Hardware sensors: Fans and fan rotation speeds, components and component temperatures, power supply and power control units, their voltages and wattages.

n Storage: Storage utilization, storage pools, containers.

l Nutanix log analytics:

o Provision of a central point for investigating logs.

o Collection of, correlation of, and search in log and performance data generated by operating systems and applications.

o Usage of predefined queries to help remediate problems occurring in Nutanix clusters.

l Problem identification and resolution mechanism:

o Provision of information that can help you identify the problem and its root cause.

o Alert-based notification about increased resource utilization.

Introduction

8

Product architecture OMS Solution for Nutanix uses a sophisticated component called HYCU OMS Data Collector for Nutanix (OMS Data Collector for Nutanix or simply Data Collector) that is installed on a system of your choice (Data Collector system). Data Collector connects to one or more Nutanix appliances by using the Nutanix REST API interface and sends the collected performance data to OMS by using its HTTP Data Collector API. Data Collector can also act as a syslog server and can forward Nutanix system log files to OMS.

The following diagram shows how OMS Solution for Nutanix connects the OMS platform and the Nutanix infrastructure.

Figure 1–1: High-level overview of the OMS Solution for Nutanix environment

About NutanixNutanix delivers enterprise computing and storage featuring built-in virtualization.

Nutanix hyperconverged infrastructure natively integrates servers, storage network, and storage into a single x86-based server deployed in scale-out clusters. Nodes (host systems) that are part of the enterprise-scale clusters run industry-standard or native hypervisors and the Nutanix operating system (AOS, formerly known as NOS). Each server contains x86-64 processors, memory, solid state drives (SSDs), and traditional hard disk drives

Introduction

9

(HDDs) that aggregate storage resources into a single storage pool. Capacity is added by adding nodes to the computing cluster.

Built-in virtualization allows applications and data to move freely between on-premises environments and public clouds. All data, metadata, and operations are distributed across the entire cluster combining physical and virtual storage. Such combined functionality eliminates performance bottlenecks, enables predictable scalability without limits, reduces power and space consumption, and eliminates storage complexity.

Nutanix Enterprise Cloud Platform features predictable performance, cloud-like infrastructure consumption, robust security, and application mobility for a broad range of enterprise applications without infrastructure constraints. The infrastructure is truly invisible, shifting focus back to applications.

About Microsoft Operations Management SuiteMicrosoft Operations Management Suite (OMS) is a cloud-based IT management solution that helps you manage and protect your on-premises and cloud infrastructure.

You can benefit from the following major value areas of OMS:

l Insight and analytics

l Automation and control

l Protection and recovery

l Security and compliance

In addition to providing valuable services on its own, OMS can integrate with Microsoft System Center components such as System Center Operations Manager to extend your existing management investment into the cloud.

System Center and OMS can work together to provide a full hybrid management experience.

10

Installation and configurationThis chapter contains instructions on how to install and configure OMS Solution for Nutanix for both the Nutanix appliance and OMS sides. To install and configure the product, complete these tasks:

1. Ensure that the installation prerequisites are fulfilled. For details, see “Installation prerequisites” below.

2. Install OMS Data Collector for Nutanix on a Linux system. For details, see “Installing OMS Data Collector for Nutanix” on page 12.

3. Configure OMS Data Collector for Nutanix. For details, see “Configuring OMS Data Collector for Nutanix” on page 13.

4. Optional. Enable Nutanix cluster nodes to provide system logs for OMS. For details, see “Enabling Nutanix system log forwarding (optional)” on page 21.

5. Deploy OMS Solution for Nutanix. For details, see “Deploying OMS Solution for Nutanix” on page 26.

t Tip In aid of tasks 3 and 4 of the process, you can use the configuration wizard included in Data Collector. In the Data Collector configuration GUI, click Help in the main toolbar and then select Configuration Wizard from the drop-down menu.

For more information, see “Configuration GUI: configuration wizard” on page 29.

Installation prerequisitesBefore installing OMS Solution for Nutanix, make sure that the following prerequisites are fulfilled:

l Product requirements documented in HYCU OMS Solution for Nutanix Release Notes are met.

l Nutanix Enterprise Cloud Platform prerequisites:

o For each Nutanix cluster that you plan to monitor, a Nutanix user account is selected.

HYCU recommends that you select accounts that have Viewer role assigned in Nutanix Prism: they can only view information (and collect monitoring data).

o Mandatory for low-level hardware monitoring. For each Nutanix cluster, a user account is selected that can access hardware sensors on the cluster nodes through

Chapter 2

Installation and configuration

11

their Redfish API implementation. OMS Solution for Nutanix supports configurations with different user accounts for different cluster nodes.

HYCU recommends that you select an account that has ReadOnlyUser role assigned: it can only view information (and collect monitoring data).

Credentials of the default Redfish user account on Nutanix cluster nodes are usually as follows:

– User name: ADMIN – Password: ADMIN

OMS Solution for Nutanix uses these credentials by default, but you can adjust that as part of product configuration. Adjustment may also be required with clusters that are based on non-Nutanix hardware.

l OMS platform prerequisites:

o The OMS workspace ID and primary key are known.

To acquire the OMS workspace ID and primary key, do the following:

1. Open a web browser, go to the Overview | Microsoft Operations Management Suite webpage and then click Sign in.

2. On the Sign in to your account webpage, provide your access credentials, and then sign in to the OMS portal.

3. Click Settings.

4. In the Overview page, select Connected Sources > Windows Servers. Locate the Workspace ID and Primary Key fields and copy their contents.

o Name resolution for the fully qualified domain name that includes the workspace ID is functioning.

To verify this, on the Data Collector system, open a command shell and run the following command:

nslookup <WorkspaceID>.ods.opinsights.azure.com

In this instance, <WorkspaceID> is the workspace ID of your workspace.

The command output should resemble the following sample output:

Server: <DNSfqdn> Address: <DNSipAddress> Non-authoritative answer: <WorkspaceID>.ods.opinsights.azure.com canonical name = opinsightsweuods.trafficmanager.net. opinsightsweuods.trafficmanager.net canonical name = opinsights-weu-ods-b.cloudapp.net. Name: opinsights-weu-ods-b.cloudapp.net Address: <IPaddress>

https://www.microsoft.com/en-us/cloud-platform/operations-management-suite

https://www.microsoft.com/en-us/cloud-platform/operations-management-suite


12

l Data Collector system prerequisites:

o Firewall is configured to enable inbound network traffic on the required ports

OMS Solution for Nutanix is preconfigured to use the following ports:

n 8080 (HTTP)

n 8443 (HTTPS)

n 54100 (syslog)

For instructions on how to configure different port numbers, see section “Configuring custom ports for inbound traffic” on page 19.

l Web browser prerequisites:

o A compatible web browser is used to access the OMS Data Collector for Nutanix configuration GUI. For a list of the compatible web browsers, see the HYCU OMS Solution for Nutanix Compatibility Matrix.

o The web browser must be set to allow JavaScript execution.

For information on Nutanix Enterprise Cloud Platform and the OMS platform (for example, hardware and software requirements, operating system support, and installation and configuration procedures), see the Nutanix and Microsoft documentation.

Installing OMS Data Collector for NutanixTo install OMS Data Collector for Nutanix, do the following:

1. Go to the OMS Solution for Nutanix - HYCU webpage and sign in with your account credentials.

If you do not have an account yet, apply for it at the following email address:[email protected]

2. When you are signed in, under Product download, click HYCU OMS Solution for Nutanix.

3. Read through the Software License and Support Terms text. If you agree with the terms, click Accept and proceed.

4. In the Product download link line, click Download to transfer the product release archive and save it on the local system..

5. Locate the HYCU.OMS.Solution.Nutanix.<Version>.zip file and extract its contents.

In this instance, <Version> is the product release version.

6. Copy the extracted hycu-oms-dc-nutanix-<Version>.x86_64.rpm file to the Linux system designated to host OMS Data Collector for Nutanix.

In this instance, <Version> is version of the RPM package.

7. Log on to the future OMS Data Collector for Nutanix host system.

8. Open a command shell and change the current directory to the directory with the installation package.

https://support.hycu.com/hc/en-us/categories/115000762505

mailto:[email protected]


13

9. Run the following command by using a user account that has privileges to install RPM packages:

rpm -i hycu-oms-dc-nutanix-<Version>.x86_64.rpm

To verify that OMS Data Collector for Nutanix was installed successfully, do the following:

1. Verify that the hycuomsdc service is started. Run the following command:

service hycuomsdc status

The command output should resemble the following:

hycuomsdc is running ... PID=<ProcessID>

t Tip You can use the following commands to manage the hycuomsdc service:

service hycuomsdc start|stop|status|restart

Configuring OMS Data Collector for NutanixTo configure OMS Data Collector for Nutanix, complete the following tasks in the OMS Data Collector for Nutanix configuration GUI:

1. Configure OMS settings.

Data Collector uses these settings to determine your OMS workspace it should forward data to.

2. Configure Nutanix Prism settings.

Data Collector uses these settings to determine its data sources (Nutanix clusters).

3. Configure Nutanix syslog forwarding settings.

Data Collector uses these settings to set up syslog forwarding for your Nutanix clusters.

4. Perform product licensing tasks.

Data Collector starts collecting and relaying data after it successfully verifies a locally installed license file.

In specific circumstances, additional configuration tasks are required:

1. Configure custom ports for inbound traffic for OMS Data Collector for Nutanix.

Port reconfiguration is needed when a firewall blocks inbound network traffic on the default (predefined) ports.

2. Configure the product to use a proxy server.

Proxy server must be used when direct communication between OMS Data Collector for Nutanix and OMS is not possible.

3. Configure Nutanix cluster node-specific Redfish credentials.

A special command-line tool set_redfish_credentials must be used to configure Redfish credentials for individual cluster nodes.


14

Configuring OMS settingsTo configure OMS settings, do the following:

1. Open a web browser and go to webpage of the OMS Data Collector for Nutanix configuration GUI.

Example Configuration GUI webpage URL:

https://computer.company.com:8443

The HYCU OMS Data Collector for Nutanix configuration wizard window appears.

2. To let Data Collector configuration wizard guide you through the process, click Start and follow instructions of the wizard (see the rest of this procedure for descriptions of the data you must supply).

Else, click Exit Wizard and proceed to the next step of this procedure.

3. In the Data Collector configuration GUI, click Microsoft OMS Settings.

Figure 2–1: Microsoft OMS Settings page

4. In the main toolbar, click Edit.

5. In the WORKSPACE ID and PRIMARY KEY text boxes, enter the workspace ID and primary key you acquired from the OMS portal.

6. Click Save.


15

Configuring Nutanix Prism settingsTo configure Nutanix Prism settings, do the following:

1. To let Data Collector configuration wizard guide you through the process, follow instructions of the wizard (see the rest of this procedure for descriptions of the data you must supply).


2. In the Data Collector configuration GUI, click Nutanix Prism Settings.

3. In the main toolbar, click Add.

Figure 2–2: Nutanix Prism Settings page

4. In the Add Nutanix Data Source dialog box, specify the Nutanix cluster that you plan to monitor. To do so, follow the steps:

a. Enter the following data:

l In the NUTANIX CLUSTER HOST NAME text box: host name or IP address of the Nutanix cluster's virtual system

l In the PORT text box: port number (default value: 9440)

l In the USER NAME and PASSWORD text boxes: credentials of the Prism user account configured to be used for connection to OMS Data Collector for Nutanix

HYCU recommends that you select an account that has privileges only for collecting (reading) data.


16

l In the REDFISH® USER NAME and REDFISH® PASSWORD text boxes: credentials for accessing hardware sensors on cluster nodes through Redfish API implementation on the nodes (IPMI web interface credentials, default values: ADMIN, ADMIN)

HYCU recommends that you select an account that has privileges only for collecting (reading) data.

i Important The specified Redfish credentials are used for all cluster nodes. If Redfish API implementations on different cluster nodes use different credentials, an additional configuration step is required later in this procedure.

b. Click Save.

5. If needed, configure different Redfish API implementation credentials for individual cluster nodes. For instructions, see “Configuring cluster node-specific Redfish credentials” on page 21.

6. Repeat steps 3 to 5 for each additional Nutanix cluster that you plan to monitor using OMS Solution for Nutanix.

Performing product licensing tasksOMS Solution for Nutanix subscription-based licenses (licenses for purchase) are issued for and bound to a specific Data Collector system. They are time-limited. Each license limits the total number of CPU sockets in all Nutanix clusters from where data is collected by the OMS Data Collector for Nutanix instance installed on the Data Collector system. If the number of actual sockets in the monitored clusters does not exceed the number specified in the license, the license is treated as valid.

Subscription-based licenses are issued based on the license specification that is sent in scope of your license order. Timely renewal of your licensees ensures continuity of product operation.

OMS Solution for Nutanix software evaluation licenses can be used on any Data Collector system.

n Note The system where OMS Data Collector for Nutanix is installed does not require Internet connectivity when the product license is activated (the license key is applied).

Requesting license activation keys and activating licensesTo request an OMS Solution for Nutanix license for one OMS Data Collector for Nutanix instance, and activate the instance so that it starts collecting and relaying monitoring data, do the following:

1. To let Data Collector configuration wizard guide you through the process, follow instructions of the wizard (see the rest of this procedure for descriptions of the data


17

you must supply).


2. In the Data Collector configuration GUI, click Product License.

Figure 2–3: Product License – License Manager page

3. If you are evaluating the product and have received evaluation license (the License.dat file), skip to step 11. If you purchased the product, continue with step 3.

4. In the License Manager pane, click Generate to generate a customized license specification that matches your OMS Data Collector for Nutanix configuration.

5. When the license specification is ready, click Save to save it to the License.req file.

6. Open a web browser and go to the Licensing Portal | HYCU webpage to submit a license request

7. If you already have a licensing portal account, click Sign in and enter your user name and password. Else, create it first by filling in the request form on the website.

8. To generate the perpetual license key, click Activate perpetual licenses, enter your purchase order number (PO number), and then click Next.

9. To upload the license request file, click Choose file, browse to the folder with the License.req file, and select the file. Click Send Request.

10. In the Activate permanent licenses page, review the list of clusters and the number of required CPU sockets within each cluster for which you want to activate the license.

11. Click Activate Licenses.

https://licensing.hycu.com/


18

Within a few minutes, you should receive an email from HYCU Customer Support with a license activation file (License.dat) attached.

12. Save the license activation file to a location on the system from where you are connected to the OMS Data Collector for Nutanix configuration GUI.

13. In the Data Collector configuration GUI, in the License Manager pane, click Browse.

14. Navigate to the folder with the License.dat file, select it, and click Open.

15. Click Upload and allow a few moments for OMS Data Collector for Nutanix to restart.

Your OMS Data Collector for Nutanix instance on this system is activated.

Checking product licensing statusData Collector configuration GUI presents information related to product licensing in the Licensing Status widget of the Dashboard page.

Figure 2–4: Dashboard page with the Licensing Status widget in the lower right corner

The following information is displayed:

l Licensing status:

Messages have the meaning as follows:

o EXCEEDED NUMBER OF SOCKETS

The license is invalid in terms of how many CPU sockets (Nutanix clusters and hosts) are being monitored and how many CPU sockets are licensed.


19

To make your license valid again, repeat the procedure documented in “Requesting license activation keys and activating licenses” on page 16.

o LICENSE IS INVALID

The licensed period expired. Contact HYCU Customer Support for assistance.

Absence of any message denotes that licensing for this OMS Data Collector for Nutanix instance is covered.

l License expiration date, number of days until expiration

l Numbers of actual CPU sockets and licensed CPU sockets

Configuring custom ports for inbound trafficTo configure OMS Data Collector for Nutanix to listen on custom (non-predefined) ports, do the following:

1. On the Data Collector system, open a command shell and run the following command to stop OMS Data Collector for Nutanix:

service hycuomsdc stop

2. Change the current directory to /opt/hycu/nutanix-oms/conf and open the configuration.json file in a plain text editor.

3. Change the main port number used by OMS Data Collector for Nutanix. To do so, locate the serverConfig object, and change the value of the following attributes:

l webServerPort, for HTTP

l webSecureServerPort, for HTTPS

Lines that define default attribute values of serverConfig are as follows:

"serverConfig": { "startWebServer": true, "webServerPort": 8080, "startSecureWebServer": true, "webSecureServerPort": 8443 },

4. Change the port number used for Nutanix system log forwarding. To do so, locate the syslogConfig object, and change the value of the port attribute:

Lines that define default attribute values of syslogConfig are as follows:

"serverConfig": { "port": 54100, "startOnStartup": true, },

5. Save your changes.


20

6. In a command shell, run the following command to start OMS Data Collector for Nutanix:

service hycuomsdc start

7. If you changed the port number used for Nutanix syslog forwarding while Nutanix system logs were already being forwarded, propagate the changes to Nutanix clusters:

l Using the GUI: perform the procedure documented in “Enabling system log forwarding by using GUI” on page 22. In step 4 of the procedure, click Edit Modules and then complete the corresponding sequence of substeps without changing the detailed configuration.

l Using the CLI: perform the procedure documented in “Enabling system log forwarding by using CLI” on page 24 by using the new port number.

Configuring the product to use a proxy serverOMS Data Collector for Nutanix automatically uses an HTTP proxy server for communication with OMS when the proxy server is set in the interactive command shell configuration for the user account that runs OMS Data Collector for Nutanix. If a proxy server is not set, you must update the configuration yourself.

To set a proxy server for OMS Data Collector for Nutanix, do the following:

1. Open the ~/.bashrc file in a plain text editor.

2. Add the following line to the file:

export HTTP_PROXY=<ProxyServerFQDN>:<ProxyServerPort>

In this instance, the placeholders have the meanings as follows.

<ProxyServerFQDN> Fully qualified domain name of the system that acts as a proxy

<ProxyServerPort> Port number that the proxy server is using

Example A line added to .bashrc:

export HTTP_PROXY=proxy.company.com:5000

3. Save your changes.

4. Open a command shell and run the following command to restart OMS Data Collector for Nutanix:

service hycuomsdc restart


21

Configuring cluster node-specific Redfish credentialsTo configure different Redfish API implementation credentials for individual nodes of a Nutanix cluster, do the following:

1. On the Data Collector system, open a command shell and run the following command to stop OMS Data Collector for Nutanix:

service hycuomsdc stop

2. Change the current directory as follows:

cd /opt/hycu/nutanix-oms/bin/tools

3. Run the following command to list configured Nutanix clusters and their nodes:

./set_redfish_credentials -l

4. Run the following command to configure or change Redfish credentials for a cluster node in the Data Collector's data source configuration:

./set_redfish_credentials -a <RedfishAddress>

In this instance, the placeholder has the meaning as follows.

<RedfishAddress>IP address of the Redfish API implementation on the cluster node

Alternatively, run the following command instead:

./set_redfish_credentials -n <HostName>

In this instance, the placeholder has the meaning as follows.

<HostName> Host name of the Nutanix cluster node

5. Supply the credentials as prompted by the command.

6. Repeat steps 4 and 5 for each additional cluster node that uses different Redfish credentials.

7. Run the following command to start OMS Data Collector for Nutanix:


Enabling Nutanix system log forwarding (optional)To utilize the OMS log analytics functionality, you must enable forwarding of system logs from the Nutanix appliances to OMS Data Collector for Nutanix. Cumulative size of the


22

forwarded logs affects the cost of your OMS license, and may grow very large. You should therefore carefully plan and decide about the following:

l Which systems to collect the logs from

l Log entries of which severity levels to include

Enabling system log forwarding by using GUITo enable Nutanix system log forwarding for a specific Nutanix cluster, by using configuration GUI of OMS Data Collector for Nutanix, do the following:

1. Open a web browser and go to webpage of the Data Collector configuration GUI.

Example Configuration GUI webpage URL:

https://computer.company.com:8443

The HYCU OMS Data Collector for Nutanix configuration wizard window appears.

2. To let Data Collector configuration wizard guide you through the process, follow instructions of the wizard (see the rest of this procedure for descriptions of the data you must supply).


3. In the left pane, click Nutanix Syslog Forwarding.

A list of configured data sources (Nutanix clusters) appears.

i Important Data Collector uses default Nutanix credentials for SSH connections to populate the list. Indicators in the SSH REACHABLE column inform you about connection success. Connection failure may indicate the SSH credentials were changed on that Nutanix cluster.

4. On the left side of the main pane, click in the line of the data source you wish to reconfigure syslog forwarding for.

The main pane shows the following information for each discovered data source:

l Nutanix cluster name

l An indicator of whether the cluster is online

l Syslog forwarding destination system

l An indicator of whether the syslog server that is running in the cluster can be reached by using SSH

l Current syslog forwarding status (enabled, disabled)

The lower pane shows current configuration of syslog forwarding in the selected data source (Nutanix cluster):

l Syslog forwarding destination system

l User name configured for SSH connection


23

l Current syslog forwarding status

l Information for each Nutanix module:

o Whether its related syslog entries are currently forwarded

o Severity level threshold (minimum) for the included log entries

Figure 2–5: Nutanix Syslog Forwarding page

t Tip Selection of multiple Nutanix clusters allows enabling or disabling syslog forwarding in general only. To select all or multiple clusters, click the appropriate check boxes on the left side of the main pane. The lower pane shows information about the last selected cluster.

5. Do one of the following:

l To enable or disable syslog forwarding, click Enable Selected or Disable Selected in the toolbar, respectively.

Allow some time for Data Collector to apply new settings.

l To change credentials that Data Collector uses to connect to the Nutanix cluster, click Set SSH Credentials:

a. In the dialog box, enter new user name and password that you want to use.

b. Click Save.

l To change detailed syslog forwarding configuration, click Edit Modules:

a. Pick a Nutanix module for which you want to adjust syslog forwarding.

b. in the LOG SEVERITY LEVEL column, select from the drop-down list the minimum severity level of syslog entries that should be forwarded for the module.

c. In the TOGGLE FORWARDING column, toggle the switch to enable or disable


24

syslog forwarding for the module.

d. Repeat steps a to c for each additional Nutanix module you plan to reconfigure with regards to syslog forwarding.

e. Click Save and allow some time for Data Collector to apply new settings.

n Note The DESTINATION SYSTEM property is automatically set to the fully qualified domain name of the system that hosts the Data Collector you are reconfiguring.

Enabling system log forwarding by using CLITo enable Nutanix system log forwarding for a specific Nutanix cluster, by using operating system's CLI, do the following:

1. Open a command shell and run the commands as specified in the continuation of the procedure.

2. Connect to the Nutanix cluster by using SSH:

ssh nutanix@<ClusterName>


nutanix One of Nutanix cluster's default (predefined) user names

<ClusterName> Host name of the Nutanix cluster

3. Start the Nutanix command-line interface:

ncli

4. Stop the rsyslog service and prevent it from being automatically started in the future:

rsyslog-config set-status enable=false

5. Enable log forwarding to OMS Data Collector for Nutanix:

rsyslog-config add-server name=<HostName> ip-address=<IPaddress> port=54100 network-protocol=UDP


<HostName>Fully qualified domain name of the system where OMS Data Collector for Nutanix is installed

<IPaddress>IP address of the system where OMS Data Collector for Nutanix is installed


25

Example A command line that enables syslog forwarding in general for the computer.company.com system:

rsyslog-config add-server name=computer.company.com ip-address=10.17.100.100 port=54100 network-protocol=UDP

6. Specify Nutanix modules from which you plan to collect logs and the log severity levels. For each module, you can select a different level.

For each Nutanix module, run the following command:

rsyslog-config add-module server-name=<HostName> module-name=<ModuleName> level=<Level> include-monitor-logs=true


<HostName>Fully qualified domain name of the system where OMS Data Collector for Nutanix is installed

<ModuleName>A Nutanix module name; available modules are: cassandra, cerebro, curator, genesis, prism, stargate, zookeeper

<Level>

One of the following severity levels: INFO, WARNING, ERROR, FATAL; the specified level defines the minimum severity level that is still included in data forwarding

i Important Configured severity level affects the size of the forwarded logs. To avoid overloading OMS, consider setting a higher minimum severity level.

Example Command lines that enable syslog forwarding for all Nutanix modules:

rsyslog-config add-module server-name=computer.company.com module-name=cassandra level=WARNING include-monitor-logs=true rsyslog-config add-module server-name=computer.company.com module-name=cerebro level=WARNING include-monitor-logs=true rsyslog-config add-module server-name=computer.company.com module-name=curator level=WARNING include-monitor-logs=true rsyslog-config add-module server-name=computer.company.com module-name=genesis level=WARNING include-monitor-logs=true rsyslog-config add-module server-name=computer.company.com module-name=prism level=WARNING include-monitor-logs=true rsyslog-config add-module server-name=computer.company.com module-name=stargate level=WARNING include-monitor-logs=true


26

rsyslog-config add-module server-name=computer.company.com module-name=zookeeper level=WARNING include-monitor-logs=true

7. Start the rsyslog service:

rsyslog-config set-status enable=true

Deploying OMS Solution for NutanixDepending on the data you want to view on the OMS portal, you must add all or specific solutions to your OMS workspace.

To add solutions to your OMS workspace, do the following:

1. Sign in to the Azure portal.

2. In the New blade under Marketplace, select the Monitoring + management group.

3. In the Monitoring + Management blade, click See all.

4. To the right of Management Solutions, click More.

5. In the Management Solutions blade, select one of the following management solutions that you want to add to a workspace:

l Nutanix Clusters

l Nutanix Hardware

l Nutanix Hardware Sensors

l Nutanix Log and Event Analytics

l Nutanix Storage

l Nutanix Virtual Machines

6. In the management solution blade, review information, and then click Create.

7. In the blade of the added management solution, select a workspace to associate the solution with.

8. Review other options and click Create.

9. Repeat steps 2 to 8 for each additional solution that you want to use.

27

UninstallationThis chapter contains instructions on how to completely uninstall OMS Solution for Nutanix from your environment. To uninstall OMS Solution for Nutanix, complete these tasks:

1. Uninstall OMS Data Collector for Nutanix from its host system. For details, see “Uninstalling OMS Data Collector for Nutanix” below.

2. Remove included solutions from OMS portal. For details, see “Removing solutions from the OMS workspace” below.

Uninstalling OMS Data Collector for NutanixTo uninstall OMS Data Collector for Nutanix, do the following:

1. On the Data Collector system, open a command shell.

2. Run the following command by using a user account that has privileges to remove RPM packages:

rpm -e hycu-oms-dc-nutanix

Removing solutions from the OMS workspaceTo remove solutions from the OMS workspace, do the following:

1. Sign in to the Azure portal.

2. Navigate to Log Analytics > Subscriptions > <YourWorkspaceName>.

In this instance, <YourWorkspaceName> is the name of the OMS workspace you are using.

3. In the <YourWorkspaceName> blade, click Solutions.

4. In the solution list, select the solution for removal.

5. In the solution blade, click Delete, and then click Yes to confirm the deletion.

6. Repeat steps 4 and 5 for each additional component of OMS Solution for Nutanix.

Chapter 3

28

UsageThis chapter describes specific features of OMS Data Collector for Nutanix (Data Collector) and OMS functional areas of OMS Solution for Nutanix (solutions).

Data CollectorThis section describes the following features of the Data Collector configuration GUI: the Dashboard page, configuration wizard.

Configuration GUI: the Dashboard pageDashboard property page in the Data Collector configuration GUI displays an informative view of the configured data sources, data collection statistics, and the Data Collector inner workings. The information is presented in four widgets:

l Configured Clusters

This widget presents information about the configured data sources (Nutanix clusters), their availability, and their current syslog forwarding status.

l Data Collector System Information

This widget presents information about the system on which the Data Collector is running and utilization of its resource types: compute, memory, and storage.

l Data Collector Statistics

This widget presents information on the recent data flow towards the Microsoft OMS workspace.

l Licensing Status

This widget reports the current status of product licensing and the license expiration date.

Chapter 4

Usage

29

Figure 4–1: Dashboard page

t Tip You can rearrange the widgets on the Dashboard page. To do so, follow the steps: 1. Point into the widget to be moved. A "move" icon appears in the upper right corner

of the widget.

2. Click the "move" icon, hold the mouse button, and drag the widget to a new position.

Configuration GUI: configuration wizardConfiguration wizard is a feature of the Data Collector configuration GUI that aids you in configuring OMS Data Collector for Nutanix. A sequential series of visual hints guide you through both mandatory and optional configuration steps, excluding special steps required in specific circumstances.

l Configuration of OMS settings

l Configuration of Nutanix Prism settings (data sources)

l Optional. Configuration of Nutanix syslog forwarding

l Performing product licensing tasks

Usage

30

Figure 4–2: Configuration wizard assists with adding data sources

With a newly installed Data Collector that you have not configured yet, the wizard automatically starts when you access the Data Collector configuration GUI. To start the wizard at any time, click Help in the main toolbar and then select Configuration Wizard from the drop-down menu.

SolutionsThis section describes each of the solutions included in OMS Solution for Nutanix. For conceptual and usage information on OMS, see its product documentation.

General solution informationAll OMS Solution for Nutanix functional areas share a common feature: ability to monitor Nutanix appliances from an OMS workspace. Each functional area includes a set of predefined views that cover specific area of the monitored Nutanix infrastructure. These views are based on preconfigured queries. Some of the functional areas also include a set of predefined alerts, based on preconfigured semaphores. Even when an alert is enabled (switched on), it is not active until you configure its alert rule so that it automatically performs at least one action, depending on how you prefer to be notified.

i Important Only alerts of critical severity are enabled by default, but they are inactive – their alert rules are not configured.

Usage

31

You can always add new or customize the predefined views and alerts. For alerts, you can change their general settings (for example, severity, search query, and time window), their schedules, and their actions. For more information, see the Understanding alerts in OMS Log Analytics webpage on the Microsoft Docs website.

Nutanix ClustersThis solution provides an overview of the health status and performance for Nutanix clusters. It includes the following views:

l STORAGE CAPACITY (Storage Capacity by Cluster)

l CPU POWER (CPU Power by Custer)

l MEMORY SIZE (Memory Size by Cluster)

l RESOURCE UTILIZATION (STORAGE, MEMORY, CPU) (Storage Utilization, Memory Utilization, CPU Utilization)

l CLUSTER-WIDE PERFORMANCE (Cluster-wide IOPS, Cluster-wide Average I/O Latency, Cluster-wide I/O Bandwidth)

l VIRTUAL MACHINE COUNT (Total VMs)

l NUTANIX ALERT COUNT (Total Number of Alerts in All Clusters)

l LIST OF QUERIES

The solution includes the following alerts:

l ClusterCPUusage_80 rule

l ClusterCPUusage_90 rule

l ClusterMEMUsage_80 rule

l ClusterMEMUsage_90 rule

l ClusterSTORUsage_80 rule

l ClusterSTORUsage_90 rule

Nutanix HardwareThis solution provides a summary of the health status and performance for Nutanix hardware. It includes the following views:

l HOST CPU USAGE (CPU Usage Over Time)

l HOST MEMORY USAGE (Memory Usage Over Time)

l HOSTS BY NUMBER OF HOSTED VMS (VMs per Host Over Time)

l HOST DISK AVERAGE I/O LATENCY (Host Disk Average I/O Latency Over Time)

l HOST DISK IOPS (Host Disk IOPS Over Time)

l ATTACHED STORAGE DRIVES (HDD, SSD)

l LIST OF QUERIES


https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-alerts

https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-alerts

Usage

32

l HostCPUusage_70 rule

l HostCPUusage_90 rule

l HostMEMusage_70 rule

l HostMEMusage_90 rule

Nutanix Hardware SensorsThis solution extends Nutanix hardware monitoring beyond disks and hosts by using DMTF’s Redfish standard specification and schema implementations, and offers management of scalable platform hardware to collect low-level information from hardware component sensors. The solution includes the following views:

l FANS (Total Fans)

l FAN SPEEDS (Fan Speeds Over Time)

l VOLTAGE SENSORS (Total Voltage Sensors)

l VOLTAGES (Voltages Over Time)

l TEMPERATURE SENSORS (Total Temperature Sensors)

l TEMPERATURES (Temperatures Over Time)

l POWER LEVELS (INPUT VOLTAGE OVER TIME, OUTPUT POWER OVER TIME, CONSUMED POWER OVER TIME)

l LIST OF QUERIES

Nutanix Log and Event AnalyticsThis solution provides a central point for Nutanix log and event collection and analytics. It also provides predefined queries on the Nutanix log files and events to help troubleshoot various Nutanix alerts and issues. The solution includes the following views:

l SYSLOG MESSAGES (Number of All Messages)

l EVENTS (Events by Severity)

l LIST OF QUERIES

Nutanix StorageThis solution provides a summary of the health status and performance for Nutanix storage. It includes the following views:

l CLUSTER STORAGE OVERVIEW (Storage Utilization by Cluster Over Time)

l STORAGE POOL SSD VS HDD RATIO (SSD vs HDD Ratio Over Time)

l STORAGE POOL DISK PERFORMANCE (Storage Pool Disk Average I/O Latency Over Time, Storage Pool Disk I/O Bandwidth Over Time, Storage Pool Disk IOPS Over Time)

l CONTAINER SSD VS HDD RATIO (SSD vs HDD Ratio Over Time)

Usage

33

l CONTAINER PERFORMANCE (Container Average I/O Latency Over Time, Container I/O Bandwidth Over Time, Container IOPS Over Time)

l LIST OF QUERIES

Nutanix Virtual MachinesThis solution provides a summary of the health status and performance for virtual machines hosted on Nutanix clusters. It includes the following views:

l VMS PER CLUSTER (VMs Per Cluster Over Time)

l VM CPU UTILIZATION (VM CPU Utilization Over Time)

l VM MEMORY UTILIZATION (VM Memory Utilization Over Time)

l VM AVERAGE I/O LATENCY (VM Average I/O Latency Over Time)

l VM I/O BANDWIDTH (VM I/O Bandwidth Over Time)

l VM IOPS (VM IOPS Over Time)

l CONTROLLER VM CPU UTILIZATION (CVM CPU Utilization Over Time)

l CONTROLLER VM MEMORY UTILIZATION (CVM Memory Utilization Over Time)

l LIST OF QUERIES


l NutanixCVMCPUusage_70 rule

l NutanixCVMCPUusage_90 rule

l NutanixCVMMEM_70 rule

l NutanixCVMMEM_90 rule

l NutanixVMCPU_70 rule

l NutanixVMCPU_90 rule

l NutanixVMMEM_70 rule

l NutanixVMMEM_90 rule

34

TroubleshootingIf you encounter problems when using OMS Solution for Nutanix, you can often solve them yourself. This chapter contains information that may help you in such cases.

General troubleshooting guidelinesWhen investigating an issue, first verify that:

l All installation prerequisites are fulfilled and the product is configured according to the provided instructions.

l You are not running into a known product limitation. For a list of the limitations, see the HYCU OMS Solution for Nutanix Release Notes.

l Your issue is not related to third-party software or hardware (Nutanix or Microsoft). Otherwise, contact the respective vendor for assistance.

l You have the latest operating system and software application patches installed on the affected systems.

l The affected systems are not running out of memory or storage space.

OMS Data Collector for Nutanix log filesOMS Data Collector for Nutanix records occurrences of unexpected behavior (errors) into its log files. You can browse through the most recent log entries in the Data Collector Log page of the Data Collector configuration GUI.

Chapter 5

Troubleshooting

35

Figure 5–1: Data Collector Log – Recent Log Entries page

To download the complete set of log files with an entire error history and further error details, click Download Entire Log in the main toolbar.

Problems and solutionsThis section lists symptoms of common problems that you may encounter while using OMS Solution for Nutanix, together with proposed actions – resolution steps.

You cannot reach OMS Data Collector for Nutanix configuration GUISymptom

Webpage of the OMS Data Collector for Nutanix configuration GUI is inaccessible.

Action

Verify the status of the hycuomsdc service on the Data Collector system. Do the following:

1. Open a command shell and run the following command:

service hycuomsdc status

Troubleshooting

36

2. Depending on the command output that you get, do one of the following:

l hycuomsdc is not running ...

Run the following command to start it:


l hycuomsdc is running ... PID=<ProcessID>

In this instance, <ProcessID> is the process identification number of the Data Collector process.

This means that the service is running, but unresponsive. Run the following command to restart it:

service hycuomsdc restart

Microsoft OMS settings do not appear to be savedSymptom

In the Microsoft OMS Settings page of the OMS Data Collector for Nutanix configuration GUI, nothing happens after you attempt to save configuration for which a valid workspace ID and a primary key are specified.

Action

Inspect the OMS Data Collector for Nutanix log for the following error—it may indicate that OMS Data Collector for Nutanix is not able to establish a direct connection to OMS:

"message":"Could not process web request to OMS.","stack":"Error: connect ETIMEDOUT <OMSworkspaceAddress>:443"

In this instance, <OMSworkspaceAddress> is the URL of your OMS workspace.

If you find this error, set the HTTP proxy server in the operating system's configuration on the Data Collector system. For instructions, see section "Configuring the product to use a proxy server" on page 1.

An error related to local time configuration is reported when saving Microsoft OMS settingsSymptom

In the Microsoft OMS Settings page of the OMS Data Collector for Nutanix configuration GUI, after you attempt to save configuration for which a valid workspace ID and a primary key are specified, the following error is reported:

The workspace key could not be validated due to the local system time not matching the time in Azure.

Troubleshooting

37

Action

Inspect the OMS Data Collector for Nutanix log for the following error—it indicates that the local time on the OMS Data Collector for Nutanix host system is set incorrectly:

Please check that the local system time is accurate and the correct time zone is set. The request time was <RequestDateTime> while the service processed the request at <ActionDateTime>. The difference in time was <TimeDifference> and the maximum allowed difference is 00:15:00.

If you find this error, adjust time settings on the OMS Data Collector for Nutanix host system to reflect accurate date and time (in your local time zone).

Before contacting HYCU Customer SupportIf you cannot solve your issue, report it. Before contacting HYCU Customer Support, make sure that:

l You perform the general checks. For details, see section “General troubleshooting guidelines” on page 34.

l You verify that your problem is not documented in this chapter. For details, see section “Problems and solutions” on page 35.

l You collect relevant data that might be required to send to HYCU Customer Support: a description of your problem, configuration specification of your environment, and similar information. For details, see section “Customer Support” on page 38.

The HYCU Customer Support team will provide you with further instructions. Among other things, you may be asked to perform diagnostic operations in your environment and collect specific data from your systems and send it to HYCU.

n Note The HYCU Customer Support team is not qualified to solve the issues related to third-party software or hardware.

For information on how to reach HYCU Customer Support, see part “HYCU Customer Support and information ” on page 38.

38

HYCU Customer Support and information Use the communication channels listed in this section if you need:

l Help with the product licensing process

l Assistance while using the product

l Additional information about this product

l Information about other HYCU products

Customer SupportShould you require additional information or assistance while using the product, contact the vendor that shipped it.

If you have purchased the product directly from HYCU, and are experiencing a problem, search for a solution on the following webpage:support.hycu.com

In the absence of an article addressing your problem, ask HYCU Customer Support for assistance: on the webpage, click Submit a request and fill in the request form. You must be signed in with a valid account prior to submission. Apply for an account at the following email address:[email protected]

Important: Before submitting a request to the Customer Support department, perform a health check on all systems that are in failed (critical, red) state and have the following information ready:

l Symptoms

l Sequence of events leading to the problem

l Commands and options that you used

l Messages you have received (a description with the date and time)

For a complete list of pieces of required support information, check troubleshooting sections in the product documentation.

Company website and video channelFor more information about our company and other products we offer, visit HYCU website at:www.hycu.com

https://support.hycu.com/


http://www.hycu.com/

39

For additional product-related information, watch videos on the HYCU channel on YouTube:www.youtube.com/c/HYCUInc

General informationFor questions related to product business or purchase of this or other HYCU products, send an email to:[email protected]

FeedbackFor comments or suggestions about this product, including its documentation, send an email to:[email protected]

We will be glad to hear from you!

https://www.youtube.com/c/HYCUInc



www.hycu.com

Documents

HYCU OMS Solution for Nutanix User Guide · HYCU OMS Solution for Nutanix (OMS Solution for Nutanix) is an availability, performance management, and analysis solution that extends