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 API Services

Monitor NetApp FAS/AFF SANs via NetApp OnCommand API-Services

📘

Not Included in the BindPlane with Google Stackdriver offering

All of the Google Cloud Platform sources listed within this documentation are not included with the BindPlane with Google Stackdriver offering.

Data Collection Setup

Metrics are collected via NetApp OnCommand API Services REST API.

To monitor the NetApp Cluster-Mode environment, OnCommand API Services (API-S) needs to be deployed and configured. For information about OnCommand API Services, please review the OnCommand API Services support page.

NetApp OnCommand Unified Manager / OnCommand Performance Manager is required for API-S to work. For more information on what is supported, see the NetApp Interoperability Matrix:
https://www.netapp.com/us/technology/interop.aspx

NetApp SLM (Service Level Manager) will also work, as it contains API-S.

Network Requirements

Port: 8443 (TCP) Default to API-S/SLM system

Least Privileged User

User with Monitor role on the NetApp API-S system

Supported Versions

NetApp API-S: 1.2+, 2.0+
NetApp SLM: 1.0
Note: that NetApp SLM contains API-S functionality

NetApp OnCommand Unified Manager / OnCommand Performance Manager is required for API-S to work. For more information on what is supported, see the NetApp Interoperability Matrix:
https://www.netapp.com/us/technology/interop.aspx

📘

Recommended Configuration

NetApp API-S 2.1
OCUM 9.4

❗️

Direct Attach or OCUM/OCPM Mode

NetApp API-S/SLM can be configured to to attatched directly to the FAS SAN cluster or gather data from OCUM / OCPM. To gather all performance metrics, OCUM/OCPM is required.

Connection Parameters

NameRequired?Description
HostRequiredThe NetApp API-S host to connect to.
PortThe port for communication to the NetApp API-S Host. Default is: 8443
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).
Collect EventsControls whether events are collected and returned.
Connection TimeoutThe number of seconds to allow for connecting to the target.

Metrics

Aggregate

NameDescription
Aggregate TypeThe Aggregate Type of the Aggregate.
Available Capacity (Bytes)The Available Capacity of the Aggregate.
Average Volume Average Latency (Microseconds)The Average Volume Average Latency of the Aggregate.
Average Volume Other Latency (Microseconds)The Average Volume Other Latency of the Aggregate.
Average Volume Other Operations (Operations per Second)The Average Volume Other Operations of the Aggregate.
Average Volume Read Latency (Microseconds)The Average Volume Read Latency of the Aggregate.
Average Volume Read Operations (Operations per Second)The Average Volume Read Operations of the Aggregate.
Average Volume Total Operations (Operations per Second)The Average Volume Total Operations of the Aggregate.
Average Volume Write Latency (Microseconds)The Average Volume Write Latency of the Aggregate.
Average Volume Write Operations (Operations per Second)The Average Volume Write Operations of the Aggregate.
Block TypeThe Block Type of the Aggregate.
Capacity Utilization (%)The Used Capacity Percent of the Aggregate.
Cluster IDThe Cluster ID of the Aggregate.
Cluster KeyThe Cluster Key of the Aggregate.
Cluster NameThe Cluster Name of the Aggregate.
Consistency Point Read Blocks (Blocks per Second)The Consistency Point Read Blocks of the Aggregate.
Consistency Point Read Latency (Microseconds)The Consistency Point Read Latency of the Aggregate.
Consistency Point Reads (per Second)The Consistency Point Reads of the Aggregate.
Has Local RootThe Has Local Root of the Aggregate.
Has Partner RootThe Has Partner Root of the Aggregate.
Hybrid Cache Size Total (Bytes)The Hybrid Cache Size Total of the Aggregate.
Is HybridThe Is Hybrid of the Aggregate.
Is Hybrid EnabledThe Is Hybrid Enabled of the Aggregate.
KeyThe Key of the Aggregate.
Latency (Microseconds)The Latency of the Aggregate.
Mirror StatusThe Mirror Status of the Aggregate.
NameThe Name of the Aggregate.
NetApp TypeThe NetApp Type of the Aggregate.
Node KeyThe Node Key of the Aggregate.
Raid Size (Bytes)The Raid Size of the Aggregate.
Raid StatusThe Raid Status of the Aggregate.
Raid TypeThe Raid Type of the Aggregate.
Snapshot Size Available (Bytes)The Snapshot Size Available of the Aggregate.
Snapshot Size Total (Bytes)The Snapshot Size Total of the Aggregate.
Snapshot Size Used (Bytes)The Snapshot Size Used of the Aggregate.
StateThe State of the Aggregate.
Throughput (Kilobytes per Second)The Throughput of the Aggregate.
Total Capacity (Bytes)The Total Capacity of the Aggregate.
Total Committed (Bytes)The Total Committed of the Aggregate.
Total Reserved Space (Bytes)The Total Reserved Space of the Aggregate.
Total Transfers (per Second)The Total Transfers of the Aggregate.
Total Transfers HDD (per Second)The Total Transfers HDD of the Aggregate.
Total Transfers SSD (per Second)The Total Transfers SSD of the Aggregate.
Total Volume Other Operations (Operations per Second)The Total Volume Other Operations of the Aggregate.
Total Volume Read Operations (Operations per Second)The Total Volume Read Operations of the Aggregate.
Total Volume Total Operations (Operations per Second)The Total Volume Total Operations of the Aggregate.
Total Volume Write Operations (Operations per Second)The Total Volume Write Operations of the Aggregate.
Used Capacity (Bytes)The Used Capacity of the Aggregate.
User Read Blocks (Blocks per Second)The User Read Blocks of the Aggregate.
User Read Blocks HDD (per Second)The User Read Blocks HDD of the Aggregate.
User Read Blocks SSD (per Second)The User Read Blocks SSD of the Aggregate.
User Read Latency (Microseconds)The User Read Latency of the Aggregate.
User Reads (per Second)The User Reads of the Aggregate.
User Reads HDD (per Second)The User Reads HDD of the Aggregate.
User Reads SSD (per Second)The User Reads SSD of the Aggregate.
User Write Blocks (Blocks per Second)The User Write Blocks of the Aggregate.
User Write Blocks HDD (per Second)The User Write Blocks HDD of the Aggregate.
User Write Blocks SSD (per Second)The User Write Blocks SSD of the Aggregate.
User Write Latency (Microseconds)The User Write Latency of the Aggregate.
User Writes (per Second)The User Writes of the Aggregate.
User Writes HDD (per Second)The User Writes HDD of the Aggregate.
User Writes SSD (per Second)The User Writes SSD of the Aggregate.
Uses Shared DisksThe Uses Shared Disks of the Aggregate.
Utilization (%)The Utilization of the Aggregate.
UUIDThe UUID of the Aggregate.
Volume Compression Space Savings (Bytes)The Volume Compression Space Savings of the Aggregate.
Volume Dedupe Space Savings (Bytes)The Volume Dedupe Space Savings of the Aggregate.

Cluster

NameDescription
Average System System Average Latency (Microseconds)The Average System System Average Latency of the Cluster.
Average System System Read Latency (Microseconds)The Average System System Read Latency of the Cluster.
Average System System Write Latency (Microseconds)The Average System System Write Latency of the Cluster.
Average System Total Operations (Operations per Second)The Average System Total Operations of the Cluster.
Average System Write Operations (Operations per Second)The Average System Write Operations of the Cluster.
Average vServer Network Receive Data (Bytes per Second)The Average vServer Network Receive Data of the Cluster.
Average vServer Network Receive Errors (Errors per Second)The Average vServer Network Receive Errors of the Cluster.
Average vServer Network Receive Packets (Packets per Second)The Average vServer Network Receive Packets of the Cluster.
Average vServer Network Sent Data (Bytes per Second)The Average vServer Network Sent Data of the Cluster.
Average vServer Network Sent Errors (Errors per Second)The Average vServer Network Sent Errors of the Cluster.
Average vServer Network Sent Packets (Packets per Second)The Average vServer Network Sent Packets of the Cluster.
Cluster IDThe Cluster ID of the Cluster.
ContactThe Contact of the Cluster.
HA ConfiguredThe HA Configured of the Cluster.
Is Metro ClusterThe Is Metro Cluster of the Cluster.
KeyThe Key of the Cluster.
LocationThe Location of the Cluster.
Management IPThe Management IP of the Cluster.
Metro Cluster Configuration StateThe Metro Cluster Configuration State of the Cluster.
Metro Cluster ModeThe Metro Cluster Mode of the Cluster.
Metro Cluster Partner Storage System KeyThe Metro Cluster Partner Storage System Key of the Cluster.
NameThe Name of the Cluster.
NetApp TypeThe NetApp Type of the Cluster.
Serial NumberThe Serial Number of the Cluster.
StatusThe Status of the Cluster.
Time ZoneThe Time Zone of the Cluster.
Time Zone UTCThe Time Zone UTC of the Cluster.
Time Zone VersionThe Time Zone Version of the Cluster.
Total System Net Data Received (Bytes per Second)The Total System Net Data Received of the Cluster.
Total System Net Data Sent (Bytes per Second)The Total System Net Data Sent of the Cluster.
Total System Read Operations (Operations per Second)The Total System Read Operations of the Cluster.
Total System Total Operations (Operations per Second)The Total System Total Operations of the Cluster.
Total System Write Operations (Operations per Second)The Total System Write Operations of the Cluster.
Total vServer Network Receive Data (Bytes per Second)The Total vServer Network Receive Data of the Cluster.
Total vServer Network Receive Errors (Errors per Second)The Total vServer Network Receive Errors of the Cluster.
Total vServer Network Receive Packets (Packets per Second)The Total vServer Network Receive Packets of the Cluster.
Total vServer Network Sent Data (Bytes per Second)The Total vServer Network Sent Data of the Cluster.
Total vServer Network Sent Errors (Errors per Second)The Total vServer Network Sent Errors of the Cluster.
Total vServer Network Sent Packets (Packets per Second)The Total vServer Network Sent Packets of the Cluster.
UUIDThe UUID of the Cluster.
VersionThe Version of the Cluster.
Version GenerationThe Version Generation of the Cluster.
Version MajorThe Version Major of the Cluster.
Version MinorThe Version Minor of the Cluster.

Disk

NameDescription
Base For Disk BusyThe Base For Disk Busy of the Disk.
Capacity SectorsThe Capacity Sectors of the Disk.
Capacity Utilization (%)The Used Capacity Percent of the Disk.
Checksum CompatibilityThe Checksum Compatibility of the Disk.
Cluster IDThe Cluster ID of the Disk.
Cluster KeyThe Cluster Key of the Disk.
Cluster NameThe Cluster Name of the Disk.
Consistency Point Read Blocks (per Second)The Consistency Point Read Blocks of the Disk.
Consistency Point Read Latency (Microseconds)The Consistency Point Read Latency of the Disk.
Consistency Point Reads (per Second)The Consistency Point Reads of the Disk.
Container TypeThe Container Type of the Disk.
Disk Busy (%)The Disk Busy of the Disk.
Effective Interface TypeThe Effective Interface Type of the Disk.
Failed ReasonThe Failed Reason of the Disk.
Firmware RevisionThe Firmware Revision of the Disk.
Guaranteed Read Blocks (per Second)The Guaranteed Read Blocks of the Disk.
Guaranteed Read Latency (Microseconds)The Guaranteed Read Latency of the Disk.
Guaranteed Reads (per Second)The Guaranteed Reads of the Disk.
Guaranteed Write Blocks (per Second)The Guaranteed Write Blocks of the Disk.
Guaranteed Write Latency (Microseconds)The Guaranteed Write Latency of the Disk.
Guaranteed Writes (per Second)The Guaranteed Writes of the Disk.
Home Node KeyThe Home Node Key of the Disk.
Instance UUIDThe Instance UID of the Disk.
Interface TypeThe Interface Type of the Disk.
Is FailedThe Is Failed of the Disk.
Is In FDRThe Is In FDR of the Disk.
Is Local AttachThe Is Local Attach of the Disk.
Is OfflineThe Is Offline of the Disk.
Is PrefailedThe Is Prefailed of the Disk.
Is SharedThe Is Shared of the Disk.
Is VirtualThe Is Virtual of the Disk.
Is ZeroedThe Is Zeroed of the Disk.
KeyThe Key of the Disk.
ModelThe Model of the Disk.
NameThe Name of the Disk.
NetApp TypeThe NetApp Type of the Disk.
Owner Node KeyThe Owner Node Key of the Disk.
Partitioning TypeThe Partitioning Type of the Disk.
Physical Blocks (Blocks)The Physical Blocks of the Disk.
PoolThe Pool of the Disk.
Raid PositionThe Raid Position of the Disk.
Right Size SectorsThe Right Size Sectors of the Disk.
RPMThe RPM of the Disk.
Serial NumberThe Serial Number of the Disk.
ShelfThe Shelf of the Disk.
Shelf BayThe Shelf Bay of the Disk.
Size per Sector (Bytes)The Size per Sector of the Disk.
Spares Consumed (%)The Percent Spares Consumed of the Disk.
Storage Pool KeyThe Storage Pool Key of the Disk.
Total Capacity (Bytes)The Total Capacity of the Disk.
Total Latency (Microseconds)The Total Latency of the Disk.
Total Operations (Operations per Second)The Total Operations of the Disk.
Total Throughput (per Second)The Total Throughput of the Disk.
Total Transfers (per Second)The Total Transfers of the Disk.
UIDThe UID of the Disk.
Usable Data SizeThe Usable Data Size of the Disk.
Usable Root SizeThe Usable Root Size of the Disk.
Used Blocks (Blocks)The Used Blocks of the Disk.
Used Capacity (Bytes)The Used Capacity of the Disk.
User Read Blocks (per Second)The User Read Blocks of the Disk.
User Read Latency (Microseconds)The User Read Latency of the Disk.
User Reads (per Second)The User Reads of the Disk.
User Write Blocks (per Second)The User Write Blocks of the Disk.
User Write Latency (Microseconds)The User Write Latency of the Disk.
User Writes (per Second)The User Writes of the Disk.
VendorThe Vendor of the Disk.

LUN

NameDescription
AlignmentThe Alignment of the LUN.
Average Latency (Microseconds)The Average Latency of the LUN.
Average Read Latency (Microseconds)The Average Read Latency of the LUN.
Average Write Latency (Microseconds)The Average Write Latency of the LUN.
Capacity Utilization (%)The Used Capacity Percent of the LUN.
Cluster IDThe Cluster ID of the LUN.
Cluster KeyThe Cluster Key of the LUN.
Cluster NameThe Cluster Name of the LUN.
CommentThe Comment of the LUN.
Is MappedThe Is Mapped of the LUN.
Is OnlineThe Is Online of the LUN.
Is Space Allocation EnabledThe Is Space Allocation Enabled of the LUN.
Is Space Reservation EnabledThe Is Space Reservation Enabled of the LUN.
KeyThe Key of the LUN.
Lun ClassThe Lun Class of the LUN.
Maximum IO Rate (Operations per Second)The Max IOPS of the LUN.
Maximum Throughput (Bytes per Second)The Max Throughput of the LUN.
Multi Protocol TypeThe Multi Protocol Type of the LUN.
NAA NumberThe NAA Number of the LUN.
NameThe Name of the LUN.
NetApp TypeThe NetApp Type of the LUN.
Other Operations (Operations per Second)The Other Operations of the LUN.
PathThe Path of the LUN.
Policy GroupThe Policy Group of the LUN.
Policy Group ClassThe Policy Group Class of the LUN.
Prefix Size (Bytes)The Prefix Size of the LUN.
Qos Policy Group KeyThe Qos Policy Group Key of the LUN.
QTree KeyThe QTree Key of the LUN.
Read Data (Bytes per Second)The Read Data of the LUN.
Read Operations (Operations per Second)The Read Operations of the LUN.
Read Partial Blocks (%)The Read Partial Blocks of the LUN.
Serial NumberThe Serial Number of the LUN.
Storage VM KeyThe Storage VM Key of the LUN.
Suffix Size (Bytes)The Suffix Size of the LUN.
Total Capacity (Bytes)The Total Capacity of the LUN.
Total Operations (Operations per Second)The Total Operations of the LUN.
Total ThroughputThe Total Throughput of the LUN.
Used Capacity (Bytes)The Used Capacity of the LUN.
UUIDThe UUID of the LUN.
Volume KeyThe Volume Key of the LUN.
Write Data (Bytes per Second)The Write Data of the LUN.
Write Operations (Operations per Second)The Write Operations of the LUN.
Write Partial Blocks (%)The Write Partial Blocks of the LUN.

QTree

NameDescription
Cluster IDThe Cluster ID of the QTree.
Cluster NameThe Cluster Name of the QTree.
Disk LimitThe Disk Limit of the QTree.
Disk UsedThe Disk Used of the QTree.
Export Policy KeyThe Export Policy Key of the QTree.
File LimitThe File Limit of the QTree.
File UsedThe File Used of the QTree.
KeyThe Key of the QTree.
NameThe Name of the QTree.
NetApp TypeThe NetApp Type of the QTree.
OplocksThe Oplocks of the QTree.
QTree IDThe QTree ID of the QTree.
Security StyleThe Security Style of the QTree.
Soft Disk LimitThe Soft Disk Limit of the QTree.
Soft File LimitThe Soft File Limit of the QTree.
StatusThe Status of the QTree.
Storage VM KeyThe Storage VM Key of the QTree.
ThresholdThe Threshold of the QTree.
Volume KeyThe Volume Key of the QTree.
Volume UUIDThe Volume UUID of the QTree.
vServer UUIDThe vServer UUID of the QTree.

System

NameDescription
AggregatesThe Aggregates of the System.
Average Processor Busy (%)The Average Processor Busy of the System.
CIFS Operations (Operations per Second)The CIFS Operations of the System.
Clean Time UtilizationThe Clean Time Utilization of the System.
Cluster IDThe Cluster ID of the System.
Cluster KeyThe Cluster Key of the System.
Cluster NameThe Cluster Name of the System.
CPU Busy (%)The CPU Busy (%) of the System.
CPU Elapsed TimeThe CPU Elapsed Time of the System.
Cpu Firmware ReleaseThe Cpu Firmware Release of the System.
Cpu Processor IdThe Cpu Processor Id of the System.
Cpu Processor TypeThe Cpu Processor Type of the System.
Current ModeThe Current Mode of the System.
Data DisksThe Data Disks of the System.
Disk Shelf Fibre Channel Loop UtilizationThe Disk Shelf Fibre Channel Loop Utilization of the System.
Double Parity DisksThe Double Parity Disks of the System.
Enviornment Failed Power Supply MessageThe Enviornment Failed Power Supply Message of the System.
Environment Failed Fan MessageThe Env Failed Fan Message of the System.
Failed Fan CountThe Failed Fan Count of the System.
Failed Power Supply CountThe Failed Power Supply Count of the System.
Failover StateThe Failover State of the System.
FCP Data ReceivedThe FCP Data Recv of the System.
FCP Data SentThe FCP Data Sent of the System.
FCP Operations (Operations per Second)The FCP Operations of the System.
Give Back StateThe Give Back State of the System.
HTTP Operations (Operations per Second)The HTTP Operations of the System.
Interconnect LinksThe Interconnect Links of the System.
Interconnect TypeThe Interconnect Type of the System.
Is Epsilon NodeThe Is Epsilon Node of the System.
Is Failover EnabledThe Is Failover Enabled of the System.
Is Interconnect UpThe Is Interconnect Up of the System.
Is Node HealthyThe Is Node Healthy of the System.
Is Over TemperatureThe Is Over Temperature of the System.
Is Take Over PossibleThe Is Take Over Possible of the System.
iSCSI Operations (per Second)The iSCSI Operations of the System.
KeyThe Key of the System.
Local Firmware StateThe Local Firmware State of the System.
LocationThe Location of the System.
Maximum Aggregate UtilizationThe Max Aggregate Utilization of the System.
Maximum Processor Elapsed TimeThe Max Processor Elapsed Time of the System.
Memory Size (Bytes)The Memory Size of the System.
Metro Cluster Disaster Recovery Operation StateThe Metro Cluster Disaster Recovery Operation State of the System.
Metro Cluster Disaster Recovery Partner Node KeyThe Metro Cluster Disaster Recovery Partner Node Key of the System.
NameThe Name of the System.
Net Data Received (Bytes per Second)The Net Data Received of the System.
Net Data Sent (Bytes per Second)The Net Data Sent of the System.
NetApp TypeThe NetApp Type of the System.
NFS v3 Operations (Operations per Second)The NFSv3 Operations of the System.
Nvram Battery StatusThe Nvram Battery Status of the System.
Nvram IdThe Nvram Id of the System.
Other OperationsThe Other Ops of the System.
OwnerThe Owner of the System.
Parity DisksThe Parity Disks of the System.
Partner Firmware StateThe Partner Firmware State of the System.
Partner Node KeyThe Partner Node Key of the System.
Present DisksThe Present Disks of the System.
ProcessorsThe Processors of the System.
Product TypeThe Product Type of the System.
Read Operations (Operations per Second)The Read Operations of the System.
Read ThroughputThe Read Throughput of the System.
Serial NumberThe Serial Number of the System.
Spare DisksThe Spare Disks of the System.
System Average Latency (Microseconds)The System Average Latency of the System.
System ModelThe System Model of the System.
System Read Latency (Microseconds)The System Read Latency of the System.
System Write Latency (Microseconds)The System Write Latency of the System.
Takeover By Partner Not Possible ReasonThe Takeover By Partner Not Possible Reason of the System.
Takeover Failure ReasonThe Takeover Failure Reason of the System.
Takeover Of Partner Not Possible ReasonThe Takeover Of Partner Not Possible Reason of the System.
Total DisksThe Total Disks of the System.
Total Operations (Operations per Second)The Total Operations of the System.
Total Throughput (Kilobytes per Second)The Total Throughput of the System.
UptimeThe Uptime of the System.
UtilizationThe Utilization of the System.
UUIDThe UUID of the System.
VendorVendor
VersionThe Version of the System.
Version GenerationThe Version Generation of the System.
Version MajorThe Version Major of the System.
Version MinorThe Version Minor of the System.
Write Operations (Operations per Second)The Write Operations of the System.
Write ThroughputThe Write Throughput of the System.

Volume

NameDescription
Aggregate KeyThe Aggregate Key of the Volume.
Auto Size Increment SizeThe Auto Size Increment Size of the Volume.
Auto Size Maximum Size (Bytes)The Auto Size Maximum Size of the Volume.
Auto Size ModeThe Auto Size Mode of the Volume.
Average Latency (Microseconds)The Average Latency of the Volume.
Average Lun Average Latency (Microseconds)The Average Lun Average Latency of the Volume.
Average Lun Average Read Latency (Microseconds)The Average Lun Average Read Latency of the Volume.
Average Lun Average Write Latency (Microseconds)The Average Lun Average Write Latency of the Volume.
Average Lun Other Operations (Operations per Second)The Average Lun Other Operations of the Volume.
Average Lun Read Data (Bytes per Second)The Average Lun Read Data of the Volume.
Average Lun Read Operations (Operations per Second)The Average Lun Read Operations of the Volume.
Average Lun Write Data (Bytes per Second)The Average Lun Write Data of the Volume.
Average Lun Write Operations (Operations per Second)The Average Lun Write Operations of the Volume.
Capacity Utilization (%)The Used Capacity Percent of the Volume.
CIFS Other Latency (Microseconds)The CIFS Other Latency of the Volume.
CIFS Other Operations (Operations per Second)The CIFS Other Operations of the Volume.
CIFS Read Latency (Microseconds)The CIFS Read Latency of the Volume.
CIFS Read Operations (Operations per Second)The CIFS Read Operations of the Volume.
CIFS Read Throughput (per Second)The CIFS Read Throughput of the Volume.
CIFS Write Latency (Microseconds)The CIFS Write Latency of the Volume.
CIFS Write Operations (Operations per Second)The CIFS Write Operations of the Volume.
CIFS Write Throughput (per Second)The CIFS Write Throughput of the Volume.
Clone Parent KeyThe Clone Parent Key of the Volume.
Cluster IDThe Cluster ID of the Volume.
Cluster KeyThe Cluster Key of the Volume.
Cluster NameThe Cluster Name of the Volume.
Compression Space Saved (Bytes)The Compression Space Saved of the Volume.
Compression Space Saved Ratio (%)The Percentage Compression Space Saved of the Volume.
Deduplication Space Saved (Bytes)The Deduplication Space Saved of the Volume.
Deduplication Space Saved Ratio (%)The Percentage Deduplication Space Saved of the Volume.
Derived StyleThe Derived Style of the Volume.
Export Policy KeyThe Export Policy Key of the Volume.
FCP Other Latency (Microseconds)The FCP Other Latency of the Volume.
FCP Other Operations (Operations per Second)The FCP Other Operations of the Volume.
FCP Read Latency (Microseconds)The FCP Read Latency of the Volume.
FCP Read Operations (Operations per Second)The FCP Read Operations of the Volume.
FCP Read Throughput (per Second)The FCP Read Throughput of the Volume.
FCP Write Latency (Microseconds)The FCP Write Latency of the Volume.
FCP Write Operations (Operations per Second)The FCP Write Operations of the Volume.
FCP Write Throughput (per Second)The FCP Write Throughput of the Volume.
Flex Cache Minimum ReserveThe Flex Cache Min Reserve of the Volume.
Flex Cache Origin KeyThe Flex Cache Origin Key of the Volume.
Fractional Reserve Ratio (%)The Percentage Fractional Reserve of the Volume.
Hybrid Cache EligibilityThe Hybrid Cache Eligibility of the Volume.
Inode Block TypeThe Inode Block Type of the Volume.
Inode Files TotalThe Inode Files Total of the Volume.
Inode Files UsedThe Inode Files Used of the Volume.
Instance UUIDThe Instance UUID of the Volume.
Is Atime Update EnabledThe Is Atime Update Enabled of the Volume.
Is Auto Snapshots EnabledThe Is Auto Snapshots Enabled of the Volume.
Is Convert Ucode EnabledThe Is Convert Ucode Enabled of the Volume.
Is Create Ucode EnabledThe Is Create Ucode Enabled of the Volume.
Is Data Protection MirrorThe Is Data Protection Mirror of the Volume.
Is I2P EnabledThe Is I2P Enabled of the Volume.
Is Junction ActiveThe Is Junction Active of the Volume.
Is Load Sharing MirrorThe Is Load Sharing Mirror of the Volume.
Is Move MirrorThe Is Move Mirror of the Volume.
Is Replica VolumeThe Is Replica Volume of the Volume.
Is SIS Compression EnabledThe Is SIS Compression Enabled of the Volume.
Is SIS Inline Compression EnabledThe Is SIS Inline Compression Enabled of the Volume.
Is SIS VolumeThe Is SIS Volume of the Volume.
Is Snap Directory Access EnabledThe Is Snap Directory Access Enabled of the Volume.
Is Snapshot Auto Delete EnabledThe Is Snapshot Auto Delete Enabled of the Volume.
Is Snapshot Clone Dependency EnabledThe Is Snapshot Clone Dependency Enabled of the Volume.
Is Space Guarantee EnabledThe Is Space Guarantee Enabled of the Volume.
Is Storage Virtual Machines RootThe Is Storage Virtual Machines Root of the Volume.
iSCSI Other Latency (Microseconds)The iSCSI Other Latency of the Volume.
iSCSI Other Operations (Operations per Second)The iSCSI Other Operations of the Volume.
iSCSI Read Latency (Microseconds)The iSCSI Read Latency of the Volume.
iSCSI Read Operations (Operations per Second)The iSCSI Read Operations of the Volume.
iSCSI Read Throughput (per Second)The iSCSI Read Throughput of the Volume.
iSCSI Write Latency (Microseconds)The iSCSI Write Latency of the Volume.
iSCSI Write Operations (Operations per Second)The iSCSI Write Operations of the Volume.
iSCSI Write Throughput (per Second)The iSCSI Write Throughput of the Volume.
Junction Parent KeyThe Junction Parent Key of the Volume.
Junction PathThe Junction Path of the Volume.
KeyThe Key of the Volume.
Language CodeThe Language Code of the Volume.
Maximum IO Rate (Operations per Second)The Max IOPS of the Volume.
Maximum Throughput (Bytes per Second)The Max Throughput of the Volume.
NameThe Name of the Volume.
NetApp TypeThe NetApp Type of the Volume.
NFS Other Latency (Microseconds)The NFS Other Latency of the Volume.
NFS Other Operations (Operations per Second)The NFS Other Operations of the Volume.
NFS Read Latency (Microseconds)The NFS Read Latency of the Volume.
NFS Read Operations (Operations per Second)The NFS Read Operations of the Volume.
NFS Read Throughput (per Second)The NFS Read Throughput of the Volume.
NFS Write Latency (Microseconds)The NFS Write Latency of the Volume.
NFS Write Operations (Operations per Second)The NFS Write Operations of the Volume.
NFS Write Throughput (per Second)The NFS Write Throughput of the Volume.
Oldest Snapshot TimestampThe Oldest Snapshot Timestamp of the Volume.
Other Latency (Microseconds)The Other Latency of the Volume.
Other Operations (Operations per Second)The Other Operations of the Volume.
Overwrite Reserve (Bytes)The Overwrite Reserve of the Volume.
Overwrite Reserve Actual Used (Bytes)The Overwrite Reserve Actual Used of the Volume.
Overwrite Reserve Available (Bytes)The Overwrite Reserve Available of the Volume.
Overwrite Reserve Required (Bytes)The Overwrite Reserve Required of the Volume.
Overwrite Reserve Used (Bytes)The Overwrite Reserve Used of the Volume.
Pg IdentifierThe Pg Identifier of the Volume
Policy GroupThe Policy Group of the Volume.
Policy Group ClassThe Policy Group Class of the Volume.
Qos Policy KeyThe Qos Policy Group Key of the Volume.
Quota CommittedThe Quota Committed of the Volume.
Quota Over CommittedThe Quota Over Committed of the Volume.
Quota StatusThe Quota Status of the Volume.
Read Latency (Microseconds)The Read Latency of the Volume.
Read Operations (Operations per Second)The Read Operations of the Volume.
Read Throughput (per Second)The Read Throughput of the Volume.
San Read Throughput (per Second)The San Read Throughput of the Volume.
San Write Throughput (per Second)The San Write Throughput of the Volume.
Security Group IdThe Security Group Id of the Volume.
Security PermissionsThe Security Permissions of the Volume.
Security StyleThe Security Style of the Volume.
Security User IdThe Security User Id of the Volume.
SIS Last Operation Begin TimestampThe SIS Last Operation Begin Timestamp of the Volume.
SIS Last Operation End TimestampThe SIS Last Operation End Timestamp of the Volume.
SIS Last Operation ErrorThe SIS Last Operation Error of the Volume.
SIS Last Operation SizeThe SIS Last Operation Size of the Volume.
SIS Last Operation StateThe SIS Last Operation State of the Volume.
SIS Policy KeyThe SIS Policy Key of the Volume.
SIS ProgressThe SIS Progress of the Volume.
SIS ScheduleThe SIS Schedule of the Volume.
SIS StateThe SIS State of the Volume.
SIS StatusThe SIS Status of the Volume.
SIS TypeThe SIS Type of the Volume.
Size (Bytes)The Size of the Volume.
Size Available (Bytes)The Size Available of the Volume.
Size Available For Snapshot (Bytes)The Size Available For Snapshot of the Volume.
Size Used By Snapshots (Bytes)The Size Used By Snapshots of the Volume.
Snapshot Auto Delete CommitmentThe Snapshot Auto Delete Commitment of the Volume.
Snapshot Auto Delete Defer DeleteThe Snapshot Auto Delete Defer Delete of the Volume.
Snapshot Auto Delete Delete OrderThe Snapshot Auto Delete Delete Order of the Volume.
Snapshot Auto Delete Destroy ListThe Snapshot Auto Delete Destroy List of the Volume.
Snapshot Auto Delete PrefixThe Snapshot Auto Delete Prefix of the Volume.
Snapshot Auto Delete Target Free Space (Bytes)The Snapshot Auto Delete Target Free Space of the Volume.
Snapshot Auto Delete TriggerThe Snapshot Auto Delete Trigger of the Volume.
Snapshot Policy KeyThe Snapshot Policy Key of the Volume.
Snapshot Reserve (%)The Percentage Snapshot Reserve of the Volume.
Snapshot Reserve Size (Bytes)The Snapshot Reserve Size of the Volume.
Snapshot Reserve Used (Bytes)The Snapshot Reserve Use of the Volume.
Space GuaranteeThe Space Guarantee of the Volume.
Space Management Option Try FirstThe Space Management Option Try First of the Volume.
StateThe State of the Volume.
Storage Virtual Machines KeyThe Storage Virtual Machines Key of the Volume.
StyleThe Style of the Volume.
Total Capacity (Bytes)The Total Capacity of the Volume.
Total CIFS Operations (Operations per Second)The Total CIFS Operations of the Volume.
Total FCP Operations (Operations per Second)The Total FCP Operations of the Volume.
Total iSCSI Operations (Operations per Second)The Total iSCSI Operations of the Volume.
Total Lun Other Operations (Operations per Second)The Total Lun Other Operations of the Volume.
Total Lun Read Data (Bytes per Second)The Total Lun Read Data of the Volume.
Total Lun Read Operations (Operations per Second)The Total Lun Read Operations of the Volume.
Total Lun Total Operations (Operations per Second)The Total Lun Total Operations of the Volume.
Total Lun Write Data (Bytes per Second)The Total Lun Write Data of the Volume.
Total Lun Write Operations (Operations per Second)The Total Lun Write Operations of the Volume.
Total NFS Operations (Operations per Second)The Total NFS Operations of the Volume.
Total Operations (Operations per Second)The Total Operations of the Volume.
Total Throughput (per Second)The Total Throughput of the Volume.
Used Capacity (Bytes)The Used Capacity of the Volume.
UUIDThe UUID of the Volume.
Virtual Machines Align SectorThe Virtual Machines Align Sector of the Volume.
Virtual Machines Align SuffixThe Virtual Machines Align Suffix of the Volume.
Volume TypeThe Vol Type of the Volume.
Write Latency (Microseconds)The Write Latency of the Volume.
Write Operations (Operations per Second)The Write Operations of the Volume.
Write Throughput (per Second)The Write Throughput of the Volume.

VServer

NameDescription
Active NIS Domain NameThe Active NIS Domain Name of the VServer.
Active NIS ServersThe Active NIS Servers of the VServer.
Allowed ProtocolsThe Allowed Protocols of the VServer.
Available Capacity (Bytes)The Available Capacity of the VServer.
Average Volume Average Latency (Microseconds)The Average Volume Average Latency of the VServer.
Average Volume Other Latency (Microseconds)The Average Volume Other Latency of the VServer.
Average Volume Other Operations (Operations per Second)The Average Volume Other Operations of the VServer.
Average Volume Read Latency (Microseconds)The Average Volume Read Latency of the VServer.
Average Volume Read Operations (Operations per Second)The Average Volume Read Operations of the VServer.
Average Volume Total Operations (Operations per Second)The Average Volume Total Operations of the VServer.
Average Volume Write Latency (Microseconds)The Average Volume Write Latency of the VServer.
Average Volume Write Operations (Operations per Second)The Average Volume Write Operations of the VServer.
Capacity Utilization (%)The Used Capacity Percent of the VServer.
CIFS Authentication StyleThe CIFS Authentication Style of the VServer.
CIFS DomainThe CIFS Domain of the VServer.
CIFS EnabledThe CIFS Enabled of the VServer.
CIFS Latency (Microseconds)The CIFS Latency of the VServer.
CIFS Latency BaseThe CIFS Latency Base of the VServer.
CIFS Operations (Operations per Second)The CIFS Operations of the VServer.
CIFS Read Latency (Microseconds)The CIFS Read Latency of the VServer.
CIFS Read Operations (Operations per Second)The CIFS Read Operations of the VServer.
CIFS ServerThe CIFS Server of the VServer.
CIFS Write Latency (Microseconds)The CIFS Write Latency of the VServer.
CIFS Write Operations (Operations per Second)The CIFS Write Operations of the VServer.
Cluster IDThe Cluster ID of the VServer.
Cluster KeyThe Cluster Key of the VServer.
Cluster NameThe Cluster Name of the VServer.
Default Unix GroupThe Default Unix Group of the VServer.
Default Unix UserThe Default Unix User of the VServer.
Disallowed ProtocolsThe Disallowed Protocols of the VServer.
DNS Domain NamesThe DNS Domain Names of the VServer.
DNS EnabledThe DNS Enabled of the VServer.
DNS ServersThe DNS Servers of the VServer.
Export Policy EnabledThe Export Policy Enabled of the VServer.
FCP Average Latency (Microseconds)The Average Latency of the VServer.
FCP Average Other Latency (Microseconds)The Average Other Latency of the VServer.
FCP Average Read Latency (Microseconds)The Average Read Latency of the VServer.
FCP Average Write Latency (Microseconds)The Average Write Latency of the VServer.
FCP EnabledThe FCP Enabled of the VServer.
FCP Node NameThe FCP Node Name of the VServer.
FCP Other Operations (Operations per Second)The Other Operations of the VServer.
FCP Read Data (Bytes per Second)The Read Data of the VServer.
FCP Read Operations (Operations per Second)The Read Operations of the VServer.
FCP Total Operations (Operations per Second)The Total Operations of the VServer.
Fcp Total ThroughputThe Fcp Total Throughput of the VServer.
FCP Write Data (Bytes per Second)The Write Data of the VServer.
FCP Write Operations (Operations per Second)The Write Operations of the VServer.
Is Config Locked For ChangesThe Is Config Locked For Changes of the VServer.
Is Kerberos EnabledThe Is Kerberos Enabled of the VServer.
iSCSI Alias NameThe iSCSI Alias Name of the VServer.
iSCSI Average Latency (Microseconds)The iSCSI Average Latency of the VServer.
iSCSI Average Other Latency (Microseconds)The iSCSI Average Other Latency of the VServer.
iSCSI Average Read Latency (Microseconds)The iSCSI Average Read Latency of the VServer.
iSCSI Average Write Latency (Microseconds)The iSCSI Average Write Latency of the VServer.
iSCSI Command TransferedThe iSCSI Command Transfered of the VServer.
iSCSI Data In BlocksThe iSCSI Data In Blocks of the VServer.
iSCSI Data Out BlocksThe iSCSI Data Out Blocks of the VServer.
iSCSI EnabledThe iSCSI Enabled of the VServer.
iSCSI Node NameThe iSCSI Node Name of the VServer.
iSCSI Other Operations (Operations per Second)The iSCSI Other Operations of the VServer.
Iscsi Read DataThe Iscsi Read Data of the VServer.
iSCSI Read Operations (Operations per Second)The iSCSI Read Operations of the VServer.
Iscsi Total OperationsThe Iscsi Total Operations of the VServer.
Iscsi Total ThroughputThe Iscsi Total Throughput of the VServer.
Iscsi Write DataThe Iscsi Write Data of the VServer.
iSCSI Write Operations (Operations per Second)The iSCSI Write Operations of the VServer.
KeyThe Key of the VServer.
LanguageThe Language of the VServer.
LDAP Client EnabledThe LDAP Client Enabled of the VServer.
LUNThe LUNs of the VServer.
Maximum Throughput (Bytes per Second)The Max Throughput of the VServer.
Maximum VolumesThe Maximum Volumes of the VServer.
NameThe Name of the VServer.
Name Server SwitchThe Name Server Switch of the VServer.
NetApp TypeThe NetApp Type of the VServer.
Network IP Space KeyThe Network IP Space Key of the VServer.
Network Receive Data (Bytes per Second)The Network Receive Data of the VServer.
Network Receive Errors (Errors per Second)The Network Receive Errors of the VServer.
Network Receive Packets (Packets per Second)The Network Receive Packets of the VServer.
Network Sent Data (Bytes per Second)The Network Sent Data of the VServer.
Network Sent Errors (Errors per Second)The Network Sent Errors of the VServer.
Network Sent Packets (Packets per Second)The Network Sent Packets of the VServer.
Network Total PacketsThe Network Total Packets of the VServer.
Network Total ThroughputThe Network Total Throughput of the VServer.
NFS41 ACL EnabledThe NFS41 ACL Enabled of the VServer.
NFS EnabledThe NFS Enabled of the VServer.
NFS v2 SupportedThe NFS v2 Supported of the VServer.
NFS v3 Operations (Operations per Second)The NFSv3 Operations of the VServer.
NFS v3 Read Average Latency (Microseconds)The NFSv3 Read Average Latency of the VServer.
NFS v3 Read Operations (Operations per Second)The NFSv3 Read Operations of the VServer.
NFS v3 Read Throughput (Bytes per Second)The NFSv3 Read Throughput of the VServer.
NFS v3 Read Total (Bytes)The NFSv3 Read Total of the VServer.
NFS v3 SupportedThe NFS v3 Supported of the VServer.
NFS v3 Throughput (Bytes per Second)The NFSv3 Throughput of the VServer.
NFS v3 Total LatencyThe NFS v3 Total Latency of the VServer.
NFS v3 Total OperationsThe NFS v3 Total Operations of the VServer.
NFS v3 Write Average Latency (Microseconds)The NFSv3 Write Average Latency of the VServer.
NFS v3 Write Operations (Operations per Second)The NFSv3 Write Operations of the VServer.
NFS v3 Write Throughput (Bytes per Second)The NFSv3 Write Throughput of the VServer.
NFS v3 Write Total (Bytes)The NFSv3 Write Total of the VServer.
NFS v41 Migration EnabledThe NFS v41 Migration Enabled of the VServer.
NFS v41 Operations (Operations per Second)The NFSv41 Operations of the VServer.
NFS v41 PNFS EnabledThe NFS v41 PNFS Enabled of the VServer.
NFS v41 Read Average Latency (Microseconds)The NFSv41 Read Average Latency of the VServer.
NFS v41 Read Throughput (Bytes per Second)The NFSv41 Read Throughput of the VServer.
NFS v41 Read Total (Bytes)The NFSv41 Read Total of the VServer.
NFS v41 Referrals EnabledThe NFS v41 Referrals Enabled of the VServer.
NFS v41 SupportedThe NFS v41 Supported of the VServer.
NFS v41 Throughput (Bytes per Second)The NFSv41 Throughput of the VServer.
NFS v41 Total LatencyThe NFS v41 Total Latency of the VServer.
NFS v41 Total OperationsThe NFS v41 Total Operations of the VServer.
NFS v41 Write Average Latency (Microseconds)The NFSv41 Write Average Latency of the VServer.
NFS v41 Write Throughput (Bytes per Second)The NFSv41 Write Throughput of the VServer.
NFS v41 Write Total (Bytes)The NFSv41 Write Total of the VServer.
NFS v4 Migration EnabledThe NFS v4 Migration Enabled of the VServer.
NFS v4 Operations (Operations per Second)The NFSv4 Operations of the VServer.
NFS v4 Read Average Latency (Microseconds)The NFSv4 Read Average Latency of the VServer.
NFS v4 Read Delegation EnabledThe NFS v4 Read Delegation Enabled of the VServer.
NFS v4 Read Throughput (Bytes per Second)The NFSv4 Read Throughput of the VServer.
NFS v4 Read Total (Bytes)The NFSv4 Read Total of the VServer.
NFS v4 Referrals EnabledThe NFS v4 Referrals Enabled of the VServer.
NFS v4 SupportedThe NFS v4 Supported of the VServer.
NFS v4 Throughput (Bytes per Second)The NFSv4 Throughput of the VServer.
NFS v4 Total LatencyThe NFS v4 Total Latency of the VServer.
NFS v4 Total OperationsThe NFS v4 Total Operations of the VServer.
NFS v4 Write Average Latency (Microseconds)The NFSv4 Write Average Latency of the VServer.
NFS v4 Write Delegation EnabledThe NFS v4 Write Delegation Enabled of the VServer.
NFS v4 Write Throughput (Bytes per Second)The NFSv4 Write Throughput of the VServer.
NFS v4 Write Total (Bytes)The NFSv4 Write Total of the VServer.
NIS EnabledThe NIS Enabled of the VServer.
Operational StateThe Operational State of the VServer.
Pg IdentifierThe Pg Identifier of the VServer.
Policy Group ClassThe Policy Group Class of the VServer.
QoS Policy KeyThe QoS Policy Key of the VServer.
QoS Policy NameThe QoS Policy Name of the VServer.
QTreeThe QTrees of the VServer.
Read LatencyThe Read Latency of the VServer.
Read OperationsThe Read Operations of the VServer.
Read ThroughputThe Read Throughput of the VServer.
StateThe State of the VServer.
Storage Virtual Machine KeyThe Storage Virtual Machine Key of the VServer.
SubtypeThe Subtype of the VServer.
Total Capacity (Bytes)The Total Capacity of the VServer.
Total Latency (Microseconds)The Total Latency of the VServer.
Total Operations (Operations per Second)The Total Operations of the VServer.
Total Throughput (Kilobytes per Second)The Total Throughput of the VServer.
Total Volume Other Operations (Operations per Second)The Total Volume Other Operations of the VServer.
Total Volume Read Operations (Operations per Second)The Total Volume Read Operations of the VServer.
Total Volume Total Operations (Operations per Second)The Total Volume Total Operations of the VServer.
Total Volume Write Operations (Operations per Second)The Total Volume Write Operations of the VServer.
TypeThe Type of the VServer.
Used Capacity (Bytes)The Used Capacity of the VServer.
UUIDThe UUID of the VServer.
VolumeThe Volume of the VServer.
Write LatencyThe Write Latency of the VServer.
Write OperationsThe Write Operations of the VServer.
Write ThroughputThe Write Throughput of the VServer.

Updated 8 months ago

NetApp API Services


Monitor NetApp FAS/AFF SANs via NetApp OnCommand API-Services

Suggested Edits are limited on API Reference Pages

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