Synology HDD DB

https://github.com/007revad/synology_hdd_db
Admin
A script that allows users to add various drive types (HDDs, SSDs, NVMe M.2) to Synology's...
Tokens:46,325
Snippets:356
Trust Score:9.6
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### install_binfile function

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-platform-functions.md

Installs a dependency file either from a bundled path or by downloading and verifying its MD5 hash. Exits with status 1 on hash mismatch or user decline. Downloads with curl -kL -m 30 --connect-timeout 5.

```bash
install_binfile(){
    # install_binfile <file> <file-url> <destination> <chmod> <bundled-path> <hash>
    # example:
    #  file_url="https://raw.githubusercontent.com/${repo}/main/bin/dtc"
    #  install_binfile dtc "$file_url" /usr/bin/dtc a+x bin/dtc
    # 1. use bundled "${scriptpath}/<bundled-path>" (or its basename in scriptpath) if present
    # 2. else download to /tmp/<file>; verify md5 == "$6"
    #    (prompt unless autoupdate=yes or is_schedule_running)
    #    mismatch -> "ERROR Downloaded <file> md5 hash does not match!" + exit 1
    #    declined -> "ERROR Cannot add M2 PCIe card without <file>!" + exit 1
    # 3. chmod "$4"; cp -p "$binfile" "$3"
}
```

--------------------------------

### Install telnet via Homebrew

Source: https://github.com/007revad/synology_hdd_db/blob/main/2025_plus_models.md

Install telnet on a Mac using Homebrew after Homebrew is installed.

```bash
brew install telnet
```

--------------------------------

### Boot-up command for syno_hdd_db.sh

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/configuration.md

Example command to run syno_hdd_db.sh at boot-up with the -nr flag and autoupdate set to 3. The script detects scheduled execution via detect_scheduler and is_schedule_running to suppress interactive prompts; add -e for color-free scheduler emails.

```bash
/volume1/scripts/syno_hdd_db.sh -nr --autoupdate=3
```

--------------------------------

### Install Homebrew on Mac

Source: https://github.com/007revad/synology_hdd_db/blob/main/2025_plus_models.md

Install Homebrew on a Mac if it is not already installed, as a prerequisite for installing telnet.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

--------------------------------

### get_vid — resolve NVMe vendor id

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-drive-discovery-functions.md

Takes an NVMe device node as $1. Uses nvme id-ctrl to get the vendor id, then looks it up in $vidfile. If not found, chains vendor_from_id and set_vendor.

```bash
get_vid(){
    # $1 is /dev/nvme0n1 etc
    vid=$(nvme id-ctrl "$1" | grep -E ^vid | awk '{print $NF}')
    if [[ $vid ]]; then
        val=$(/usr/syno/bin/synogetkeyvalue "$vidfile" "${vid,,}")
        if [[ -z $val ]]; then
            vendor_from_id "$vid" && set_vendor
        fi
    fi
}
```

--------------------------------

### Bypass install check in virtual machine

Source: https://github.com/007revad/synology_hdd_db/blob/main/2025_plus_models.md

Use this command instead of the single touch command when DSM is running in a virtual machine, to continuously bypass the installable check.

```bash
while true; do touch /tmp/installable_check_pass; sleep 1; done
```

--------------------------------

### Bypass DSM 7.2.2 install check on 2025 Plus models

Source: https://github.com/007revad/synology_hdd_db/blob/main/2025_plus_models.md

Execute this command in the telnet session to bypass the installable check when setting up a 2025 or later Plus model with only unverified HDDs.

```bash
touch /tmp/installable_check_pass
```

--------------------------------

### wait_status - Wait for package to reach expected state

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-shutdown.md

Polls package_status every 1 second up to 20 times until the expected state (0=started or 1=stopped) is observed. Breaks after 20 polls. Parameters: $1 is package name, $2 is 'start' or 'stop'.

```bash
wait_status(){
    # Wait for package to finish stopping or starting
    # $1 is package
    # $2 is start or stop
    # polls package_status every 1s up to 20 times until the expected state
    # (0=started / 1=stopped) is observed; breaks after 20 polls
}
```

--------------------------------

### package_status - Normalize synopkg status codes

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-shutdown.md

Returns a normalized status code for a Synology package by calling synopkg status. Maps DSM-specific exit codes to a stable contract: 0=started, 1=stopped, 255=not installed, 150=broken. Passes through any other code.

```bash
package_status(){
    # $1 is package name
    /usr/syno/bin/synopkg status "${1}" >/dev/null
    code="$?"
    # DSM 7.2       0 = started, 17 = stopped, 255 = not_installed, 150 = broken
    # DSM 6 to 7.1  0 = started,  3 = stopped,   4 = not_installed, 150 = broken
    if [[ $code == "0" ]]; then
        return 0
    elif [[ $code == "17" ]] || [[ $code == "3" ]]; then
        return 1
    elif [[ $code == "255" ]] || [[ $code == "4" ]]; then
        return 255
    elif [[ $code == "150" ]]; then
        return 150
    else
        return "$code"
    fi
}
```

--------------------------------

### edit_modeldtb — syno_hdd_db.sh:2191

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-platform-functions.md

Patches the model.dtb file for device-tree models. Ensures dtc is installed (installs from bin/dtc with pinned MD5 01381dabbe86e13a2f4a8017b5552918 if missing), decompiles to dts, appends nodes via dts_m2_card, recompiles, and copies to /etc/model[_{hw_revision}].dtb. Sets rebootmsg=yes.

```bash
edit_modeldtb(){
    # $1 is E10M20-T1 or M2D20 or M2D18 or M2D17
    if [[ -f /etc.defaults/model.dtb ]]; then  # Is device tree model
        # ensure dtc exists+executable; else install_binfile dtc "<raw.githubusercontent url>" \
        #     /usr/sbin/dtc "a+x" bin/dtc "01381dabbe86e13a2f4a8017b5552918"
        # backupdb "$dtb_file" long
        # dtc -q -I dtb -O dts -o "$dts_file" "$dtb_file"
        # for each card in cards[]: dts_m2_card if ! grep -q "$c" "$dtb_file"
        # dtc -q -I dts -O dtb -o "$dtb_file" "$dts_file"
        # chmod a+r; chown root:root; cp -pu "$dtb_file" "$dtb2_file"
        # rebootmsg=yes
    fi
}
```

--------------------------------

### Create /opt directory with sudo mkdir

Source: https://github.com/007revad/synology_hdd_db/blob/main/2025_plus_models.md

Creates the /opt directory with permissions 775 using sudo. This is the first step in the SSH method.

```bash
sudo mkdir /opt && sudo chmod 775 /opt
```

--------------------------------

### backupdb - Backup database file if needed

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-db-functions.md

Backs up a database file, creating a .bak and .bakver. Returns 1 for non-existent files, otherwise 0 on success. Callers handle failure fatally.

```bash
backupdb(){
    # Backup database file if needed
    # $1 = file; $2 = "long" (full path in messages) or short (default)
    local bakversion newversion fname
    [[ -z "$1" || ! -f "$1" ]] && return 1  # Don't try to backup non-existent files
    # sanitize_smart_quotes for *.db / *.db.new
    # creates "$1.bak"; for *.db files mirrors "$1.version" -> "$1.bakver"
    # re-backs-up when the current .version is newer than .bakver
    # chmod 644 on the source file
    return 0
}
```

--------------------------------

### Basic script execution

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db.md

Run the script with the commonly recommended option set.

```bash
sudo -s /volume1/scripts/syno_hdd_db.sh -nr
```

--------------------------------

### Create /opt directory with -m775

Source: https://github.com/007revad/synology_hdd_db/blob/main/2025_plus_models.md

Creates the /opt directory with permissions 775 in a single command. This is an alternative to the previous command.

```bash
sudo mkdir -m775 /opt
```

--------------------------------

### Run syno_hdd_db.sh

Source: https://github.com/007revad/synology_hdd_db/blob/main/2025_plus_models.md

Runs the syno_hdd_db.sh script as root. No options are needed at this point.

```bash
sudo -s /opt/syno_hdd_db.sh
```

--------------------------------

### Download syno_hdd_vendor_ids.txt to /opt

Source: https://github.com/007revad/synology_hdd_db/blob/main/2025_plus_models.md

Downloads the syno_hdd_vendor_ids.txt file from the GitHub repository to /opt using curl.

```bash
sudo curl -O "https://raw.githubusercontent.com/007revad/Synology_HDD_db/refs/heads/main/syno_hdd_vendor_ids.txt"
```

--------------------------------

### usage — syno_hdd_db.sh:56

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-platform-functions.md

Prints the option help text (-h|--help), and is also the fallback branch when getopt fails. Exits 0 (not an error exit).

```bash
usage(){
    cat <<EOF
$script $scriptver - by 007revad

Usage: $(basename "$0") [options]
...
EOF
    exit 0
}
```

--------------------------------

### Run script with --showedits flag

Source: https://github.com/007revad/synology_hdd_db/blob/main/README.md

Execute the script with the --showedits flag to view modifications made to the compatible-drive database.

```YAML
sudo -s /path-to-script/syno_hdd_db.sh -nr --showedits
```

--------------------------------

### Command-line options for synology_hdd_db.sh

Source: https://github.com/007revad/synology_hdd_db/blob/main/README.md

A list of available flags and arguments for configuring the script's behavior, such as disabling compatibility checks or enabling specific hardware support.

```YAML
  -s, --showedits       Show edits made to <model>_host db and db.new file(s)
  -n, --noupdate        Prevent DSM updating the compatible drive databases
                        Always use this option unless you need to update
                        firmware on Synology drives
  -r, --ram             Disable memory compatibility checking (DSM 7.x only)
                        and sets max memory to the amount of installed memory
  -f, --force           Force DSM to not check drive compatibility
                        Do not use this option unless absolutely needed
                        Do not use this option with DSM 7.4
  -i, --incompatible    Change incompatible drives to supported
                        Do not use this option unless absolutely needed
  -w, --wdda            Disable WD Device Analytics to prevent DSM showing
                        a false warning for WD drives that are 3 years old
                          DSM 7.2.1 and later already has WDDA disabled
  -p, --pcie            Enable creating volumes on M2 in unknown PCIe adaptor
  -e, --email           Disable colored text in output scheduler emails
  -S, --ssd=DRIVE       Enable write_mostly on internal HDDs so DSM primarily 
                        reads from internal SSDs or your specified drives
                          -S automatically sets internal SSDs as DSM preferred
                          --ssd=DRIVE requires the fast drive(s) as argument,
                          or restore as the argument to reset drives to default
                          --ssd=sata1 or --ssd=sata1,sata2 or --ssd=sda etc
                          --ssd=restore
      --restore         Undo all changes made by the script (except -S --ssd)
                        To restore all changes including write_mostly use
                          --restore --ssd=restore
      --autoupdate=AGE  Auto update script (useful when script is scheduled)
                          AGE is how many days old a release must be before
                          auto-updating. AGE must be a number: 0 or greater
  -I, --ihm             Update IronWolf Health Management to 2.5.1 to support
                        recent model IronWolf and IronWolf Pro drives.
                        For NAS with x86_64 CPUs only.
                        Also installs IHM on '22 series and newer models (untested)
      --reboot          Reboot after a DSM update when build number has changed
                        Only works if script is running from a boot-up schedule
                        Only needed if NVMe volume or PCIe card need a 2nd 
                        reboot after DSM update
  -h, --help            Show this help message
  -v, --version         Show the script version
```

--------------------------------

### Create syno_hdd_reboot.txt state file

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/configuration.md

Creates the state file syno_hdd_reboot.txt if it does not exist, writes a warning message, and stores the current DSM build number under the key dsm_build. The --reboot option later uses this value to detect DSM updates.

```bash
reboot_file="${scriptpath}/syno_hdd_reboot.txt"
if [[ ! -f "$reboot_file" ]]; then
    echo "Do NOT delete this file!" > "$reboot_file"
    echo "It is used to track if DSM has updated." >> "$reboot_file"
    /usr/syno/bin/synosetkeyvalue "$reboot_file" dsm_build "$buildnumber"
fi
```

--------------------------------

### set_vendor — add missing vendor to pci_vendor_ids.conf

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-drive-discovery-functions.md

Reads globals vendor, vid, vidfile, vidfile2. Appends 0x…="Vendor" entries to /usr/syno/etc.defaults/pci_vendor_ids.conf and /usr/syno/etc/pci_vendor_ids.conf. Echoes success or failure to stderr.

```bash
set_vendor(){
    # Add missing vendors to /usr/syno/etc.defaults/pci_vendor_ids.conf
    if [[ $vendor ]]; then
        # synosetkeyvalue "${vid,,}" "$vendor" into $vidfile and $vidfile2,
        # and re-writes short ids with a leading zero (0x5dc -> 0x05dc)
    fi
}
```

--------------------------------

### Download syno_hdd_db.sh to /opt

Source: https://github.com/007revad/synology_hdd_db/blob/main/2025_plus_models.md

Downloads the syno_hdd_db.sh script from the GitHub repository to /opt using curl.

```bash
sudo curl -O "https://raw.githubusercontent.com/007revad/Synology_HDD_db/refs/heads/main/syno_hdd_db.sh"
```

--------------------------------

### Function template for all drive discovery functions

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-drive-discovery-functions.md

Shows the common structure of all functions in this file: a function name, opening brace, and positional parameters documented in comments. Parameters are positional strings with no named arguments or defaults.

```bash
function_name(){
    # positional parameters documented per-function, e.g.:
    # $1 is /sys/block/sata1 etc
}
```

--------------------------------

### Advanced configuration execution

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db.md

Run with specific SSD preferences, disable WDDA, and skip drive-db auto-updates.

```bash
sudo -s "/volume1/scripts/syno_hdd_db.sh" -n -w --ssd=sata1,sata2
```

--------------------------------

### enable_card — syno_hdd_db.sh:1972

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-platform-functions.md

Enables a PCIe M.2 card by editing adapter_cards.conf. Backs up the config, sets the model key to 'yes' in the specified section, and sets rebootmsg=yes on success. Errors with 'ERROR 9 Failed to enable $3 for ${modelname}!' on failure. Converts 'RP' to 'rp' in the model name to match DSM's lower-case keys.

```bash
enable_card(){
    # $1 is the file
    # $2 is the section
    # $3 is the card model and mode
    if [[ -f $1 && -n $2 && -n $3 ]]; then
        backupdb "$adapter_cards" long
        backupdb "$adapter_cards2" long
        # error if "^\['"$2"'\]$" section missing
        # if get_section_key_value "$1" "$2" "$modelrplowercase" != "yes":
        #     set_section_key_value "$1"  "$2" "$modelrplowercase" yes
        #     set_section_key_value "$2.file" "$2" "$modelrplowercase" yes
        #     "ERROR 9 Failed to enable $3 for ${modelname}!" on failure
        # else "already enabled"
    fi
}
```

--------------------------------

### skip_dev_tools function (syno_hdd_shutdown.sh:267)

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-shutdown.md

Checks if a package should be skipped based on its INFO file. Returns 0 if startable or ctl_stop is 'no', indicating a dev tool with no data, otherwise 1. Takes the package name as $1.

```bash
skip_dev_tools(){
    # $1 is $package
    skip1="$(synogetkeyvalue "/var/packages/${package}/INFO" startable)"
    skip2="$(synogetkeyvalue "/var/packages/${package}/INFO" ctl_stop)"
    if [[ $skip1 == "no" ]] || [[ $skip2 == "no" ]]; then
        return 0
    else
        return 1
    fi
}
```

--------------------------------

### Script execution with edits and auto-update

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db.md

Show database edits and enable a scheduled-task-friendly auto-update.

```bash
sudo -s /volume1/scripts/syno_hdd_db.sh -nr --showedits --autoupdate=3
```

--------------------------------

### stop_packages function (syno_hdd_shutdown.sh:237)

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-shutdown.md

Stops a package, logs it, and handles ContainerManager/Docker. Returns 1 if the package is still running after the stop sequence, otherwise 0. Appends the package name to syno_hdd_shutdown.log and runs killall containerd-shim for ContainerManager/Docker.

```bash
stop_packages(){
    # Check package is running (package_is_running "$pkg")
    # package_stop "$pkg" "$pkg_name"
    # if still running after stop -> "ERROR Failed to stop ${pkg_name}!" + return 1
    # else append "$pkg" to $shutdown_log
    # if pkg is ContainerManager or Docker -> killall containerd-shim
}
```

--------------------------------

### Set permissions on syno_hdd_db.sh

Source: https://github.com/007revad/synology_hdd_db/blob/main/2025_plus_models.md

Sets the executable permission on /opt/syno_hdd_db.sh to 750.

```bash
sudo chmod 750 /opt/syno_hdd_db.sh
```

--------------------------------

### scriptversion — syno_hdd_db.sh:105

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-platform-functions.md

Prints version banner (-v|--version). Exits 0.

```bash
scriptversion(){
    cat <<EOF
$script $scriptver - by 007revad

See https://github.com/$repo
EOF
    exit 0
}
```

--------------------------------

### compactdb - Compact database file to one line

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-db-functions.md

Rewrites pretty-printed JSON to one compact line using jq -c. Used in the chain backupdb && compactdb && check_and_merge_dupes && updatedb.

```bash
compactdb(){
    # Compact database file if needed
    # DSM 7.3+ / pretty-print files are detected by (grep ': ' && grep ', ') or > 1 line
    cp -p "$1" "$1.tmp" && jq -c . "$1.tmp" > "$1" && chmod 644 "$1" && rm "$1.tmp"
    # re-check; failure -> "ERROR Failed to compact <name>!" + return 1
}
```

--------------------------------

### package_stop - Stop a package with progress and error handling

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-shutdown.md

Stops a Synology package using synopkg stop with a 30-minute timeout, displays a progress bar, and waits for the package to fully stop. Uses progbar and progstatus for feedback and error handling.

```bash
package_stop(){
    # $1 is package name
    # $2 is package display name
    timeout 30m /usr/syno/bin/synopkg stop "$1" >/dev/null &
    pid=$!
    string="Stopping ${2}"
    progbar "$pid" "$string"
    wait "$pid"
    progstatus "$?" "$string" "line ${LINENO}"
    wait_status "$1" stop &
    pid=$!
    string="Waiting for ${2} to stop"
    progbar "$pid" "$string"
    wait "$pid"
    progstatus "$?" "$string" "line ${LINENO}"
}
```

--------------------------------

### Parse drive tuple fields

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/types.md

Extracts model, firmware, and size from a comma-separated drive tuple string using cut.

```bash
hdmodel=$(printf "%s" "$1" | cut -d"," -f 1)
fwrev=$(printf "%s" "$1" | cut -d"," -f 2)
size_gb=$(printf "%s" "$1" | cut -d"," -f 3)
```

--------------------------------

### Change directory to /opt

Source: https://github.com/007revad/synology_hdd_db/blob/main/2025_plus_models.md

Changes the current directory to /opt, with a fallback message and exit if it fails.

```bash
cd /opt || (echo "Failed to CD to /opt"; exit 1)
```

--------------------------------

### Scheduled task execution

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db.md

Run the script at boot with ANSI color escapes disabled for scheduler emails.

```bash
/volume1/scripts/syno_hdd_db.sh -nr --autoupdate=3 -e
```

--------------------------------

### Argument parsing with getopt

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db.md

The script uses getopt to handle command-line options. Note that --noupdate is documented but rejected by getopt, requiring the use of -n or --nodbupdate instead.

```bash
args=("$@")                                                              # syno_hdd_db.sh:116
if options="$(getopt -o SIabcdefghijklmnopqrstuvwxyz0123456789 -l \
    ssd:,ihm,restore,showedits,nodbupdate,m2,force,incompatible,ram,pcie,wdda,email,autoupdate:,reboot,help,version,debug -- "$@")"; then
    eval set -- "$options"
    # ...case dispatch sets global variables, then:
    #     --)  shift; break                                    (line 196)
    #     *)   echo -e "Invalid option '$1'\n"; usage "$1"     (line 199–203)
else
    echo
    usage
fi
```

--------------------------------

### Shipped content of syno_hdd_vendor_ids.txt

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/configuration.md

The default vendor ID mappings shipped with the script. Each line maps a hexadecimal vendor ID to a vendor name. The script reads this file as a synogetkeyvalue key-value file.

```text
0x025e="Solidigm"       0x05dc="Lexar"         0x0ed1="aigo"         0x10ec="TEAMGROUP"
0x137e="Patriot"        0x1458="Gigabyte"      0x1462="MSI"          0x196e="PNY"
0x1987="Phison"         0x1b1c="Corsair"       0x1bdc="Apacer"       0x1c5c="SK Hynix"
0x1cc4="UMIS"           0x1cfa="Corsair"       0x1d79="Transcend"    0x1dbe="ADATA"
0x1e0f="KIOXIA"         0x1e49="ZHITAI"        0x1e4b="FIKWOT"       0x1f40="Netac"
```

--------------------------------

### Reset write-mostly on internal drives

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-platform-functions.md

Runs the script with the ssd restore flag to reset the write-mostly configuration on all internal drives.

```bash
sudo -s /volume1/scripts/syno_hdd_db.sh --ssd=restore
```

--------------------------------

### Run as Scheduled Task

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-shutdown.md

Execute the script as a root user-defined task within the Synology Task Scheduler.

```bash
/volume1/scripts/syno_hdd_shutdown.sh
```

--------------------------------

### find_eunit_db_files function - syno_hdd_db.sh:1448

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-drive-discovery-functions.md

Finds database files for expansion-unit model families, allowing Synology's '_v7' and space-delimited filename suffixes while preventing model family cross-matching (e.g., RX1217 does not match RX1217RP or RX1217SAS). Outputs unique matches.

```bash
find_eunit_db_files(){
    # Match an exact expansion-unit model family while allowing Synology's
    # "_v7" and space-delimited filename suffixes. Do not let RX1217 also
    # select RX1217RP or RX1217SAS.
    local db_dir="$1"
    local extension="$2"
    shift 2
    for eunit in "$@"; do
        find "$db_dir" -maxdepth 1 -type f \
            \( -name "${eunit,,}${extension}" \
            -o -name "${eunit,,}_*${extension}" \
            -o -name "${eunit,,} *${extension}"\)
    done | sort -u
}
```

--------------------------------

### Connect to Synology via telnet

Source: https://github.com/007revad/synology_hdd_db/blob/main/2025_plus_models.md

Use this command in a telnet client (PowerShell, PuTTY, Terminal) to connect to the Synology NAS. Replace <NAS-IP> with the NAS's IP address.

```bash
telnet <NAS-IP>
```

--------------------------------

### fixdrivemodel — normalize drive model string (syno_hdd_db.sh:1041)

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-drive-discovery-functions.md

Normalizes a raw drive model read from /sys/block/<dev>/device/model by removing a trailing " 00Y" from Samsung/Lenovo SSDs and stripping brand prefixes (WDC, HGST, TOSHIBA, HCST, Hitachi, SAMSUNG, FUJISTU, APPLE HDD) plus leading whitespace. Sets the global hdmodel; leaves it unchanged when no rule matches. The required parameter $1 is the raw model string.

```bash
fixdrivemodel(){
    # Remove " 00Y" from end of Samsung/Lenovo SSDs  # Github issue #13
    # Strip "BRAND " prefixes: WDC, HGST, TOSHIBA, HCST (issue #389), Hitachi,
    # SAMSUNG, FUJISTU, "APPLE HDD "; then trim leading whitespace
}
```

--------------------------------

### Restore script changes

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db.md

Restore everything the script changed, including write-mostly state.

```bash
sudo -s /volume1/scripts/syno_hdd_db.sh --restore --ssd=restore
```

--------------------------------

### package_is_running - Check if package is running

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-shutdown.md

Returns the exit status of synopkg is_onoff for the given package. A status of 0 indicates the package is running.

```bash
package_is_running(){
    # $1 is package name
    /usr/syno/bin/synopkg is_onoff "${1}" >/dev/null
    return "$code"
}
```

--------------------------------

### get_size_gb — syno_hdd_db.sh:1073

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-drive-discovery-functions.md

Queries synodisk for total capacity and rounds the size in GB down to a multiple of 4. Expects $1 to be a /sys/block path like /sys/block/sata1 or /sys/block/nvme0n1; sets global disk_size_gb.

```bash
get_size_gb(){
    # $1 is /sys/block/sata1 or /sys/block/nvme0n1 etc
    disk_size_gb=$(/usr/syno/bin/synodisk --info /dev/"$(basename -- "$1")" 2>/dev/null | \
        grep 'Total capacity' | awk '{gb = $4 * 1.073741824; printf "%d\n", int(gb / 4 + 0.5) * 4}')
}
```

--------------------------------

### Parse --trace option in syno_hdd_shutdown.sh

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-shutdown.md

Checks for the optional --trace or -t flag before the main flow, enabling trace lines in progstatus/package_* functions.

```bash
if [[ $1 == "--trace" ]] || [[ $1 == "-t" ]]; then
    trace="yes"
fi
```

--------------------------------

### Download and extract Synology HDD DB script via SSH

Source: https://github.com/007revad/synology_hdd_db/blob/main/README.md

Commands to download the latest source code from GitHub, extract the zip file, and list the contents of the directory.

```bash
cd $HOME
wget https://github.com/007revad/Synology_HDD_db/archive/refs/heads/main.zip -O syno_hdd_db.zip
7z x syno_hdd_db.zip
cd Synology_HDD_db-main && ls -ali
```

--------------------------------

### Set script as executable

Source: https://github.com/007revad/synology_hdd_db/blob/main/README.md

Grant execution permissions to the script file using the chmod command.

```YAML
sudo chmod +x "/volume1/scripts/syno_hdd_db.sh"
```

--------------------------------

### Extract and evaluate a specific function

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-platform-functions.md

Demonstrates how to extract a single function from the script using sed and evaluate it in the current shell, as used in the project's test suite.

```bash
# source just one function from the script (as the repo's test does)
extract_function() { sed -n "/^${1}(){/,/^}/p" syno_hdd_db.sh; }
eval "$(extract_function detect_scheduler)"
if detect_scheduler; then echo "running from task scheduler"; fi
```

--------------------------------

### vendor_from_id — resolve vendor from PCI vendor id

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-drive-discovery-functions.md

Maps a PCI vendor id (lower-cased) to a vendor name using a hardcoded case statement. Sets global 'vendor' (empty on miss) and always returns exit status 0. On miss, prints a warning and instructions to edit syno_hdd_vendor_ids.txt.

```bash
vendor_from_id(){
    # Vendor ids missing in /usr/syno/etc.defaults/pci_vendor_ids.conf
    # $1 is vendor id
    case "${1,,}" in
        0x10ec) vendor=TEAMGROUP ;;
        # ... 20 hardcoded ids total (0x10ec, 0x025e, 0x1458, 0x1462, 0x196e, 0x1987,
        # 0x1b1c, 0x1c5c, 0x1cc4, 0x1cfa, 0x1d97, 0x1dbe, 0x1e0f, 0x1e49,
        # 0x1e4b, 0x1f40, 0x1bdc, 0x0ed1, 0x05dc, 0x1d79)
        *)
            # fallback: synogetkeyvalue "${scriptpath}/syno_hdd_vendor_ids.txt" "$1"
        ;;
    esac
}
```

--------------------------------

### Run script via SSH

Source: https://github.com/007revad/synology_hdd_db/blob/main/README.md

Basic command to execute the script with root privileges via SSH.

```YAML
sudo -s /path-to-script/syno_hdd_db.sh -nr
```

--------------------------------

### Run with Debug Tracing

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-shutdown.md

Execute the script from a shell with tracing enabled to debug operations.

```bash
sudo -s /volume1/scripts/syno_hdd_shutdown.sh --trace
```

--------------------------------

### Identity constants in syno_hdd_db.sh

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db.md

These constants define the script version, name, and repository location used for self-updates.

```bash
scriptver="v3.6.139"                    # syno_hdd_db.sh:32
script=Synology_HDD_db                  # syno_hdd_db.sh:33
repo="007revad/Synology_HDD_db"         # syno_hdd_db.sh:34 — GitHub org/repo used by self-update
scriptname=syno_hdd_db                  # syno_hdd_db.sh:35
```

--------------------------------

### getdbtype - Detect database type (DSM 7/6/1)

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-db-functions.md

Detects the database type by checking for 'disk_compatbility_info' (DSM 7) or a list array (DSM 6). Sets global dbtype to 7, 6, or 1. Used to branch between jq and sed editing.

```bash
getdbtype(){
    # Detect drive db type
    # Synology misspelt compatibility as compatbility
    if jq -e 'has("disk_compatbility_info")' "$1" >/dev/null 2>&1; then
        dbtype=7        # DSM 7 db files
    elif jq -e '.success == 1 and (.list | type == "array")' "$1" >/dev/null 2>&1; then
        dbtype=6        # DSM 6 db files
    elif [[ ! $1 =~ .*".db.new" ]]; then
        # warn for .db files only: "ERROR <name> is 0 bytes!" / "ERROR Unknown database type <name>!"
        dbtype=1
    else
        dbtype=1
    fi
}
```

--------------------------------

### get_eunit_container_aliases function - syno_hdd_db.sh:1360

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-drive-discovery-functions.md

Processes synodisk --enum -t ebox output to extract canonical expansion-unit family names. Reads container files from the runtime root (default /run/synostorage/disks), strips '-<digits>' suffixes, and keeps names matching the pattern ^([FRD]XD?[0-9]{3,4})(rp|ii|sas)?$. Outputs one family per line (e.g., RX1217 from container RX1217-1).

```bash
get_eunit_container_aliases(){
    # DSM can report one expansion unit with different model names.
    # $1 = `synodisk --enum -t ebox` output; $2 = runtime root, default /run/synostorage/disks
    local ebox_info="$1"
    local runtime_root="${2:-/run/synostorage/disks}"
    # for each "Disk path:" entry: read <runtime_root>/<dev>/container,
    # strip "-<digits>" suffix, keep if it matches: ^([FRD]XD?[0-9]{3,4})(rp|ii|sas)?$
}
```

--------------------------------

### cleanup_tmp — syno_hdd_db.sh:455

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-platform-functions.md

Removes the self-update download artifacts. No parameters. Failure is only logged (not fatal).

```bash
cleanup_tmp(){
    cleanup_err=
    # Delete downloaded "/tmp/$script-$shorttag.tar.gz" and "/tmp/$script-$shorttag"
    # On failure: "ERROR Failed to delete ..." to stderr, cleanup_err=1
    if [[ $cleanup_err ]]; then
        syslog_set warn "$script update failed to delete tmp files"
    fi
}
```

--------------------------------

### Identity constants for syno_hdd_shutdown.sh

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-shutdown.md

Defines script version, script name, and log file path used throughout the script.

```bash
scriptver="v1.0.1"                    # syno_hdd_shutdown.sh:13
script=Synology_HDD_shutdown          # syno_hdd_shutdown.sh:14
scriptname=syno_hdd_shutdown          # syno_hdd_shutdown.sh:16
shutdown_log="${scriptpath}/${scriptname}.log"   # syno_hdd_shutdown.sh:111
```

--------------------------------

### Execute script with spaces in path

Source: https://github.com/007revad/synology_hdd_db/blob/main/README.md

Use double quotes to enclose the path and script name when the directory structure contains spaces.

```YAML
sudo -s "/volume1/my scripts/syno_hdd_db.sh -n"
```

--------------------------------

### editdb7 — syno_hdd_db.sh:1727

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-db-functions.md

Edits the Synology host database file using jq. Takes the db file path as $1, creates a temporary file with mktemp, and fails with an error message if the temp file cannot be created.

```bash
editdb7(){
    # $1 is the db file
    local dbfile="$1" tmpfile existed
    tmpfile="$(mktemp "${dbfile}.XXXXXX")" || { echo "ERROR Failed to create tmp file for <name>"; return 1; }
    # jq --arg model "$hdmodel" --arg fw "$fwrev" --argjson fwbn 1 --argjson size_gb "$size_gb"
    #   writes .disk_compatbility_info[$model][$fw] = { fw_build: 1, size_gb: $size_gb }
}
```

--------------------------------

### get_script_vol — syno_hdd_db.sh:525

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-platform-functions.md

Sets global vol_name (device backing the script's volume, e.g. /dev/md2). Called before the NVMe-volume guard (exit 3).

```bash
get_script_vol() {
    local script_root vol_num vg_name
    script_root="${scriptpath#/*}"
    script_root="${script_root%%/*}"
    if [[ $script_root =~ ^volume ]]; then
        # lvs/pvs to resolve /dev/<name> backing volume_N
    else
        # df --output=source "/$script_root"
    fi
}
```

--------------------------------

### dts_m2_card — syno_hdd_db.sh:2009

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-platform-functions.md

Appends a device-tree node to a .dts file for a given M.2 card model. Removes a trailing '^};' line and appends the node. The exact node text is emitted via heredoc in the source (lines 2013–2041); the block above is a paraphrase, not byte-exact. The power_limit and pcie_postfix values are quoted verbatim.

```bash
dts_m2_card(){
# $1 is the card model
# $2 is the dts file
# Removes a trailing "^};" line, then appends a device-tree node. Exact output per card:
# E10M20-T1 / M2D20:
#   <NAME> {
#       compatible = "Synology";
#       model = "synology_<name>";
#       power_limit = "14.85,14.85";
#       m2_card@1 { nvme { pcie_postfix = "00.0,08.0,00.0"; port_type = "ssdcache"; }; };
#       m2_card@2 { nvme { pcie_postfix = "00.0,04.0,00.0"; port_type = "ssdcache"; }; };
#   };
# M2D18: power_limit "9.9,9.9"; m2_card@1/@2 each with ahci (ata_port <0x00>/<0x01>,
#        pcie_postfix "00.0,03.0,00.0") plus nvme ("00.0,04.0,00.0" / "00.0,05.0,00.0")
# M2D17: power_limit "9.9,9.9"; m2_card@1/@2 ahci only (ata_port <0x00>/<0x01>)
}
```

--------------------------------

### detect_scheduler — syno_hdd_db.sh:262

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-platform-functions.md

Walks the parent-process chain looking for DSM's scheduler processes (SYNO.Core.TaskS, SYNO.Core.Event, crond). Exit status: 0 = running from the task scheduler; 1 = interactive/SSH shell.

```bash
detect_scheduler(){
    # SYNO.Core.TaskS is regular scheduled task
    # SYNO.Core.Event is triggered scheduled task
    local pid=$PPID
    local comm
    while [[ "$pid" != "1" && -n "$pid" ]]; do
        comm=$(ps -p "$pid" -o comm=)
        [[ "$comm" =~ (SYNO.Core.TaskS|SYNO.Core.Event|crond) ]] && return 0
        pid=$(ps -p "$pid" -o ppid= | tr -d ' ')
    done
    return 1
}
```

--------------------------------

### is_schedule_running function

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-platform-functions.md

Queries the Synology Task Scheduler database to check if the script is scheduled and running. Returns 0 if a live PID is found, 1 otherwise. Requires the sqlite3 CLI.

```bash
is_schedule_running(){
    # $1 is script's filename. e.g. syno_hdd_db.sh etc
    # queries /usr/syno/etc/esynoscheduler/esynoscheduler.db (SQLite) for tasks whose
    # operation contains "$1"; sums the PIDs parsed from the "status" column
    [ -n "$result" ] || return 1
}
```

--------------------------------

### Check syno_hdd_db.sh exit status in shell

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/errors.md

Invokes syno_hdd_db.sh with -nr as root and branches on the exit status: 0 means success, 4 means host db files are missing for the model (see /var/lib/disk-compatibility/), and any other code is reported as a failure. Use this pattern in a shell or DSM scheduled task to react to the script's failure contract.

```bash
sudo -s /volume1/scripts/syno_hdd_db.sh -nr
status=$?
if [[ $status -eq 0 ]]; then
    echo "ok"
elif [[ $status -eq 4 ]]; then
    echo "host db files missing for this model — see /var/lib/disk-compatibility/"
else
    echo "failed with exit code $status"
fi
```

--------------------------------

### set_writemostly — syno_hdd_db.sh:706

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-platform-functions.md

Writes 'writemostly' or '-writemostly' to the md0 (DSM) and md1 (swap) partition state files under /sys/block/md0|md1/md/dev-<dev><n|pN>/state. Skips partitions that don't exist. Echoes the device model and resulting state values.

```bash
set_writemostly(){
    # $1 is writemostly or -writemostly
    # $2 is sata1 or sas1 or sda etc
    model="$(xargs < /sys/block/"${2}"/device/model)"
    if [[ ${1::2} == "sd" ]]; then
        # sda-style: state files are /sys/block/md0/md/dev-<sda>1 and /sys/block/md1/md/dev-<sda>2
    else
        # sata1/sas1-style: state files are /sys/block/md0/md/dev-<sata1>p1 and /sys/block/md1/md/dev-<sata1>p2
    fi
    # each: echo "$1" > <state file>; then print "  <dev> DSM partition:  <state>"
    #       echo "$1" > <state file>; then print "  <dev> Swap partition: <state>"
}
```

--------------------------------

### progstatus - Check process status and handle errors

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-shutdown.md

Checks the exit status of a process. On success, prints the status line. On failure, rings the bell, prints an error message, and exits unless exitonerror is set to 'no'. Clears the global exitonerror variable after each check.

```bash
progstatus(){
    # $1 is return status of process
    # $2 is string to echo
    # $3 line number function was called from
    # traces via ${FUNCNAME[0]} when trace=yes
    if [[ $1 == "0" ]]; then
        echo -e "$2            "
    else
        ding
        echo -e "Line ${LINENO}: ERROR $2 failed!"
        if [[ $exitonerror != "no" ]]; then
            exit 1  # Skip exit if exitonerror != no
        fi
    fi
    exitonerror=""
}
```

--------------------------------

### ding — syno_hdd_db.sh:52

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-platform-functions.md

Rings the terminal bell. No parameters. Used before every fatal error and the TRIM warning.

```bash
ding(){
    printf \a
}
```

--------------------------------

### Scheduled task user-defined script

Source: https://github.com/007revad/synology_hdd_db/blob/main/2025_plus_models.md

The script to paste into the Task Scheduler user-defined script box. It creates /opt, downloads the required files, sets permissions, and runs the script with the -e option.

```bash
mkdir -m775 /opt
cd /opt || (echo "Failed to CD to /opt"; exit 1)
curl -O "https://raw.githubusercontent.com/007revad/Synology_HDD_db/refs/heads/main/syno_hdd_db.sh"
curl -O "https://raw.githubusercontent.com/007revad/Synology_HDD_db/refs/heads/main/syno_hdd_vendor_ids.txt"
chmod 750 /opt/syno_hdd_db.sh
/opt/syno_hdd_db.sh -e
```

--------------------------------

### pause — syno_hdd_db.sh:389

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-platform-functions.md

Blocks until a key is pressed; restores terminal echo. Intended to be inserted manually while debugging; not called in the shipped flow.

```bash
pause(){
    # When debugging insert pause command where needed
    read -s -r -n 1 -p "Press any key to continue..."
    read -r -t 0.1 -s -e --  # Silently consume all input
    stty echo echok  # Ensure read didn't disable echoing user input
}
```

--------------------------------

### editcount — count drives added to host db files (syno_hdd_db.sh:1717)

Source: https://github.com/007revad/synology_hdd_db/blob/main/_autodocs/api-reference/syno-hdd-db-db-functions.md

Increments db1Edits for *.db files or db2Edits for *.db.new files. Called from editdb7 for new model entries.

```bash
editcount(){
    # Count drives added to host db files
    if [[ $1 =~ .*\\.db$ ]]; then
        db1Edits=$((db1Edits +1))
    elif [[ $1 =~ .*\\.db.new ]]; then
        db2Edits=$((db2Edits +1))
    fi
}
```
Tokens:
Raw