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!

Nimble Storage

Monitor HPE Nimble Storage Arrays

Data Collection Setup

Metrics are collected via SNMP and Nimble REST API running on Nimble OS.

Network Requirements

Port: 5392 (TCP) for Nimble API
Port: 161 (UDP) for SNMP v2

Least Privileged User

Nimble user accounts of all access levels will work for metric collection. Additionally, a SNMP community string needs to be configured.

Supported Versions

Hardware:

  • HPE Nimble Storage CS210+

Software:

  • Nimble OS 2.x+
  • Nimble API 1.3+

Connection Parameters

NameRequired?Description
HostRequiredThe Nimble Management Interface to connect to.
PortThe port for communication with the Nimble Management Interface. Default: 5392
UsernameRequired
PasswordRequired
Community StringSNMP Community String for Performance metrics

Metrics

Array

NameDescription
Creation TimeCreation Time
DescriptionDescription
Free Space (Terabytes)Free Space
IDID
Last Modified TimeLast Modified Time
ModelModel
NameName
Pending Delete (Bytes)Pending Delete
Pool IDPool ID
Raw Capacity (Terabytes)Raw Capacity
Serial NumberSerial Number
Snapshot CompressionSnapshot Compression
Snapshot Space Reduction (Bytes)Snapshot Space Reduction
Snapshot Space Saved (Gigabytes)Snapshot Space Saved
Snapshot Usage (Megabytes)Snapshot Usage
Usable Space (Terabytes)Usable Space
Used Space (Terabytes)Used Space
VersionVersion
Volume CompressionVolume Compression
Volume Space Saved (Gigabytes)Volume Space Saved
Volume Usage (Gigabytes)Volume Usage

Folder

NameDescription
Compression RatioCompression Ratio
Creation TimeCreation Time
DescriptionDescription
Encryption EnabledEncryption Enabled
Free Space (Gigabytes)Free Space
IDID
Last Modified TimeLast Modified Time
NameName
Pool IDPool ID
Snapshot CollectionsSnapshot Collections
Snapshot Compressed Usage (Gigabytes)Snapshot Compressed Usage
Snapshot Compression RatioSnapshot Compression Ratio
Snapshot Uncompressed Usage (Gigabytes)Snapshot Uncompressed Usage
SnapshotsSnapshots
Space Limit (Gigabytes)Space Limit
Unused Reserve Space (Gigabytes)Unused Reserve Space
Usage ValidUsage Valid
Used Space (Gigabytes)Used Space
Volume Compressed Usage (Gigabytes)Volume Compressed Usage
Volume Compression RatioVolume Compression Ratio
Volume Uncompressed Usage (Gigabytes)Volume Uncompressed Usage

Group

NameDescription
Cache Hit (%)Cache Hit
Compression RatioCompression Ratio
Disk Used for Snapshots High (Bytes)Disk Used for Snapshots High
Disk Used for Snapshots Low (Bytes)Disk Used for Snapshots Low
Disk Used for Volumes High (Bytes)Disk Used for Volumes High
Disk Used for Volumes Low (Bytes)Disk Used for Volumes Low
Free Space (Terabytes)Free Space
IDID
Management IPManagement IP
NameName
Non-Sequential ReadsNon-Sequential Reads
Read Latency (Milliseconds)Read Latency
Read Throughput (Bytes)Read Throughput
Read Time (Microseconds)Read Time
ReadsReads
Sequential Read Throughput (Bytes)Sequential Read Throughput
Sequential ReadsSequential Reads
Sequential Write Throughput (Bytes)Sequential Write Throughput
Sequential WritesSequential Writes
Snapshot Used Disk Space (Gigabytes)Snapshot Used Disk Space
Unused Reserve Space (Terabytes)Unused Reserve Space
Usable Space (Terabytes)Usable Space
Usage ValidUsage Valid
Used Space (Terabytes)Used Space
Volume Used Disk Space (Gigabytes)Volume Used Disk Space
Write Latency (Milliseconds)Write Latency
Write Throughput (Bytes)Write Throughput
Write Time (Microseconds)Write Time
WritesWrites

Performance Policy

NameDescription
Block Size (Kilobytes)Block Size
Cache PolicyCache Policy
CachedCached
CompressedCompressed
Creation TimeCreation Time
DescriptionDescription
IDID
Last Modified TimeLast Modified Time
NameName
Space PolicySpace Policy

Pool

NameDescription
All FlashAll Flash
ArraysArrays
Cache Capacity (Gigabytes)Cache Capacity
Creation TimeCreation Time
DescriptionDescription
Force Delete PoolForce Delete Pool
Free Space (Terabytes)Free Space
IDID
Last Modified TimeLast Modified Time
NameName
Pinnable Cache Capacity (Gigabytes)Pinnable Cache Capacity
Pinned Cache Capacity (Gigabytes)Pinned Cache Capacity
Snapshot CollectionsSnapshot Collections
SnapshotsSnapshots
Total Space (Terabytes)Total Space
Unused Reserve Space (Bytes)Unused Reserve Space
Usage ValidUsage Valid
Used Space (Terabytes)Used Space
VolumesVolumes

Protection Schedule

NameDescription
Attached Object IDAttached Object ID
Creation TimeCreation Time
Days RunDays Run
DescriptionDescription
Disable Application SynchronizationDisable Application Synchronization
Downstream Replication PartnerDownstream Replication Partner
IDID
Last Modified TimeLast Modified Time
NameName
Period UnitPeriod Unit
Replicate Every X SnapshotsReplicate Every X Snapshots
Replication Time until Alert (Seconds)Replication Time until Alert
Retained Snapshots on ReplicasRetained Snapshots on Replicas
Schedule TypeSchedule Type
Skip Database Consistency CheckSkip Database Consistency Check
Snapshot Rate (per Day)Snapshot Rate
Snapshot Time Range (Seconds)Snapshot Time Range
Snapshots per UnitSnapshots per Unit
Snapshots RetainedSnapshots Retained
Start Taking Snapshots At (Seconds)Start Taking Snapshots At
Stop Taking Snapshots At (Seconds)Stop Taking Snapshots At
Verify SnapshotsVerify Snapshots

Replication

NameDescription
Control PortControl Port
Data PortData Port
HostnameHostname
IDID
NameName
PausedPaused
Subnet LabelSubnet Label
Subnet TypeSubnet Type

User

NameDescription
Creation TimeCreation Time
DescriptionDescription
DisabledDisabled
Email AddressEmail Address
IDID
Inactivity Timeout (Seconds)Inactivity Timeout
Last LoginLast Login
Last LogoutLast Logout
Last Modified TimeLast Modified Time
Logged InLogged In
NameName
RoleRole
Role IDRole ID

Volume

NameDescription
Agent TypeAgent Type
Backup Data Stored in Snapshots (Gigabytes)Backup Data Stored in Snapshots
Base Snapshot IDBase Snapshot ID
Base Snapshot NameBase Snapshot Name
Block Size (Kilobytes)Block Size
Cache EnabledCache Enabled
Cache Needed for Pin (Gigabytes)Cache Needed for Pin
Cache PinnedCache Pinned
Cache PolicyCache Policy
CloneClone
Collection IDCollection ID
Combined IO Rate (Operations per Second)Combined IO Rate
Combined Latency (Milliseconds)Combined Latency
Combined Throughput (Bytes)Combined Throughput
Compressed Usage (Gigabytes)Compressed Usage
Compression RatioCompression Ratio
ConnectionsConnections
Creation TimeCreation Time
DescriptionDescription
Encryption CipherEncryption Cipher
Fibre Channel ConnectionsFibre Channel Connections
Folder IDFolder ID
Forced OfflineForced Offline
Free Space (Gigabytes)Free Space
Group OwnerGroup Owner
IDID
iSCSI ConnectionsiSCSI Connections
Last Modified TimeLast Modified Time
Multi-Initiator AccessibleMulti-Initiator Accessible
NameName
Offline ReasonOffline Reason
Offline SnapshotsOffline Snapshots
OnlineOnline
Online SnapshotsOnline Snapshots
Performance Policy IDPerformance Policy ID
Pinned Cache Size (Gigabytes)Pinned Cache Size
Pool IDPool ID
Projected Number of SnapshotsProjected Number of Snapshots
Read IO Rate (Operations per Second)Read IO Rate
Read Latency (Milliseconds)Read Latency
Read OnlyRead Only
Read Throughput (Bytes)Read Throughput
Reserve Space (%)Reserve Space
Serial NumberSerial Number
Snapshot Compressed Usage (Gigabytes)Snapshot Compressed Usage
Snapshot Compression RatioSnapshot Compression Ratio
Snapshot Uncompressed Usage (Gigabytes)Snapshot Uncompressed Usage
Snapshot Warning Level (%)Snapshot Warning Level
SnapshotsSnapshots
Space Reserved for Snapshots (%)Space Reserved for Snapshots
StateState
Target NameTarget Name
Thin ProvisionedThin Provisioned
Total Space (Gigabytes)Total Space
Uncompressed Usage (Gigabytes)Uncompressed Usage
Upstream Cache PinnedUpstream Cache Pinned
Usable Space (Gigabytes)Usable Space
Usage Limit (%)Usage Limit
Usage ValidUsage Valid
Used Space (Gigabytes)Used Space
Warning Level (%)Warning Level
Write IO Rate (Operations per Second)Write IO Rate
Write Latency (Milliseconds)Write Latency
Write Throughput (Bytes)Write Throughput

Volume Collection

NameDescription
Application Cluster NameApplication Cluster Name
Application IDApplication ID
Application ServerApplication Server
Application Service NameApplication Service Name
Application SynchronizationApplication Synchronization
Creation TimeCreation Time
DescriptionDescription
IDID
Last Modified TimeLast Modified Time
NameName
Policy Owner NamePolicy Owner Name
Snapshot CollectionsSnapshot Collections

Updated 8 months ago

Nimble Storage


Monitor HPE Nimble Storage Arrays

Suggested Edits are limited on API Reference Pages

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