Supported Versions
ONTAP API cluster-mode APIs
NetApp Cluster version 8.2.2

NetApp cluster is a storage disk array operating system.

Prerequisites

Transport Layer Security (TLS) must be enabled on the NetApp Cluster.

To check the TLS status:

SSH username@hostname
system services web show

If TLS is not enabled: tls.enable on

Example output:

External Web Services: true
               Status: online
   HTTP Protocol Port: 80
  HTTPS Protocol Port: 443
        TLSv1 Enabled: true
        SSLv3 Enabled: true
        SSLv2 Enabled: true

OpsRamp configuration

Step 1: Create a credential

  1. From All Clients, choose a client.
  2. Go to Setup > Accounts > Clients.
  3. In the client’s Credentials tab, add the credential information. Credential settings include:
    • Type: NetAppCluster

    • Use Password Vault: If enabled, specify Policy Mapping, otherwise, enter a password.

      • Policy mapping enables a Password Manager application integration with credentials.
      • Password is the authentication password to access a resource.
    • Port:

      • For HTTP, use port 80.
      • For HTTPS, select Is Secure and use port 443.

Step 2: Install and configure the integration

  1. From All Clients, choose a client.

  2. Go to Setup > Integrations > Integrations.

  3. From Available Integrations, select Storage > NetApp Cluster and click Install.

  4. Enter:

    • Name
    • IP address
    • Credentials. Select an existing credential or create a new credential.
  5. Click Save.

Step 3: Add a discovery profile

  1. From the Discovery Profiles tab, click + Add.
  2. From the Add Discovery Profile window, enter:
    • Profile Name: Discovery profile name.
    • Select Profile: Choose a management profile.
    • IP Address: NetApp Cluster IP address.
  3. From the Filter Criteria section, filter for resources using one of the following:
    • Smart Filters: Filter resources based on the resource type.
    • Resource Filters: Filter resources based on resource attributes.
      • Select matching criteria to match Any or All rules.
      • Filter for resources using the following attributes: resource type, attribute name, logical operator, and value.
        Use regular expressions to filter resources using logical operator regex.
  4. From the Perform Actions section, choose Manage Device to set the resources as managed.
  5. From the Discovery Schedule section, select Recurrence Pattern to add one of the following:
    • Hourly
    • Daily
    • Weekly
    • Monthly
  6. Click Save.
  7. From the Discovery Profiles section, click Scan Now for the associated profile.

Step 4: View the NetApp Cluster infrastructure details

NetApp Cluster is displayed in the Infrastructure > Resources > Storage > NetApp Cluster category. Click the name to view details. Monitoring is enabled according to the configured metric criteria.

Netapp Cluster Infrastructure

Step 5: Assign the monitoring template

To assign monitoring templates to NetApp Cluster, see Assigning Templates. For more information on NetApp Cluster templates, see NetApp Cluster.

Step 6: View resource metrics

To confirm NetApp Cluster 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.
NetApp Cluster Metric Graph

Supported metrics

OpsRamp MetricMetric Display NameUnit
Metrics

Description
Metric NameUnit
aggregate.total_transfers

Total number of disk operations serviced by the aggregate
netapp.cluster.aggregate.total_transfersPER_SEC
aggregate.user_reads

Number of user read operations performed by the aggregate
netapp.cluster.aggregate.user_readsPER_SEC
aggregate.user_writes

Number of user write operations performed by the aggregate
netapp.cluster.aggregate.user_writesPER_SEC
aggregate.cp_reads

Number of read operations to the aggregate during consistency-point processing
netapp.cluster.aggregate.cp_readsPER_SEC
aggregate.user_read_blocks

Number of blocks transferred for user read operations
netapp.cluster.aggregate.user_read_blocksPER_SEC
aggregate.user_write_blocks

Number of blocks transferred for user write operations
netapp.cluster.aggregate.user_write_blocksPER_SEC
aggregate.cp_read_blocks

Number of blocks transferred for consistency-point read operations
netapp.cluster.aggregate.cp_read_blocksPER_SEC
disk.total_transfers

Total number of disk operations performed by the aggregate
netapp.cluster.disk.total_transfersPER_SEC
disk.user_reads

Number of user read operations performed by the aggregate
netapp.cluster.disk.user_readsPER_SEC
disk.user_writes

Number of user write operations performed by the aggregate
netapp.cluster.disk.user_writesPER_SEC
disk.cp_reads

Number of read operations to the aggregate during consistency point processing
netapp.cluster.disk.cp_readsPER_SEC
disk.guarenteed_read_blocks

Number of blocks transferred for guaranteed read operations per second
netapp.cluster.disk.guarenteed_read_blocksPER_SEC
disk.guarenteed_write_blocks

Number of blocks transferred for guaranteed write operations per second
netapp.cluster.disk.guarenteed_write_blocksPER_SEC
disk.user_read_blocks

Number of blocks transferred for user read operations
netapp.cluster.disk.user_read_blocksPER_SEC
disk.user_write_blocks

Number of blocks transferred for user write operations
netapp.cluster.disk.user_write_blocksPER_SEC
disk.cp_read_blocks

Number of blocks transferred for consistency-point read operations
netapp.cluster.disk.cp_read_blocksPER_SEC
ifnet.recv_packets

Packets received per second
netapp.cluster.ifnet.recv_packetsPER_SEC
ifnet.recv_errors

Errors per second while receiving packets
netapp.cluster.ifnet.recv_errorsPER_SEC
ifnet.send_packets

Packets sent per second
netapp.cluster.ifnet.send_packetsPER_SEC
ifnet.send_errors

Errors per second while sending packets
netapp.cluster.ifnet.send_errorsPER_SEC
ifnet.collisions

Collisions per second on CSMA interfaces
netapp.cluster.ifnet.collisionsPER_SEC
ifnet.recv_data

Total bytes received per second
netapp.cluster.ifnet.recv_dataB_PER_SEC
ifnet.send_data

Total bytes sent per second
netapp.cluster.ifnet.send_dataB_PER_SEC
ifnet.recv_mcasts

Packets received per second through multicast
netapp.cluster.ifnet.recv_mcastsPER_SEC
ifnet.send_mcasts

Packets sent per second through multicast
netapp.cluster.ifnet.send_mcastsPER_SEC
lun.read_ops

Read operations per second
netapp.cluster.lun.read_opsPER_SEC
lun.write_ops

Write operations per second
netapp.cluster.lun.write_opsPER_SEC
lun.other_ops

Other operations per second
netapp.cluster.lun.other_opsPER_SEC
lun.read_data

Read bytes per second
netapp.cluster.lun.read_dataB_PER_SEC
lun.write_data

Write bytes per second
netapp.cluster.lun.write_dataB_PER_SEC
lun.total_ops

Total number of operations on the LUN
netapp.cluster.lun.total_opsPER_SEC
lun.queuefull

Queue full responses per second
netapp.cluster.lun.queuefullPER_SEC
system.net_data_recv

Network KB received per second
netapp.cluster.system.net_data_recvKB_PER_SEC
system.net_data_sent

Network KB sent per second
netapp.cluster.system.net_data_sentKB_PER_SEC
system.disk_data_read

Disk KB read per second
netapp.cluster.system.disk_data_readKB_PER_SEC
system.disk_data_written

Disk KB written per second
netapp.cluster.system.disk_data_writtenKB_PER_SEC
system.total_ops

Total operations per second
netapp.cluster.system.total_opsPER_SEC
system.read_ops

Read operations per second
netapp.cluster.system.read_opsPER_SEC
system.write_ops

Write operations per second
netapp.cluster.system.write_opsPER_SEC
system.cifs_ops

CIFS operations per second
netapp.cluster.system.cifs_opsPER_SEC
system.fcp_ops

FCP operations per second
netapp.cluster.system.fcp_opsPER_SEC
system.http_ops

HTTP operations per second
netapp.cluster.system.http_opsPER_SEC
system.iscsi_ops

iSCSI operations per second
netapp.cluster.system.iscsi_opsPER_SEC
system.nfs_ops

NFS operations per second
netapp.cluster.system.nfs_opsPER_SEC
volume.total_ops

Number of operations performed by the volume
netapp.cluster.volume.total_opsPER_SEC
volume.read_ops

Number of reads to the volume
netapp.cluster.volume.read_opsPER_SEC
volume.read_data

Bytes read from the volume
netapp.cluster.volume.read_dataB_PER_SEC
volume.write_data

Bytes written to the volume
netapp.cluster.volume.write_dataB_PER_SEC
volume.other_ops

Number of other operations to the volume
netapp.cluster.volume.other_opsPER_SEC
volume.write_ops

Number of writes to the volume
netapp.cluster.volume.write_opsPER_SEC
volume.nfs_read_ops

Number of NFS reads to the volume
netapp.cluster.volume.nfs_read_opsPER_SEC
volume.nfs_write_ops

Number of NFS writes to the volume
netapp.cluster.volume.nfs_write_opsPER_SEC
volume.nfs_other_ops

Number of other NFS operations to the volume
netapp.cluster.volume.nfs_other_opsPER_SEC
volume.cifs_read_ops

Number of CIFS reads to the volume
netapp.cluster.volume.cifs_read_opsPER_SEC
volume.cifs_write_ops

Number of CIFS writes to the volume
netapp.cluster.volume.cifs_write_opsPER_SEC
volume.cifs_other_ops

Number of other CIFS operations to the volume
netapp.cluster.volume.cifs_other_opsPER_SEC
volume.san_read_ops

Number of block protocol reads to the volume
netapp.cluster.volume.san_read_opsPER_SEC
volume.san_write_ops

Number of block protocol writes to the volume
netapp.cluster.volume.san_write_opsPER_SEC
volume.san_other_ops

Number of other block protocol operations to the volume
netapp.cluster.volume.san_other_opsPER_SEC
volume.flexcache_other_ops

Number of other FlexCache operations to the volume
netapp.cluster.volume.flexcache_other_opsPER_SEC
volume.flexcache_read_ops

Number of FlexCache read operations from the volume
netapp.cluster.volume.flexcache_read_opsPER_SEC
volume.flexcache_write_ops

Number of FlexCache write operations to the volume
netapp.cluster.volume.flexcache_write_opsPER_SEC
volume:vserver.other_ops

Number of other operations to the volume at the Vserver level
 netapp.cluster.volume:vserver.other_opsPER_SEC
volume:vserver.read_data

Bytes read from the volume at the Vserver level
netapp.cluster.volume:vserver.read_dataB_PER_SEC
volume:vserver.read_ops

Number of reads to the volume, at the Vserver level
netapp.cluster.volume:vserver.read_opsPER_SEC
volume:vserver.total_ops

Number of operations performed by the volume at the Vserver level
netapp.cluster.volume:vserver.total_opsPER_SEC
volume:vserver.write_data

Bytes written to the volume, at the Vserver level
netapp.cluster.volume:vserver.write_dataB_PER_SEC
volume:vserver.write_ops

Number of writes to the volume, at the Vserver level
netapp.cluster.volume:vserver.write_opsPER_SEC
volume:node.other_ops

Number of other operations to the volume at the Vserver level
netapp.cluster.volume:node.other_opsPER_SEC
volume:node.read_data

Bytes read from the volume, at the Vserver level
netapp.cluster.volume:node.read_dataB_PER_SEC
volume:node.read_ops

Number of reads to the volume, at the Vserver level
netapp.cluster.volume:node.read_opsPER_SEC
volume:node.total_ops

Number of operations performed by the volume, at the Vserver level
netapp.cluster.volume:node.total_opsPER_SEC
volume:node.write_data

Bytes written to the volume, at the Vserver level
netapp.cluster.volume:node.write_dataB_PER_SEC
volume:node.write_ops

Number of writes to the volume, at the Vserver level
netapp.cluster.volume:node.write_opsPER_SEC
volume:node.avg_latency

Average latency in microseconds for the WAFL file system to process all the operations on the volume
netapp.cluster.volume:node.avg_latencyUSECS
volume:node.cifs_other_latency

Average time for the WAFL file system to process other CIFS operations to the volume
netapp.cluster.volume:node.cifs_other_latencyUSECS
volume:node.cifs_other_ops

Number of other CIFS operations to the volume
netapp.cluster.volume:node.cifs_other_opsPER_SEC
volume:node.cifs_read_latency

Average time for the WAFL file system to process CIFS read requests to the volume
netapp.cluster.volume:node.cifs_read_latencyUSECS
volume:node.cifs_read_ops

Number of CIFS reads to the volume
netapp.cluster.volume:node.cifs_read_opsPER_SEC
volume:node.cifs_write_latency

Average time for the WAFL file system to process CIFS write requests to the volume
netapp.cluster.volume:node.cifs_write_latencyUSECS
volume:node.cifs_write_ops

Number of CIFS writes to the volume
netapp.cluster.volume:node.cifs_write_opsPER_SEC
volume:node.flexcache_other_ops

Number of other FlexCache operations to the volume
netapp.cluster.volume:node.flexcache_other_opsPER_SEC
volume:node.flexcache_read_ops

Number of FlexCache read operations from the volume
netapp.cluster.volume:node.flexcache_read_opsPER_SEC
volume:node.flexcache_write_ops

Number of FlexCache write operations to the volume
netapp.cluster.volume:node.flexcache_write_opsPER_SEC
volume:node.nfs_other_latency

Average time for the WAFL file system to process other NFS operations to the volume
netapp.cluster.volume:node.nfs_other_latencyUSECS
volume:node.nfs_other_ops

Number of other NFS operations to the volume
netapp.cluster.volume:node.nfs_other_opsPER_SEC
volume:node.nfs_read_latency

Average time for the WAFL file system to process NFS protocol read requests to the volume
netapp.cluster.volume:node.nfs_read_latencyUSECS
volume:node.nfs_read_ops

Number of NFS reads to the volume
netapp.cluster.volume:node.nfs_read_opsPER_SEC
volume:node.nfs_write_latency

Average time for the WAFL file system to process NFS protocol write requests to the volume
netapp.cluster.volume:node.nfs_write_latencyUSECS
volume:node.nfs_write_ops

Number of NFS writes to the volume
netapp.cluster.volume:node.nfs_write_opsPER_SEC
volume:node.other_latency

Average latency in microseconds for the WAFL file system to process other operations to the volume
netapp.cluster.volume:node.other_latencyUSECS
volume:node.read_latency

Average latency in microseconds for the WAFL file system to process read request to the volume
netapp.cluster.volume:node.read_latencyUSECS
volume:node.san_other_latency

Average time for the WAFL file system to process other block protocol requests to the volume
netapp.cluster.volume:node.san_other_latencyUSECS
volume:node.san_other_ops

Number of other block protocol operations to the volume
netapp.cluster.volume:node.san_other_opsPER_SEC
volume:node.san_read_latency

Average time for the WAFL file system to process block protocol read requests to the volume
netapp.cluster.volume:node.san_read_latencyUSECS
volume:node.san_read_ops

Number of block protocol reads to the volume
netapp.cluster.volume:node.san_read_opsPER_SEC
volume:node.san_write_latency

Average time for the WAFL file system to process block protocol write requests to the volume
netapp.cluster.volume:node.san_write_latencyUSECS
volume:node.san_write_ops

Number of block protocol writes to the volume
netapp.cluster.volume:node.san_write_opsPER_SEC
volume:node.write_latency

Average latency in microseconds for the WAFL file system to process write request to the volume
netapp.cluster.volume:node.write_latencyUSECS
raid.tetris_written

Tetrises written per second
netapp.cluster.raid.tetris_writtenPER_SEC
raid.stripes_written

Stripes written per second
netapp.cluster.raid.stripes_writtenPER_SEC
raid.partial_stripes

Partial stripes written per second
netapp.cluster.raid.partial_stripesPER_SEC
raid.full_stripes

Full stripes written per second
netapp.cluster.raid.full_stripesPER_SEC
raid.blocks_written

Blocks written per second
netapp.cluster.raid.blocks_writtenPER_SEC
raid.blocks_read

Blocks read per second
netapp.cluster.raid.blocks_readPER_SEC
nfsv3.nfsv3_ops

Total number of NFSv3 operations
netapp.cluster.nfsv3.nfsv3_opsPER_SEC
nfsv3.nfsv3_read_ops

Total NFSv3 read operations
netapp.cluster.nfsv3.nfsv3_read_opsPER_SEC
nfsv3.nfsv3_write_ops

Total NFSv3 write operations
netapp.cluster.nfsv3.nfsv3_write_opsPER_SEC
aggregate.raid-status                                           

RAID status. Possible values: normal, verifying, SnapMirrored, copying, ironing, mirrored, resyncing, mirror degraded, invalid, needs check, initializing, growing, partial, noparity, degraded, reconstruct, out-of-date, foreign, raid4, raid0, raid_dp, mixed_raid_type. These values may appear by themselves or in combination separated by commas (e.g., "reconstruct,growing"). An aggregate could be of only one of the following RAID types:
netapp.cluster.aggregate.raid-statusText
aggregate.state

Aggregate state. The possible values: "creating", "destroying", "failed", "frozen", "inconsistent", "iron_restricted", "mounting", "offline", "online", "partial", "quiesced", "quiescing", "restricted", "reverted", "unknown", "unmounted", "unmounting".
netapp.cluster.aggregate.stateText
aggregate.percent-used-capacity

The percentage of disk space currently in use on the referenced file system.
netapp.cluster.aggregate.percent-used-capacityPercentage
aggregate.size-available

Number of bytes still available in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned.
netapp.cluster.aggregate.size-availableBytes
aggregate.size-total

Total size (in bytes) of the referenced file system. If the referenced file system is restricted or offline, a value 0 is returned.
netapp.cluster.aggregate.size-totalBytes
aggregate.size-used

Number of bytes used in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned.
netapp.cluster.aggregate.size-usedBytes
cf.node-state

State of the storage failover of the node. Refer API for possible values.
netapp.cluster.cf.node-stateText
cf.state

If state equals "takeover_failed", this is the reason for the takeover failure.
netapp.cluster.cf.stateText
diagnosis.status

Overall system health (ok,ok-with-suppressed,degraded,unreachable) as determined by the diagnosis framework. Attributes: non-creatable, non-modifiable
netapp.cluster.diagnosis.statusText
storage-disk.is-offline

True if disk is offline. Omitted if excluded by 'desired-attributes'.
netapp.cluster.storage-disk.is-offlineTrue/False
storage-disk.is-prefailed

True if the admin issued a 'disk fail' or if the the system marked this disk for Rapid RAID Recovery. This flag is expected to remain set until the system has copied the contents of this disk to a system-selected replacement disk. At that point, this disk is expected to be removed from service and placed in in the broken pool. Omitted if excluded by 'desired-attributes'.
netapp.cluster.storage-disk.is-prefailedTrue/False
storage-disk.is-replacing

True if the admin issued 'disk replace' to replace this disk with a specified replacement disk. This flag is expected to remain true until the system has copied the contents of this disk to the admin-specified replacement disk. At that point this disk is expected to be released to the spare pool. Omitted if excluded by 'desired-attributes'.
netapp.cluster.storage-disk.is-replacingTrue/False
storage-disk.is-zeroed

True if disk is in pre-zeroed state. Omitted if excluded by 'desired-attributes'.
netapp.cluster.storage-disk.is-zeroedTrue/False
storage-disk.bytes-per-sector

Number of bytes per disk sector. A sector count element, such as 'capacity-sectors' and 'right-size-sectors', may be multiplied by this value to convert to a byte count. Omitted if excluded by 'desired-attributes'.
netapp.cluster.storage-disk.bytes-per-sectorBytes
storage-disk.capacity-sectors

Total number of disk sectors on this disk, given in units of 'bytes-per-sector'. Omitted if excluded by 'desired-attributes'.
netapp.cluster.storage-disk.capacity-sectorsBytes
storage-disk.right-size-sectors

Number of usable disk sectors that remain after subtracting the right-size adjustment for this disk. Given in units of 'bytes-per-sector'. Omitted if information is unavailable, or if excluded by 'desired-attributes'.
netapp.cluster.storage-disk.right-size-sectorsBytes
lun.online

State of the LUN, ("online" or "offline"). "true" if online, "false" otherwise.
netapp.cluster.lun.onlineTrue/False
lun.size

Size of this LUN in bytes in the active FS. This field is unavailable while the LUN is fenced for a restore operation.
netapp.cluster.lun.sizeBytes
lun.size-used

Number of bytes used by this LUN. This field is unavailable while the LUN is fenced for a restore operation.
netapp.cluster.lun.size-usedBytes
qtree.status

Status of the qtree. Possible values include: "snapvaulted", "snapmirrored", "normal", and "readonly".
netapp.cluster.qtree.statusText
snapmirror.mirror-state

Specifies the mirror state of the SnapMirror relationship. Possible values are:
netapp.cluster.snapmirror.mirror-stateText
volume.state

State of the volume. Possible values: "offline", "online", "restricted" and "unknown" for both flexible and traditional volumes, and "creating", "failed", and "partial" specifically for traditional volumes.
netapp.cluster.volume.stateText
volume.size

Filesystem size (in bytes) of the volume. This is the total usable size of the volume, not including WAFL reserve.
netapp.cluster.volume.sizeBytes
volume.size-available

The size (in bytes) that is still available in the volume. This field is valid only when the volume is online.
netapp.cluster.volume.size-availableBytes
volume.size-used

The size (in bytes) that is used in the volume. This field is valid only when the volume is online.
netapp.cluster.volume.size-usedBytes
volume.percentage-size-used

Percentage of the volume size that is used. This field is valid only when the volume is online.
netapp.cluster.volume.percentage-size-usedPercentage
volume.snapshot-reserve-size

The size (in bytes) in the volume that has been set aside as reserve for snapshot usage.
netapp.cluster.volume.snapshot-reserve-sizeBytes
volume.size-available-for-snapshots

Total free space (in bytes) available in the volume and the snapshot reserve.
netapp.cluster.volume.size-available-for-snapshotsBytes
system.size-total

System total size
netapp.cluster.system.size-totalBytes
system.size-used

System used size
netapp.cluster.system.size-usedBytes
system.utilization

System Utilization
netapp.cluster.system.utilizationPercentage
vserver.state

State of the Vserver. This field represents the data serving ability of a Vserver,
netapp.cluster.vserver.stateText
cluster-peer.is-cluster-healthy

The status of peer cluster health. Attributes: non-creatable, non-modifiable
netapp.cluster.cluster-peer.is-cluster-healthyTrue/False
system.is-node-healthy

This parameter is used to determine health of a node in a cluster. A boolean value
netapp.cluster.system.is-node-healthyTrue/False
net.administrative-status

Specifies the administrative status of the LIF. Possible values: 'up', 'down', 'unknown'
netapp.cluster.net.administrative-statusText
netapp.cluster.aggregate.snapshot-reserved-percentage

space reserved for aggregate Snapshot copies in the aggregate
Netapp Cluster Aggregate Snapshot Reserved PercentagePercentage
netapp.cluster.aggregate.aggr-over-commitment

An over-committed aggregate is one in which the total space allocated to volumes exceeds that of what is allowable by the containing aggregate
Netapp Cluster Aggregate Aggr Over CommitmentPercentage
netapp.cluster.volume.percentage-snapshots-reserved

space reserved for volume Snapshot copies in the volume
Netapp Cluster Volume Percentage Snapshots ReservedPercentage
netapp.cluster.volume.spacefull-threshold-percentage

Specifies the percentage at which a volume is considered full.
Netapp Cluster Volume Spacefull Threshold PercentagePercentage
netapp.cluster.volume.volume-snapshot-count

Specifies the number of snapshots in the volume
Netapp Cluster Volume Volume Snapshot CountCount
netapp.cluster.volume.grow-threshold-percentage

Specifies the percentage at which a volume's growth rate is considered to be normal before the system generates a Volume Growth Rate Abnormal event
Netapp Cluster Volume Grow Threshold PercentagePercentage
netapp.cluster.volume.over-dedupplication

Over deduplication is the effective deduplication-enabled storage of more logical bytes of data in a volume container than are actually allotted to that container
Netapp Cluster Volume Over DedupplicationNo units
netapp.cluster.volume.tooold-snapshot

Specifies about the snapshots created before 52weeks
Netapp Cluster Volume Too Old Snapshotseconds
netapp.cluster.snapmirror.lag-time

Lag time is the amount of time by which the destination system lags behind the source system.
Netapp Cluster Snapmirror Lag Timemilli seconds