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

Connection Parameters

Name
Required?
Description

Host

Required

The NetApp SolidFire host to connect to.

Port

The port for communication to the NetApp SolidFire host.

Username

Required

Password

Required

SSL Configuration

The 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 Severity

Events with a severity level below this minimum will not be returned.

Metrics

Cluster

Name
Description

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 Utilization

The cluster capacity being utilized.

Client Queue Depth (Operations)

The number of outstanding read and write operations to the cluster.

Compression Factor

The 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 Factor

The amount of space saved by not duplicating data for all volumes in the account. Stated as a ratio.

ESXi Host IDs

ESXi Host IDs

Expected Services

The 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.

MVIP

The floating (virtual) IP address for the cluster on the management network.

MVIP Interface

The physical interface associated with the MVIP address.

MVIP Node ID

The node that holds the master MVIP address

MVIP VLAN Tag

The VLAN identifier for the MVIP address.

Name

The 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 Factor

Overall 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 Count

The number of replicas of each piece of data to store in the cluster. The valid value is '2'.

Services Running

The 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.

SVIP

The floating (virtual) IP address for the cluster on the storage (iSCSI) network.

SVIP Interface

The physical interface associated with the master SVIP address.

SVIP Node ID

The node holding the master SVIP address.

SVIP VLAN Tag

The VLAN identifier for the master SVIP address.

Thin Provisioning Factor

The 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 Blocks

The 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 ID

The 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.

UUID

UUID

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 Blocks

The total number of empty 4KiB blocks without data after the last round of garbage collection operation has completed.

Storage Container

Name
Description

Account ID

The 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.

Name

The name of the storage container.

Protocol Endpoint Type

The storage container's protocol endpoint type. SCSI is the only valid value.

Status

The status of the storage container.

Storage Container ID

Storage Container ID

Total VVol Size (Bytes)

The total provisioned size of a VVol in this storage container.

Storage Node

Name
Description

Chassis Type

The hardware platform of the node.

Cluster Interface

Network interface used for cluster communication.

Cluster IP Address

The 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 Model

The CPU model of the hardware platform.

CPU Usage (%)

CPU usage, in %.

Fibre Channel Service ID

The Fibre service ID for the node. '0' if the node is not a Fibre Channel node.

Fibre Channel Target Port Group

The target group associated with this node.

Management Interface

The network interface used for node management.

Management IP

The 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 ID

Master service ID for the node.

Model

The node model name.

Name

Host name for the node.

Network Utilization for Storage Interface (%)

Network interface utilization (in %) for the storage network interface.

Node ID

NodeID for this node.

Node Slot

For 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 Version

Returns the current version of Element OS software running on the node.

Storage Interface

The network interface used for storage traffic.

Storage IP

The storage IP address assigned to the node

Storage Received (Bytes)

Bytes in on the storage interface.

Storage Sent

Bytes out on the storage interface.

Total Memory Usage (Bytes)

Total memory usage in bytes.

UUID

UUID

Write Latency (Microseconds)

Total time spent performing write operations on the node.

Write Operations (Operations)

Total write operations of the node.

Volume

Name
Description

Access

The type of access allowed for the volume

Account ID

The 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 Credit

The 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 Emulation

If set to true, the volume provides 512 byte sector emulation

iSCSI Qualified Name

The 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.

Name

The 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 ID

Globally unique SCSI device identifier for the volume in EUI-64 based 16-byte format.

SCSI NAA Device ID

Globally unique SCSI device identifier for the volume in NAA IEEE Registered Extended format.

Size (Bytes)

Total provisioned capacity in bytes

Status

The current status of the volume.

Throttle

A 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.

UUID

UUID

Volume ID

The unique volumeID for the volume.

Volume Utilization

A 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

Name
Description

Access

The type of access allowed for the volume

Account ID

The 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 Credit

The 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 Emulation

If set to true, the volume provides 512 byte sector emulation

iSCSI Qualified Name

The 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.

Name

The 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 ID

The 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 ID

Globally unique SCSI device identifier for the volume in EUI-64 based 16-byte format.

SCSI NAA Device ID

Globally unique SCSI device identifier for the volume in NAA IEEE Registered Extended format.

Size (Bytes)

Total provisioned capacity in bytes

Snapshot ID

The ID of the underlying volume snapshot. This value is 0 if the virtual volume does not represent a snapshot.

Status

The current status of the volume.

Storage Container ID

The ID of the storage container that owns this virtual volume.

Throttle

A 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.

UUID

UUID

VMware Container ID

VMware Container ID

VMware Guest OS Type

VMware Guest OS Type

VMware Virtual Machine ID

VMware Virtual Machine ID

VMware VVol Allocation Type

VMware VVol Allocation Type

VMware VVol Name

VMware VVol Name

VMware VVol Namespace

VMware VVol Namespace

VMware VVol Profile

VMware VVol Profile

VMware VVol Type

VMware VVol Type

Volume ID

The unique volumeID for the volume.

Volume Utilization

A 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 ID

The VVol ID

VVol Status

Current status of the virtual volume.

VVol Type

The 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.