Skip to content

Latest commit

 

History

History
235 lines (192 loc) · 12.3 KB

README.md

File metadata and controls

235 lines (192 loc) · 12.3 KB
Raw

Synology M2 volume

Donate committers.top badge

Description

Easily create an M.2 volume on Synology NAS without a lot of typing and no need for any how-to guides. And you don't need Synology branded NVMe drives.

This script creates the RAID and storage pool on your NVMe drive(s) so you can then create the volume in the Storage Manager.

All you have to do is run the script and type yes and 1, 2, 3 or 4 to answer some simple questions. Then go to Storage Manager and select Create Volume.

It also allows you to create a storage pool/volume spanning internal NVMe drives and NVMe drives in a Synology M.2 PCIe card.

For Xpenology users the script supports an unlimited number of NVMe drives (except for RAID 1 and Basic).

Supports DSM 7 and later

For DSM 6 use v1 and run without the auto update option.

NEW in v2

  • Now shows "M.2 Drive #" the same as storage manager.
  • Now uses synostgpool command which allows the following: (Thanks to Severe_Pea_2128 on reddit)
    • Now supports JBOD, SHR, SHR2 and RAID F1.
    • Added choice of multi-volume or single-volume storage pool. Multi-volume allows overprovisioning.
    • Added option to skip drive check.
    • No longer need to reboot after running the script.
    • No longer need to do an online assemble.
  • Removed drive check progress as it was not possible with synostgpool.
    • You can see the drive check progress in Storage Manager.
  • Removed dry run mode as it was not possible with synostgpool.
  • Removed support for SATA M.2 drives.
    • If you have SATA M.2 drives use v1 and run without the auto update option.

RAID levels supported

RAID Level Min Drives Required Maximum Drives Script version
SHR 1 1 or more drives Unlimited v2 and later (DSM 7 only)
SHR 2 4 or more drives Unlimited v2 and later (DSM 7 only)
Basic 1 drive 1 drive all
JBOD 1 or more drives Unlimited v2 and later (DSM 7 only)
RAID 0 2 or more drives Unlimited all
RAID 1 2 or more drives 4 drives all
RAID 5 3 or more drives Unlimited all
RAID 6 4 or more drives Unlimited v1.3.15 and later
RAID 10 4 or more drives Unlimited v1.3.15 and later
RAID F1 3 or more drives Unlimited v2 and later (DSM 7 only)

If RAID F1 is selected the script enables RAID F1 on Synology models that don't officially support RAID F1.

Confirmed working on

Click here to see list
Model DSM version M.2 card Notes
All DSM 6 Use v1 run without auto update option
RS2423+ DSM 7.2-64570 Update 1
DS1823xs+ DSM 7.2-64561 M2D20
DS923+ DSM 7.2.1-69057 Update 5
DS923+ DSM 7.2.1-69057 Update 2
DS923+ DSM 7.1.1-42962 Update 5
DS723+ DSM 7.2.1-69057 Update 3
DS723+ DSM 7.2-64570 Update 1
DS723+ DSM 7.1.1-42962 Update 4
DS423+ DSM 7.2.1-69057 Update 3
DS423+ DSM 7.2-64570 Update 3
DS423+ DSM 7.1.1-42962 Update 4
DS3622xs+ DSM 7.2-64216 Beta E10M20-T1
DS3622xs+ DSM 7.1.1-42962 Update 1
DS2422+ DSM 7.2.1-69057 Update 4 E10M20-T1
DS1522+ DSM 7.2.1-69057 Update 4
DS1522+ DSM 7.2-64570
DS1522+ DSM 7.1.1-42962 Update 4
DS1821+ DSM 7.2.1-69057 Update 4 E10M20-T1 Also needs Synology enable_M2_card
DS1821+ DSM 7.2.1-69057 Update 4 M2D20 Also needs Synology enable_M2_card
DS1821+ DSM 7.2.1-69057 Update 4 M2D18 Also needs Synology enable_M2_card
DS1821+ DSM 7.2.1-69057 Update 4
DS1821+ DSM 7.2.1-69057 Update 3
DS1821+ DSM 7.2.1-69057 Update 2
DS1821+ DSM 7.2.1-69057 Update 1
DS1821+ DSM 7.2.1-69057
DS1821+ DSM 7.2-64570 Update 3
DS1821+ DSM 7.2-64570 Update 1 E10M20-T1 Also needs Synology enable_M2_card
DS1821+ DSM 7.2-64570 Update 1 M2D18 Also needs Synology enable_M2_card
DS1821+ DSM 7.2-64570 Update 1
DS1821+ DSM 7.2-64570
DS1821+ DSM 7.2-64561
DS1821+ DSM 7.2-64216 Beta
DS1821+ DSM 7.2-64213 Beta
DS1821+ DSM 7.1.1-42962 Update 4
DS1621+ DSM 7.2-64570 Update 1 E10M20-T1 Also needs Synology enable_M2_card
DS1621+ DSM 7.2-64570 Update 1
DS1621+ DSM 7.1.1-42962 Update 4
RS1221+ DSM 7.2-64570 Update 1 E10M20-T1
RS1221+ DSM 7.1.1 E10M20-T1
DS1520+ DSM 7.2.1-69057 Update 2
DS1520+ DSM 7.2-64570 Update 1
DS1520+ DSM 7.1.1-42962 Update 4
DS920+ DSM 7.2.1-69057 Update 5
DS920+ DSM 7.2.1-69057 Update 4
DS920+ DSM 7.2.1-69057 Update 3
DS920+ DSM 7.2.1-69057 Update 2
DS920+ DSM 7.2.1-69057 update 1
DS920+ DSM 7.2.1-69057
DS920+ DSM 7.2-64570 Update 1
DS920+ DSM 7.2-64561
DS920+ DSM 7.2-64216 Beta
DS920+ DSM 7.1.1-42962 Update 1
DS918+ DSM 7.2-64570 Update 3
RS820+ DSM 7.2-64570 Update 3 M2D20
DS720+ DSM 7.2.1-69057 Update 4
DS720+ DSM 7.2.1-69057 Update 3
DS720+ DSM 7.2.1-69057 Update 2
DS720+ DSM 7.2.1-69057 Update 1
DS720+ DSM 7.2.1-69057
DS720+ DSM 7.2-64570 Update 3
DS720+ DSM 7.2-64570 Update 1
DS720+ DSM 7.2-64570
DS720+ DSM 7.2-64561
DS720+ DSM 7.2-64216 Beta
DS420+ DSM 7.2-64570 Update 1
DS1819+ DSM 7.2-64216 Beta M2D20
DS1819+ DSM 7.1.1 M2D20
DS1019+ DSM 7.2.1-69057 Update 2
DS1019+ DSM 7.2-64561
DS1019+ DSM 7.1.1-42962 Update 4
DS1618+ DSM 7.1.1 M2D18
DS918+ DSM 7.2.1-69057 Update 5
DS918+ DSM 7.2-64561
DS918+ DSM 7.1.1
DS3617xs DSM 7.2-64570 M2D20

Important

If you later update DSM and your M.2 drives are shown as unsupported and the storage pool is shown as missing, and online assemble fails, you need to run the Synology_HDD_db script. The Synology_HDD_db script should run after every DSM update.

Download the script

  1. Download the latest version Source code (zip) from https://github.com/007revad/Synology_M2_volume/releases
  2. Save the download zip file to a folder on the Synology.
  3. Unzip the zip file.

To run the script via SSH

How to enable SSH and login to DSM via SSH

sudo -s /volume1/scripts/syno_create_m2_volume.sh

Note: Replace /volume1/scripts/ with the path to where the script is located.

Troubleshooting

If the script won't run check the following:

  1. If the path to the script contains any spaces you need to enclose the path/scriptname in double quotes: 
    sudo -s "/volume1/my scripts/syno_create_m2_volume.sh"
  2. Make sure you unpacked the zip or rar file that you downloaded and are trying to run the syno_create_m2_volume.sh file.
  3. Set the syno_create_m2_volume.sh file as executable: 
    sudo chmod +x "/volume1/scripts/syno_create_m2_volume.sh"

Options:

  -a, --all        List all M.2 drives even if detected as active
  -s, --steps      Show the steps to do after running this script
  -h, --help       Show this help message
  -v, --version    Show the script version

What to do after running the script

  1. Create the volume as you normally would:
    • Select the new Storage Pool > Create > Create Volume.
    • Set the allocated size.
      • Optionally enter a volume description. Be creative :)
    • Click Next.
    • Select the file system (Btrfs or ext4) and click Next.
    • Optionally enable Encrypt this volume and click Next.
      • Create an encryption password or enter your existing encryption password.
    • Confirm your settings and click Apply to finish creating your M.2 volume.
  2. Optionally enable and schedule TRIM:
    • Storage Pool > ... > Settings > SSD TRIM
    • Note: DSM 7.1.1. has no SSD TRIM setting for M.2 storage pools
    • Note: DSM 7.2 Beta has no SSD TRIM setting for M.2 RAID 0 or RAID 5

How to repair a NVMe storage pool or upgrade to larger drives

DSM 7 screen shots

Create SHR Storage Pool

Create Volume

Volume description

Allocate volume capacity

Select file system

Success!

Enable TRIM