Synology Query Help

Overview

Precursor Systems Synology Query is an tool to interact with the Synology Disk Station Manager (DSM) via its API. It can report on:

• DEVICE INFO (Model Name, Serial Number, RAM, I.P. Address, OS Version, Uptime)
• DISK HEALTH (Total Capacity, Used Space, Percentage of Space Used, Number of Disks, RAID Config)
• DRIVESHARE STATUS (Sync Server, Sync Status, Synced Folders)

Before using the Get Device Info button you will want to add your organizations devices. You will need to supply:

• The full name of the company or organization AND its nickname (or short name)
• The devices URL (e.g. mydevice.example.com or 192.168.1.x)
• The Port number of the device (e.g. 5001, 443, etc.)
• The Admin's User Name
• The Admin's password
• The OTP Secret from the 2FA URL

If you have MBS Plugin and have supplied the OTP Secret all device info will be gathered automatically. Otherwise, you will use the above information to get the SID session code by adding in your 2FA / OTP passcode manually.

Help

Brings you to this Help page.

Devices

Brings you to the Devices query page that gets all the device information.

Listings

Brings you to the Listings page to view based information at a glance. (Note: Full details are available on the Devices pages.)

API Docs

Takes you to the Synology DSM API documentation page.

Get Devices

Before using the Get Device Info button on the home page you will want to add your organizations devices. In the top half of the page, you will need to supply:

1. The full name of the company or organization AND its nickname (or short name)
2. The devices URL (e.g. mydevice.example.com or 192.168.1.x)
3. The Port number of the device (e.g. 5001, 443, etc.)
4. The Admin's User Name
5. The Admin's password
6. The OTP Secret from the 2FA URL. (NB. This requires the MBS Plugin from Monkey Bread Software.)
7. You will need to click the "Yes" button for orgENABLE for each FileMaker record.

If you have MBS Plugin you can skip the following section on manually getting your sessions code and proceed to Get Device Info.

You will use the above information to get the SID session code by adding in your 2FA / OTP password.

To get the Session Code (SID), Click the "Get Session ID" button and add your current 2FA/OTP code from your autheticator app.

Once you have an SID you will be able to click any of the blue buttons to get information about the device listed in this record.

• Get Device Info: supplies basic info like serial number and RAM.
• Get Network Info: supplies the LAN address of the Disk Station.
• Get RAID Info: supplies the size of the disk/array, the number of disks involved, the redundancy factor and the current percentage of disk usage.
• Get DriveShare Info: supplies information about the status of an off-site clone set up with Synology DriveShare including its status and what Team (shared) Folders are being synced.

Listings

You can review summary information from all the devices here.

Get All Device Info

If you have filled out all the devices' authentication info and yo uhave the MBS plugin installed then clicking this button will get the session code and the info for each device. (Otherwise you will have to manually add in OTP codes using the method described above.)

Delete All Devices Status

Once you have all the info it will take you to the Listings page. If you want to refresh you should delete the status info first using the "Delete All Devices Status" button on the home page.

Troubleshooting

1 Note: this does not work through QuickConnect. You devices must be reachable through LAN or WAN directly (or through reverse proxy) with a valid commercial or LetsEncrypt SSL certificate. It is assumed that all your devices are set up as HTTPS and have 2FA enabled. You will need to supply the i.p. Address, the admin username and password, and a Session ID (SID) that you obtain with the ip/username/pw and a valid 2FA/OTP code.

Frequently Asked Questions

Q: Does this solution require Claris FileMaker?

A: Yes. You could use the 45 day trial version, but if you are member of the Apple Consultants Network your member benefits include an NFR copy. You also may be able to get an NFR by attending Claris Engage, or by becoming a Claris Partner.

Resources

For more help consult:

• FileMaker cURL Options (Claris): https://support.claris.com/s/article/new-curl-options-in-insert-from-url?language=en_US
• FileMaker 19 New cURL Options (Claris): https://support.claris.com/s/article/FileMaker-Pro-19-New-cURL-options?language=en_US
• Parsing JSON (Soliant): https://www.soliantconsulting.com/blog/parsing-json-filemaker-16/
• Going API with FileMaker (MacTech Conference L.A. - 2019): https://www.youtube.com/watch?v=ZRPJ4KW-h9E