Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

NetApp SolidFire

Monitor NetApp Solidfire Storage Arrays and NetApp HCI Hyper Converged Appliances

Data Collection Setup

Metrics are collected via the Solidfire Element OS API.

Network Requirements

Port: 443 (TCP) HTTPS to the Solidfire Element OS.

Least Privileged User

To create a least-privileged user (LPU) for BindPlane, you must create a Cluster user with a minimum of read-only access to the SolidFire Element OS API to be used as your source configuration.

Creating LPU in Element-OS

  1. From the SolidFire Element OS API console, navigate to Users -> Cluster Admins, then click the Create Cluster Admin button.
  1. In the Create a New Cluster Admin window that appears, ensure that the following settings are configured:
    Select User Type: Cluster
    Enter User Details: Enter your desired username and password.
    Select User Permissions: Do not select any of the listed permissions. A read-only user will be created by default.
    End User License Agreement: Accept the terms of the agreement.
  1. Save your user settings. The new user should now be listed in your Cluster Admins list from the previous screen.

Supported Versions

Hardware: NetApp HCI or SolidFire
Software: SolidFire Element OS API version 10.2

Connection Parameters

NameRequired?Description
HostRequiredThe NetApp SolidFire / HCI host to connect to.
PortThe port for communication to the NetApp SolidFire host. Default is 443
UsernameRequired
PasswordRequired
SSL ConfigurationThe SSL mode to use when connecting to the target. Can be configured to not use SSL (No SSL), use SSL but do not verify the target's certificate (No Verify), and use SSL and verify the target's certificate (Verify).
Connection Timeout (seconds)The number of seconds to allow for connecting to the target.
Minimum Event SeverityEvents with a severity level below this minimum will not be returned.

Metrics

Cluster

NameDescription
Active Block Space (Bytes)The amount of space on the block drives. This includes additional information such as metadata entries and space which can be cleaned up
Active Sessions (Sessions)The number of active iSCSI sessions communicating with the cluster
Actual IO Rate (Operations per Second)Current actual IOPS for the entire cluster in the last 500 milliseconds.
Average IO Rate (Operations per Second)The average IOPS for the cluster since midnight Coordinated Universal Time (UTC).
Average IOPS Size (Bytes)Average size in bytes of recent I/O to the cluster in the last 500 milliseconds.
Capacity UtilizationThe cluster capacity being utilized.
Client Queue Depth (Operations)The number of outstanding read and write operations to the cluster.
Compression FactorThe amount of space saved by data compression for all volumes in the account. Stated as a ratio.
Current IO Rate (Operations per Second)The average IOPS for all volumes in the cluster over the last 5 seconds.
Deduplication FactorThe amount of space saved by not duplicating data for all volumes in the account. Stated as a ratio.
ESXi Host IDsESXi Host IDs
Expected ServicesThe total number of expected services running on the cluster.
Latency (Microseconds)The average time, in microseconds, to complete operations to a cluster in the last 500 milliseconds.
Maximum Over Provisionable Space (Bytes)The maximum amount of provisionable space.
Maximum Provisioned Space (Bytes)The total amount of provisionable space if all volumes are 100% filled (no thin provisioned metadata).
Maximum Used Metadata Space (Bytes)The number of bytes on volume drives used to store metadata.
Maximum Used Space (Bytes)The total amount of space on all active block drives.
MVIPThe floating (virtual) IP address for the cluster on the management network.
MVIP InterfaceThe physical interface associated with the MVIP address.
MVIP Node IDThe node that holds the master MVIP address
MVIP VLAN TagThe VLAN identifier for the MVIP address.
NameThe unique cluster name.
Non-Zero Blocks (Blocks)The total number of 4KiB blocks that contain data after the last garbage collection operation has completed.
Normalized IO Rate (Operations per Second)Average number of IOPS for the entire cluster in the last 500 milliseconds.
Overall Efficiency FactorOverall Efficiency Factor
Peak Active Sessions (Sessions)The peak number of iSCSI connections since midnight UTC.
Peak IO Rate (Operations per Second)The highest value for currentIOPS since midnight UTC.
Provisioned Space (Bytes)The total amount of space provisioned in all volumes on the cluster
Rated Maximum IO Rate (Operations per Second)The estimated maximum IOPS capability of the current cluster.
Read Latency (Microseconds)The average time, microseconds, to complete read operations to the cluster in the last 500 milliseconds.
Read Operations (Reads)The total cumulative read operations to the cluster.
Reads (Bytes)The total cumulative bytes read from the cluster.
Recent IO Size (Bytes)The average size of IOPS to all volumes in the cluster.
Replica CountThe number of replicas of each piece of data to store in the cluster. The valid value is '2'.
Services RunningThe number of services running on the cluster. If equal to the servicesTotal, this indicates that valid statistics were collected from all nodes.
Snapshot Non-Zero Blocks (Blocks)The total number of 4KiB blocks that contain data after the last garbage collection operation has completed for snapshots.
SVIPThe floating (virtual) IP address for the cluster on the storage (iSCSI) network.
SVIP InterfaceThe physical interface associated with the master SVIP address.
SVIP Node IDThe node holding the master SVIP address.
SVIP VLAN TagThe VLAN identifier for the master SVIP address.
Thin Provisioning FactorThe ratio of space used to the amount of space allocated for storing data. Stated as a ratio.
Total Operations (Operations)The total number of I/O operations performed.
Unaligned Reads (Reads)The total cumulative unaligned read operations to a cluster.
Unaligned Writes (Writes)The total cumulative unaligned write operations to a cluster.
Unique BlocksThe total number of blocks stored on the block drives. The value includes replicated blocks.
Unique Blocks Used Space (Bytes)The total amount of data the uniqueBlocks take up on the block drives. This number is always consistent with the uniqueBlocks value.
Unique IDThe unique identifier for the cluster.
Used Metadata Space (Bytes)The total number of bytes on volume drives used to store metadata.
Used Metadata Space In Snapshots (Bytes)The number of bytes on volume drives used for storing unique data in snapshots. This number provides an estimate of how much metadata space would be regained by deleting all snapshots on the system.
Used Space (Bytes)The total amount of space used by all block drives in the system.
UUIDUUID
Write Latency (Microseconds)The average time, in microseconds, to complete write operations to a cluster in the last 500 milliseconds.
Write Operations (Writes)The total cumulative write operations to the cluster.
Writes (Bytes)The total cumulative bytes written to the cluster.
Zero BlocksThe total number of empty 4KiB blocks without data after the last round of garbage collection operation has completed.

Storage Container

NameDescription
Account IDThe ID of the storage system account associated with the storage container.
Average VVol Latency (Microseconds)The average latency for VVols in this storage container.
Average VVol Read Latency (Microseconds)The average read latency for VVols in this storage container.
Average VVol Size (Bytes)The average provisioned size of a VVol in this storage container.
Average VVol Write Latency (Microseconds)The average write latency for VVols in this storage container.
NameThe name of the storage container.
Protocol Endpoint TypeThe storage container's protocol endpoint type. SCSI is the only valid value.
StatusThe status of the storage container.
Storage Container IDStorage Container ID
Total VVol Size (Bytes)The total provisioned size of a VVol in this storage container.

Storage Node

NameDescription
Chassis Type The hardware platform of the node.
Cluster InterfaceNetwork interface used for cluster communication.
Cluster IP AddressThe cluster IP address assigned to the node.
Cluster Network Interface Utilization (%)Network interface utilization (in %) for the cluster network interface.
Cluster Received (Bytes)Bytes in on the cluster interface.
Cluster Sent (Bytes)Bytes out on the cluster interface.
CPU ModelThe CPU model of the hardware platform.
CPU Usage (%)CPU usage, in %.
Fibre Channel Service IDThe Fibre service ID for the node. '0' if the node is not a Fibre Channel node.
Fibre Channel Target Port GroupThe target group associated with this node.
Management InterfaceThe network interface used for node management.
Management IPThe IP address used for node management.
Management Received (Bytes)Bytes in on the management interface.
Management Sent (Bytes)Bytes out on the management interface.
Master Service IDMaster service ID for the node.
ModelThe node model name.
NameHost name for the node.
Network Utilization for Storage Interface (%)Network interface utilization (in %) for the storage network interface.
Node IDNodeID for this node.
Node SlotFor HCI platforms, the letter corresponding to the chassis slot this node is in ('A', 'B', 'C', or 'D').
Physical Memory (Gibibytes)The amount of memory installed in the physical platform in GB.
Platform Configuration Version The version of software configured for this node hardware.
Read Latency (Microseconds)Total time spent performing read operations on the node.
Read Operations (Operations)Total read operations of the node.
Software VersionReturns the current version of Element OS software running on the node.
Storage InterfaceThe network interface used for storage traffic.
Storage IPThe storage IP address assigned to the node
Storage Received (Bytes)Bytes in on the storage interface.
Storage SentBytes out on the storage interface.
Total Memory Usage (Bytes)Total memory usage in bytes.
UUIDUUID
Write Latency (Microseconds)Total time spent performing write operations on the node.
Write Operations (Operations)Total write operations of the node.

Volume

NameDescription
AccessThe type of access allowed for the volume
Account IDThe accountID of the account containing the volume.
Actual IO Rate (Operations per Second)The current actual IOPS to the volume in the last 500 milliseconds.
Average IOPS Size (Bytes)The average size in bytes of recent I/O to the volume in the last 500 milliseconds.
Block Size (Bytes)The size of blocks on the volume
Burst IOPS CreditThe total number of IOP credits available to the user. When volumes are not using up to the configured maxIOPS, credits are accrued.
Client Queue Depth (Operations)The number of outstanding read and write operations to the volume.
Enable 512 Byte Sector EmulationIf set to true, the volume provides 512 byte sector emulation
iSCSI Qualified NameThe iSCSI Qualified Name of the volume.
Latency (Microseconds)The average time, in microseconds, to complete operations to the volume in the last 500 milliseconds. A zero value means there is no I/O to the volume.
NameThe name of the volume as provided at creation time.
Non-Zero Blocks (Blocks)The total number of 4KiB blocks that contain data after the last garbage collection operation has completed.
QoS Burst IO Rate (Operations per Second)Maximum 'peak' 4KB IOPS allowed for short periods of time. Allows for bursts of I/O activity over the normal maxIOPS value.
QoS Burst Time (Seconds)The length of time burstIOPS is allowed. The value returned is represented in seconds. This value is calculated by the system based on IOPS set for QoS.
QoS Maximum IO Rate (Operations per Second)The desired maximum 4KB IOPS allowed over an extended period of time.
QoS Minimum IO Rate (Operations per Second)The desired minimum 4KB IOPS to guarantee. The allowed IOPS will only drop below this level if all volumes have been capped at their minIOPS value and there is still insufficient performance capacity.
Read Latency (Microseconds)The average time, in microseconds, to complete read operations to the volume in the last 500 milliseconds.
Read Operations (Operations)The total read operations to the volume since the creation of the volume.
Reads (Bytes)The total cumulative bytes read from the volume since the creation of the volume.
SCSI EUI-64 Device IDGlobally unique SCSI device identifier for the volume in EUI-64 based 16-byte format.
SCSI NAA Device IDGlobally unique SCSI device identifier for the volume in NAA IEEE Registered Extended format.
Size (Bytes)Total provisioned capacity in bytes
StatusThe current status of the volume.
ThrottleA floating value between 0 and 1 that represents how much the system is throttling clients below their maxIOPS because of rereplication of data, transient errors, and snapshots taken.
Unaligned Reads (Reads)The total cumulative unaligned read operations to a volume since the creation of the volume.
Unaligned Writes (Writes)The total cumulative unaligned write operations to a volume since the creation of the volume.
UUIDUUID
Volume IDThe unique volumeID for the volume.
Volume UtilizationA floating value that describes how much the client is using the volume. Possible values: 0: The client is not using the volume 1: The client is using their maximum. >1: The client is using their burst
Write Latency (Microseconds)The average time, in microseconds, to complete write operations to a volume in the last 500 milliseconds.
Write Operations (Operations)The total cumulative write operations to the volume since the creation of the volume.
Writes (Bytes)The total cumulative bytes written to the volume since the creation of the volume
Zero Blocks (Blocks)The total number of empty 4KiB blocks without data after the last round of garbage collection operation has completed.

VVol

NameDescription
AccessThe type of access allowed for the volume
Account IDThe accountID of the account containing the volume.
Actual IO Rate (Operations per Second)The current actual IOPS to the volume in the last 500 milliseconds.
Average IOPS Size (Bytes)The average size in bytes of recent I/O to the volume in the last 500 milliseconds.
Block Size (Bytes)The size of blocks on the volume
Burst IOPS CreditThe total number of IOP credits available to the user. When volumes are not using up to the configured maxIOPS, credits are accrued.
Client Queue Depth (Operations)The number of outstanding read and write operations to the volume.
Enable 512 Byte Sector EmulationIf set to true, the volume provides 512 byte sector emulation
iSCSI Qualified NameThe iSCSI Qualified Name of the volume.
Latency (Microseconds)The average time, in microseconds, to complete operations to the volume in the last 500 milliseconds. A zero value means there is no I/O to the volume.
NameThe name of the volume as provided at creation time.
Non-Zero Blocks (Blocks)The total number of 4KiB blocks that contain data after the last garbage collection operation has completed.
Parent VVol IDThe virtual volume ID of the parent virtual volume. If the ID is all zeros, this is an independent virtual volume with no link to a parent.
QoS Burst IO Rate (Operations per Second)Maximum 'peak' 4KB IOPS allowed for short periods of time. Allows for bursts of I/O activity over the normal maxIOPS value.
QoS Burst Time (Seconds)The length of time burstIOPS is allowed. The value returned is represented in seconds. This value is calculated by the system based on IOPS set for QoS.
QoS Maximum IO Rate (Operations per Second)The desired maximum 4KB IOPS allowed over an extended period of time.
QoS Minimum IO Rate (Operations per Second)The desired minimum 4KB IOPS to guarantee. The allowed IOPS will only drop below this level if all volumes have been capped at their minIOPS value and there is still insufficient performance capacity.
Read Latency (Microseconds)The average time, in microseconds, to complete read operations to the volume in the last 500 milliseconds.
Read Operations (Operations)The total read operations to the volume since the creation of the volume.
Reads (Bytes)The total cumulative bytes read from the volume since the creation of the volume.
SCSI EUI-64 Device IDGlobally unique SCSI device identifier for the volume in EUI-64 based 16-byte format.
SCSI NAA Device IDGlobally unique SCSI device identifier for the volume in NAA IEEE Registered Extended format.
Size (Bytes)Total provisioned capacity in bytes
Snapshot IDThe ID of the underlying volume snapshot. This value is 0 if the virtual volume does not represent a snapshot.
StatusThe current status of the volume.
Storage Container IDThe ID of the storage container that owns this virtual volume.
ThrottleA floating value between 0 and 1 that represents how much the system is throttling clients below their maxIOPS because of rereplication of data, transient errors, and snapshots taken.
Unaligned Reads (Reads)The total cumulative unaligned read operations to a volume since the creation of the volume.
Unaligned Writes (Writes)The total cumulative unaligned write operations to a volume since the creation of the volume.
UUIDUUID
VMware Container IDVMware Container ID
VMware Guest OS TypeVMware Guest OS Type
VMware Virtual Machine IDVMware Virtual Machine ID
VMware VVol Allocation TypeVMware VVol Allocation Type
VMware VVol NameVMware VVol Name
VMware VVol NamespaceVMware VVol Namespace
VMware VVol ProfileVMware VVol Profile
VMware VVol TypeVMware VVol Type
Volume IDThe unique volumeID for the volume.
Volume UtilizationA floating value that describes how much the client is using the volume. Possible values: 0: The client is not using the volume 1: The client is using their maximum. >1: The client is using their burst
VVol IDThe VVol ID
VVol StatusCurrent status of the virtual volume.
VVol TypeThe type of the virtual volume.
Write Latency (Microseconds)The average time, in microseconds, to complete write operations to a volume in the last 500 milliseconds.
Write Operations (Operations)The total cumulative write operations to the volume since the creation of the volume.
Writes (Bytes)The total cumulative bytes written to the volume since the creation of the volume
Zero Blocks (Blocks)The total number of empty 4KiB blocks without data after the last round of garbage collection operation has completed.

Updated 8 months ago

NetApp SolidFire


Monitor NetApp Solidfire Storage Arrays and NetApp HCI Hyper Converged Appliances

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.