Supported Versions
Version 6.1
REST API version: using V2 and V3

Application Version and Upgrade Details

Application VersionBug fixes / Enhancements
4.0.1Fixed Issues related to discovery of Vms and cluster metrics.
4.0.0
  • Feasibility to provide API Timeouts from UI.
  • Nutanix Host Hypervisor Memory Usage PPM new Metric support.
  • Changed the PPM value metrics to Percentage(%) and Bytes metric values to GB values.
3.0.0API Statistics and Full discovery support.
Click here to view the earlier version updates
Application VersionBug fixes / Enhancements
2.1.3Bug fix for Vm Discovery.
2.1.0V3 version API for fetching the alerts.
2.0.0
  • Nutanix Vm Metrics support.
  • Alerting on gateway in initial Case of Discovery Failure.

Introduction

Prism is a distributed resource management platform which allows you to manage and monitor objects, and services across the Nutanix environment, whether hosted locally or in the cloud.

Prism is broken down into two main components:

  • Prism Central (PC)
    • Multiple Nutanix Clusters are managed by Multi-cluster managers and also provide a single, centralized management interface. This is an optional software appliance (VM) which can be deployed in addition to the AOS Cluster (can run on it).
    • 1-to-many cluster manager
  • Prism Element (PE)
    • Localized cluster manager responsible for local cluster management and operations. Every Nutanix Cluster has a Prism Element built-in.
    • 1-to-1 cluster manager.

Monitoring Use cases

The device monitoring collects the metric values with respect to time and sends alerts to your team to act up immediately in case of any threshold breach or unexpected metric behavior based on configurations. In a way it helps you with smooth functioning of business with minimal or zero downtime in case of any infrastructure related issues occurring.

The below figure illustrates the conceptual relationship between Prism Central and Prism Element:

Nutanix Prism

Prerequisites

  • OpsRamp Classic Gateway 14.0.0 and above.
  • OpsRamp NextGen Gateway 14.0.0 and above.
  • Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc.

Hierarchy of Nutanix Elements

  Cluster
   - Host
    - VM
    - Disks
  - Storage Container

Default Monitoring Configurations

Nutanix Prism Central have default Global Device Management Policies, Global Templates, Global Monitors and Global metrics in OpsRamp. You can customize these default monitoring configurations as per their business use cases by cloning respective global templates and global Device Management Policies. OpsRamp recommends doing this activity before installing the application to avoid noise alerts and data.

  1. Default Global Device Management Policies

OpsRamp has a Global Device Management Policy for each Native Type of Nutanix Prism Central. You can find those Device Management Policies at Setup > Resources > Device Management Policies, search with suggested names in global scope. Each Device Management Policy follows below naming convention:

{appName nativeType - version}

Ex: nutanix-prism-central Nutanix Storage Container - 1 (i.e, appName = nutanix-prism-central, nativeType = Nutanix Storage Container, version = 1)

  1. Default Global Templates

OpsRamp has a Global template for each Native Type of Nutanix Prism Central. You can find those templates at Setup > Monitoring > Templates, search with suggested names in global scope. Each template follows below naming convention:

{appName nativeType 'Template' - version}

Ex: nutanix-prism-central Nutanix Storage Container Template - 1 (i.e, appName = nutanix-prism-central, nativeType = Nutanix Storage Container Template, version = 1)

  1. Default Global Monitors

OpsRamp has a Global Monitors for each Native Type which has monitoring support. You can find those monitors at Setup > Monitoring > Monitors, search with suggested names in global scope. Each Monitors follows below naming convention:

{monitorKey appName nativeType - version}

Ex: Nutanix Storage Container Monitor nutanix-prism-central Nutanix Storage Container 1(i.e, monitorKey = Nutanix Storage Container Monitor, appName = nutanix-prism-central, nativeType = Nutanix Storage Container, version = 1)

Configure and Install the Nutanix Prism Central Integration

  1. From All Clients, select a client.
  2. Go to Setup > Integrations and Apps.
  3. The INSTALLED INTEGRATIONS page, where all the installed applications are displayed.
    Note: If there are no installed applications, it will navigate to the ADD APP page.
  1. Click + ADD on the INSTALLED INTEGRATIONS page. The AVAILABLE INTEGRATIONS AND APPS page displays all the available applications along with the newly created application with the version.
    Note: You can even search for the application using the search option available. Also you can use the All Categories option to search.
Nutanix Prism
  1. Click ADD in the Nutanix Prism Central application.
  2. In the Configurations page, click + ADD. The Add Configuration page appears.
  3. Enter the below mentioned BASIC INFORMATION:
FunctionalityDescription
NameEnter the name for the integration
IP Address/Host NameIP address/host name of the target.
PortPort

Note: By default 9440 is added.
CredentialsSelect the credentials from the drop-down list.
Note: Click + Add to create a credential.

Notes:

  • By default the Is Secure checkbox is selected.
  • Ip Address/Host Name and Port should be accessible from Gateway.
  • Select the following:
    • App Failure Notifications: if turned on, you will be notified in case of an application failure.
    • Alert Configuration: map alert configuration for third party alerts into OpsRamp.
  • Below are the default values set for:
    • Alert Severity: Possible values of Alert Severity Filter configuration property are kWarning, kCritical, kinfo.
    • Alert Severity Mapping: Possible values of Alert Severity Mapping Filter configuration property are kWarning, kCritical, kInfo.
  1. Select the below mentioned CUSTOM ATTRIBUTE:
Object NameDescription
Custom AttributeSelect the custom attribute from the drop down list box
ValueSelect the value from the drop down list box.

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

  1. In the RESOURCE TYPE section, select:

    • ALL: All the existing and future resources will be discovered.
    • SELECT: You can select one or multiple resources to be discovered.
  2. In the DISCOVERY SCHEDULE section, select recurrence pattern to add one of the following patterns:

    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  3. Click ADD.

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

  1. Click NEXT
  2. Below are the optional steps you can perform on the Installation page.
  • Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.

    Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.

Cisco FirePower
  • Click +ADD to create a new collector by providing a name or use the pre-populated name.
Aruba Airwave Integrations
  1. Select an existing registered profile.
Aruba Airwave Integrations
  1. Click FINISH.

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

Modify the Configuration

View the Nutanix Prism Central Details

The Nutanix Prism Central integration is displayed in the Infrastructure > Resources > Cluster. You can navigate to the Attributes tab to view the discovery details, and Metrics tab to view the metric details for Nutanix Prism Central.

Nutanix Prism
Nutanix Prism

Supported Alert Custom Macros

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

Click here to view the alert subject and description with macros

                                ${resource.name}

                                ${resource.ip}

                                ${resource.mac}

                                ${resource.aliasname}

                                ${resource.os}

                                ${resource.type}

                                ${resource.dnsname}

                                ${resource.alternateip}

                                ${resource.make}

                                ${resource.model}

                                ${resource.serialnumber}

                                ${resource.systemId}

                                ${Custome Attributes in the resource}

                                ${parent.resource.name}

Supported Metrics

Click here to view the supported metrics
Native TypeMetric NameDisplay NameUnitsApplication VersionDescription
Clusternutanix_cluster_is_AvailableNutanix Cluster Availability1.0.0Provides Nutanix Cluster Availability. Possible values 1-active 0-inactive
nutanix_cluster_controller_NumIOPSNutanix Cluster Controller NumIOPSiops1.0.0Provides Nutanix Cluster Controller NumIOPS
nutanix_cluster_dataReduction_overallSavingRatio_PPMNutanix Cluster DataReduction Overall SavingRatio PPM%1.0.0Provides Nutanix Cluster DataReduction Overall SavingRatio PPM
nutanix_cluster_NumReadIOPSNutanix Cluster NumReadIOPSiops1.0.0Provides Nutanix Cluster NumReadIOPS
nutanix_cluster_NumWriteIOPSNutanix Cluster NumWriteIOPSiops1.0.0Provides Nutanix Cluster NumWriteIOPS
nutanix_cluster_storage_CapacityBytesNutanix Cluster Storage CapacityBytesGB1.0.0Provides Nutanix Cluster Storage CapacityBytes
nutanix_cluster_storage_FreeBytesNutanix Cluster Storage FreeBytesGBProvides Nutanix Cluster Storage FreeBytes
nutanix_Cluster_hypervisor_avgIO_LatencyUsecsNutanix Cluster Hypervisor AvgIO LatencyUsecsmicrosec1.0.0Provides Nutanix Cluster Hypervisor AvgIO LatencyUsecs
nutanix_cluster_hypervisorWrite_IOBandwidthKBPSNutanix Cluster Hypervisor WriteIO BandwidthKBPSkbps1.0.0Provides Nutanix Cluster Hypervisor WriteIO BandwidthKBPS
nutanix_cluster_readIO_PPMNutanix Cluster ReadIO PPM%1.0.0Provides Nutanix Cluster ReadIO PPM
nutanix_cluster_replicationTransmitted_BandwidthKBPSNutanix Cluster Replication Transmitted BandwidthKBPSKbps1.0.0Provides Nutanix Cluster Replication Transmitted BandwidthKBPS
nutanix_cluster_hypervisor_cpuUsage_PPMNutanix Cluster Hypervisor Cpu Usage PPM%1.0.0Provides Nutanix Cluster Hypervisor Cpu Usage PPM
nutanix_cluster_controller_ReadIOPPMNutanix Cluster Controller ReadIO PPM%1.0.0Provides Nutanix Cluster Controller ReadIO PPM
nutanix_cluster_contentCache_HitPPMNutanix Cluster Content Cache HitPPM%1.0.0Provides Nutanix Cluster Content Cache HitPPM
nutanix_cluster_hypervisor_avgReadIO_LatencyUsecsNutanix Cluster Hypervisor Avg ReadIO LatencyUsecsmicrosec1.0.0Provides Nutanix Cluster Hypervisor Avg ReadIO LatencyUsecs
nutanix_cluster_replicationReceived_BandwidthKBPSNutanix Cluster Replication Received BandwidthKBPSKbps1.0.0Provides Nutanix Cluster Replication Received BandwidthKBPS
nutanix_cluster_controller_avgIO_LatencyUsecsNutanix Cluster Controller AvgIO LatencyUsecsmicrosec1.0.0Provides Nutanix Cluster Controller AvgIO LatencyUsecs
nutanix_cluster_controller_readIO_BandwidthKBPSNutanix Cluster Controller ReadIO BandwidthKBPSKbps1.0.0Provides Nutanix Cluster Controller ReadIO BandwidthKBPS
nutanix_cluster_controller_IO_BandwidthKBPSNutanix Cluster Controller IO BandwidthKBPSKbps1.0.0Provides Nutanix Cluster Controller IO BandwidthKBPS
nutanix_cluster_avgIO_LatencyUsecsNutanix Cluster AvgIO LatencyUsecsmicrosec1.0.0Provides Nutanix Cluster AvgIO LatencyUsecs
nutanix_cluster_controller_writeIO_BandwidthKBPSNutanix Cluster Controller WriteIO BandwidthKBPSKbps1.0.0Provides Nutanix Cluster Controller WriteIO BandwidthKBPS
nutanix_cluster_controller_writeIO_PPMNutanix Cluster Controller WriteIO PPM%1.0.0Provides Nutanix Cluster Controller WriteIO PPM
nutanix_cluster_hypervisor_avgWriteIO_LatencyUsecsNutanix Cluster Hypervisor Avg WriteIO LatencyUsecsmicrosec1.0.0Provides Nutanix Cluster Hypervisor Avg WriteIO LatencyUsecs
nutanix_cluster_readIO_BandwidthKBPSNutanix Cluster Read IO BandwidthKBPSKbps1.0.0Provides Nutanix Cluster Read IO BandwidthKBPS
nutanix_cluster_hypervisor_memoryUsage_PPMNutanix Cluster Hypervisor MemoryUsage PPM%1.0.0Provides Nutanix Cluster Hypervisor MemoryUsage PPM
nutanix_cluster_hypervisor_IO_BandwidthKBPSNutanix Cluster Hypervisor IO BandwidthKBPSKbps1.0.0Provides Nutanix Cluster Hypervisor IO BandwidthKBPS
nutanix_cluster_hypervisor_kvm_cpuUsage_PPMNutanix Cluster Hypervisor Kvm Cpu Usage PPM%1.0.0Provides Nutanix Cluster Hypervisor Kvm Cpu Usage PPM
nutanix_cluster_writeIO_BandwidthKBPSNutanix Cluster WriteIO BandwidthKBPSKbps1.0.0Provides Nutanix Cluster WriteIO BandwidthKBPS
nutanix_cluster_hypervisor_readIO_BandwidthKBPSNutanix Cluster Hypervisor ReadIO BandwidthKBPSKbps1.0.0Provides Nutanix Cluster Hypervisor ReadIO BandwidthKBPS
nutanix_cluster_hypervisor_kvm_memoryUsage_PPMNutanix Cluster Hypervisor Kvm MemoryUsage PPM%1.0.0Provides Nutanix Cluster Hypervisor Kvm MemoryUsage PPM
nutanix_cluster_controller_avgReadIO_LatencyUsecsNutanix Cluster Controller AvgReadIO LatencyUsecsmicrosec1.0.0Provides Nutanix Cluster Controller AvgReadIO LatencyUsecs
nutanix_cluster_IO_BandwidthKBPSNutanix Cluster IO BandwidthKBPSKbps1.0.0Provides Nutanix Cluster IO BandwidthKBPS
nutanix_cluster_controller_avgWriteIO_LatencyUsecsNutanix Cluster Controller Avg WriteIO LatencyUsecsmicrosec1.0.0Provides Nutanix Cluster Controller Avg WriteIO LatencyUsecs
nutanix_cluster_storage_TierDasSata_CapacityBytesNutanix Cluster Storage Tier Das Sata CapacityBytesGB1.0.0Provides Nutanix Cluster Storage Tier Das Sata CapacityBytes
nutanix_cluster_storage_TierDasSata_FreeBytesNutanix Cluster Storage Tier Das Sata FreeBytesGB1.0.0Provides Nutanix Cluster Storage Tier Das Sata FreeBytes
nutanix_cluster_storage_tier_ssd_CapacityBytesNutanix Cluster Storage Tier SSD CapacityBytesGB1.0.0Provides Nutanix Cluster Storage Tier SSD CapacityBytes
nutanix_cluster_storage_tier_ssd_FreeBytesNutanix Cluster Storage Tier SSD FreeBytesGB1.0.0Provides Nutanix Cluster Storage Tier SSD FreeBytes
nutanix_prism_central_APIStatsNutanix Prism Central API Statistics3.0.0Provides the number of API calls made within the frequency and resources.
Note: This is not a default metrics, needs to be applied manually on the root resource native type only.
Hostnutanix_host_hypervisor_cpu_usage_PPMNutanix Host Hypervisor Cpu Usage PPM%1.0.0Provides Nutanix Host Hypervisor Cpu Usage PPM
nutanix_host_hypervisor_mem_usage_PPMNutanix Host Hypervisor Memory Usage PPM%4.0.0Provides Nutanix Host Hypervisor Memory Usage PPM
nutanix_host_storage_CapacityBytesNutanix Host Storage Capacity BytesGB1.0.0Provides Nutanix Host Storage Capacity Bytes
nutanix_host_storage_TierDasSata_CapacityBytesNutanix Host Storage Tier Das Sata Capacity BytesGB1.0.0Provides Nutanix Host Storage Tier Das Sata Capacity Bytes
nutanix_host_storage_FreeBytesNutanix Host Storage Free BytesGB1.0.0Provides Nutanix Host Storage Free Bytes
nutanix_host_storage_tier_ssd_CapacityBytesNutanix Host Storage Tier SSD Capacity BytesGB1.0.0Provides Nutanix Host Storage Tier SSD Capacity Bytes
nutanix_host_storage_TierDasSata_FreeBytesNutanix Host Storage Tier Das Sata Free BytesGB1.0.0Provides Nutanix Host Storage Tier Das Sata Free Bytes
nutanix_host_storage_tier_ssd_FreeBytesNutanix Host Storage Tier SSD Free BytesGB1.0.0Provides Nutanix Host Storage Tier SSD Free Bytes
Disknutanix_disk_avg_io_LatencyUsecsNutanix Disk Avg IO Latency Usecsmicrosec1.0.0Provides Nutanix Disk Avg IO Latency Usecs
nutanix_disk_read_io_bandwidth_KBPSNutanix Disk Read IO Band Width KBPSKbps1.0.0Provides Nutanix Disk Read IO Bandwidth KBPS
nutanix_disk_write_io_bandwidth_KBPSNutanix Disk Write IO Band Width KBPSKbps1.0.0Provides Nutanix Disk Write IO Bandwidth KBPS
nutanix_disk_storage_CapacityBytesNutanix Disk Storage Capacity BytesGB1.0.0Provides Nutanix Disk Storage Capacity Bytes
nutanix_disk_storage_FreeBytesNutanix Disk Storage Free BytesGB1.0.0Provides Nutanix Disk Storage Free Bytes
nutanix_disk_storage_UsageBytesNutanix Disk Storage Usage BytesGB1.0.0Provides Nutanix Disk Storage Usage Bytes
Storage Containernutanix_storageContainer_ReadIO_PPMNutanix Storage Container ReadIO PPM%1.0.0Provides Nutanix Storage Container ReadIO PPM
nutanix_storageContainer_AvgIO_LatencyUsecsNutanix Storage Container AvgIO LatencyUsecsmicrosec1.0.0Provides Nutanix Storage Container AvgIO LatencyUsecs
nutanix_storageContainer_ReadIO_Bandwidth_KBPSNutanix Storage Container ReadIO Bandwidth KBPSKbps1.0.0Provides Nutanix Storage Container ReadIO Bandwidth KBPS
nutanix_storageContainer_WriteIO_Bandwidth_KBPSNutanix Storage Container WriteIO Bandwidth KBPSKbps1.0.0Provides Nutanix Storage Container WriteIO Bandwidth KBPS
nutanix_storageContainer_WriteIO_PPMNutanix Storage Container WriteIO PPM%1.0.0Provides Nutanix Storage Container WriteIO PPM
nutanix_storageContainer_Storage_TierDasSata_UsageBytesNutanix Storage Container StorageTier DasSata UsageBytesGB1.0.0Provides Nutanix Storage Container StorageTier DasSata UsageBytes
nutanix_storageContainer_Storage_UsageBytesNutanix Storage Container Storage UsageBytesGB1.0.0Provides Nutanix Storage Container Storage UsageBytes
nutanix_storageContainer_Storage_CapacityBytesNutanix Storage Container Storage CapacityBytesGB1.0.0Provides Nutanix Storage Container Storage CapacityBytes
nutanix_storageContainer_Storage_FreeBytesNutanix Storage Container Storage FreeBytesGB1.0.0Provides Nutanix Storage Container Storage FreeBytes
Virtual Machinenutanix_vm_guest_memory_UsageBytesNutanix VM Guest Memory Usage BytesGB2.0.0Provides Nutanix VM Guest Memory Usage Bytes
nutanix_vm_hypervisor_io_BandwidthKBPSNutanix VM Hypervisor IO BandwidthKBPSkbps2.0.0Provides Nutanix VM Hypervisor IO Bandwidth KBPS
nutanix_vm_hypervisor_readIO_BandwidthKBPSNutanix VM Hypervisor ReadIO BandwidthKBPSkbps2.0.0Provides Nutanix VM Hypervisor Read IO Bandwidth KBPS
nutanix_vm_hypervisor_writeIO_BandWidthKBPSNutanix VM Hypervisor WriteIO BandwidthKBPSkbps2.0.0Provides Nutanix VM Hypervisor Write IO Bandwidth KBPS
nutanix_vm_controller_IO_BandwidthKBPSNutanix VM Controller IO BandwidthKBPSkbps2.0.0Provides Nutanix VM Controller IO Bandwidth KBPS
nutanix_vm_controller_readIO_BandwidthKBPSNutanix VM Controller ReadIO BandwidthKBPSkbps2.0.0Provides Nutanix VM Controller Read IO Bandwidth KBPS
nutanix_vm_controller_writeIO_BandwidthKBPSNutanix VM Controller WriteIO BandwidthKBPSkbps2.0.0Provides Nutanix VM Controller Write IO Bandwidth KBPS
nutanix_vm_hypervisor_avgIO_LatencyUsecsNutanix VM Hypervisor AvgIO LatencyUsecsmicroseconds2.0.0Provides Nutanix VM Hypervisor Avg IO Latency Usecs
nutanix_vm_hypervisor_avgReadIO_LatencyUsecsNutanix VM Hypervisor Avg ReadIO LatencyUsecsmicroseconds2.0.0Provides Nutanix VM Hypervisor Avg Read IO Latency Usecs
nutanix_vm_hypervisor_avgWriteIO_LatencyUsecsNutanix VM Hypervisor Avg WriteIO LatencyUsecsmicroseconds2.0.0Provides Nutanix VM Hypervisor Avg Write IO Latency Usecs
nutanix_vm_controller_avgIO_LatencyUsecsNutanix VM Controller AvgIO LatencyUsecsmicroseconds2.0.0Provides Nutanix VM Controller Avg IO Latency Usecs
nutanix_vm_controller_avgReadIO_LatencyUsecsNutanix VM Controller Avg ReadIO LatencyUsecsmicroseconds2.0.0Provides Nutanix VM Controller Avg Read IO Latency Usecs
nutanix_vm_controller_avgWriteIO_LatencyUsecsNutanix VM Controller Avg WriteIO LatencyUsecsmicroseconds2.0.0Provides Nutanix VM Controller Avg Write IO Latency Usecs
nutanix_vm_PowerStateNutanix VM PowerState2.0.0Provides Nutanix VM Power State
nutanix_vm_memoryUsage_PPMNutanix VM Memory Usage PPM%2.0.0Provides Nutanix VM Memory Usage PPM
nutanix_vm_guest_memoryUsage_PPMNutanix VM Guest Memory Usage PPM%2.0.0Provides Nutanix VM Guest Memory Usage PPM
nutanix_vm_hypervisor_memoryUsage_PPMNutanix VM Hypervisor Memory Usage PPM%2.0.0Provides Nutanix VM Hypervisor Memory Usage PPM
nutanix_vm_hypervisor_cpuUsage_PPMNutanix VM Hypervisor CPU Usage PPM%2.0.0Provides NutanixVM Hypervisor CPU Usage PPM
nutanix_vm_hypervisor_consumed_MemoryBytesNutanix VM Hypervisor Consumed Memory BytesGB2.0.0Provides Nutanix VM Hypervisor Consumed Memory Bytes

Risks, Limitations & Assumptions

  • Application can handle Critical/Recovery failure notifications for below two cases when user enables App Failure Notifications in configuration
    • Connectivity Exception (ConnectTimeoutException, HttpHostConnectException, UnknownHostException)
    • Authentication Exception (UnauthorizedException)
  • Application will not send any duplicate/repeat failure alert notification until the existing critical alert is recovered.
  • Application cannot control monitoring pause/resume actions based on above alerts.
  • Metrics can be used to monitor Nutanix resources and can generate alerts based on the threshold values.
  • Event/Alert polling will be started only if the user enables Event/Alert Polling in configuration.
  • Possible values of Event/Alert Severity Filter configuration property are kWarning,kCritical,kInfo.
  • OpsRamp has given sample mappings to map Nutanix Severity with OpsRamp Severities as part of the Event/Alert Severity Mapping configuration file. Users can modify them as per their use-case at any point of time from the sdk application configuration page. Possible OpsRamp Severities are Critical, Warning, Ok, Info.
  • For VM resources there is no metric support as of now.
  • Application is not compatible with Cluster Gateway.
  • A user may be able to access the Prism WebUI, but may not have access to RestAPIs. User credentials used in configuration needs to have RestAPI access to perform discovery and monitoring.
  • Support for Macro replacement for threshold breach alerts (i.e, customisation for threshold breach alert’s subject, description).
  • No support of showing activity log and applied time.
  • Support for the option to get Latest snapshot metric.
  • This application supports both Classic Gateway and NextGen Gateway