MIB Synology DiskStation User Guide

Synology DiskStation
MIB Guide

THIS DOCUMENT CONTAINS PROPRIETARY TECHNICAL INFORMATION WHICH IS THE PROPERTY OF SYNOLOGY INCORPORATED AND SHALL NOT BE REPRODUCED, COPIED, OR USED AS THE BASIS FOR DESIGN, MANUFACTURING, OR SALE OF APPARATUS WITHOUT WRITTEN PERMISSION OF SYNOLOGY INCORPORATED

Synology Inc.
© 2015-2019 Synology Inc.
All rights reserved.
No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, mechanical, electronic, photocopying,
recording, or otherwise, without prior written permission of Synology Inc., with the following exceptions: Any person is hereby authorized to store documentation on a single computer for personal use only and to print copies of documentation for personal use provided that the documentation contains Synology’s copyright notice.
The Synology logo is a trademark of Synology Inc.
No licenses, express or implied, are granted with respect to any of the technology described in this document. Synology retains all intellectual property rights associated with the technology described in this document. This document is intended to assist application developers to develop applications only for Synology-labelled computers.
Every effort has been made to ensure that the information in this document is accurate. Synology is not responsible for typographical errors.
Synology Inc.
9F., No.1. Yuandong Rd., Banqiao Dist., New Taipei City 220, Taiwan Synology, and the Synology logo are trademarks of Synology Inc., registered in the United States and other countries.
Marvell is a registered trademark of Marvell Semiconductor, Inc. or its subsidiaries in the United States and other countries.
Freescale is a registered trademark of Freescale Semiconductor, Inc. or its subsidiaries in the United States and other countries.
Other products and company names mentioned herein are trademarks of their respective holders.
Even though Synology has reviewed this document, SYNOLOGY MAKES NO WARRANTY OR REPRESENTATION, EITHER EXPRESS OR IMPLIED,
WITH RESPECT TO THIS DOCUMENT, ITS QUALITY, ACCURACY, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. AS A RESULT, THIS DOCUMENT IS PROVIDED “AS IS,” AND YOU, THE READER, ARE ASSUMING THE ENTIRE RISK AS TO ITS QUALITY AND ACCURACY. IN NO EVENT WILL SYNOLOGY BE LIABLE FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES RESULTING FROM ANY DEFECT OR INACCURACY IN THIS DOCUMENT, even if advised of the possibility of such damages.
THE WARRANTY AND REMEDIES SET FORTH ABOVE ARE EXCLUSIVE AND IN LIEU OF ALL OTHERS, ORAL OR WRITTEN, EXPRESS OR
IMPLIED. No Synology dealer, agent, or employee is authorized to make any modification, extension, or addition to this warranty.
Some states do not allow the exclusion or limitation of implied warranties or liability for incidental or consequential damages, so the above limitation or
exclusion may not apply to you. This warranty gives you specific legal rights, and you may also have other rights which vary from state to state.

Introduction

Synology DiskStation Manager (DSM) allows users to monitor the status of their Synology NAS through Network Management Systems (NMS) via Simple Network Management Protocol (SNMP). However, Synology DSM does not provide SNMP trap capability.
This document introduces Management Information Base (MIB) files of Synology NAS. It focuses on which MIB files are supported by DSM, while also describes how Object Identifiers (OIDs) in Synology MIBs are used with your preferred NMS software. Users are encouraged to have experience and knowledge of NMS and SNMP before consulting this document.

Supported MIB Files

DSM supports numerous MIB files that can help users monitor different information on their Synology NAS. Table 1 shows the MIBs supported by DSM.
These MIB files can be separated into two types: general SNMP MIB and Synology MIB. General SNMP MIB files are equipped on NMS clients natively. This document does not explain the OIDs of general SNMP MIB files. If you would like to learn more about OIDs in general SNMP MIB files, please visit this website.
Synology MIB files can provide specific data about a Synology NAS’s system, disks, RAID, and connected UPS devices. Please see the “Synology MIB Files” section below for more Synology MIB information.
To download the Synology MIB file, please use the link below:
• https://global.download.synology.com/download/Document/MIBGuide/Synology_MIB_File.zip

Table 1. General MIB Files Supported by DSM

management purposes
DISMAN-SCHEDULE-MIB| For scheduling SNMP set operations periodically or at specific points in time
HOST-RESOURCES-MIB| For use in managing host systems
IF-MIB| For describing network interface sub-layers
IP-FORWARD-MIB| For the management of CIDR multipath IP Routes
IP-MIB| For IP and ICMP management objects
IPV6-ICMP-MIB| For entities implementing the ICMPv6
IPV6-MIB| For entities implementing the IPv6 protocol
IPV6-TCP-MIB| For entities implementing TCP over IPv6
IPV6-UDP-MIB| For entities implementing UDP over IPv6
NET-SNMP-AGENT-MIB| For monitoring structures for the Net-SNMP agent
NET-SNMP-EXTEND-MIB| For scripted extensions for the Net-SNMP agent
NET-SNMP-VACM-MIB| Defines Net-SNMP extensions to the standard VACM view table
NOTIFICATION-LOG-MIB| For logging SNMP Notifications
SNMP-COMMUNITY-MIB| To help support coexistence between SNMPvl, SNMPv2c, and SNMPv3
SNMP-FRAMEWORK-MIB| The SNMP Management Architecture MIB
SNMP-MPD-MIB| For Message Processing and Dispatching
SNMP-USER-BASED-SM-MIB| For the SNMP User-based Security Model
SNMP-VIEW-BASED-ACM-MIB| For the View-based Access Control Model for SNMP
SNMPv2-MIB| For SNMP entities
SYNOLOGY-DISK-MIB| For Synology disk information (Synology only)
SYNOLOGY-EBOX-MIB| For Synology box information (Synology only)
SYNOLOGY-FLASHCACHE-MIB| For Synology FlashCache information (Synology only)
SYNOLOGY-ISCSILUN-MIB| For Synology iSCSI LUN information (Synology only)
SYNOLOGY-RAID-MIB| For Synology RAID information (Synology only)
SYNOLOGY-SERVICES-MIB| For Synology services information (Synology only)
SYNOLOGY-SHA-MIB| For Synology High-Availability information (Synology only)
SYNOLOGY-SMART-MIB| For Synology smart information (Synology only)
SYNOLOGY-SPACEIO-MIB| For Synology SpacelO information (Synology only)
SYNOLOGY-STORAGE-MIB| For Synology StoragelO information (Synology only)
SYNOLOGY-SYSTEM-MIB| For Synology system information (Synology only)
SYNOLOGY-UPS-MIB| For Synology UPS information (Synology only)
TCP-MIB| For managing TCP implementations
UCD-DISKIO-MIB| For disk IO statistics
UCD-DLMOD-MIB| For dynamic loadable MIB modules
UCD-SNMP-MIB| For private UCD SNMP MIB extensions
UDP-MIB| For managing UDP implementations

Synology MIB Files

The following Synology MIB files are provided in DSM. These MIB files are the child-nodes of OID (Object Identifier) 1.3.6.1.4.1.6574. Table 2 shows the exact OID of each MIB. Please note that the MIB files are mutually dependent. Before your NMS can monitor any of the items in these MIB files, please make sure that all of them have been imported together and use SNMPv2c to obtain the complete Synology OID information.

Table 2. OID of Synology MIBs

Synology System MIB

The Synology System MIB displays all system statuses, including temperature and fan status. Users can monitor this MIB for system functionality. Table 3 shows information provided in the System MIB.

Table 3. System MIB

CHO| Name| Type| 1 Statuslype
Normal(1)
Failed(2)| Explanation
---|---|---|---|---
.1| system status| Integer| System partition status
.2| temperature| Integer| | The temperature of this NAS
.3| power status| Integer| Normal(1)
Failed(2)| Returns an error if power supplies fail
.4.1| system fan status| Integer| Normal(1)
Failed(2)| Returns an error if the system fan fails
.4.2| CPU fan status| Integer| Normal(1)
Failed(2)| Returns an error if CPU fan fails
.5.1| modelName| String| | The model name of this NAS
.5.2| serialNumber| String| –| Model serial number
.5.3| version| String| –| The version of DSM
.5.4| upgrade available| Integer| Available(1) Unavailable(2) Connecting(3) Disconnected(4) Others(5)| Checks whether a new version or update of DSM is available

Synology Disk MIB

The Synology Disk MIB contains several types of information regarding hard drives, including ID, type and so on, as listed in Table 4. This MIB is a table in SNMP. As such, it can increase or decrease in size when disks are inserted or removed. For example, if a disk is inserted, an additional row containing relevant information will emerge. The OID DiskIndex (.1) is reserved for an index of table rows and cannot be accessed. Table 5 describes the contents of each DiskStatus in detail.

Table 4. Disk MIB

• For DiskStatus details, please Table 5

Table 5. DiskStatus Explanation

Synology RAID MIB

In addition to the disk MIB, Synology also provides an MIB for monitoring RAID status. This MIB is similar to the disk MIB in that rows will appear or disappear to reflect RAID creation and deletion. Table 6 lists the contents of the RAID MIB. Table 7 describes each RAID status in detail.

Table 6. RAID MIB

• For RAID status details, please Table 7

Table 7. RAID Status Explanation

Repairing(2)
Migrating(3)
Expanding(4)
Deleting(5)
Creating(6)
RaidSyncing(7)
RaidParityChecking(8)
RaidAssembling(9)
Canceling(10)| These statuses are shown when RAID is created or deleted
Degrade(11)| Degrade is shown when a tolerable failure of disk(s) Occurs
---|---
Crashed(12)| RAID has crashed and is now read-only
DataScrubbing (13)| RAID is DataScrubbing
RaidDeploying (14)| RAID is deploying Single volume on pool
RaidUnDeploying (15)| RAID is not deploying Single volume on pool
RaidMountCache (16)| RAID is mounting SSD cache
RaidUnmountCache (17)| RAID is not mounting SSD cache
RaidExpandingUnfinishedSHR (18)| RAID continue expanding SHR if interrupted
RaidConvertSHRToPool (19)| RAID is converting Single volume on SHR to multiple volume on SHR
RaidMigrateSHR1ToSHR2 (20)| RAID is migrating SHR1 to SHR2
RaidUnknownStatus (21)| RAID status is not included in the status above

Synology UPS MIB

The Synology UPS MIB provides the ability to monitor the status of a UPS device connected to the Synology NAS. Please note that the available OIDs of the UPS MIB depends on what information is provided by the UPS device. If a UPS device does not provide data for a certain OID, that OID will not appear in the NMS software.
Table 8 shows a partial UPS MIB table only. If you are interested in all OIDs, please refer to the MIB file SYNOLOGY-UPS-MIB.txt.

Table 8. Partial UPS MIB

to Warning state (percent)
.3.12| upsBatteryType| Float| –| Battery chemistry

Synology Smart MIB

The Synology SMART MIB provides the SMART information of each disk same as Storage Manager does.
Because every disk may have different SMART attributes, one OID records one SMART attribute and has diskSMARTInfoDevName to indicate which disk it belongs to.

Table 9. SMART MIB

accessible
.2| diskSMARTInfoDevName| String| –| Describes the disk to which this SMART info belongs to
.3| diskSMARTAttrName| String| –| The name of the SMART info attribute, e.g. Raw_ReadError Rate
.4| diskSMARTAttrld| Integer| –| SMART attribute ID number
.5| diskSMARTAttrCurrent| Integer| –| SMART attribute current value
.6| diskSMARTAttrWorst| Integer| –| SMART attribute worst value
.7| diskSMARTAttrThreshold| Integer| –| SMART attribute threshold value
.8| diskSMARTAttrRaw| Integer| –| SMART attribute raw value
.9| diskSMARTAttrStatus| String| –| Status of this SMART info

Synology Services MIB

The Synology Services MIB monitors the number of users logging in via HTTP, CIFS, AFP, FTP, SFTP, TELNET, and SSH.

Table 10. Services MIB

accessible
.2| serviceName| String| –| The name of the service
.3| serviceUsers| Integer| –| The number of users using this service

Synology StorageIO MIB

The Synology StorageIO MIB has I/O information of disks.
Table 11. StorageIO MIB

accessible
.2| storage device| String| –| The name of the device we are counting/checking
.3| storagelONRead| Counter32| –| The number of bytes read from this device since boot
(32-bit VER.)
.4| storageIONWritten| Counter32| –| The number of bytes written to this device since boot
(32-bit VER.)
.5| storage reads| Counter32| –| The number of reading accesses
from this device since boot
.6| storageI0Writes| Counter32| –| The number of writes accesses to this device since boot
.7| storage lol| Integer| –| A load of disk (%)
.8| storageIOLA1| Integer| –| The 1-minute average load of the disk (%)
.10| storagelOLAS| Integer| –| The 5-minute average load of disk (%)
.11| storageIOLA15| Integer| –| A the-15 minute average load of the disk (%)
.12| storagelONReadX| Counter64| –| The number of bytes read from this device since boot
(64-bit VER.)
.13| storageIONWrittenX| Counter64| –| The number of bytes written to this device since boot (64-bit VER.)

Synology SpaceIO MIB

The Synology SpaceIO MIB has I/O information of volumes.

Table 12. space MIB

accessible
.2| spacer device| String| –| The name of the device this volume mounted on
.3| spacelONRead| Counter32| –| The number of bytes read from this volume since boot
(32-bit VER.)
.4| spaceIONWritten| Counter32| –| The number of bytes written to this volume since boot
(32 bit VER.)
---|---|---|---|---
.5| space reads| Counter32| –| The number of read accesses
from this volume since boot
.6| spaceI0Writes| Counter32| –| The number of write accesses to this volume since boot
.7| spacelOLA| Integer| –| A load of disk in the volume (%)
.8| Spacelab| Integer| –| The 1-minute average load of disk in the volume (%)
.10| spacelOLAS| Integer| –| The 5-minute average load of disk in the volume (%)
.11| spaceIOLA15| Integer| –| The 15-minute average load of the disk in the volume (%)
.12| spaceIONReadX| Counter64| –| The number of bytes read from this volume since boot
(64-bit VER.)
.13| spaceIONWrittenX| Counter64| –| The number of bytes written to this volume since boot
(64-bit VER.)

Synology FlashCache MIB

The Synology FlashCache MIB monitors the resource usage of the SSD cache. The collection frequency is 5 seconds.
Note: The MIB is only suitable for the model which supports SSD cache. Otherwise, it will return zero value for each OID path.

Table 13. FlashCache MIB

counting/ checking
.3| flashCacheSpaceDev| String| –| The space device name on flash cache we are counting/ checking
.4| flashCacheReadHits| Integer| –| The number of reads on flash cache
.5| flashCacheWriteHits| Counter64| –| The number of writes on flash cache
.6| flashCacheDiskRead| Counter64| –| The number of reads on the disk
.7| flashCacheDiskWrite| Counter64| –| The number of writes on disk
.8| flashCacheTotalRead| Counter64| –| The number of reads on volume with flash cache
.9| flashCacheTotalWrite| Counter64| –| The number of writes on volume with flash cache
.10| flashCacheReadHitRate| Integer| –| The read hit rate of flash cache (%)
.11| flashCacheWriteHitRate| Integer| –| The write hit rate of flash cache (%)
.12| flashCacheReadSeqSkip| Counter64| –| The number of skipped sequential reads on flash cache
.13| flashCacheWriteSeqSkip| Counter64| –| The number of skipped sequential reads on flash cache
.14| flashCacheWriteMissSsd| Counter64| –| The number of data writes to SSD for the first time
.15| flashCacheSsdUuid| String| –| The SSD UUID on flash cache we are counting/checking

Synology iSCSI LUN MIB

The Synology iSCSI LUN MIB can list all the loaded LUNs and show their running information. If a LUN has been created but not loaded (e.g. when linked to a target), it will not appear in this list. The throughput value may be over int32 range, so we use two i to record it.

Table 14. iSCSI LUN MIB

accessible
.2| iSCSILUNUUID| String| –| LUN uuid
.3| iSCSILUNName| String| –| LUN name
.4| iSCSILUNThroughputReadHigh| Integer| –| The higher 32 bit of read throughput
.5| iSCSILUNThroughputReadLow| Integer| –| The lower 32 bit of read throughput
.6| iSCSILUNThroughputWriteHigh| Integer| –| The higher 32 bit of write throughput
.7| iSCSILUNThroughputWriteLow| Integer| –| The lower 32 bit of write throughput
.8| iSCSILUNIopsRead| Integer| –| LUN read iops
.9| iSCSILUNIopsWrite| Integer| –| LUN write iops
.10| iSCSILUNDiskLatencyRead| Integer| –| LUN read disk latency
.11| iSCSILUNDiskLatencyWrite| Integer| –| LUN write disk latency
.12| iSCSILUNNetworkLatencyTx| Integer| –| LUN network tx latency
.13| iSCSILUNNetworkLatencyRx| Integer| –| LUN network rx latency
.14| iSCSILUNIoSizeRead| Integer| –| LUN read average i/o size
.15| iSCSILUNIoSizeWrite| Integer| –| LUN write average i/o size
.16| iSCSILUNQueueDepth| Integer| –| Number of iSCSI commands in LUN queue
.17| iSCSILUNType| String| –| LUN type (advanced lun, block lun, etc.)

Synology Ebox MIB

The Synology Ebox MIB provides the power status of the expansion unit connected to the Synology NAS. Table 14 shows the information provided in box MIB. Table 15 describes the content of each box power and eboxRedundantPower status in detail.

Table 15. Ebox MIB

the expansion unit (if the box has no redundant power interface, this OID will not appear)

• For eboxPower and eboxRedundantPower details, please see Table 15.

Table 16. Ebox Power and Redundant Power Status Explanation

Synology SHA MIB

The Synology SHA MIB provides basic cluster information and monitors cluster status and heartbeat status.

Table 17. SHA MIB

second
.8| heartbeatLatency| Integer| –| Heartbeat latency in microseconds (10A-6 seconds)

Table 17-1. Cluster Status Explanation * For cluster status details, please see Table 17-1.

• For heartbeat status details, please see Table 17-2.

Action should be taken to resume the High-Availability feature. Please refer to High-Availability Manager for more details.
critical (2)| The High-Availability cluster is in danger and should be resolved as soon as possible.
Please refer to High-Availability Manager for more details.
upgrading (3)| The High-Availability cluster is upgrading.
processing (4)| The High-Availability cluster is undergoing some operation.

Table 17-2. Heartbeat Status Explanation

passive server through the heartbeat interface, or it is currently in split- brain mode.
empty (3)| The High-Availability cluster has no passive server.

Useful OIDs

Although there are many native MIB files supported by Synology, users may be interested in specific information about the Synology NAS, such as CPU, memory and so on. The tables below list the native OIDs related to loading, CPU, memory, network and disk for gathering useful device’s data easily.

Table 18. CPU-Related OID

minute
.1.3.6.1.4.1.2021.10.1.5.2| laLoadInt.2| System load average within the last 5 minutes
.1.3.6.1.4.1.2021.10.1.5.3| laLoadInt.3| System load average within the last 15 minutes
.1.3.6.1.4.1.2021.11.9.0| ssCpuUser| The percentage of CPU time spent processing user-level code
.1.3.6.1.4.1.2021.11.10.0| ssCpuSystem| The percentage of CPU time spent processing system-level code, calculated over the last minute
.1.3.6.1.4.1.2021.11.11.0| ssCpuldle| The percentage of processor time spent idle, calculated over the last minute

Table 19. Memory-Related OID

configured for this host
.1.3.6.1.4.1.2021.4.4.0| memAvailSwap| The amount of swap space currently unused or available
.1.3.6.1.4.1.2021.4.5.0| memTotalReal| The total amount of real/physical memory
.1.3.6.1.4.1.2021.4.6.0| memAvailReal| The amount of real/physical memory currently unused or available
.1.3.6.1.4.1.2021.4.11.0| me total free| The total amount of memory free or available for use on this host (This value typically covers both real memory and swap space or virtual memory.)
.1.3.6.1.4.1.2021.4.13.0| memShared| The total amount of real or virtual memory currently allocated for use as shared memory
.1.3.6.1.4.1.2021.4.14.0| memBuffer| The total amount of real or virtual memory currently allocated for use as memory buffers
.1.3.6.1.4.1.2021.4.15.0| Memcached| The total amount of real or virtual memory currently allocated for use as cache memory

Table 20. Network-Related OID

the interface
.1.3.6.1.2.1.31.1.1.1.10| ifHCOutOctets| The total number of octets transmitted out of the interface

Table 21. Disk-Related OID

.1.3.6.1.2.1.25.2.3.1.3| hrStorageDescr| A description of the type and instance of the storage described by this entry
---|---|---
.1.3.6.1.2.1.25.2.3.1.4| hrStorageAllocationUnits| The size, in bytes, of the data
objects allocated from this pool
.1.3.6.1.2.1.25.2.3.1.5| hrStorageSize| The size of the storage represented by this entry, in units of hrStorageAllocationUnits
.1.3.6.1.2.1.25.2.3.1.6| hrStorageUsed| The amount of the storage
represented by this entry
.1.3.6.1.4.1.2021.13.15.1.1.2| diskI0Device| The name of the device we are counting/checking
.1.3.6.1.4.1.2021.13.15.1.1.12| disklONReadX| The number of bytes read from this device since boot
.1.3.6.1.4.1.2021.13.15.1.1.13| diskIONWrittenX| The number of bytes written to this device since boot
.1.3.6.1.4.1.6574.2| sync disk| For Synology disk information (Synology only)

Table 22. System-Related OID

only)

Table 23. Disk-Related OID

Table 24. RAID-Related OID

Table 25. UPS-Related OID

Monitor Specific OIDs

In any NMS, particular MIB files are needed in order to capture data through SNMP. Users need to import all MIB files to ensure that the NMS can resolve specific OIDs. Once imported, data can be captured by setting up the NMS. Although the means of operating different kinds of NMS may vary, the process of OID monitoring is similarThe overall procedure is as follows.

1.  Import MIB file into NMS.
2. Set up the NMS to monitor specific OIDs.

The following guide demonstrates the usage of PRTG (a type of NMS) including how to import MIB files and set up monitoring for the provided OIDs. For further help regarding PRTG, please consult PRTG documentation, as the following is only intended to be a brief description of OID monitoring.

Import MIB Files
As PRTG cannot import MIB files directly, Paessler MIB Importer is required to convert MIB files into the PRTG format:

1. Download Paessler MIB Importer from http://www.paessler.com/tools/mibimporter and install it on your computer.
2. Go to Import > MIB Files.
3. Choose all the Synology MIB file together and click Open File.

All MIB files (cf. Table 2) must be imported together as they are mutually dependent and Paessler MIB Importer cannot load them individually. If the import is successful, a window as shown in Figure 1 should appear. Detailed information is shown in Figure 2.

Figure 1. Import MIB: Successful

Figure 2. Detailed Information on MIB

4. Go to File > Save As to export to the PRTG-supported format.
A PRTG-supported library containing the MIB information will then be generated.

Set up the NMS
The PRTG-supported library containing the MIB files in question should be placed into the folder: “snmplibs”.
Once this has been done, specific OIDs can be set up for monitoring in PRTG. This guide assumes that your Synology NAS has already been added to the devices list and focuses only on how to add OIDs for monitoring.

1.   Enter the PRTG Network Monitor.

2. Go to Sensors > Add Sensor.
   

3. Click Add sensor to an existing device and choose a device.
   
   

4. Choose SNMP Library and the library exported in the previous section.
   

5. Select items for monitoring.
   

Document Revision History

This table describes the revisions made to Synology NAS MIB Guide.
Table 26. Document Revision History

Added useful OIDs in RAID MIB
2018-12-18| Added FlashCache MIB
2018-12-24| Added SHA MIB

Chapter 6: Document Revision History

© 2015-2019 Synology Inc. All rights reserved.

References

• Import MIB files into PRTG Network Monitor

Read User Manual Online (PDF format)

Download This Manual (PDF format)

Download this manual  >>