/Synology_M2_volume

Easily create an M.2 volume on Synology NAS

Primary LanguageShellMIT LicenseMIT

Synology M2 volume

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.

  • DSM 7 This script creates the RAID and storage pool on your NVMe drive(s) so you can then create the volume in the DSM GUI.
  • DSM 6 This script creates the RAID, storage pool and volume on your NVMe drive(s) for you.

All you have to do is run the script and type yes and 1, 2, 3 or 4 to answer some simple questions. Then reboot, go to Storage Manager, Online Assemble and 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 for RAID 0, 5, 6 and 10.

RAID levels supported:

RAID Level Drives Required Maximum Drives
Single 1 drive 1 drive
RAID 0 2 or more drives Unlimited
RAID 1 2 or more drives 4 drives
RAID 5 3 or more drives Unlimited
RAID 6 4 or more drives Unlimited
RAID 10 4 or more drives Unlimited

Confirmed working on:

Model DSM version M.2 card Notes
RS2423+ DSM 7.2-64570 Update 1
DS1823xs+ DSM 7.2-64561 M2D20
DS923+ DSM 7.1.1-42962 Update 5
DS723+ DSM 7.2-64570 Update 1
DS723+ DSM 7.1.1-42962 Update 4
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
DS1522+ DSM 7.2-64570
DS1522+ DSM 7.1.1-42962 Update 4
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 M2D18 Needs Synology HDD db
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
DS1821+ DSM 6.2.4-25556 Update 7
DS1621+ DSM 7.2-64570 Update 1 E10M20-T1 Needs Synology HDD db
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-64570 Update 1
DS1520+ DSM 7.1.1-42962 Update 4
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
DS920+ DSM 6
RS820+ DSM 7.2-64570 Update 3 M2D20
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
DS720+ DSM 6.2.4
DS420+ DSM 7.2-64570 Update 1
DS1819+ DSM 7.2-64216 Beta M2D20
DS1819+ DSM 7.1.1 M2D20
DS1019+ DSM 7.2-64561
DS1019+ DSM 7.1.1-42962 Update 4
DS1618+ DSM 7.1.1 M2D18
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

See How to download the script for the easiest way to download the script.

Video guide

Vikash has created a step by step YouTube video here: https://www.youtube.com/watch?v=sclQprHsXQE

To run the script

sudo -i /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 -i "/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

It also has a dry run mode so you can see what it would have done had you run it for real.

What to do after running the script

DSM 7

  1. Restart the Synology NAS.
  2. Go to Storage Manager and select Online Assemble:
    • Storage Pool > Available Pool > Online Assemble
  3. 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.
  4. 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

DSM 6

  1. Restart the Synology NAS.

DSM 7 screen shots

Storage Pool available for Online Assemble

Online Assemble step 1

Online Assemble step 2

Create Volume

Allocate volume capacity

Volume description

Select file system

Success!

Enable TRIM