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!

Pure Storage FlashArray

Connection Parameters

Name
Required?
Description

Host

Required

The Pure Storage Flash Array to connect to.

Port

The port for communication to the Pure Storage Flash Array.

Username

Required

Password

Required

SSL Configuration

The SSL mode to use when connecting to the target. Can be configured to use SSL but do not verify the target's certificate (No Verify), and use SSL and verify the target's certificate (Verify).

Max Simultaneous Requests

Set the maximum simultaneous requests to the Pure Storage API.

Metrics

Array

Name
Description

Capacity (Bytes)

The capacity of the Array.

Data Reduction

The data reduction ratio of the Array.

Data Reduction Ratio (%)

The data reduction ratio of the Array.

Host Count

The current number of hosts on the Array.

Host Group Count

The current number of host groups on the Array.

Hostname

The hostname of the Array.

ID

The ID of the Array.

Parity (%)

The percentage of data that is protected.

Protection Group Count

The current number of protection groups on the Array.

Protection Group Snapshot Count

The current number of protection group snapshots on the Array.

Queue Depth

The average number of queued I/O requests.

Read Bandwidth (Bytes per Second)

The number of bytes read per second.

Read IO Rate (Reads per Second)

The number of read requests processed per second.

Read Latency (Microseconds)

The average time it takes to process an I/O read request.

Revision

The revision level of the Array.

SAN Read Latency (Microseconds)

The average time required to transfer data from the array to the initiator.

SAN Write Latency (Microseconds)

The average time required to transfer data from the initiator to the array.

Shared Space (Bytes)

The physical space occupied by deduplicated data.

Snapshot Space (Bytes)

The physical space occupied by snapshots.

Snapshot Space Ratio (%)

The percentage of physical space occupied by snapshots.

System Space (Bytes)

The physical space occupied by internal array metadata.

Thin Provisioning (%)

The percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed.

Total Bandwidth (Bytes per Second)

The sum of bytes read and written per second.

Total IO Rate (Operations per Second)

The sum of read and write requests processed per second.

Total Provisioned Space (Bytes)

The sum of provisioned space for all volumes on the Array.

Total Reduction

The data reduction ratio (including thin provisioning) of the Array.

Total Reduction Ratio (%)

The data reduction ratio (including thin provisioning) of the Array.

Total Used Space (Bytes)

The total physical space occupied by system, shared space, volume, and snapshot data.

Total Used Space Ratio (%)

The percentage of physical space occupied by system, shared space, volume, and snapshot data.

Version

The firmware version of the Array.

Volume Count

The current number of volumes on the Array.

Volume Group Count

The current number of volume groups on the Array.

Volume Snapshot Count

The current number of volume snapshots on the Array.

Volume Space (Bytes)

The physical space occupied by volumes.

Write Bandwidth (Bytes per Second)

The number of bytes written per second.

Write IO Rate (Writes per Second)

The number of write requests processed per second.

Write Latency (Microseconds)

The average time it takes to process an I/O write request.

Host

Name
Description

Data Reduction

The data reduction ratio of all volumes connected to this Host.

Data Reduction Ratio (%)

The data reduction ratio of all volumes connected to this Host.

IQNs

A comma-separated list of IQNs associated with this host.

Name

Name of the Host.

Provisioned Space (Bytes)

The provisioned space of volumes connected to this Host.

Read Bandwidth (Bytes per Second)

The number of bytes read per second on volumes connected to this Host.

Read IO Rate (Reads per Second)

The number of read requests processed per second on volumes connected to this Host.

Read Latency (Microseconds)

The average time it takes to process an I/O read request on volumes connected to this Host.

SAN Read Latency (Microseconds)

The average time required to transfer data from the array to the initiator on volumes connected to this Host.

SAN Write Latency (Microseconds)

The average time required to transfer data from the initiator to the array on volumes connected to this Host.

Snapshot Space (Bytes)

The physical space occupied by snapshots on volumes connected to this Host.

Thin Provisioning (%)

The percentage of sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed in volumes connected to this Host.

Total Bandwidth (Bytes per Second)

The sum of bytes read and written per second.

Total IO Rate (Operations per Second)

The sum of read and write requests processed per second.

Total Reduction

The data reduction ratio (including thin provisioning) of all volumes connected to this Host.

Total Reduction Ratio (%)

The data reduction ratio (including thin provisioning) of all volumes connected to this Host.

Total Used Space (Bytes)

The total physical space occupied by system, shared space, volume, and snapshot data.

Total Used Space Ratio (%)

The percentage of physical space occupied by system, shared space, volume, and snapshot data.

Volume Space (Bytes)

The physical space occupied by all volumes connected to this Host.

Write Bandwidth (Bytes per Second)

The number of bytes written per second on volumes connected to this Host.

Write IO Rate (Writes per Second)

The number of write requests processed per second on volumes connected to this Host.

Write Latency (Microseconds)

The average time it takes to process an I/O write request on volumes connected to this Host.

WWNs

A comma-separated list of WWNs associated with this host.

Host Group

Name
Description

Data Reduction

The data reduction ratio of all volumes connected to hosts in this Host Group.

Data Reduction Ratio (%)

The data reduction ratio of all volumes connected to hosts in this Host Group.

Name

Name of the Host Group.

Provisioned Space (Bytes)

The total provisioned space of all volumes connected to hosts in this Host Group.

Read Bandwidth (Bytes per Second)

The number of bytes read per second on volumes connected to hosts in this Host Group.

Read IO Rate (Reads per Second)

The number of read requests processed per second on volumes connected to hosts in this Host Group.

Read Latency (Microseconds)

The average time it takes to process an I/O read request on volumes connected to hosts in this Host Group.

SAN Read Latency (Microseconds)

The average time required to transfer data from the array to the initiator on volumes connected to hosts in this Host Group.

SAN Write Latency (Microseconds)

The average time required to transfer data from the initiator to the array on volumes connected to hosts in this Host Group.

Snapshot Space (Bytes)

The total physical space occupied by snapshots on all volumes connected to hosts in this Host Group.

Thin Provisioning (%)

The percentage of sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed in volumes connected to hosts in this Host Group.

Total Bandwidth (Bytes per Second)

The sum of bytes read and written per second.

Total IO Rate (Operations per Second)

The sum of read and write requests processed per second.

Total Reduction

The ratio of data reduction including thin provisioning on volumes connected to hosts in this Host Group.

Total Reduction Ratio (%)

The data reduction ratio (including thin provisioning) of all volumes connected to hosts in this Host Group.

Total Used Space (Bytes)

The total physical space occupied by system, shared space, volume, and snapshot data on volumes connected to hosts in this Host Group.

Total Used Space Ratio (%)

The percentage of physical space occupied by system, shared space, volume, and snapshot data.

Volume Space (Bytes)

The physical space occupied by volumes connected to hosts in this Host Group.

Write Bandwidth (Bytes per Second)

The number of bytes written per second on volumes connected to hosts in this Host Group.

Write IO Rate (Writes per Second)

The number of write requests processed per second on volumes connected to hosts in this Host Group.

Write Latency (Microseconds)

The average time it takes to process an I/O write request on volumes connected to hosts in this Host Group.

Protection Group

Name
Description

Name

Name of the Protection Group.

Snapshot Count

The current number of snapshots of the Protection Group.

Snapshot Space (Bytes)

The physical space occupied by snapshots.

Targets

A comma-separated list of arrays targeted by this Protection Group for replication purposes.

Volume

Name
Description

Creation Timestamp

A timestamp representing the time when Volume object was created.

Data Reduction

The data reduction ratio of the Volume.

Data Reduction Ratio (%)

The data reduction ratio of the Volume.

NAA ID

NAA ID of the Volume.

Physical Space Occupied (Bytes)

The physical space occupied by the Volume.

Provisioned Space (Bytes)

The provisioned size of the Volume.

Read Bandwidth (Bytes per Second)

The number of bytes read per second.

Read IO Rate (Reads per Second)

The number of read requests processed per second.

Read Latency (Microseconds)

The average time it takes to process an I/O read request.

SAN Read Latency (Microseconds)

The average time required to transfer data from the array to the initiator.

SAN Write Latency (Microseconds)

The average time required to transfer data from the initiator to the array.

Serial

Serial Number of the Volume.

Serial Number

Serial Number of the Volume.

Snapshot Count

The current number of snapshots of the Volume.

Snapshot Space (Bytes)

The physical space occupied by snapshots.

Snapshot Space Ratio (%)

The percentage of physical space occupied by snapshots.

Thin Provisioning (%)

The percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed.

Total Bandwidth (Bytes per Second)

The sum of bytes read and written per second.

Total IO Rate (Operations per Second)

The sum of read and write requests processed per second.

Total Reduction

The data reduction ratio (including thin provisioning) of the Volume.

Total Reduction Ratio (%)

The data reduction ratio (including thin provisioning) of the Volume.

Total Used Space (Bytes)

The total physical space occupied by system, shared space, volume, and snapshot data.

Total Used Space Ratio (%)

The percentage of physical space occupied by system, shared space, volume, and snapshot data.

Write Bandwidth (Bytes per Second)

The number of bytes written per second.

Write IO Rate (Writes per Second)

The number of write requests processed per second.

Write Latency (Microseconds)

The average time it takes to process an I/O write request.

Volume Group

Name
Description

Data Reduction

The data reduction ratio of all volumes in this Volume Group.

Data Reduction Ratio (%)

The data reduction ratio of all volumes in this Volume Group.

Name

Name of the Volume Group.

Physical Space Occupied (Bytes)

The physical space occupied by volumes in this Volume Group.

Provisioned Space (Bytes)

The total provisioned space of all volumes in this Volume Group.

Read Bandwidth (Bytes per Second)

The number of bytes read per second on volumes in this Volume Group.

Read IO Rate (Reads per Second)

The number of read requests processed per secodn on volumes in this Volume Group.

Read Latency (Microseconds)

The average time it takes to process an I/O request on volumes in this Volume Group.

SAN Read Latency (Microseconds)

The average time required to transfer data from the array to the initiator on volumes in this Volume Group.

SAN Write Latency (Microseconds)

The average time required to transfer data from the initiator to the array on volumes in this Volume Group.

Thin Provisioning (%)

The percentage of sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed in volumes in this Volume Group.

Total Bandwidth (Bytes per Second)

The sum of bytes read and written per second.

Total IO Rate (Operations per Second)

The sum of read and write requests processed per second.

Total Reduction

The ratio of data reduction including thin provisioning on volumes in this Volume Group.

Total Reduction Ratio (%)

The data reduction ratio (including thin provisioning) of all volumes in this Volume Group.

Volume Used Space (%)

The percentage of physical spaced occupied by volumes in this Volume Group.

Write Bandwidth (Bytes per Second)

The number of bytes written per second on volumes in this Volume Group.

Write IO Rate (Writes per Second)

The number of write requests processed per second on volumes in this Volume Group.

Write Latency (Microseconds)

The average time it take sto process an I/O write request on volumes in this Volume Group.