HPE 

Operations Connector for

Nutanix
Software Version: 1.00
Windows® operating systems

Integration Guide

Document Release Date: January 2017

Software Release Date: January 2017
Integration Guide

Legal Notices
Warranty
The only warranties for Hewlett Packard Enterprise 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. HPE shall not be liable for technical or editorial errors or omissions
contained herein.
The information contained herein is subject to change without notice.

Restricted Rights Legend

Confidential computer software. Valid license from HPE required for possession, use or copying. Consistent
with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and
Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard
commercial license.

Copyright Notice
© Copyright 2016 Hewlett Packard Enterprise Development LP

Trademark Notices
Microsoft®, Windows® and Windows Server® are U.S. registered trademarks of Microsoft Corporation.
Nutanix is a trademark of Nutanix, Inc.

Documentation Updates
The title page of this document contains the following identifying information:
l Software Version number, which indicates the software version.
l Document Release Date, which changes each time the document, is updated.
l Software Release Date, which indicates the release date of this version of the software.
To check for recent updates or to verify that you are using the most recent edition of a document, go to:
https://hpln.hpe.com/. This site requires that you register for an HPE Passport and sign in. To register for an
HPE Passport ID, click Log in on the HPE Live Network site or click New users - please register on the HPE
Passport login page.

Support
This document describes HPE Live Network Content Marketplace. Hewlett Packard Enterprise Software
does not test, certify or support Community Content. Please use the Community Content discussion forums
on HPE Live Network Content Marketplace or contact the original submitter of the Community Content
directly if any support, configuration or usability questions arise. Please back up all appropriate Operations
Connector for Nutanix files before applying Community Content in your environment.

HPE Operations Connector for Nutanix (1.00) Page 2 of 17

Integration Guide

Contents
Chapter 1: Introduction 4
Using Ops Connector for Nutanix 4

Setup Options 4

Ops Connector for Nutanix Topology in OMi Environment 4

Ops Connector for Nutanix Events in OMi Environment 6

Ops Connector for Nutanix Metrics in OMi Environment 7

Chapter 2: Installing Operations Connector for Nutanix 8

Installation Prerequisites 9
Application Software 9
TCP/IP Ports 9
Other Prerequisites and Requirements 10

Install Operations Connector for Nutanix 11

Downloading and Installing Operations Connector for Nutanix 11

Installing OMi Content Pack for Nutanix 12

Chapter 3: Configuring Operations Connector for Nutanix 13

Configure Data Collection 13

Manage Integration Services 15

Starting and Stopping the Services 15
Restarting the Services 15
Checking the Service States 15

Send Documentation Feedback 17

HPE Operations Connector for Nutanix (1.00) Page 3 of 17

Chapter 1: Introduction
HPE Operations Connector for Nutanix (Ops Connector for Nutanix) and HPE Operations Manager i (OMi)
integrates Nutanix so that the gathered systems-management data in a Nutanix environment is made
available to the OMi solution. Such data can then be monitored and processed effectively within OMi. Ops
Connector for Nutanix therefore enables you to establish a link between Nutanix environment and operations
management in OMi.

Using Ops Connector for Nutanix

Ops Connector for Nutanix is essentially a product complementary to Operations Connector (OpsCx). It
enhances Operations Connector to provide the following functionality:

l Collecting Nutanix alerts1 (events), monitored objects (topology), and performance data (metrics) from a
Nutanix environment.
l Mapping the collected data to an OMi-compliant form.
l Customizing data collection and data mapping.
The basic part of Ops Connector for Nutanix is the Generic Integrator module (GenInt). It provides Ops
Connector for Nutanix with common functionality for integrating Operations Connector and a third-party or
HPE's systems, storage, or infrastructure management application.

Setup Options
Operations Connector and Ops Connector for Nutanix reside on a dedicated integration server outside the
Nutanix architecture.

Ops Connector for Nutanix Topology in OMi

Environment
Ops Connector for Nutanix dynamically propagates the Nutanix topology data to OMi as follows (the process
is repeated regularly):

1Alerts are generated when events occur on the monitored objects, when data analysis indicates deviations

from normal metric values, or when a problem occurs with one of the Nutanix components.

HPE Operations Connector for Nutanix (1.00) Page 4 of 17

Integration Guide
Chapter 1: Introduction

1. Topology structures are collected from Nutanix with a Web Service request to the Ops Connector for
Nutanix host.
2. In Ops Connector for Nutanix, the collected topology data is preprocessed with a Lua script, and then
stored in an XML file on the Ops Connector for Nutanix host.
3. The preprocessed topology data is mapped using an Operations Connector policy of the XML File type,
and then forwarded to OMi.
The collection, processing, and mapping of the topology data can be configured as part of advanced
configuration of Ops Connector for Nutanix.

Figure 1. Architectural overview of the Nutanix topology integration with OMi, as implemented in a
distributed setup.

Nutanix topology structure is mapped to an equivalent structure in OMi. The topology structure is constructed
from three topology entity types:

l Configuration items (CIs) (objects in Nutanix)

l CI attributes (object attributes in Nutanix)
l Relations between CIs (relations between objects in Nutanix)

Note: When a CI is still present in OMi, but its corresponding original object no longer exists in the Ops
Connector for Nutanix-managed infrastructure, OMi initiates the deletion only when the CI's last update
time falls out of the aging time threshold configured in the Operations Connector policy for Nutanix
topology. Therefore, such CI is not necessarily deleted immediately after the next topology collection
query executed by Ops Connector for Nutanix.

HPE Operations Connector for Nutanix (1.00) Page 5 of 17

Integration Guide
Chapter 1: Introduction

In scope of topology collection, Ops Connector for Nutanix also acquires and forwards identification data of
the integrated systems-management application (Nutanix Prism) to OMi. Nutanix is therefore presented in
the HPE Operations Manager i console as the origin of the collected topology data.

Ops Connector for Nutanix Events in OMi

Environment
Ops Connector for Nutanix makes Nutanix events available in OMi as follows (the process is repeated at
regular intervals):

1. Events are collected from Nutanix with a Web Service request to the Ops Connector for Nutanix host.
2. In Ops Connector for Nutanix, the collected events are preprocessed with a Lua script, and then sent to
the REST Web Service endpoint of Operations Connector.
3. The preprocessed events are mapped using an Operations Connector policy of the REST Web Service
Listener type, and then forwarded to OMi.
The collection, processing, and mapping of events can be configured as part of advanced configuration of
Ops Connector for Nutanix.

Figure 2. Architectural overview of the Ops Connector for Nutanix event integration with OMi, as
implemented in a consolidated setup.

HPE Operations Connector for Nutanix (1.00) Page 6 of 17

Integration Guide
Chapter 1: Introduction

Ops Connector for Nutanix Metrics in OMi

Environment
Ops Connector for Nutanix makes Nutanix metrics available in OMi as follows (the process is repeated
regularly):

1. Metric structures are collected from Ops Connector for Nutanix with a Web Service request to the Ops
Connector for Nutanix UI virtual machine.
2. In Operations Connector for Nutanix, the collected metrics are sent to the REST Web Service endpoint
of Operations Connector.
3. The preprocessed metrics are mapped using an Operations Connector policy of the REST Web Service
Listener type, and then forwarded to OMi.
Figure 3. Architectural overview of the Ops Connector for Nutanix metric integration with OMi, as
implemented in a consolidated setup.

The mapped metrics are visually presented in HPE Operations Manager i with the help of performance
dashboard provided by Ops Connector for Nutanix. The visual metric representation is available at
Workspaces > Operations Console > Performance Perspective > Nutanix_Cluster_Topology.

HPE Operations Connector for Nutanix (1.00) Page 7 of 17

Chapter 2: Installing Operations
Connector for Nutanix
The following section provides information about installing Ops Connector for Nutanix version 1.00.

Before installing Ops Connector for Nutanix, consider the installation prerequisites . Before you start with the
installation process, familiarize yourself with the conventions listed in the table in this section.

Installation of Ops Connector for Nutanix consists of following tasks. Complete them in the following order:

1. Obtain and install Ops Connector for Nutanix. See "Install Operations Connector for Nutanix" on page
11.
2. Install the OMi Content Pack for Nutanix. See "Installing OMi Content Pack for Nutanix" on page 12.
Although performing this task is mandatory only if you plan to collect Nutanix topology, visualize Nutanix
metrics, or if you intend to enrich the collected Nutanis events with topology-related information, HPE
strongly recommends that you perform it in any case.
Conventions Used in the Installation, Configuration, and Other Procedures

The following placeholders are used in the instructions throughout this document. When performing the steps,
specify the actual value in place of each placeholder:

Placeholder Meaning Example of Default Values

<Version> Product version string of Ops Connector for Example:

Nutanix: major version, minor version, and
build number. It is embedded in the filename
of the installation package.
01.00.007
This string represents the version 1.00
and the build number 007.

<OvInstallDir> Directory where HPE Operations Agent and Windows:

Ops Connector for Nutanix are installed on C:\Program Files\HP \
the Operations Connector host. \HP BTO Software

<OvDataDir> Data directory of HPE Operations Agent Windows:

that is jointly used by Operations Connector C:\ProgramData\HP\HP BTO Software
and Ops Connector for Nutanix.
Tip: The C:\ProgramData directory
is hidden by default.

<OMiHome> Directory where Operations Manager i is Windows:

installed. C:\HPBSM

HPE Operations Connector for Nutanix (1.00) Page 8 of 17

Integration Guide
Chapter 2: Installing Operations Connector for Nutanix

Note: All paths in this document use slash (/) as path delimiters except in contexts where the operating
system specifics are stated. When performing the steps, use the path delimiters that your operating
system supports.

Installation Prerequisites
The following sections list the prerequisites that need to be fulfilled to enable installation of Operations
Connector for Nutanix.

Application Software
Before you install Operations Connector for Nutanix, the following software applications must be installed
and configured:

Application Supported Versions

Nutanix 4.7

HPE Operations 10.11 or later

Manager i

Operations 10.11 or later

Connector
Note: Operations Connector must be configured as a connected server in
HPE Operations Manager i and properly integrated to HPE Operations Manager i.

TCP/IP Ports
The following table lists the ports that Operations Connector for Nutanix uses by default. In your Operations
Connector environment, these ports may not be used by other software applications.

Port Number Port Description

9440 Default REST Web Service Listener port on Nutanix Prism UI (default HTTPS port).

Used for receiving topology, events and metrics data from the Nutanix UI.

30005 Default port of Operations Connector policies of the REST Web Service Listener
type.

Used for dispatching Nutanix events and metrics to the respective Operations
Connector policies.

HPE Operations Connector for Nutanix (1.00) Page 9 of 17

Integration Guide
Chapter 2: Installing Operations Connector for Nutanix

Port Number Port Description

30006 Default socket communication port.

Used for receiving events and topology data from a remote Nutanix virtual machine.

Caution: If Nutanix and Operations Connector communicate through a firewall, make sure the firewall
rules allow connections through the listed ports.

If the default ports are not free, you can still change the port numbers while configuring Operations Connector
for Nutanix. Remember that changing the port numbers include mandatory actions also in the third-party
system management application or Operations Connector in order to reconfigure specific ports.

Other Prerequisites and Requirements

The following is a list of additional prerequisites and the requirements you must consider before installing the
product:

l For collecting the metrics, topology, and events, you must use a Nutanix user account with administrative
privileges to access the Ops Connector for Nutanix web UI.
l To be able to configure and administer Operations Connector for Nutanix, familiarize yourself with HPE
Operations Connector and its console. For example, you can learn how to import, activate, and reconfigure
policies. For more information about these and other relevant topics, see the OMi Connector User Guide.

HPE Operations Connector for Nutanix (1.00) Page 10 of 17

Integration Guide
Chapter 2: Installing Operations Connector for Nutanix

Install Operations Connector for Nutanix

The following section provides information about installing Operations Connector for Nutanix version 1.00.

Downloading and Installing Operations Connector for

Nutanix
To download and install Operations Connector for Nutanix, perform the following steps:

1. From the web site HPE Live Network, download the Operations Connector for Nutanix product
installation package (product image archive) for the target operating system.
2. Store the product image archive at a temporary location on the Operations Connector host.
3. Check if there are installations of Operations Connector components for other systems management
applications on the Operations Connector host. If such components are present, stop their data
collection services by running the following command:
ovc -stop <collection service>

Note: Operations Connector for Nutanix may include a newer version of GenInt from the already
installed Operations Connector components. In this case, the installed GenInt is upgraded. GenInt
is backward compatible.

4. Considering the operating system on the Operations Connector host, install Operations Connector for
Nutanix on the Operations Connector host as follows:
o For Windows:
i. Launch Windows Explorer and locally unzip the product image archive
ProductImage-OpsCxNutanix-<Version>-Win5.2_64-release.zip.
ii. To start the installer program, change the current directory to
ProductImage-OpsCxNutanix-<Version>-Win5.2_64-release and run the following
command:

OpsCxNutanix_<Version>_Setup.exe

iii. To start the installation, follow the instructions displayed by the installer program. If all
prerequisite checks pass, click Install.
iv. To close the installer program, click Done after the installation completes.

5. If there are Operations Connector components for other third-party system management applications
already installed on the Operations Connector host, start the data collection services of these
components again by keying in the following command:
ovc -start <collection service>

HPE Operations Connector for Nutanix (1.00) Page 11 of 17

Integration Guide
Chapter 2: Installing Operations Connector for Nutanix

Installing OMi Content Pack for Nutanix

OMi Content pack include Topology Synchronization files, performance dashboard and topology model. Ops
connector for Nutanix can forward only Nutanix topology to OMi when required toposync package is registred
with OMi. This package is included in the Ops Connector for Nutanix product image archive. Additionally,
visual representation of metrics in the Ops Connector for Nutanix web interface is only available when the
bundled performance dashboard are imported into Ops Connector for Nutanix as a content pack.

To install OMi content pack for Nutanix, perform these steps:

1. On the Ops Connector for Nutanix host, locate the OpsCxNutanix_OMi_Content.zip file at the following
location:
<OvDataDir>\installation\OpsCxNutanix\omi-content
2. Copy the ZIP file from the directory on the Ops Connector for Nutanix host to a location of your choice on
the OMi host, and unzip.
3. Change the current directory to the OpsCxNutanix subdirectory within the temporary directory where you
unpacked the archive.
4. Considering the host operating system, run the following command :
Windows:
cscript OpsCxInstall.vbs -i

After you successfully complete the installation procedures, continue with the configuration steps as
described in "Configuring Operations Connector for Nutanix" on page 13.

HPE Operations Connector for Nutanix (1.00) Page 12 of 17

Chapter 3: Configuring Operations
Connector for Nutanix
Essential Configuration

Essential configuration of Operations Connector for Nutanix consists of the following tasks. Based on the
setup options, follow the steps accordingly:

1. Configure the event integration: set the event integration options, import the policy for Nutanix events
into Operations Connector and activate it:
2. Configure the topology integration: set the topology integration options, import the policy for Nutanix
topology into Operations Connector and activate it:
3. Configure the metric integration: set the metric integration options, import the policy for Nutanix metrics
into Operations Connector and activate it:
Advanced Configuration

Advanced configuration of Operations Connector for Nutanix is not mandatory. It includes the following tasks:

l Configure the behavior of the events and topology integrations.

Caution: HPE recommends that the advanced configuration tasks are performed only by users with
Nutanix Operations Manager domain expertise.

Configure Data Collection

To integrate Nutanix events, topology, and metrics into OMi, complete the following procedure on your
Operations Connector host.

Note: In case you do not want to integrate all Nutanix entity types, omit the actions specific to the type
you chose to exclude.

Complete the following procedure on your Operations Connector host:

1. Change the current directory to <OvDataDir>/conf/OpsCxNutanix and open the nutanix_remote.conf

file (the shared integration configuration file) in a plain text editor.
2. In the configuration file, replace the values in quotation marks in the lines of the following options:
o nutanix-hostname: The FQDN or IP address of your Nutanix UI.

3. Review the preconfigured values of basic configuration options and adjust them as needed. Add and
configure advanced options if necessary.

HPE Operations Connector for Nutanix (1.00) Page 13 of 17

Integration Guide
Chapter 3: Configuring Operations Connector for Nutanix

4. Save your changes.

5. Log on to the Operations Connector web interface.
6. Import the policies by navigating to the <OvDataDir>/installation/OpsCxNutanix/policies
directory and selecting the following files:
o For Nutanix events:
n faf71921-0b9d-4a81-9a9e-8636c79feafa_data

n faf71921-0b9d-4a81-9a9e-8636c79feafa_header.xml

o For Nutanix topology:

n a791172b-b723-47b7-82cb-c27d01728900_data

n a791172b-b723-47b7-82cb-c27d01728900_header.xml

For Nutanix self-discovery topology:

n b7de0660-bd29-484b-8ca0-e0c10968a7c8_data

n b7de0660-bd29-484b-8ca0-e0c10968a7c8_header.xml

o For Nutanix metrics:

n 3872de8d-1aab-4a10-bd06-4d9b8158bfcd_data

n 3872de8d-1aab-4a10-bd06-4d9b8158bfcd_header.xml

In Operations Connector, the type of policies for Nutanix events and metrics is REST Web Service
Listener, and the type of policies for Nutanix topology and self-discovery topology is XML File.
Operations Connector validates them after importing.
7. Review the policies to make sure their settings are proper for your Operations Connector for Nutanix
configuration.
8. From the Operations Connector web interface, activate the imported policies.
9. Open a Command Prompt window (command shell).
10. To configure the credentials of the user account with administrative privileges to access the Nutanix
UI for collecting metrics, run the following commands and enter the appropriate values:
genintcrypt --generate
genintcrypt --set nutanix_user
genintcrypt --set nutanix_password

Tip: Typed text is not visible in the Command Prompt window. If you make an error, do not attempt
to correct the text, but rather run the command again.

11. To verify the entered credentials, run the following commands:

genintcrypt --check nutanix_user
genintcrypt --check nutanix_password

HPE Operations Connector for Nutanix (1.00) Page 14 of 17

Integration Guide
Chapter 3: Configuring Operations Connector for Nutanix

A correct configuration is denoted by the following response of each command:

genintcrypt:Value exists for ID '<ArgumentName>'
12. Considering the operating system on the Operations Connector host, run the following command to
register the corresponding component with HPE Operations Agent:
For Windows:
ovcreg -add "<OvDataDir>\installation\OpsCxNutanix\ovc\OpsCxNutanix.xml"
13. To start the shared data collection service, run the following command:
ovc -start nutanix

Manage Integration Services

Operations Connector for Nutanix enables you to manage its event, topology, and metric integration services.

Starting and Stopping the Services

While you do not need to manually start or stop the integration services of Operations Connector for Nutanix
in normal circumstances, there may be cases when this action is necessary. To start or stop the integration
services, perform these steps:

1. Open a Command Prompt window (command shell).

2. To start or stop all integration services on the Operations Connector host, run the appropriate command:
ovc -start nutanix
ovc -stop nutanix

Restarting the Services

After reconfiguring Operations Connector for Nutanix, you must restart its integration services. You can
restart either all integration services or a specific service if only a specific configuration file has changed.
Perform these steps:

1. Open a Command Prompt window (command shell).

2. To restart all integration services on the Operations Connector host, run the following command:
ovc -restart nutanix

Checking the Service States

Using the Operations Connector for Nutanix command-line interface, you can also check whether the
integration services are running. Perform these steps:

HPE Operations Connector for Nutanix (1.00) Page 15 of 17

Integration Guide
Chapter 3: Configuring Operations Connector for Nutanix

1. Open a Command Prompt window.

2. To check the states of all integration services on the Operations Connector host , run the following
command:
ovc -status nutanix

HPE Operations Connector for Nutanix (1.00) Page 16 of 17

Send Documentation Feedback
If you have comments about this document, you can contact the documentation team by email. If an email
client is configured on this system, click the link above and an email window opens with the following
information in the subject line:

Feedback on Integration Guide (Operations Connector for Nutanix 1.00)

Just add your feedback to the email and click send.

If no email client is available, copy the information above to a new message in a web mail client, and send
your feedback to docfeedback@hpe.com.

We appreciate your feedback!

HPE Operations Connector for Nutanix (1.00) Page 17 of 17