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!

Connection Parameters

Name
Required?
Description

Host

Required

Port

Username

Required

Password

Required

SSL Configuration

Connection Timeout

Time (in seconds) to attempt to connect with the HPE 3PAR REST API.

Types To Collect

Comma-separated list of resource types to collect.

Metrics

Array

Name
Description

Allocated Capacity (Mebibytes)

Allocated capacity of the Array.

Allow Raid 0

Allow RAID-0 CPGs.

Allow Writeback Single Node

Enable the system going into write through if a single node state occurs.

API Version

The version of the API running on the Array.

Auto-Export

Automatically export VLUNs after a reboot.

Chunklets Size (Mebibytes)

The size of defined 'chunklets' in the system.

Contact

Point of Contact for the Array.

Disable Compression

Disable the compression of all new write requests to the compressed VVs

Disable Deduplication

Disable the duplication of new write requests to TDVVs serviced by the system.

Event Log Size (Bytes)

Event log size in bytes

Failed Capacity (Mebibytes)

Failed capacity of the Array.

Failover Matched Set

Enable the automatic failover of matched-set VLUNs during a persistent port failover.

Fast Class Allocated Capacity (Mebibytes)

The allocated capacity on Fast Class devices.

Fast Class Capacity Allocated to Volume (Mebibytes)

The capacity of Fast Class devices allocated to Virtual Volumes.

Fast Class Free Capacity (Mebibytes)

The free capacity on Fast Class devices.

Free Capacity (Mebibytes)

Free capacity of the Array.

Host Data Integrity Field

Enable host based T10 Data Integrity Field support for all ports.

ID

Identifying number of the Array.

Installed Patches

A comma separated list of patches installed on the Array.

IPv4 Address

The public IPv4 Address associated with the Array.

IPv6 Address

The public IPv6 Address associated with the Array.

Location

Where the array is physically located.

Model

The model number of the Array.

Near Line Allocated Capacity (Mebibytes)

The allocated capacity on Near Line devices.

Near Line Allow Raid 5

Allow RAID-5 on Near Line drives.

Near Line Capacity Allocated to Volume (Mebibytes)

The capacity of Near Line devices allocated to Virtual Volumes.

Near Line Free Capacity (Mebibytes)

The free capacity on Near Line devices.

Over Provisioning Ratio Limit

The over provisioning ratio that limits the system and all CPGs

Owner

Owner of the Array.

Port Failover

Automatic failover of target ports to their designated partner ports.

Remote Copy Host Throttling

Enable Remote Copy throttling policy for host IO replicated in asynchronous streaming mode.

Remote System Log

Sending events as syslog messages to a remote system.

Serial Number

The public IPv4 Address associated with the Array.

Session Timeout (Seconds)

Specifies the value in seconds that can be set for the idle timeout for a CLI session.

Solid State Drive Allocated Capacity (Mebibytes)

The allocated capacity on Solid State Drive devices.

Solid State Drive Capacity Allocated to Volume (Mebibytes)

The capacity of Solid State Drive devices allocated to Virtual Volumes.

Solid State Drive Free Capacity (Mebibytes)

The free capacity on Solid State Drive devices.

System Version

The version of the system software running on the Array.

Thermal Shutdown

Enable a system shutdown when the temperature gets too hot.

Timezone

Which timezone the array is located in.

Total Capacity (Mebibytes)

Total capacity of the Array.

Total External Port Throughput (Kilobytes per Second)

The total external port throughput of I/O operations processed by the array.

Total Fast Class Capacity (Mebibytes)

The total Array capacity from Fast Class devices.

Total Near Line Capacity (Mebibytes)

The total Array capacity from Near Line devices.

Total Solid State Drive Capacity (Mebibytes)

The total Array capacity from Solid State Drive devices.

Volume Allocated Array Capacity (Mebibytes)

The capacity of the Array allocated to Virtual Volumes.

Controller Node

Name
Description

Access Read I/O (per Second)

Number of Read I/Os per second

Access Write I/O (per Second)

Number of Write I/Os per second

Clean (Pages)

Number of clean cache pages (valid data on page). A page is clean when data in cache matches data on disk.

Context Switches (per Second)

Number of context switches per second

Delayed Copy (Pages)

Number of pages waiting for delayed copy on write resolution.

Free (Pages)

Number of cache pages without valid data on them

Hit Read I/O (per Second)

Number of Read I/Os per second in which data was already in cache.

Hit Read Ratio (%)

Read Hits divided by Accesses

Hit Write I/O (per Second)

Number of Write I/Os per second in which data was already in cache.

Hit Write Ratio (%)

Write Hits divided by Accesses

ID

ID (0-7) of the Controller Node

Idle Time (%)

Percent of the CPU time in idle

Interrupts (per Second)

Number of interrupts per second

Lock Bulk I/O (Pages per Second)

Number of pages being modified per second by host I/O that are being written to disk by the flusher

Master Node

Whether or not this node is the Master Node on the given Array

Miss Read I/O (per Second)

Number of Read I/Os per second in which data was not already in cache.

Miss Write I/O (per Second)

Number of Write I/Os per second in which data was not already in cache.

Online

Online status of the controller node

System Time (%)

Percent of the CPU time spent in system mode

Total Access I/O (per Second)

Number of total read and write I/Os per second

User Time (%)

Percent of the CPU time spent in user mode

Write Multiple (Pages)

Number of dirty pages that have been modified more than 1 time.

Write Once (Pages)

Number of dirty pages that have been modified exactly 1 time. A page is dirty when it has been modified in cache but not written to disk.

Write Scheduled (Pages)

Number of pages scheduled to be written to disk

Writing (Pages)

Number of pages being currently written by the flusher to disk

CPG

Name
Description

Administrator Disk Raid Level

The RAID type of the administrator logical disk

Administrator Growth Increment (Mebibytes)

The administrator growth increment, the amount of logical disk storage created on each auto-grow operation

Deduplication Capable

Whether the CPG is capable of dedpulication

Domain

Domain to which the CPG belongs

Raw Total Space (Mebibytes)

Sum of raw total user, admin, and snapshot space

Raw Used Administration Space (Mebibytes)

Amount of raw (physical) administration space used

Raw Used Snapshot Space (Mebibytes)

Amount of raw (physical) snapshot space used

Raw Used Space (Mebibytes)

Sum of raw used user, admin, and snapshot space

Raw Used User Space (Mebibytes)

Amount of raw (physical) user space used

Snapshot Disk Raid Level

The RAID type of the snapshot logical disk

Snapshot Growth Increment (Mebibytes)

The snapshot growth increment, the amount of logical disk storage created on each auto-grow operation

State

Overall state of the CPG

Total Administration Space (Mebibytes)

Total logical disk administration space

Total Raw Administration Space (Mebibytes)

Total raw (physical) administration space used

Total Raw Snapshot Space (Mebibytes)

Total raw (physical) snapshot space used

Total Raw User Space (Mebibytes)

Total raw (physical) user space used

Total Snapshot Space (Mebibytes)

Total logical disk snapshot space

Total Space (Mebibytes)

Sum of total user, admin, and snapshot space

Total User Space (Mebibytes)

Total logical disk user space

Used Administration Space (Mebibytes)

Amount of logical administration space used

Used Snapshot Space (Mebibytes)

Amount of logical snapshot space used

Used Space (Mebibytes)

Sum of used user, admin, and snapshot space

Used User Space (Mebibytes)

Amount of logical user space used

UUID

UUID of the CPG

Disk

Name
Description

Average I/O Size (Kilobytes)

The average size of I/O requests processed by the disk.

Average Latency (Milliseconds)

The average time to service I/O requested from the disk.

Average Read Size (Kilobytes)

The average size of read requests processed by the disk.

Average Write Size (Kilobytes)

The average size of write requests processed by the disk.

Busy Time (%)

The average percent of time the disk is performing operations.

Cage ID

The ID of the cage in which the disk is located.

Cage Side

The side of the cage where the disk is located.

Chunklets Available Clean

Number of available chunklets on this disk that have no data on them.

Chunklets Available Dirty

Number of available chunklets on this disk that have been used but can be reclaimed.

Chunklets Available Failed

Number of available chunklets on this disk that have failed.

Chunklets Used Failed

Number of used chunklets on this disk that have failed.

Chunklets Used Healthy

Number of used chunklets on this disk that are healthy.

ID

Identifying number of the Disk.

Life Left (%)

Estimated percent of lifetime usage remaining.

Magazine ID

The ID of the magazine in which the disk is located.

Position

The position of the disk (Node:slot:Port).

Queue Length

The average length of the disk's I/O request queue.

Read I/O (Reads per Second)

The frequency of read I/O operations performed by the disk.

Read Latency (Milliseconds)

The average time to service a read requested from the disk.

Read Throughput (Kilobytes per Second)

The average throughput of read I/O operations processed by the disk.

Spare Chunklets Available Clean

Number of available spare chunklets on this disk that have no data on them.

Spare Chunklets Available Dirty

Number of available spare chunklets on this disk that have been used but can be reclaimed.

Spare Chunklets Available Failed

Number of available spare chunklets on this disk that have failed.

Spare Chunklets Used Failed

Number of used spare chunklets on this disk that have failed.

Spare Chunklets Used Healthy

Number of used spare chunklets on this disk that are healthy.

Speed (Rotations per Minute)

The speed of the disk's spindle.

Temperature (Celsius)

Internal temperature of the disk drive.

Total Chunklets

Number of chunklets allocated for production use. Does not include spare or failed chunklets.

Total Chunklets Available

Number of chunklets available for production use. Does not include used, spare, or failed chunklets.

Total Chunklets Failed

Number of chunklets that have failed. Totals production and spare failed chunklets.

Total I/O (Operations per Second)

The frequency of I/O operations performed by the disk.

Total Spare Chunklets

Number of chunklets allocated for spare use. Does not include production or failed chunklets.

Total Spare Chunklets Available

Number of chunklets available for spare use. Does not include used, production, or failed chunklets.

Total Throughput (Kilobytes per Second)

The average throughput of I/O operations processed by the disk.

Type

The storage type of the disk drive.

Write I/O (Writes per Second)

The frequency of write I/O operations performed by the disk.

Write Latency (Milliseconds)

The average time to service a write requested from the disk.

Write Throughput (Kilobytes per Second)

The average throughput of write I/O operations processed by the disk.

Host

Name
Description

Comment

Additional information about the host.

Contact

The host's owner and point of contact.

Domain

Domain to which the host belongs.

ID

Identifying number of the Host.

IP Address

The IP address assigned to the host.

Location

Physical location of the host.

Model

The model of the host.

Name

Name of the host.

Operating System

The OS running on the host.

Persona

ID of the persona assigned to the host.

LUN

Name
Description

Failed Path Monitoring Interval

Seconds between checks for for failed paths.

Failed Path Monitoring Method

The failed path monitoring method.

Host Device Name

The device name for this LUN on the Host.

Host Name

The name of the Host or Host Set that this LUN is exported to.

ID

The exported LUN value.

Multipathing Method

The Multipathing method in use.

Port Position

The position of the Port this VLUN is exported to (Node:slot:Port).

Remote Name

The Host WWN, iSCSI name, or SAS address.

Type

The LUN type

Volume Name

The name of the exported Virtual Volume or Virtual Volume Set.

Volume WWN

The WWN of the exported Virtual Volume (not applicable if a Virtual Volume Set is exported).

Port

Name
Description

Average I/O Size (Kilobytes)

The average size of I/O requests processed by the port.

Average Latency (Milliseconds)

The average time to service requests by the port.

Average Queue Length

The average length of the I/O queue for the port.

Average Read Size (Kilobytes)

The average size of read requests processed by the port.

Average Write Size (Kilobytes)

The average size of write requests processed by the port.

Busy Time (%)

The utilization percentage of the port.

Connection Type

The connection type for the port.

Device Names

List of device names connected to the port.

Failover State

The current failover state of the port.

Hardware Address

The Hardware address for this RCIP/iSCSI port.

IP Address

The IP address of this RCIP/iSCSI port.

iSCSI Name

The name for this iSCSI port.

Label

User-supplied label identifying the port.

Link State

The current link state of the port.

MAC Address

The ethernet node MAC address for the port.

Mode

The current mode of the port.

Node World Wide Name

The World Wide Name (WWN) of the node.

Partner Position

The position of the partner of the port (Node:slot:Port).

PFC Mask

The Primary Flow Control (PFC) mask for the port.

Port World Wide Name

The World Wide Name (WWN) for this Fibre Channel port.

Position

The position of the port (Node:slot:Port).

Protocol

The current protocol used by the port.

Read I/O (Reads per Second)

The frequency of read I/O operations performed by the port.

Read Latency (Milliseconds)

The average time to service read requests by the port.

Read Throughput (Kilobytes per Second)

The average throughput of read I/O operations performed by the port.

Total I/O (Operations per Second)

The frequency of I/O operations performed by the port.

Total Throughput (Kilobytes per Second)

The average throughput of I/O operations performed by the port.

Write I/O (Writes per Second)

The frequency of write I/O operations performed by the port.

Write Latency (Milliseconds)

The average time to service write requests by the port.

Write Throughput (Kilobytes per Second)

The average throughput of write I/O operations performed by the port.

Virtual Volume

Name
Description

Additional States

Additional detailed states of the volume.

Average I/O Size (Kilobytes)

The average size of I/O requests processed on the volume.

Average Latency (Milliseconds)

The average time to service I/O requested from the volume.

Average Read Size (Kilobytes)

The average size of read requests processed on the volume.

Average Write Size (Kilobytes)

The average size of write requests processed on the volume.

Busy Time (%)

The average percent of time operations are being performed on the volume.

Compaction Ratio

The overall amount of storage space saved with 3PAR thin technology.

Compression

The amount of storage space saved using compression.

Creation Time

The creation time of the volume.

Data Reduction

The amount of storage space saved using deduplication and compression together.

Deduplication

The amount of storage space saved with 3PAR thin deduplication.

Deduplication State

The deduplication state of the volume.

Degraded States

Detailed degraded states of the volume.

Failed States

Detailed failed states of the volume.

ID

The volume identifier.

Over Provisioning

The amount of overprovisioned storage space.

Provisioning Type

The provisioning type of the volume.

Queue Length

The average length of the volume's I/O request queue.

Read I/O (Reads per Second)

The frequency of read I/O operations performed on the volume.

Read Latency (Milliseconds)

The average time to service a read requested from the volume.

Read Throughput (Kilobytes per Second)

The average throughput of read I/O operations processed on the volume.

Snapshot Free Space (Mebibytes)

The amount of free snapshot space.

Snapshot Raw Reserved Space (Mebibytes)

The amount of raw reserved snapshot space.

Snapshot Reserved Space (Mebibytes)

The amount of reserved snapshot space.

Snapshot Used Space (Mebibytes)

The amount of used snapshot space.

State

The state of the volume.

Total Free Space (Mebibytes)

The amount of total free space on the volume.

Total I/O (Operations per Second)

The frequency of I/O operations performed on the volume.

Total Reserved Space (Mebibytes)

The amount of total reserved space on the volume.

Total Size (Mebibytes)

The virtual size of volume.

Total Throughput (Kilobytes per Second)

The average throughput of I/O operations processed on the volume.

Total Used Space (Mebibytes)

The amount of total used space on the volume.

User Free Space (Mebibytes)

The amount of free user space.

User Raw Reserved Space (Mebibytes)

The amount of raw reserved user space.

User Reserved Space (Mebibytes)

The amount of reserved user space.

User Used Space (Mebibytes)

The amount of used user space.

Write I/O (Writes per Second)

The frequency of write I/O operations performed on the volume.

Write Latency (Milliseconds)

The average time to service a write requested from the volume.

Write Throughput (Kilobytes per Second)

The average throughput of write I/O operations processed on the volume.

WWN

The WWN of the volume.