Automating DSM VM Creation on Proxmox VE with a Bash Script

pve-dsm.jpg

About

Recently, I wanted to automate the creation of a Synology DSM VM on my Proxmox VE server.
This saves time compared to manually going through the steps in the Proxmox GUI.

Note: This is for homelab test only. Do not use it for production.

Deploy VM on PVE (Walkthrough)

1. Make the script asks for a VMID to use for the new VM. It checks if a VM with that ID already exists, and offers to delete it if needed.

read -p "Enter Virtual Machine ID for Synology DSM install: " VMID

if qm status $VMID &> /dev/null
then
  # Offer to delete existing VM
fi

1. Install unzip if it is not already present, as we'll need it to extract the VM image later:

if ! command -v unzip &> /dev/null; then
  apt install unzip -y
fi

1. Grabs the latest DSM loader image release from the GitHub API:

version=$(curl -s https://api.github.com/repos/fbelavenuto/arpl/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")')

Specify the newversion for URL

newversion=${version:1}

1. It constructs a download URL using that newversion, downloads and unzips the image:

   Set up Image Directory Path

image_folder="/var/lib/vz/template/iso/"

Gather the loader image and unzips to the specify folder:

url="https://github.com/fbelavenuto/arpl/releases/download/$version/arpl-$newversion.img.zip"

wget $url
unzip "arpl-$newversion.img.zip" -d $image_folder 
rm "arpl-$newversion.img.zip"

1. create the VM with qm create, using the VMID provided earlier:

2023-07-06_114000.png

qm create "$VMID" --name DSM --memory 4096 --sockets 1 --cores 2 --cpu host --net0 virtio,bridge=vmbr0 --ostype l26

1. imports the image (loader) downloaded previously as the boot disk:

2023-07-06_114000-1689211750121.png

2023-07-06_114028.png

qm importdisk "$VMID" "$image" local-lvm 
qm set "$VMID" -sata0 local-lvm:vm-$VMID-disk-0
qm set "$VMID" --boot c --bootdisk sata0

1. also attaches a blank volume for extra storage:

2023-07-06_114000-1689211779812.png

qm set "$VMID" --sata1 volume02:32 

1. Finally, the VM is started:

qm start "$VMID"

The full content of the script

#!/bin/bash
#
# Script name: pve-dsm.sh
# Author: King Tam
# Website: https://kingtam.eu.org
# Date: July 7, 2023
# Purpose: Automatic creation of DSM VM on Proxmox VE.
#

set -e

# Ask for VMID
read -p "Enter Virtual Machine ID for Synology DSM install: " VMID

# Check if VMID already exists
if qm status $VMID &> /dev/null
then
    read -p "VM $VMID already exists. Do you want to remove it? (y/n) " choice
    case "$choice" in
        y|Y )
            qm stop $VMID
            qm destroy $VMID
            echo "VM $VMID has been removed."
            ;;
        * )
            echo "Please enter a different VMID."
            exit 1
            ;;
    esac
fi

# Check if unzip is installed, install if not
if ! command -v unzip &> /dev/null; then
    echo "unzip could not be found, installing..."
    apt install unzip -y
fi

# Get latest release version from GitHub API
version=$(curl -s https://api.github.com/repos/fbelavenuto/arpl/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")')
newversion=${version:1}

# Construct download URL using latest release version
url="https://github.com/fbelavenuto/arpl/releases/download/$version/arpl-$newversion.img.zip"

# Download and extract arpl image
wget $url
image_folder="/var/lib/vz/template/iso/"
unzip "arpl-$newversion.img.zip" -d $image_folder
rm "arpl-$newversion.img.zip"


# Create virtual machine
qm create "$VMID" --name DSM --memory 4096 --sockets 1 --cores 2 --cpu host --net0 virtio,bridge=vmbr0 --ostype l26

# Import arpl image as boot disk
image="/var/lib/vz/template/iso/arpl.img"
qm importdisk "$VMID" "$image" local-lvm
qm set "$VMID" -sata0 local-lvm:vm-$VMID-disk-0
qm set "$VMID" --boot c --bootdisk sata0

# Add a new SATA disk to the virtual machine
qm set "$VMID" --sata1 volume02:32

# Start the virtual machine
qm start "$VMID"

Configuring the Loader

The loader (Automated Redpill Loader) automatically detects which device is being used, SATADoM or USB, detecting its VID and PID correctly.

Open VM Console by PVE

2023-07-06_095054.png

We can access the loader via a browser.

In this case that the URL is http://10.1.1.73:7681

2023-07-06_095259.png

2023-07-06_095328.png

2023-07-06_095343.png

2023-07-06_095353.png

2023-07-06_095407.png

2023-07-06_095415.png

2023-07-06_095441.png

2023-07-06_095452.png

2023-07-06_095504.png

2023-07-06_095515.png

Now the loader has been built, and the details are as follows

Install DSM

Install using a web browser.

Open a web browser on a computer and go to http://10.1.1.73:5000

2023-07-06_100030.png

2023-07-06_100112.png

According to previous built information, then manual down the DSM OS via Download Center

2023-07-06_100412.png

2023-07-06_100425.png

2023-07-06_100448.png

2023-07-06_100530.png

2023-07-06_100746.png

2023-07-06_100847.png

Conclusion

That's it! The script now automatically creates a DSM VM on Proxmox VE, configured and ready to go.
Finally, I greatly appreciate and thank fbelavenuto's loader and Jun's code.

Related

• Automated Redpill Loader