Supported Target Versions
ONTAP Simulator 9.8
Active IQ Unified manager 9.9

Application Version and Upgrade Details

Application VersionBug fixes / Enhancements
3.0.0Added API Statistics metric, resource display order in search ui, sub-category.
2.0.0Changed Monitor names.
1.0.0Supported netapp-active-iq-unified-manager integration through rest API's.

Introduction

NetApp Active IQ Unified Manager

NetApp® OnCommand® Unified Manager is a graphical management product that provides comprehensive monitoring and key management capabilities for NetApp ONTAP® systems to help manage the availability, capacity, protection, and performance risks of your storage systems.

You can deploy Unified Manager on a Linux server, on a Windows server, or as a virtual appliance on a VMware host.

Storage resources in a 2-node cluster:

Physical storage resources

Refers to the physical storage objects provided by ONTAP. Physical storage resources include disks, clusters, storage controllers, nodes, and aggregates.

Logical storage resources

Refers to the storage resources provided by ONTAP that are not tied to a physical resource. These resources are associated with a storage virtual machine (SVM, formerly known as Vserver), and they exist independently of any specific physical storage resource such as a disk, array LUN, or aggregate.

Cluster

A cluster consists of one or more nodes grouped together as (HA pairs) to form a scalable cluster. Creating a cluster enables the nodes to pool their resources and distribute work across the cluster, while presenting administrators with a single entity to manage. Clustering also enables continuous service to end users if individual nodes go offline.

Node

A node is a controller in a cluster. It is connected to other nodes in the cluster over a private management cluster network. It is also connected to the disk shelves that provide physical storage for the Data ONTAP system or to third-party storage arrays that provide array LUNs for Data ONTAP use.

Volume

Volumes are data containers that enable you to partition and manage your data. Understanding the types of volumes and their associated capabilities enables you to design your storage architecture for maximum storage efficiency and ease of administration.

Volumes are the highest-level logical storage object. Unlike aggregates, which are composed of physical storage resources, volumes are completely logical objects.

Aggregate

An aggregate is a collection of disks (or partitions) arranged into one or more RAID groups. It is the most basic storage object within ONTAP and is required to allow for the provisioning of space for connected hosts.

SVM

Storage Virtual Machines (SVMs) contain data volumes and one or more LIFs (logical interfaces) through which they serve data to the clients.

A cluster can have one or more SVMs with FlexVol volumes and SVMs with Infinite Volume.

Namespace

A namespace is a logical grouping of volumes that are joined together at junction points to create a single, logical file system that derives from the Storage Virtual Machine (SVM) root volume. Each SVM has a namespace.

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.
  • Hardware: VMware ESXi with 2 VMs - Memory 8GB , CPU’s 2 No’s, Hard Disk 50 GB for each VM.
  • Software: ONTAP Simulator 9.8 & Active IQ Unified manager 9.9- Available.

Resource Hierarchy

 NetApp Active Iq Unified Manager

 NetApp Cluster

     → Cluster Nodes
        → Aggregates
        → Storage Ports
        → Ethernet Ports
               → Logical Interfaces(LIF’s)
        → FCP Adapters
               → FC Interfaces
      → Storage Virtual Machine/SVM
         → Storage Volumes
            → Storage Luns
            → QTrees
               → Disks
         → Shelves

Application Migration

  1. As per the prerequisite step, check for the gateway version as - classic gateway-12.0.1 and above.
    Notes:
  2. Once all discoveries are completed with the sdk 2.0 application, follow any one of the approaches.
  • Direct uninstallation of the sdk 1.0 adaptor application through the uninstall API with skipDeleteResources=true in the post request.

End-Point:

https://{{host}}/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}

Request Body:

    {
        "uninstallReason": "Test",
        "skipDeleteResources": true
     }

(OR)

  • Delete the configuration one by one through the Delete adaptor config API with the request parameter as skipDeleteResources=true

End-Point: https://{{host}}/api/v2/tenants/{tenantId}/integrations/installed/config/{configId}?skipDeleteResources=true.

  • Finally, uninstall the adaptor application through API with skipDeleteResources=true in the post request.

End-Point:

https://{{host}}/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}

Request Body:

    {
        "uninstallReason": "Test",
        "skipDeleteResources": true
    }

Supported Metrics

Click here to view the supported metrics
Native TypeMetric NameMetric Display NameUnitsApplication VersionDescription
NetApp Active IQ Unified Managernetapp_aiqm_APIStatsNetApp AIQM API Statistics3.0.0Provides the number of API calls made within the frequency and resources.
NetApp Active IQ Unified Manager Clusternetapp_aiqm_cluster_hardware_HealthStatusCluster Hardware Health Status1.0.0Returns the status of the Hardware Components of the Cluster. Possible states are unknown(0), unreachable(1), degraded(2), ok-with-suppressed(3) and ok(4)
netapp_aiqm_cluster_IopsCluster IopsReq per Sec1.0.0Average number of input/output operations the cluster processes per second.
netapp_aiqm_cluster_ThrouhputCluster ThroughPutMbps1.0.0Number of bytes of data transferred to and from this cluster per second.
netapp_aiqm_cluster_ClusterPeerStatusPeer Cluster Status1.0.0Returns the state of the peer cluster. Possible states are unidentified(0), unavailable(1), available(2), partial(3) and pending(4)
netapp_aiqm_cluster_system_SizeAvailableCluster System Size AvailableGB1.0.0System Available size.Sum of the available size of all the aggregates in a cluster
netapp_aiqm_cluster_system_UtilizationCluster System Utilization%1.0.0System Utilization.Percentage space used of all the aggregates in a cluster
netapp_aiqm_cluster_snapmirror_StatusSnapMirror Status1.0.0SnapMirror state.Possible states are broken_off(0), out_of_sync(1), uninitialized(2), paused(3), snapmirrored(4), in_sync(5) and synchronizing(6)
netapp_aiqm_cluster_snapmirror_LagTimeSnapMirror LagTimems1.0.0Time since the exported Snapshot copy was created
NetApp Active IQ Unified Manager Nodenetapp_aiqm_node_LatencyNode Latency1.0.0The response time for all I/O requests, expressed in microseconds per operation
netapp_aiqm_node_ThroughputNode ThroughPutMbps1.0.0The throughput on the node, measured in bytes per second.
netapp_aiqm_node_IopsNode IopsReq per Sec1.0.0Number of input/output operations per second on the node
netapp_aiqm_node_UpTimeNode Up Times1.0.0Total time in seconds that the node has been up
netapp_aiqm_node_ControllerOverTemperatureNode Controller Over Temperature1.0.0Node Controller Over Temperature. Possible values are over(0), normal(1)
netapp_aiqm_node_StatusNode Status1.0.0State of the Node. Possible states are unknown(0), degraded(1), down(2), up(3), booting(4), waiting_for_giveback(5) and taken_over(6)
netapp_aiqm_node_FrusStatusNode Frus Status1.0.0State of List of FRUs on the node.Possible values are ok(1), error(0)
netapp_aiqm_node_ServiceProcessorStatusNode ServiceProcessor Status1.0.0State of the service processor on the node.Possible states are unknown(0), degraded(1), offline(2), node_offline(3), sp_daemon_offline(4), online(5), rebooting(6) and updating(7)
netapp_aiqm_node_ServiceProcessorLinkStatusNode ServiceProcessor Link Status1.0.0Service Processor Link status on the Node.Possible states are unknown(0), disabled(1), down(2) and up(3)
netapp_aiqm_node_CpuUtilizationNode Cpu Utilization%1.0.0Node Cpu Utilization
netapp_aiqm_node_HaPortStatusNode HaPort Status1.0.0Node HA Port State.Possible states are initialized(0), armed(1), down(2), active(3) and reserved(4)
netapp_aiqm_node_TakeOverStatusNode TakeOver Status1.0.0Represents the state of the node that is taking over storage from its HA partner. Possible states are not_possible(0), in_takeover(1), not_attempted(2), failed(3) and in_progress(4)
netapp_aiqm_node_GiveBackStatusNode GiveBack Status1.0.0Represents the state of the node that is giving storage back to its HA partner.Possible states are nothing_to_giveback(0), not_attempted(1), in_progress(2) and failed(3)
NetApp Active IQ Unified Manager Aggregatenetapp_aiqm_aggregate_StatusAggregate Status1.0.0operational State of the Aggregate. Possible states are unknown(0), failed(1), offline(2), offlining(3), unmounted(4), inconsistent(5), online(6), onlining(7), relocating(8) and restricted(9)
netapp_aiqm_aggregate_SizeUsedAggregate Used SizeGB1.0.0Space used on the Aggregate
netapp_aiqm_aggregate_SizeTotalAggregate Total SizeGB1.0.0Total usable space not including WAFL reserve and aggregate Snapshot copy reserve
netapp_aiqm_aggregate_SizeAvailableAggregate Available SizeGB1.0.0Number of input/output operations per second on the node
netapp_aiqm_aggregate_PercentageUsedCapacityAggregate Utilization%1.0.0Percentage used Capacity of an Aggregate
netapp_aiqm_aggregate_SpaceFullThresholdPercentAggregate SpaceFull Threshold Percentage%1.0.0Spacefull Threshold Percentage of an Aggregate
netapp_aiqm_aggregate_InactiveUserDataAggregate Inactive User DataGB1.0.0The size that is physically used in the block storage and has a cold temperature.only supported if the aggregate is either attached to a cloud store or can be attached to a cloud store.
netapp_aiqm_aggregate_MirrorStatusAggregate Mirror Status1.0.0Aggregate Mirror State. Possible states are failed(0), degraded(1), unmirrored(2), normal(3) and resynchronizing(4)
netapp_aiqm_aggregate_DiskCountAggregate Disk Countcount1.0.0Number of disks used in the aggregate. This includes parity disks, but excludes disks in the hybrid cache
netapp_aiqm_aggregate_RaidSizeAggregate Raid Sizecount1.0.0Specifies the maximum number of disks that can be included in a RAID group.
netapp_aiqm_aggregate_ThroughputAggregate ThroughPutMbps1.0.0The throughput on the aggregates, measured in bytes per second.
netapp_aiqm_aggregate_IopsAggregate IopsReq per Sec1.0.0The average input/output operations per second on the aggregates
netapp_aiqm_aggregate_LatencyAggregate Latencymicrosec1.0.0The average response time for all I/O requests, expressed in microseconds per operation.
netapp_aiqm_aggregate_SnapshotReservePercentAggregate Snapshot Reseve Percentage%1.0.0Aggregate Snapshot Reserve percentage
netapp_aiqm_aggregate_OverCommitmentAggregate Over Commitment%1.0.0Aggregate has had more space allocated to volumes than the amount of usable space in the aggregate
NetApp Active IQ Unified Manager Disknetapp_aiqm_disk_StatusDisk Status1.0.0Disk State. Possible states are broken(0), pending(1), removed(2), partner(3), copy(4), present(5), reconstructing(6), maintenance(7), spare(8), unfail(9) and zeroing(10)
netapp_aiqm_disk_SizeAvailableDisk Available SizeGB1.0.0Disk Available Size
NetApp Active IQ Unified Manager FC Portnetapp_aiqm_fcp_StatusFCP Status1.0.0FC Port State.Possible states are unknown(0), node_offline(1), offlined_by_system(2), offlined_by_user(3), link_disconnected(4), link_not_connected(5), startup(6) and online(7)
netapp_aiqm_fcp_ReadThroughPutFCP Read ThroughPutBps1.0.0Read Throughput for all read I/O operations of an FC Port
netapp_aiqm_fcp_WriteThroughPutFCP Write ThroughPutBps1.0.0WriteThroughput for all write I/O operations of an FC Port
netapp_aiqm_fcp_TotalThroughPutFCP Total ThroughPutBps1.0.0Total Throughput for all types of I/O operations of an FC Port
netapp_aiqm_fcp_ReadLatencyFCP Read Latencymicrosec1.0.0The response time for all read I/O requests, expressed in microseconds
netapp_aiqm_fcp_WriteLatencyFCP Write Latencymicrosec1.0.0The response time for all write I/O requests, expressed in microseconds
netapp_aiqm_fcp_TotalLatencyFCP Total Latencymicrosec1.0.0The response time for all I/O requests, expressed in microseconds
netapp_aiqm_fcp_OtherLatencyFCP Other Latencymicrosec1.0.0The response time for all other I/O requests, expressed in microseconds
netapp_aiqm_fcp_ReadOpsFCP Read Opss1.0.0Number of read I/O operations performed on the FC Port
netapp_aiqm_fcp_WriteOpsFCP Write Opss1.0.0Number of write I/O operations performed on a FC Port
netapp_aiam_fcp_TotalOpsFCP Total Opss1.0.0Performance metric aggregated over all types of I/O operations of an FC Port
netapp_aiqm_fcp_OtherOpsFCP Other Opss1.0.0Number of other operations performed on cluster. Other I/O operations can be metadata operations, such as directory lookups and so on
netapp_aiqm_fcp_IsAdministrativeUpFCP Administrative Status1.0.0The administrative state of the FC port. If this property is set to false, all FC connectivity to FC interfaces are blocked. Possible states false(0) and true(1)
NetApp Active IQ Unified Manager Ethernet Portnetapp_aiqm_ethernet_port_StatusEthernetPort Status1.0.0Net-Port Status. Possible states are down(0) and up(1)
netapp_aiqm_ethernet_port_ReadThroughPutEthernetPort Read ThroughPutBps1.0.0Read Throughput for all read I/O operations
netapp_aiqm_ethernet_port_WriteThroughPutEthernetPort Write ThroughPutBps1.0.0WriteThroughput for all write I/O operations
netapp_aiqm_ethernet_port_TotalThroughPutEthernetPort Total ThroughPutBps1.0.0Total Throughput for all types of I/O operations
netapp_aiqm_ethernet_port_LinkDownCountEthernetPort Link Down Countcount1.0.0The number of link state changes from up to down seen on the device
netapp_aiqm_ethernet_port_ReceivedPacketsEthernetPort Packets Receivedcount1.0.0Number of packets received
netapp_aiqm_ethernet_port_TransmittedPacketsEthernetPort Packets Transmittedcount1.0.0Number of packets transmitted
netapp_aiqm_ethernet_port_IsAdministrativeUpEthernetPort Adinistrative Statuscount1.0.0Administrative status of the Port. Possible states are false(0) and true(1)
NetApp Active IQ Unified Manager LIF Interfacenetapp_aiqm_lif_interface_StatusLIF Interface Status1.0.0Returns Interface state. Possible states are up(1), down(0)
netapp_aiqm_lif_interface_ReadThroughPutLIF Interface Read ThroughPutBps1.0.0Read Throughput for all read I/O operations of an Interface
netapp_aiqm_lif_interface_WriteThroughPutLIF Interface Write ThroughPutBps1.0.0WriteThroughput for all write I/O operations of an Interface
netapp_aiqm_lif_interface_TotalThroughPutLIF Interface Total ThroughPutBps1.0.0Total Throughput for all types of I/O operations of an Interface
NetApp Active IQ Unified Manager FC Interfacenetapp_aiqm_fc_interface_StatusFC Interface Status1.0.0The current operational state of the FC interface. The state is set to down if the interface is not enabled.If the node hosting the port is down or unavailable, no state value is returned.Possible states can be returned are down(0) and up(1)
netapp_aiqm_fc_interface_ReadThroughPutFC Interface Read ThroughPutBps1.0.0Read Throughput for all read I/O operations of an FC Interface
netapp_aiqm_fc_interface_WriteThroughPutFC Interface Write ThroughPutBps1.0.0WriteThroughput for all write I/O operations of an FC Interface
netapp_aiqm_fc_interface_TotalThroughPutFC Interface Total ThroughPutBps1.0.0Total Throughput for all types of I/O operations of an FC Interface
netapp_aiqm_fc_interface_ReadLatencyFC Interface Read Latencymicrosec1.0.0The response time for all read I/O requests, expressed in microseconds
netapp_aiqm_fc_interface_WriteLatencyFC Interface Write Latencymicrosec1.0.0The response time for all write I/O requests, expressed in microseconds
netapp_aiqm_fc_interface_TotalLatencyFC Interface Total Latencymicrosec1.0.0The response time for all I/O requests, expressed in microseconds
netapp_aiqm_fc_interface_OtherLatencyFC Interface Other Latencymicrosec1.0.0The response time for all other I/O requests, expressed in microseconds
netapp_aiqm_fc_interface_ReadOpsFC Interface Read Opss1.0.0Number of read I/O operations performed on the FC Interface
netapp_aiqm_fc_interface_WriteOpsFC Interface Write Opss1.0.0Number of write I/O operations performed on a FC Interface
netapp_aiqm_fc_interface_TotalOpsFC Interface Total Opss1.0.0Performance metric aggregated over all types of I/O operations of an FC Interface
netapp_aiqm_fc_interface_OtherOpsFC Interface Other Opss1.0.0Number of other operations performed. Other I/O operations can be metadata operations, such as directory lookups and so on
netapp_aiqm_fc_interface_IsAdministrativeUpFC Interface Administrative Status1.0.0The administrative state of the FC interface. The FC interface can be disabled to block all FC communication with the SVM through this interfacePossible returned values are false(0) and true(1)
NetApp Active IQ Unified Manager SVMnetapp_aiqm_vserver_StatusSVM Status1.0.0vServer /SVM Status.Possible states are starting(0), running(1), stopping(2), stopped(3) and deleting(4)
netapp_aiqm_vserver_IopsSVM IopsReq per Sec1.0.0Number of input/output operations per second on the SVM
netapp_aiqm_vserver_LatencySVM Latencymicrosec1.0.0The average response time for all I/O requests, expressed in microseconds per operation.
netapp_aiqm_vserver_ThroughputSVM ThroughPutMbps1.0.0The throughput on the SVM, measured in bytes per second.
netapp_aiqm_vserver_nfsv3_ReadOpsSVM NFSV3 Read Opss1.0.0Number of nfsv3 read input/output operations per second
netapp_aiqm_vserver_nfsv3_WriteOpsSVM NFSV3 Write Opss1.0.0Number of nfsv3 write input/output operations per second
netapp_aiqm_vserver_nfsv3_TotalOpsSVM NFSV3 Total Opss1.0.0Number of nfsv3 toal input/output operations per second
netapp_aiqm_vserver_nfsv3_OtherOpsSVM NFSV3 Other Opss1.0.0Number of nfsv3 write input/output operations per second.Other I/O operations can be metadata operations, such as directory lookups and so on
netapp_aiqm_vserver_cifs_ReadThroughPutSVM CIFS Read ThroughPutBps1.0.0Cifs Read throughput measured in bytes per second.
netapp_aiqm_vserver_cifs_WriteThroughPutSVM CIFS Write ThroughPutBps1.0.0Cifs write throughput measured in bytes per second.
netapp_aiqm_vserver_cifs_TotalThroughPutSVM CIFS Total ThroughPutBps1.0.0Cifs total throughput measured in bytes per second.
netapp_aiqm_vserver_cifs_ReadLatencySVM CIFS Read Latencymicrosec1.0.0The average response time for all read I/O requests, expressed in microseconds per operation.
netapp_aiqm_vserver_cifs_WriteLatencySVM CIFS Write Latencymicrosec1.0.0The average response time for all write I/O requests, expressed in microseconds per operation.
netapp_aiqm_vserver_cifs_TotalLatencySVM CIFS Total Latencymicrosec1.0.0The average response time for all I/O requests, expressed in microseconds per operation.
netapp_aiqm_vserver_cifs_OtherLatencySVM CIFS Other Latencymicrosec1.0.0The average response time for all other I/O requests, expressed in microseconds per operation.Other I/O operations can be metadata operations, such as directory lookups and so on
netapp_aiqm_vserver_cifs_ReadOpsSVM CIFS Read Opss1.0.0Number of read input/output operations per second
netapp_aiqm_vserver_cifs_WriteOpsSVM CIFS Write Opss1.0.0Number of write input/output operations per second
netapp_aiqm_vserver_cifs_TotalOpsSVM CIFS Total Opss1.0.0Number of total input/output operations per second
netapp_aiqm_vserver_cifs_OtherOpsSVM CIFS Other Opss1.0.0Number of other input/output operations per second
netapp_aiqm_vserver_iscsi_ReadThroughPutSVM ISCSI Read ThroughPutBps1.0.0Iscsi Read throughput measured in bytes per second
netapp_aiqm_vserver_iscsi_WriteThroughputSVM ISCSI Write ThroughPutBps1.0.0Iscsi write throughput measured in bytes per second.
netapp_aiqm_vserver_iscsi_TotalThroughputSVM ISCSI Total ThroughPutBps1.0.0Iscsi total throughput measured in bytes per second.
netapp_aiqm_vserver_iscsi_ReadOpsSVM ISCSI Read Opss1.0.0Number of read input/output operations per second
netapp_aiqm_vserver_iscsi_WriteOpsSVM ISCSI Write Opss1.0.0Number of write input/output operations per second
netapp_aiqm_vserver_iscsi_TotalOpsSVM ISCSI Total Opss1.0.0Number of total input/output operations per second
netapp_aiqm_vserver_iscsi_OtherOpsSVM ISCSI Other Opss1.0.0Number of other input/output operations per second
netapp_aiqm_vserver_iscsi_ReadLatencySVM ISCSI Read Latencymicrosec1.0.0The average response time for all read I/O requests, expressed in microseconds per operation.
netapp_aiqm_vserver_iscsi_WriteLatencySVM ISCSI Write Latencymicrosec1.0.0The average response time for all write I/O requests, expressed in microseconds per operation.
netapp_aiqm_vserver_iscsi_TotalLatencySVM ISCSI Total Latencymicrosec1.0.0The average response time for all I/O requests, expressed in microseconds per operation.
netapp_aiqm_vserver_iscsi_OtherLatencySVM ISCSI Other Latencymicrosec1.0.0The average response time for all other I/O requests, expressed in microseconds per operation. Other I/O operations can be metadata operations, such as directory lookups and so on
NetApp Active IQ Unified Manager Volumenetapp_aiqm_volume_StatusVolume Status1.0.0The state of the volume that is being exported. Possible State: error(0), offline(1), mixed(2), online(3)
netapp_aiqm_volume_SizeTotalVolume Total SizeGB1.0.0Total provisioned size. The default size is equal to the minimum size of 20MB, in GB
netapp_aiqm_volume_SizeAvailableVolume Available SizeGB1.0.0The available space in volume, in GB.
netapp_aiqm_volume_SizeUsedVolume Size UsedGB1.0.0Returns the space used in volume, in GB.
netapp_aiqm_volume_PercentageSizeUsedVolume Utilization1.0.0Percentage of the volume size that is used. This field is valid only when the volume is online.
netapp_aiqm_volume_FilesTotalVolume File Totalcount1.0.0The maximum number of files (inodes) for user-visible data allowed on the volume
netapp_aiqm_volume_FilesUsedVolume Files Usedcount1.0.0Number of user-visible files (inodes) used
netapp_aiqm_volume_InodeUtilizationVolume Inode(Files) Utilization%1.0.0Number of input/output operations per second on the node
netapp_aiqm_volume_SnapshotReserveSizeUsedVolume Snapshots Reserved Size UsedGB1.0.0The total space used by Snapshot copies in the volume, in GB.
netapp_aiqm_volume_PercentageSnapshotsReservedVolume Snapshots Reserved Percentage%1.0.0The space that has been set aside as a reserve for Snapshot copy usage, in percent
netapp_aiqm_volume_FootprintVolume FootPrintGB1.0.0Data used for this volume in the aggregate, in GB
netapp_aiqm_volume_MetadataVolume MetaDataGB1.0.0Space used by the volume metadata in the aggregate, in GB
netapp_aiqm_volume_LogicalSpaceUsedByAfsVolume Logical Space Used By AFSGB1.0.0The virtual space used by AFS alone (includes volume reserves) and along with storage efficiency, in GB
netapp_aiqm_volume_CompressionStateVolume Compression Status1.0.0The system can be enabled/disabled compression. Possible states are none(0), inline(1), mixed(2), background(3) and both(4)
netapp_aiqm_volume_DeduplicationStateVolume Deduplication Status1.0.0The system can be enabled/disabled dedupe. Possible states are none(0), inline(1), mixed(2), background(3) and both(4)
netapp_aiqm_volume_CrossVolumeDeduplicationStateVolume Cross Deduplication Status1.0.0The system can be enabled/disabled cross volume dedupe. it can be enabled only when dedupe is enabled. Possible states are none(0), inline(1), mixed(2), background(3) and both(4)
netapp_aiqm_volume_CompactionStateVolume Compaction State1.0.0The system can be enabled/disabled compaction. Possible states are none(0), inline(1) and mixed(2)
netapp_aiqm_volume_QuotaStateVolume Quota State1.0.0Quota state of the volume. Possible states are corrupt(0), initializing(1), mixed(2), off(3), on(4) and resizing(5)
netapp_aiqm_volume_GrowThresholdPercentageVolume Grow Threshold Percentage%1.0.0Used space threshold size, in percentage, for the automatic growth of the volume. When the amount of used space in the volume becomes greater than this threhold, the volume automatically grows unless it has reached the maximum size
netapp_aiqm_volume_ShrinkThresholdPercentageVolume Shrink Threshold Percentage%1.0.0Used space threshold size, in percentage, for the automatic shrinkage of the volume. When the amount of used space in the volume drops below this threshold, the volume automatically shrinks unless it has reached the minimum size
netapp_aiqm_volume_LatencyVolume Latencymicrosec1.0.0The response time for all I/O requests, expressed in microseconds per operation
netapp_aiqm_volume_IOpsVolume IopsReq per Sec1.0.0The input/output operations per second for the volume
netapp_aiqm_volume_ThroughputVolume ThroughPutMbps1.0.0Throughput on the volume, measured in bytes per second
netapp_aiqm_volume_SnapshotCountVolume Snapshot Countcount1.0.0Volume SnapShot Count
netapp_aiqm_volume_TooOldSnapshotVolume Too Old SnapshotDays1.0.0Specifies the age of a Snapshot copy, which, if exceeded, is considered too old for the volume
netapp_aiqm_volume_QuotaToalFilesUsedVolume Quota Total Files Usedcount1.0.0Total files used in Quota
netapp_aiqm_volume_QuotaSpaceHardLimitVolume Quota Space HardLimtBytes1.0.0Quota Space hard limit in GB
netapp_aiqm_volume_QuotaSpaceHardLimitPercentageUsedVolume Quota Space HardLimt Utilization%1.0.0Total space used as a percentage of space hard limit
netapp_aiqm_volume_QuotaToalSpaceUsedVolume Quota Space UsedGB1.0.0Total space used by Quota
netapp_aiqm_volume_SpaceFullThresholdPercentVolume SpaceFull Threshold Percent1.0.0Volume SpaceFull Threshold Percentage
NetApp Active IQ Unified Manager Lunnetapp_aiqm_lun_SizeTotalLun Total SizeGB1.0.0The total storage capacity of the LUN, in gigabytes.
netapp_aiqm_lun_SizeUsedLun Used SizeGB1.0.0The amount of space consumed by the main data stream of the LUN
netapp_aiqm_lun_SizeAvailableLun Available SizeGB1.0.0The amount of space available after the space consumed by the main data stream of the LUN
netapp_aiqm_lun_PercentageSizeUsedLun Utilization%1.0.0Lun Utilization
netapp_aiqm_lun_StatusLun Status1.0.0Returns status of Lun.Possible states are foreign_lun_error(0), nvfail(1), offline(2), online(3) and space_error(4)
netapp_aiqm_lun_LatencyLun Latencymicrosec1.0.0The average response time for all I/O requests, expressed in microseconds per operation.
netapp_aiqm_lun_IopsLun IopsReq per Sec1.0.0Number of input/output operations per second on the Lun
netapp_aiqm_lun_ThroughputLun ThroughPutMbps1.0.0The throughput on the LUN, measured in bytes per second
NetApp Active IQ Unified Manager Qtreenetapp_aiqm_qtree_ReadOpsQtree Read Opss1.0.0Number of read input/output operations per second on the qtree
netapp_aiqm_qtree_WriteOpsQtree Write Opss1.0.0Number of write input/output operations performed per second on qtree
netapp_aiqm_qtree_OtherOpsQtree Other Opss1.0.0Number of other operations performed. Other I/O operations can be metadata operations, such as directory lookups and so on
netapp_aiqm_qtree_TotalOpsQtree Total Opss1.0.0Performance metric aggregated over all types of I/O operations
netapp_aiqm_qtree_StatusQtree Status1.0.0Returns status of Qtree. Possible states are ok(0), error(1), partial_no_data(2), partial_no_uuid(3), partial_no_response(4), partial_other_error(5),negative_delta(6), backfilled_data(7), inconsistent_delta_time(8), inconsistent_old_data(9)
NetApp Active IQ Unified Manager Storage Portnetapp_aiqm_port_SpeedStorage Port SpeedGbps1.0.0Cluster Storage Port Speed
netapp_aiqm_port_StatusStorage Port Status1.0.0Storage Port Status, Possible status are error(0), online(1) and offline(2)
NetApp Active IQ Unified Manager Shelfnetapp_aiqm_shelf_StatusShelf Status1.0.0Returns the status of the Shelf. Possible states are unknown(0), error(1) and ok(2)
netapp_aiqm_shelf_PortStatusShelf Port Status1.0.0Returns the status of the Ports associated with the shelf. Possible states are disconnected(0), error(1) and connected(2)

Default Monitoring Configurations

NetApp Active IQ Unified Manager application 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. OpsRamp recommends performing 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 NetApp Active IQ Unified Manager. 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: netapp-active-iq-unified-manager NetApp Cluster - 1 (i.e, appName = netapp-active-iq-unified-manager, nativeType = NetApp Cluster, version = 1)

  2. Default Global Templates

    OpsRamp has a Global Templtemplate for each Native Type of NetApp Active IQ Unified Manager. 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: etapp-active-iq-unified-manager NetApp Cluster Template - 1 (i.e, appName = netapp-active-iq-unified-manager, nativeType = NetApp Cluster, version = 1)

  3. 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: NetApp AIQM Cluster Monitor netapp-active-iq-unified-manager NetApp Cluster 1 (i.e, monitorKey = NetApp AIQM Cluster Monitor, appName = netapp-active-iq-unified-manager, nativeType = NetApp Cluster, version = 1)

Configure and Install the Netapp ActiveIQ Unified Manager Integration

  1. From All Clients, select a client.
  2. Go to Setup > Account.
  3. Select the Integrations and Apps tab.
  4. 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.
  5. 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.
  1. Click ADD in the Netapp ActiveIQ Unified Manager 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 configuration
IP Address/Host NameIP address/host name of the target.
PortPort.

Example: By default 443 is selected.
NetApp Active Iq 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.
  • App Failure Notifications: if turned on, you will be notified in case of an application failure that is, Connectivity Exception, Authentication Exception.
  • Alert Configuration: map alert configuration for third party alerts into OpsRamp.
  • Alert On Root Resource: Alerts generated on root resource.
  • Below are the default values set for:
    • Alert Severity: possible values of Alert Severity Filter configuration property are new,obsolete,acknowledged,resolved.
    • Alert Severity Mapping: possible values of Alert Severity Mapping Filter configuration property are “new”:{“critical”: “Critical”,“error”: “Critical”,“warning”: “Warning”,“information”: “Info”,“normal”: “Info”},“acknowledged”: {“critical”: “Critical”,“error”: “Critical”,“warning”: “Warning”,“information”: “Info”,“normal”: “Info”},“obsolete”: {“critical”: “Ok”,“error”: “Ok”,“warning”: “Ok”,“information”: “Ok”,“normal”: “Ok”},“resolved”: {“critical”: “Ok”,“error”: “Ok”,“warning”: “Ok”,“information”: “Ok”,“normal”: “Ok”}.
  1. Select the below mentioned Custom Attribute:
FunctionalityDescription
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 NetApp Active IQ details

The discovered resource(s) are displayed in Infrastructure > Resources > Storage > NetApp Cluster > Resources. You can navigate to the Attributes tab to view the discovery details, and Metrics tab to view the metric details for NetApp Active IQ.

Linux Install Integration
Linux Install Integration

View resource metrics

To confirm NetApp Active IQ monitoring, review the following:

  • Metric graphs: A graph is plotted for each metric that is enabled in the configuration.
  • Alerts: Alerts are generated for metrics that are configured as defined for integration.
Linux Install Integration

Resource Filter Input keys

NetApp Active Iq Unified Manager application 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
NetApp Active Iq Unified ManagerServices
NetApp Active IQ Unified Manager ClusterLocation
Node Count
NetApp Active IQ Unified Manager NodeRoot Cluster
NetApp Active IQ Unified Manager AggregateRoot Cluster
NetApp Active IQ Unified Manager SVMRoot Cluster
NetApp Active IQ Unified Manager VolumeSVM Name
Volume Type
Volume Style
Root Cluster
NetApp Active IQ Unified Manager LunRoot Cluster
Volume Name
SVM Name
NetApp Active IQ Unified Manager DiskPool
Disk Type
Container Type
Firmware Version
Aggregates
NetApp Active IQ Unified Manager FC PortNode
wwnn
wwpn
NetApp Active IQ Unified Manager FC Interfacewwnn
wwpn
Data Protocol
Port Address
FcPort Name
NetApp Active IQ Unified Manager Ethernet PortPort Type
MTU
Speed
Node
Member Ports
Active Member Ports
NetApp Active IQ Unified Manager LIF InterfaceIP NetMask
Services
Scope
EthernetPort Name
NetApp Active IQ Unified Manager Storage PortNode
wwn
Cable Length
Cable Identifier
Cable Part Number
Cable Serial Number
NetApp Active IQ Unified Manager QtreeRoot Cluster
SVM
Volume
Security Style
Unix Permissions
NetApp Active IQ Unified Manager ShelfModule Type
Node

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}

                                ${parent.resource.name}

                                ${Custom attributes on the resource}

Risks, Limitations & Assumptions

  • Application can handle Critical/Recovery failure notifications for below two cases when user enables App Failure Notifications in configuration
    • Connectivity Exception
    • Authentication Exception
  • Application will not send any duplicate/repeat failure alert notification until the already existing critical alert is recovered.
  • Using metrics for monitoring the resources and generating alerts when the threshold values are breached.
  • Application cannnot control monitoring pause/resume actions based on above alerts
  • NetApp Active Iq Unified Manager Event/AlertPolling will be started only if the user enables App Failure Notifications in configuration.
  • Possible values of Alert Severity Filter configuration property are warning, critical and error.
  • OpsRamp has given sample mappings to map NetApp Active Iq Unified Manager Severity with OpsRamp Severities as part of the Event/Alert Severity Mapping configuration file.
  • This application supports both Classic Gateway and NextGen Gateway.
  • No support of showing activity log and applied time

References

NetApp-Active-IQ - version 9.9 (Sample responses from Swagger)

Swagger Link: https://library.netapp.com/ecmdocs/ECMLP2876865/html/index.html#/datacenter/metrics_svm_get_by_key