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

Application Version and Upgrade Details

Application VersionBug fixes / Enhancements
6.0.2Added the nativeType check for the Cluster Manager and Cluster.
6.0.1Replacement of Tokens with the actual Values in the Alerts.
6.0.0
  • Used,Free Percentage Metrics support for Nutanix Clusters,Hosts,StorageContainers and Disks
  • Additional Metrics Support for ControllerVMS.
Click here to view the earlier version updates
Application VersionBug fixes / Enhancements
5.0.1Added the resourceName details in the hostName and the customAttribute "subnetName" for the Nutanix VMS.
5.0.0
  • Support for New Native types:
    • Nutanix Cluster Manager
    • Nutanix Controller VM
  • "Nutanix Controller VM Oplog Disk Size" ,"Nutanix Controller VM Oplog Disk Percentage" new Metrics support for the native type Nutanix Controller VM.
  • Support for new metric "Nutanix Disk status" and serial Number for Nutanix Disk.
  • Added support for VM IP address and Os details for Nutanix VM.
4.0.2Modifying the resource name of Nutanix Disk native types, name will be disk path for easy identification.
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.
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: We recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc.

Hierarchy of Nutanix Elements

• Nutanix Cluster Manager
       • Nutanix Cluster
              • Nutanix Host
                      • Nutanix Controller VM
                      • Nutanix VM
                      • Nutanix Disks
              • Nutanix Storage_container

Supported Metrics

Click here to view the supported metrics
Native TypeMetric NameDisplay NameMetric LabelUnitsApplication VersionDescription
Nutanix Clusternutanix_cluster_storage_used_percentageNutanix Cluster Storage Used Percentage%6.0.0Provides Nutanix Cluster Storage Used Percentage
nutanix_cluster_storage_free_percentageNutanix Cluster Storage Free Percentage%6.0.0Provides Nutanix Cluster Storage Free Percentage
nutanix_cluster_is_AvailableNutanix Cluster AvailabilityAvailability1.0.0Provides Nutanix Cluster Availability. Possible values true-1,false-0
nutanix_cluster_controller_NumIOPSNutanix Cluster Controller NumIOPSPerformanceiops1.0.0Provides Nutanix Cluster Controller NumIOPS
nutanix_cluster_dataReduction_overallSavingRatio_PPMNutanix Cluster DataReduction Overall SavingRatio PPMPerformance%1.0.0Provides Nutanix Cluster DataReduction Overall SavingRatio PPM
nutanix_cluster_NumReadIOPSNutanix Cluster NumReadIOPSPerformanceiops1.0.0Provides Nutanix Cluster NumReadIOPS
nutanix_cluster_NumWriteIOPSNutanix Cluster NumWriteIOPSPerformanceiops1.0.0Provides Nutanix Cluster NumWriteIOPS
nutanix_cluster_storage_CapacityBytesNutanix Cluster Storage CapacityBytesUsageGB1.0.0Provides Nutanix Cluster Storage CapacityBytes
nutanix_cluster_storage_FreeBytesNutanix Cluster Storage FreeBytesUsageGBProvides Nutanix Cluster Storage FreeBytes
nutanix_Cluster_hypervisor_avgIO_LatencyUsecsNutanix Cluster Hypervisor AvgIO LatencyUsecsPerformancemicrosec1.0.0Provides Nutanix Cluster Hypervisor AvgIO LatencyUsecs
nutanix_cluster_hypervisorWrite_IOBandwidthKBPSNutanix Cluster Hypervisor WriteIO BandwidthKBPSPerformancekbps1.0.0Provides Nutanix Cluster Hypervisor WriteIO BandwidthKBPS
nutanix_cluster_readIO_PPMNutanix Cluster ReadIO PPMPerformance%1.0.0Provides Nutanix Cluster ReadIO PPM
nutanix_cluster_replicationTransmitted_BandwidthKBPSNutanix Cluster Replication Transmitted BandwidthKBPSPerformanceKbps1.0.0Provides Nutanix Cluster Replication Transmitted BandwidthKBPS
nutanix_cluster_hypervisor_cpuUsage_PPMNutanix Cluster Hypervisor Cpu Usage PPMUsage%1.0.0Provides Nutanix Cluster Hypervisor Cpu Usage PPM
nutanix_cluster_controller_ReadIOPPMNutanix Cluster Controller ReadIO PPMPerformance%1.0.0Provides Nutanix Cluster Controller ReadIO PPM
nutanix_cluster_contentCache_HitPPMNutanix Cluster Content Cache HitPPMPerformance%1.0.0Provides Nutanix Cluster Content Cache HitPPM
nutanix_cluster_hypervisor_avgReadIO_LatencyUsecsNutanix Cluster Hypervisor Avg ReadIO LatencyUsecsPerformancemicrosec1.0.0Provides Nutanix Cluster Hypervisor Avg ReadIO LatencyUsecs
nutanix_cluster_replicationReceived_BandwidthKBPSNutanix Cluster Replication Received BandwidthKBPSPerformanceKbps1.0.0Provides Nutanix Cluster Replication Received BandwidthKBPS
nutanix_cluster_controller_avgIO_LatencyUsecsNutanix Cluster Controller AvgIO LatencyUsecsPerformancemicrosec1.0.0Provides Nutanix Cluster Controller AvgIO LatencyUsecs
nutanix_cluster_controller_readIO_BandwidthKBPSNutanix Cluster Controller ReadIO BandwidthKBPSPerformanceKbps1.0.0Provides Nutanix Cluster Controller ReadIO BandwidthKBPS
nutanix_cluster_controller_IO_BandwidthKBPSNutanix Cluster Controller IO BandwidthKBPSPerformanceKbps1.0.0Provides Nutanix Cluster Controller IO BandwidthKBPS
nutanix_cluster_avgIO_LatencyUsecsNutanix Cluster AvgIO LatencyUsecsPerformancemicrosec1.0.0Provides Nutanix Cluster AvgIO LatencyUsecs
nutanix_cluster_controller_writeIO_BandwidthKBPSNutanix Cluster Controller WriteIO BandwidthKBPSPerformanceKbps1.0.0Provides Nutanix Cluster Controller WriteIO BandwidthKBPS
nutanix_cluster_controller_writeIO_PPMNutanix Cluster Controller WriteIO PPMPerformance%1.0.0Provides Nutanix Cluster Controller WriteIO PPM
nutanix_cluster_hypervisor_avgWriteIO_LatencyUsecsNutanix Cluster Hypervisor Avg WriteIO LatencyUsecsPerformancemicrosec1.0.0Provides Nutanix Cluster Hypervisor Avg WriteIO LatencyUsecs
nutanix_cluster_readIO_BandwidthKBPSNutanix Cluster Read IO BandwidthKBPSPerformanceKbps1.0.0Provides Nutanix Cluster Read IO BandwidthKBPS
nutanix_cluster_hypervisor_memoryUsage_PPMNutanix Cluster Hypervisor MemoryUsage PPMPerformance%1.0.0Provides Nutanix Cluster Hypervisor MemoryUsage PPM
nutanix_cluster_hypervisor_IO_BandwidthKBPSNutanix Cluster Hypervisor IO BandwidthKBPSPerformanceKbps1.0.0Provides Nutanix Cluster Hypervisor IO BandwidthKBPS
nutanix_cluster_hypervisor_kvm_cpuUsage_PPMNutanix Cluster Hypervisor Kvm Cpu Usage PPMUsage%1.0.0Provides Nutanix Cluster Hypervisor Kvm Cpu Usage PPM
nutanix_cluster_writeIO_BandwidthKBPSNutanix Cluster WriteIO BandwidthKBPSPerformanceKbps1.0.0Provides Nutanix Cluster WriteIO BandwidthKBPS
nutanix_cluster_hypervisor_readIO_BandwidthKBPSNutanix Cluster Hypervisor ReadIO BandwidthKBPSPerformanceKbps1.0.0Provides Nutanix Cluster Hypervisor ReadIO BandwidthKBPS
nutanix_cluster_hypervisor_kvm_memoryUsage_PPMNutanix Cluster Hypervisor Kvm MemoryUsage PPMUsage%1.0.0Provides Nutanix Cluster Hypervisor Kvm MemoryUsage PPM
nutanix_cluster_controller_avgReadIO_LatencyUsecsNutanix Cluster Controller AvgReadIO LatencyUsecsPerformancemicrosec1.0.0Provides Nutanix Cluster Controller AvgReadIO LatencyUsecs
nutanix_cluster_IO_BandwidthKBPSNutanix Cluster IO BandwidthKBPSPerformanceKbps1.0.0Provides Nutanix Cluster IO BandwidthKBPS
nutanix_cluster_controller_avgWriteIO_LatencyUsecsNutanix Cluster Controller Avg WriteIO LatencyUsecsPerformancemicrosec1.0.0Provides Nutanix Cluster Controller Avg WriteIO LatencyUsecs
nutanix_cluster_storage_TierDasSata_CapacityBytesNutanix Cluster Storage Tier Das Sata CapacityBytesUsageGB1.0.0Provides Nutanix Cluster Storage Tier Das Sata CapacityBytes
nutanix_cluster_storage_TierDasSata_FreeBytesNutanix Cluster Storage Tier Das Sata FreeBytesUsageGB1.0.0Provides Nutanix Cluster Storage Tier Das Sata FreeBytes
nutanix_cluster_storage_tier_ssd_CapacityBytesNutanix Cluster Storage Tier SSD CapacityBytesUsageGB1.0.0Provides Nutanix Cluster Storage Tier SSD CapacityBytes
nutanix_cluster_storage_tier_ssd_FreeBytesNutanix Cluster Storage Tier SSD FreeBytesUsageGB1.0.0Provides Nutanix Cluster Storage Tier SSD FreeBytes
nutanix_prism_central_APIStatsNutanix Prism Central API StatisticsUsage3.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.
Nutanix Hostnutanix_host_storage_used_percentageNutanix Host Storage Used Percentage%6.0.0Provides Nutanix Host Storage Used Percentage
nutanix_host_storage_free_percentageNutanix Host Storage Free Percentage%6.0.0Provides Nutanix Host Storage Free Percentage
nutanix_host_hypervisor_cpu_usage_PPMNutanix Host Hypervisor Cpu Usage PPMUsage%1.0.0Provides Nutanix Host Hypervisor Cpu Usage PPM
nutanix_host_hypervisor_mem_usage_PPMNutanix Host Hypervisor Memory Usage PPMUsage%4.0.0Provides Nutanix Host Hypervisor Memory Usage PPM
nutanix_host_storage_CapacityBytesNutanix Host Storage Capacity BytesUsageGB1.0.0Provides Nutanix Host Storage Capacity Bytes
nutanix_host_storage_TierDasSata_CapacityBytesNutanix Host Storage Tier Das Sata Capacity BytesUsageGB1.0.0Provides Nutanix Host Storage Tier Das Sata Capacity Bytes
nutanix_host_storage_FreeBytesNutanix Host Storage Free BytesUsageGB1.0.0Provides Nutanix Host Storage Free Bytes
nutanix_host_storage_tier_ssd_CapacityBytesNutanix Host Storage Tier SSD Capacity BytesUsageGB1.0.0Provides Nutanix Host Storage Tier SSD Capacity Bytes
nutanix_host_storage_TierDasSata_FreeBytesNutanix Host Storage Tier Das Sata Free BytesUsageGB1.0.0Provides Nutanix Host Storage Tier Das Sata Free Bytes
nutanix_host_storage_tier_ssd_FreeBytesNutanix Host Storage Tier SSD Free BytesUsageGB1.0.0Provides Nutanix Host Storage Tier SSD Free Bytes
Nutanix Disknutanix_disk_storage_used_percentageNutanix Disk Storage Used Percentage%6.0.0Provides Nutanix Disk Storage Used Percentage
nutanix_disk_storage_free_percentageNutanix Disk Storage Free Percentage%6.0.0Provides Nutanix Disk Storage Free Percentage
nutanix_disk_avg_io_LatencyUsecsNutanix Disk Avg IO Latency UsecsPerformancemicrosec1.0.0Provides Nutanix Disk Avg IO Latency Usecs
nutanix_disk_read_io_bandwidth_KBPSNutanix Disk Read IO Band Width KBPSPerformanceKbps1.0.0Provides Nutanix Disk Read IO Bandwidth KBPS
nutanix_disk_write_io_bandwidth_KBPSNutanix Disk Write IO Band Width KBPSPerformanceKbps1.0.0Provides Nutanix Disk Write IO Bandwidth KBPS
nutanix_disk_storage_CapacityBytesNutanix Disk Storage Capacity BytesUsageGB1.0.0Provides Nutanix Disk Storage Capacity Bytes
nutanix_disk_storage_FreeBytesNutanix Disk Storage Free BytesUsageGB1.0.0Provides Nutanix Disk Storage Free Bytes
nutanix_disk_storage_UsageBytesNutanix Disk Storage Usage BytesUsageGB1.0.0Provides Nutanix Disk Storage Usage Bytes
nutanix_disk_statusNutanix Disk StatusAvailability5.0.0Provides Nutanix Disk Status.Possible values 1-NORMAL 2-DATA_MIGRATION_INITIATED 3-MARKED_FOR_REMOVAL_BUT_NOT_DETACHABLE 4-DETACHABLE
Nutanix Storage Containernutanix_storageContainer_Storage_Used_PercentageNutanix Storage Container Storage Used Percentage%6.0.0Provides Nutanix Storage Container Storage Used Percentage
nutanix_storageContainer_Storage_Free_PercentageNutanix Storage Container Storage Free Percentage%6.0.0Provides Nutanix Storage Container Storage Free Percentage
nutanix_storageContainer_ReadIO_PPMNutanix Storage Container ReadIO PPMPerformance%1.0.0Provides Nutanix Storage Container ReadIO PPM
nutanix_storageContainer_AvgIO_LatencyUsecsNutanix Storage Container AvgIO LatencyUsecsPerformancemicrosec1.0.0Provides Nutanix Storage Container AvgIO LatencyUsecs
nutanix_storageContainer_ReadIO_Bandwidth_KBPSNutanix Storage Container ReadIO Bandwidth KBPSPerformanceKbps1.0.0Provides Nutanix Storage Container ReadIO Bandwidth KBPS
nutanix_storageContainer_WriteIO_Bandwidth_KBPSNutanix Storage Container WriteIO Bandwidth KBPSPerformanceKbps1.0.0Provides Nutanix Storage Container WriteIO Bandwidth KBPS
nutanix_storageContainer_WriteIO_PPMNutanix Storage Container WriteIO PPMPerformance%1.0.0Provides Nutanix Storage Container WriteIO PPM
nutanix_storageContainer_Storage_TierDasSata_UsageBytesNutanix Storage Container StorageTier DasSata UsageBytesUsageGB1.0.0Provides Nutanix Storage Container StorageTier DasSata UsageBytes
nutanix_storageContainer_Storage_UsageBytesNutanix Storage Container Storage UsageBytesUsageGB1.0.0Provides Nutanix Storage Container Storage UsageBytes
nutanix_storageContainer_Storage_CapacityBytesNutanix Storage Container Storage CapacityBytesUsageGB1.0.0Provides Nutanix Storage Container Storage CapacityBytes
nutanix_storageContainer_Storage_FreeBytesNutanix Storage Container Storage FreeBytesUsageGB1.0.0Provides Nutanix Storage Container Storage FreeBytes
Nutanix VMnutanix_vm_guest_memory_UsageBytesNutanix VM Guest Memory Usage BytesUsageGB2.0.0Provides Nutanix VM Guest Memory Usage Bytes
nutanix_vm_hypervisor_io_BandwidthKBPSNutanix VM Hypervisor IO BandwidthKBPSPerformancekbps2.0.0Provides Nutanix VM Hypervisor IO Bandwidth KBPS
nutanix_vm_hypervisor_readIO_BandwidthKBPSNutanix VM Hypervisor ReadIO BandwidthKBPSPerformancekbps2.0.0Provides Nutanix VM Hypervisor Read IO Bandwidth KBPS
nutanix_vm_hypervisor_writeIO_BandWidthKBPSNutanix VM Hypervisor WriteIO BandwidthKBPSPerformancekbps2.0.0Provides Nutanix VM Hypervisor Write IO Bandwidth KBPS
nutanix_vm_controller_IO_BandwidthKBPSNutanix VM Controller IO BandwidthKBPSPerformancekbps2.0.0Provides Nutanix VM Controller IO Bandwidth KBPS
nutanix_vm_controller_readIO_BandwidthKBPSNutanix VM Controller ReadIO BandwidthKBPSPerformancekbps2.0.0Provides Nutanix VM Controller Read IO Bandwidth KBPS
nutanix_vm_controller_writeIO_BandwidthKBPSNutanix VM Controller WriteIO BandwidthKBPSPerformancekbps2.0.0Provides Nutanix VM Controller Write IO Bandwidth KBPS
nutanix_vm_hypervisor_avgIO_LatencyUsecsNutanix VM Hypervisor AvgIO LatencyUsecsPerformancemicroseconds2.0.0Provides Nutanix VM Hypervisor Avg IO Latency Usecs
nutanix_vm_hypervisor_avgReadIO_LatencyUsecsNutanix VM Hypervisor Avg ReadIO LatencyUsecsPerformancemicroseconds2.0.0Provides Nutanix VM Hypervisor Avg Read IO Latency Usecs
nutanix_vm_hypervisor_avgWriteIO_LatencyUsecsNutanix VM Hypervisor Avg WriteIO LatencyUsecsPerformancemicroseconds2.0.0Provides Nutanix VM Hypervisor Avg Write IO Latency Usecs
nutanix_vm_controller_avgIO_LatencyUsecsNutanix VM Controller AvgIO LatencyUsecsPerformancemicroseconds2.0.0Provides Nutanix VM Controller Avg IO Latency Usecs
nutanix_vm_controller_avgReadIO_LatencyUsecsNutanix VM Controller Avg ReadIO LatencyUsecsPerformancemicroseconds2.0.0Provides Nutanix VM Controller Avg Read IO Latency Usecs
nutanix_vm_controller_avgWriteIO_LatencyUsecsNutanix VM Controller Avg WriteIO LatencyUsecsPerformancemicroseconds2.0.0Provides Nutanix VM Controller Avg Write IO Latency Usecs
nutanix_vm_PowerStateNutanix VM PowerStateAvailability2.0.0Provides Nutanix VM Power State
nutanix_vm_memoryUsage_PPMNutanix VM Memory Usage PPMUsage%2.0.0Provides Nutanix VM Memory Usage PPM
nutanix_vm_guest_memoryUsage_PPMNutanix VM Guest Memory Usage PPMUsage%2.0.0Provides Nutanix VM Guest Memory Usage PPM
nutanix_vm_hypervisor_memoryUsage_PPMNutanix VM Hypervisor Memory Usage PPMUsage%2.0.0Provides Nutanix VM Hypervisor Memory Usage PPM
nutanix_vm_hypervisor_cpuUsage_PPMNutanix VM Hypervisor CPU Usage PPMUsage%2.0.0Provides NutanixVM Hypervisor CPU Usage PPM
nutanix_vm_hypervisor_consumed_MemoryBytesNutanix VM Hypervisor Consumed Memory BytesUsageGB2.0.0Provides Nutanix VM Hypervisor Consumed Memory Bytes
Nutanix Controller VMnutanix_controller_vm_oplog_disk_sizeNutanix Controller VM Oplog Disk SizeGB5.0.0Provides Nutanix Controller VM Oplog Disk Size
nutanix_controller_vm_oplog_disk_pctNutanix Controller VM Oplog Disk Percentage%5.0.0Provides Nutanix Controller VM Oplog Disk Percentage
nutanix_cvm_powerStateNutanix Controller VM Power StateAvailability6.0.0Provides Nutanix Controller VM Power State
nutanix_cvm_hypervisor_avgIO_LatencyUsecsNutanix Controller VM Hypervisor Avg IO Latency Usecsmicroseconds6.0.0Provides Nutanix Controller VM Hypervisor Avg IO Latency Usecs
nutanix_cvm_hypervisor_writeIO_BandWidthKBPSNutanix Controller VM Hypervisor Write IO Bandwidth KBPSKBps6.0.0Provides Nutanix Controller VM Hypervisor Write IO Bandwidth KBPS
nutanix_cvm_hypervisor_cpu_usage_ppmNutanix Controller VM Hypervisor CPU Usage PPM%6.0.0Provides Nutanix Controller VM Hypervisor CPU Usage PPM
nutanix_cvm_avgReadIO_LatencyUsecsNutanix Controller VM Avg Read IO Latency Usecsmicroseconds6.0.0Provides Nutanix Controller VM Avg Read IO Latency Usecs
nutanix_cvm_memory_usage_ppmNutanix Controller VM Memory Usage PPM%6.0.0Provides Nutanix Controller VM Memory Usage PPM
nutanix_cvm_hypervisor_avgReadIO_LatencyUsecsNutanix Controller VM Hypervisor Avg Read IO latencyUsecsmicroseconds6.0.0Provides Nutanix Controller VM Hypervisor Avg Read IO latencyUsecs
nutanix_cvm_guest_memoryUsage_PPMNutanix Controller VM Guest Memory Usage PPM%6.0.0Provides Nutanix Controller VM Guest Memory Usage PPM
nutanix_cvm_guest_memory_UsageBytesNutanix Controller VM Guest Memory Usage BytesGB6.0.0Provides Nutanix Controller VM Guest Memory Usage Bytes
nutanix_cvm_read_io_bandwidth_kBpsNutanix Controller VM Read IO Bandwidth KBPSKBps6.0.0Provides Nutanix Controller VM Read IO Bandwidth KBPS
nutanix_cvm_hypervisor_memory_usage_ppmNutanix Controller VM Hypervisor Memory Usage PPM%6.0.0Provides Nutanix Controller VM Hypervisor Memory Usage PPM
nutanix_cvm_avgWriteIO_LatencyUsecsNutanix Controller VM Avg Write IO Latency Usecsmicroseconds6.0.0Provides Nutanix Controller VM Avg Write IO Latency Usecs
nutanix_cvm_hypervisor_consumed_MemoryBytesNutanix Controller VM Hypervisor Consumed Memory BytesGB6.0.0Provides Nutanix Controller VM Hypervisor Consumed Memory Bytes
nutanix_cvm_io_BandwidthKBPSNutanix Controller VM IO Bandwidth KBPSKBps6.0.0Provides Nutanix Controller VM IO Bandwidth KBPS

Default Monitoring Configurations

Nutanix Prism Central has default Global Device Management Policies, Global Templates, Global Monitors and Global Metrics in OpsRamp. You can customize these default monitoring configurations as per your business use cases by cloning respective Global Templates and Global Device Management Policies. We recommend doing this activity before installing the application to avoid noise alerts and data.

  1. Default Global Device Management Policies

    You can find the Device Management Policy for each Native Type at Setup > Resources > Device Management Policies. Search with suggested name 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)

  2. Default Global Templates

    You can find the Global Templates for each Native Type 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)

  3. Default Global Monitors

    You can find the Global Monitors for each Native Type at Setup > Monitoring > Monitors. Search with suggested name 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. To select your client, navigate to All Clients, and click the Client/Partner dropdown menu.
    Note: You may either type your client’s name in the search bar or select your client from the list.
  2. Navigate to Setup > Account. The Account Details screen is displayed.
  3. Click Integrations. The Installed Integrations screen is displayed with all the installed applications.
    Note: If you do not have any installed applications, you will be navigated to the Available Integrations and Apps page with all the available applications along with the newly created application with the version.
  4. Click + ADD on the Installed Integrations page.
    Note: Search for the integration either by entering the name of the integration in the search bar or by selecting the category of the integration from the All Categories dropdown list.
  5. Click ADD in the Nutanix Prism Central application.
  6. In the Configuration screen, click + ADD. The Add Configuration screen appears.
  7. Enter the following BASIC INFORMATION
Field NameDescriptionField Type
NameEnter the name for the configuration.String
IP Address/ Host NameEnter the IP address/host name of the Nutanix Prism Central. It should be accessible from Gateway.String
PortEnter the port number to communicate with OpsRamp's endpoints. It should be accessible from Gateway.
Default Value: 9440
Integer
Is SecureSelect this checkbox if you want the communication between your system and the specified endpoint to be secured using protocols such as HTTPS (HTTP over SSL/TLS).
Default Selection: When selected, it signifies that the connection is encrypted, providing an added layer of security to the data being transmitted.
Checkbox
CredentialsSelect the credential associated with your HPE Primera account. If you want to use the existing credentials, select them from the Select Credentials dropdown. Else, click + Add to create credentials. The ADD CREDENTIAL window is displayed. Enter the following information.
  • Name: Credential name.
  • Description: Brief description of the credential.
  • User Name: User name.
  • Password: Password.
  • Confirm Password: Confirm password
Dropdown
App Failure NotificationsWhen selected, you will be notified in case of an application failure such as Connectivity Exception, Authentication Exception.Checkbox
Alert ConfigurationSelect this checkbox if you want to enable integrating third party alerts into OpsRamp using further configurations.Checkbox
Alert SeverityProvides severity alerts and gets integrated out of all possible alerts.
Possible values of Alert Severity Filter configuration property are "warning","critical".
Checkbox
Alert Severity MappingPossible values of Alert Severity Mapping Filter configuration property are {"warning":"Warning","critical":"Critical"}.Checkbox
API TimeoutsWhen selected, this checkbox allows you to configure timeout settings for API requests made by the integration to the OpsRamp platform.Checkbox
Connection Timeout in SecsSelect the maximum time, in seconds, that the integration must wait while establishing a connection with the OpsRamp API endpoint.
Default Value: 60
Dropdown
Connection Request Timeout in SecsSelect the maximum time, in seconds, required to process an HTTP call: from sending a request to receiving a response.
Default Value: 60
Dropdown
Socket Timeout in SecsSelect the maximum time of inactivity between two data packets when exchanging data with a server.
Default Value: 60
Dropdown
  1. CUSTOM ATTRIBUTES: Custom attributes are the user-defined data fields or properties that can be added to the preexisting attributes to configure the integration.
Field NameDescriptionField Type
Custom AttributeSelect the custom attribute from the dropdown. You can add attributes by clicking the Add icon (+).Dropdown
ValueSelect the value from the dropdown.Dropdown

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.
12. 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.
13. Click NEXT.
14. (Optional) Click +ADD to create a new collector. You can either use the pre-populated name or give the name to your collector.
15. Select an existing registered profile.

  1. Click FINISH.
    The integration is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.

Modify the Configuration

View the Nutanix Prism Central Details

To discover resources for Nutanix Prism Central

  1. Navigate to Infrastructure > Search > HYPERCONVERGED INFRASTRUCTURE > Nutanix Prism Central.
  2. The Nutanix Prism Central page is displayed, select the application name.
  3. The RESOURCE page appears from the right.
  4. Click the ellipsis () on the top right and select View Details.
Nutanix Prism
  1. Click the Metrics tab to view the metric details for Nutanix Prism Central.
Nutanix Prism

Resource Filter Input Keys

Nutanix Prism Central Resources are filtered and discovered based on below keys:

Click here to view the Supported Input Keys
Resource TypeSupported Input Keys
All TypesresourceName
hostName
aliasName
dnsName
ipAddress
macAddress
os
make
model
serialNumber
Nutanix Clusterinternal_subnet
Nutanix Hosthypervisor_address
memory_capacity_mib
cpu_capacity_in_hz
operation_mode
Nutanix VMmemory_size_mib
num_vcpus_per_socket
vdisk_uuids
subnetName
operation_mode
Nutanix Disklocation
Host Name
storage_tier_name
disk_size
cluster_uuid
host_uuid
operation_mode
Nutanix Storage Containercompression_enabled
erasure_code
replication_factor
max_capacity
cluster_uuid
operation_mode

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}

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 send any duplicate/repeat failure alert notification for every 6 hours.
  • 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 Alert Severity configuration property are [“warning”,“critical”].
  • OpsRamp has given sample mappings to map Nutanix Severity with OpsRamp Severities as part of the 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 {“warning”:“Warning”,“critical”:“Critical”}.
  • 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.
  • Events generated in nutanix will be pulled based on frequency poll and not instantaneous

Troubleshooting

If the Nutanix integration fails to discover or monitor resources, follow these steps:

  • Check if any alerts have been generated on the Nutanix Prism Central resource, the gateway, or if there are any error logs in the vprobe.

  • If the alert or error is related to End Device Connectivity or Authentication, check the reachability of the end device from the gateway by executing the following commands:

    • Use the ping command to check the device’s IP address:
    ping <IP Address>
    
    • Use the telnet command to check connectivity to a specific port:
    telnet <IP Address> <port>
    
  • Follow the steps in SDK App Debug GCLI Command Requests (Target API / SSH Command) and check if there are any errors during the execution of the commands.

  1. Use the following sample request to prepare the request payload:
    
    {
        "apiVersion": "debug/v1",
        "module": "Debug",
        "app": "nutanix-prism-central",
        "action": "Reachability",
        "payload": {
            "protocol": "<http or https>",
            "ipAddressOrHostName": "<ipAddressOrHostName>",
            "port": "<port>",
            "userName": "<Username>",
            "password": "<Password>",
            "requestPath": "<RequestPath mentioned in the table>",
            "requestMethod": "<RequestMethod mentioned in the table>",
            "requestBody": "<RequestBody mentioned in the table>"
        }
    }
    
    
  2. Encode the request payload to Base64 format.
  3. Login to the gateway console and connect to the GCLI terminal using the following command:
  4. gcli
  5. Execute the command by replacing the <base64 encoded string> with the Base64-encoded request payload generated in Step 2:
  6. sdkappdebug base64 encoded string

    Refer to the following table for preparing the requestPath, requestBody, and requestMethod:

    Native TypeDiscoveryMonitoring
    Nutanix Cluster ManagerrequestPath : api/nutanix/v3/clusters/list
    requestMethod : POST
    requestBody : {"kind": "cluster","offset": 0, "length":1000}
    -
    Nutanix ClusterrequestPath : api/nutanix/v3/clusters/list
    requestMethod : POST
    requestBody : {"kind": "cluster","offset": 0, "length":1000}
    requestPath : PrismGateway/services/rest/v2.0/clusters
    requestMethod : GET
    requestBody : ""
    Nutanix HostrequestPath : api/nutanix/v3/hosts/list
    requestMethod : POST
    requestBody : {"kind": "host","offset": 0, "length":1000}
    requestPath : PrismGateway/services/rest/v2.0/hosts
    requestMethod : GET
    requestBody : ""
    Nutanix VMrequestPath : api/nutanix/v3/vms/list
    requestMethod : POST
    requestBody : {"kind": "vm","offset": 0, "length":1000}
    requestPath : PrismGateway/services/rest/v1/vms?filterCriteria=is_cvm==0
    requestMethod : GET
    requestBody : ""
    Nutanix DiskrequestPath : PrismGateway/services/rest/v2.0/disks
    requestMethod : GET
    requestBody : ""
    requestPath : PrismGateway/services/rest/v2.0/disks
    requestMethod : GET
    requestBody : ""
    Nutanix Storage ContainerrequestPath : PrismGateway/services/rest/v2.0/storage_containers
    requestMethod : GET
    requestBody : ""
    requestPath : PrismGateway/services/rest/v2.0/storage_containers
    requestMethod : GET
    requestBody : ""
    Nutanix Controller VMrequestPath : PrismGateway/services/rest/v1/vms?filterCriteria=is_cvm==1
    requestMethod : GET
    requestBody : ""
    requestPath : PrismGateway/services/rest/v1/vms?filterCriteria=is_cvm==1
    requestMethod : GET
    requestBody : ""

    For example, to verify the Nutanix Host Discovery Response, use the following payload:

    
    {
        "apiVersion": "debug/v1",
        "module": "Debug",
        "app": "nutanix-prism-central",
        "action": "Reachability",
        "payload": {
            "protocol": "http",
            "ipAddressOrHostName": "172.25.251.190",
            "port": "9988",
            "userName": "SvcOneAccessMonitoring",
            "password": "P!4psefokklibaulgyfcz0I!",
            "requestPath": "api/nutanix/v3/hosts/list",
            "requestMethod": "POST",
            "requestBody": "{\"kind\": \"host\",\"offset\": 0, \"length\":1000}"
        }
    }
    
    

    And for a GET API Call, use the following sample payload:

    
    {
        "apiVersion": "debug/v1",
        "module": "Debug",
        "app": "nutanix-prism-central",
        "action": "Reachability",
        "payload": {
            "protocol": "http",
            "ipAddressOrHostName": "172.25.251.190",
            "port": "9988",
            "userName": "SvcOneAccessMonitoring",
            "password": "P!4psefokklibaulgyfcz0I!",
            "requestPath": "PrismGateway/services/rest/v2.0/hosts",
            "requestMethod": "GET",
            "requestBody": ""
        }
    }