Clonezilla

https://github.com/stevenshiau/clonezilla
Admin
Clonezilla is a partition and disk imaging/cloning program that helps users perform system...
Tokens:29,968
Snippets:471
Trust Score:8.4
License:GPL-2.0
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install dependencies

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Installs the full suite of Clonezilla dependencies via apt.

```bash
apt install clonezilla
```

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

### Manually Install Grub After Restore

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/10-error-reference.md

Use these commands to manually install the bootloader if the automatic process fails due to partition or firmware mismatches.

```bash
# Restore without grub, then manual install
ocs-sr restoredisk myimage sda

# After restore, chroot and install grub
mount /dev/sda1 /mnt
mount -o bind /dev /mnt/dev
mount -o bind /proc /mnt/proc
mount -o bind /sys /mnt/sys
chroot /mnt
grub-install /dev/sda
update-grub
exit

# For UEFI
# Mount EFI partition
mount /dev/sda2 /mnt/boot/efi
grub-install --efi-directory=/mnt/boot/efi /dev/sda
```

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

### Install dialog program

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/05-cli-clonezilla.md

Install a dialog provider if the system lacks one for the Clonezilla interface.

```bash
apt install dialog    # Debian/Ubuntu
yum install dialog    # RedHat/CentOS
```

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

### Install U-Boot Tools

Source: https://github.com/stevenshiau/clonezilla/blob/master/setup/files/riscv64/HOW_TO_MKENVIMAGE.txt

Install the required u-boot-tools package on Debian or Ubuntu systems.

```bash
$ sudo apt install u-boot-tools
```

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

### Starting Clonezilla GUI

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/09-workflows-and-examples.md

Command to launch the Clonezilla interactive interface.

```bash
clonezilla -x
```

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

### Combined CLI Examples

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/05-cli-clonezilla.md

Common usage patterns combining multiple flags for automated tasks.

```bash
clonezilla -l en -p reboot
```

```bash
clonezilla -l zh_CN -s
```

```bash
clonezilla -p poweroff -n
```

```bash
clonezilla -p "systemctl suspend"
```

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

### Save entire disk with lzop compression

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/02-cli-ocs-sr.md

Example of creating a full disk image using lzop compression.

```bash
ocs-sr -z3 savedisk IMAGE1 sda
```

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

### Interactive mode

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/02-cli-ocs-sr.md

Launches the menu-driven interface for guided operations.

```bash
ocs-sr -x
```

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

### CI/CD Pipeline Integration

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/09-workflows-and-examples.md

Example configuration for running the restoration test script within a CI/CD pipeline.

```yaml
# .gitlab-ci.yml or similar
test-image:
  script:
    - /usr/local/sbin/test-image-restore.sh weekly-2025-01-27
  artifacts:
    reports:
      junit: results.xml
```

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

### Manage BitTorrent server

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Starts or stops the BitTorrent seeder daemon for mass deployment.

```bash
ocs-btsrv start|stop
```

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

### Start ezio BitTorrent leecher

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Downloads an image from ezio seeds.

```bash
ocs-ezio-leecher [OPTIONS]
```

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

### Start ezio BitTorrent seeder

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Initiates image seeding using the ezio protocol.

```bash
ocs-ezio-seeder IMAGE
```

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

### Volume Splitting Example

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/08-image-format.md

Visual representation of how a single image file is split into multiple parts when a volume limit is applied.

```text
sda1.ext4-ptcl.img.z       → sda1.ext4-ptcl.img.z.aaa (4GB)
                           → sda1.ext4-ptcl.img.z.aab (4GB)
                           → sda1.ext4-ptcl.img.z.aac (remaining)
```

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

### GNU Parted Partition Table Format

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/08-image-format.md

Example of a machine-readable partition table output generated by GNU parted.

```text
# partition table created by parted
# parted version: 3.4
# output of parted -m /dev/sda print

/dev/sda:1000GB:scsi:512:512:msdos:QEMU QEMU HARDDISK
1:1049kB:1000MB:999MB:ext4::boot
2:1000MB:1000GB:999GB:ntfs::
```

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

### Save specific partitions with ntfsclone

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/02-cli-ocs-sr.md

Example of saving multiple partitions as a single image using the ntfsclone backend.

```bash
ocs-sr --use-ntfsclone -z3 saveparts IMAGE2 "sda1 sda2"
```

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

### Override Configuration in Live Environment

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Example of overriding variables within the ocs-live.conf file.

```bash
# In /etc/ocs/ocs-live.conf
DIA="dialog"
BOOTUP="color"
SETCOLOR_SUCCESS="..."
```

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

### Partition Table Checksum Format

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/08-image-format.md

Example of a partition table checksum file containing SHA1 and MD5 hashes.

```text
SHA1SUM: 3d4a5e7f9b1c2d4e6f8a0b1c2d3e4f5a6b7c8d9e
MD5SUM: 3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d
```

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

### Get image information

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Commands to check image integrity and extract partition sizes.

```bash
ocs-chkimg myimage
ocs-pt-size-from-sf myimage 1
```

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

### Troubleshoot Decompression Failures

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/10-error-reference.md

Use these commands to verify image compression, install missing decompressors, test file integrity, and regenerate checksums.

```bash
# Check compression
file /home/partimag/myimage/sda1*.img*

# Install decompressor
apt install lzop bzip2 xz-utils pigz

# Try manual decompression test
lzop -t /home/partimag/myimage/sda1.ext4-ptcl.img.z

# Regenerate checksums
ocs-gen-chksum myimage md5sum
```

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

### restoredisk

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/02-cli-ocs-sr.md

Restores an entire image to a specified disk, including options for partition table recreation and bootloader installation.

```APIDOC
## restoredisk

### Description
Restore entire image to disk, recreating partition table.

### Usage
`ocs-sr -g auto restoredisk IMAGE1 sda`

### Parameters
- **IMAGE1** (string) - Required - The name of the image to restore.
- **sda** (string) - Required - The target disk device.

### Options
- **-g, --grub-install MODE** - Run grub-install after restore: auto, mbrinstall, partition name, or no.
- **-k, --no-create-partition** - Don't recreate partition table (assume it exists).
- **-k1, --fdisk-proportion** - Recreate partitions proportionally.
- **-k2, --fdisk-manual** - Manual partition table editing.
- **-t, --no-restore-mbr** - Don't restore MBR.
- **-t1, --restore-raw-mbr** - Restore syslinux MBR.bin.
- **-t2, --no-restore-ebr** - Don't restore extended boot record.
- **-ssnf, --skip-set-netboot-first** - Don't set network boot as 1st priority in UEFI NVRAM.
- **--mcast-port NO** - UDP port for multicast restore (server use).
```

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

### Configure UDP Sender Extra Options

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Examples of additional options for the udpcast sender, such as bitrate limits, FEC, and retry counts.

```bash
udp_sender_extra_opt_default="--max-bitrate 150m"      # Limit to 150 Mbps
udp_sender_extra_opt_default="--fec 8x16/64"           # Enable FEC
udp_sender_extra_opt_default="--retries-until-drop 50" # Faster failure detection
```

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

### Download Environment Configuration

Source: https://github.com/stevenshiau/clonezilla/blob/master/setup/files/riscv64/HOW_TO_MKENVIMAGE.txt

Fetch the default U-Boot environment text file from the repository.

```bash
$ wget -O ocs-u-boot-env-default.txt  https://raw.githubusercontent.com/ceasar-sun/clonezilla.ceasar/refs/heads/master/setup/files/riscv64/ocs-u-boot-env-default.txt
```

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

### Deploy Environment Binary to Image Template

Source: https://github.com/stevenshiau/clonezilla/blob/master/setup/files/riscv64/HOW_TO_MKENVIMAGE.txt

Write the binary file to a loop-mounted image file using kpartx.

```bash
~$ sudo kpartx -av bootable.ocs-image.img
~$ sudo dd if=./ocs-u-boot-env-default of=/dev/mapper/loop3p2 conv=fsync ; sync
~$ sudo kpartx -d /dev/loop3
~$ sudo losetup -d /dev/loop3
```

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

### Create GParted Live environment

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Initializes the creation of a GParted Live environment.

```bash
create-gparted-live [OPTIONS]
```

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

### Source Configuration File

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Loads default settings by sourcing the main configuration file.

```bash
. /etc/drbl/drbl-ocs.conf
```

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

### Booting Clonezilla Live

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/09-workflows-and-examples.md

Initial system state after booting from the Clonezilla USB or ISO media.

```bash
# System boots from USB/ISO
# Clonezilla interactive menu appears
```

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

### Skip Repository Preparation

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/05-cli-clonezilla.md

Use the -k flag to assume the image home directory is already mounted.

```bash
clonezilla -k
```

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

### Prepare image repository

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Mounts and validates the image home directory.

```bash
ocs-prep-repo [OPTIONS]
```

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

### Deploy Environment Binary to Partition

Source: https://github.com/stevenshiau/clonezilla/blob/master/setup/files/riscv64/HOW_TO_MKENVIMAGE.txt

Write the generated binary file directly to a storage partition.

```bash
~$ sudo dd if=./ocs-u-boot-env-default.bin of=/dev/mmcblk0p2 conv=fsync ; sync
```

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

### Generate U-Boot Environment Binary

Source: https://github.com/stevenshiau/clonezilla/blob/master/setup/files/riscv64/HOW_TO_MKENVIMAGE.txt

Create the binary environment image from the text configuration file using mkenvimage.

```bash
./tools/mkenvimage -s 0x4000 -o ./ocs-u-boot-env-default.bin ./ocs-u-boot-env-default.txt
```

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

### startparts Operation

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/03-cli-ocs-onthefly.md

Clones specific partitions from source to target with 1:1 mapping.

```APIDOC
## startparts

### Description
Clone specific partitions. Maps source partitions to target partitions 1:1.

### Example
`ocs-onthefly startparts "sda1 sda2" "sdb1 sdb2"`
```

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

### Configure Boot Defaults and Menu

Source: https://github.com/stevenshiau/clonezilla/blob/master/setup/files/riscv64/ocs-u-boot-env-default.txt

Sets the default boot command and defines the interactive U-Boot menu options for Clonezilla.

```bash
# Default Boot Option
bootcmd=setenv cmdlineargs "${cmdlineargs} ${ocs_toram_args}  ${ocs_lockb_args}"; run mmc_boot
bootdelay=10

#
## Useless for default menu
#setenv bootmenu_default 3

bootmenu_0="----- Clonezilla U-Boot Menu -----"=run show_boot_info
bootmenu_1="Boot Clonezilla To-RAM (use preset keyboard layout)"=setenv cmdlineargs "${cmdlineargs} ${ocs_toram_args}  ${ocs_lockb_args}"; run mmc_boot
bootmenu_2="Boot Clonezilla To-RAM (choose keyboard layout later)"=setenv cmdlineargs "${cmdlineargs} ${ocs_toram_args}"; sleep 5; run mmc_boot
bootmenu_3="Boot Clonezilla"=run mmc_boot
bootmenu_4=" --> Autoboot"=run autoboot
bootmenu_5=" --> Show Boot Info"=run show_boot_info;
bootmenu_6=" --> [Testing] Boot Clonezilla via EFI"=run efi_boot
bootmenu_7=" --> Power Reset..."=reset
```

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

### Set up eCryptFS encryption

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Mounts an encrypted image directory for use.

```bash
ocs-prepare-ecryptfs IMAGE MOUNT_POINT
```

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

### startdisk Operation

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/03-cli-ocs-onthefly.md

Clones an entire disk from source to target, including partition table creation.

```APIDOC
## startdisk

### Description
Clone entire disk from source to target.

### Options
- **-s, --source** (DEVICE) - Source device
- **-d, --dest** (DEVICE) - Destination device
- **-g, --grub-install** (MODE) - Post-clone grub: auto, manual, no

### Example
`ocs-onthefly -x -lo startdisk sda sdb`
```

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

### Configure Partimage settings

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Sets default options and supported filesystems for the legacy Partimage utility.

```bash
DEFAULT_PARTIMAGE_SAVE_OPT="-M -f3 -o -d -b -c -z0 --volume=0"
DEFAULT_PARTIMAGE_RESTORE_OPT="-M -f3 -b"
partimage_support_fs="ext2 ext3 reiserfs xfs jfs fat16 fat32 vfat hpfs ufs hfs ntfs"
```

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

### Configure BitTorrent Settings

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Initializes default BitTorrent parameters including port, metadata creator, and piece lengths for various clients.

```bash
BT_PORT_INIT="6969"
metainfo_creator_def="ezio-ptcl"
p_length_ctorrent="16777216"
p_length_mktorrent="24"
p_length_transmission="16384"
bt_client_def="ezio"
```

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

### U-Boot Boot Environment Variables

Source: https://github.com/stevenshiau/clonezilla/blob/master/setup/files/riscv64/ocs-u-boot-env-default.txt

A collection of U-Boot environment scripts for loading boot components and executing different boot sequences.

```bash
load_grub=echo "Loading grub..."; load ${bootfs_devname} ${boot_devnum}:${esp_index} \
           ${kernel_addr_r} ${grub_file}; \
           echo "OCS_info: load ${bootfs_devname} ${boot_devnum}:${esp_index} ${kernel_addr_r} ${grub_file}"; \
           sleep 5; # bootm command for fit image, booti command for PE or compress PE image
loaddtb=echo "Loading dtb..."; \
        if load ${bootfs_devname} ${boot_devnum}:${bootfs_part} ${dtb_addr} ${dtb_name}; \
        then echo "OCS_info: load ${bootfs_devname} ${boot_devnum}:${bootfs_part} ${dtb_addr} ${dtb_name}"; \
             sleep 5; \
        else echo "OCS_info: load dtb from bootfs fail, use built-in dtb and clean env.dtb_addr"; \
             setenv dtb_addr ""; sleep 5; fi;
loadknl=echo "Loading kernel..."; \
        echo "OCS_info: load ${bootfs_devname} ${boot_devnum}:${bootfs_part} ${kernel_addr_r} ${knl_name}...."; \
        sleep 2; \
        load ${bootfs_devname} ${boot_devnum}:${bootfs_part} ${kernel_addr_r} ${knl_name};
loadramdisk=echo "Loading ramdisk ..."; \
            echo "OCS_info: load ${bootfs_devname} ${boot_devnum}:${bootfs_part} ${ramdisk_addr} ${ramdisk_name} ..."; \
            sleep 3 ; \
            if load ${bootfs_devname} ${boot_devnum}:${bootfs_part} ${ramdisk_addr} ${ramdisk_name}; \
            then size ${bootfs_devname} ${boot_devnum}:${bootfs_part} ${ramdisk_name}; \
                 setenv ramdisk_size ${filesize}; \
                 setenv ramdisk_combo ${ramdisk_addr}:${ramdisk_size}; \
            else echo "OCS_info: load ramdisk from bootfs fail, use built-in ramdisk"; \
                 setenv ramdisk_addr -; fi;

start_kernel=echo "OCS_info: bootargs=${bootargs}"; fdt addr ${kernel_addr_r}; \
             if fdt list /; then \
                 echo "OCS_info: ----> bootm ${kernel_addr_r} ${ramdisk_combo} ${dtb_addr}" ; \
                 sleep 5; bootm ${kernel_addr_r} ${ramdisk_combo} ${dtb_addr}; \
             else \
                 echo "OCS_info: ----> booti ${kernel_addr_r} ${ramdisk_combo} ${dtb_addr}" ; \
                 sleep 5; booti ${kernel_addr_r} ${ramdisk_combo} ${dtb_addr}; \
             fi; \
             echo "########### Run 'start_kernel' failed by default config, check your boot config #############"
boot_grub=env set -e -bs product_name "${product_name}"; \
          env set -e -bs bootargs "${bootargs}"; \
          run detect_dtb; run loaddtb; run usb_start; run load_grub; \
          bootefi ${kernel_addr_r} ${dtb_addr};
boot_kernel=run set_root_arg; run detect_dtb; run loadknl; run loaddtb; \
             run loadramdisk; run start_kernel;

efi_boot=echo "OCS_info: Try to boot from ${bootfs_devname}${boot_devnum} ..."; \
          run commonargs; run add_bootarg; run set_mmc_args; \
          run get_esp_index; if test -e ${bootfs_devname} ${boot_devnum}:${esp_index} ${grub_file}; \
          then run boot_grub; fi; \
          echo "########### run 'efi_boot'failed by default config, check your boot config #############"
nfs_boot=echo "Try to boot from NFS ..."; run commonargs; run add_bootarg; \
          setenv bootargs "${bootargs}" root=/dev/nfs nfsroot=${serverip}:${rootfs_path} \
          bootfs=${serverip}:${bootfs_path} ip=${ipaddr}:${serverip}:${gatewayip}:${netmask}::${netdev}:off \
          noipath; echo "bootargs: ${bootargs}"; run detect_dtb; \
          echo "Loading kernel from NFS..."; nfs ${kernel_addr_r} ${serverip}:${bootfs_path}/${knl_name}; \
          echo "Loading dtb from NFS..."; nfs ${dtb_addr} ${serverip}:${bootfs_path}/${dtb_name}; \
          if test -n "${ramdisk_name}"; then \
              echo "Loading ramdisk from NFS..."; \
              nfs ${ramdisk_addr} ${serverip}:${bootfs_path}/${ramdisk_name}; \
              setenv ramdisk_size ${filesize}; \
              setenv ramdisk_combo ${ramdisk_addr}:${ramdisk_size}; \
          else setenv ramdisk_combo -; fi; \
          run start_kernel; \
          echo "########### boot kernel failed from NFS, check your boot config #############"
nor_boot=echo "Try to boot from ${bootfs_devname}${boot_devnum} ..."; \
          run commonargs; run add_bootarg; run set_nor_args; \
          run get_esp_index; if test -e ${bootfs_devname} ${boot_devnum}:${esp_index} ${grub_file}; \
          then run boot_grub; else run boot_kernel; fi; \
          echo "########### boot failed by default config, check your boot config #############"
mmc_boot=echo "OCS_info: Try to boot from ${bootfs_devname}${boot_devnum} ..."; \
           sleep 3; run commonargs; run add_bootarg; run set_mmc_args; \
           run get_esp_index; if test -e ${bootfs_devname} ${boot_devnum}:${esp_index} ${grub_file}; \
           then run boot_grub; else run boot_kernel; fi; \
           echo "########### boot failed by default config, check your boot config #############"
```

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

### Create Ubuntu-based Clonezilla Live

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Initializes the creation of an Ubuntu-based Clonezilla Live environment.

```bash
create-ubuntu-live [OPTIONS]
```

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

### Interactive Backup

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/00-index.md

Launches the interactive Clonezilla interface for manual backup configuration.

```bash
clonezilla -x
# Select device-image → Save → answer prompts
```

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

### Save specific partitions using startparts

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/04-cli-drbl-ocs.md

Configures clients to save specific partitions, provided as a space-separated list.

```bash
drbl-ocs -b -z3 startparts save 2025-01-15-img "sda1 sda2"
```

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

### Set Partclone device-to-device options

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Configures options for direct device cloning without an image file.

```bash
PARTCLONE_D2D_OPT="-a3 -z 10485760"
PARTCLONE_D2D_OPT_DD="-z 16777216"
```

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

### Clone with Post-Action

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/03-cli-ocs-onthefly.md

Clone a disk and automatically power off the system upon completion.

```bash
ocs-onthefly -p poweroff -lo startdisk sda sdb
```

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

### Set Partclone restore options

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Configures the initial restore options for Partclone.

```bash
PARTCLONE_RESTORE_OPT_INIT="-z 10485760"
```

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

### Configure Partclone settings

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Defines supported filesystems and default operational flags for Partclone save, restore, and device-to-device operations.

```bash
partclone_support_fs="apfs btrfs hfs+ hfsplus reiser4 reiserfs xfs jfs ext2 ext3 ext4 ext4dev fat12 fat16 fat32 vfat ntfs ufs exfat minix vmfs3 vmfs5 f2fs nilfs2 dd"

PARTCLONE_SAVE_OPT_INIT="-a3 -z 10485760"
PARTCLONE_SAVE_OPT_DD_INIT="-z 16777216"
PARTCLONE_RESTORE_OPT_INIT="-z 10485760"
PARTCLONE_RESTORE_OPT_DD_INIT="-z 16777216"
PARTCLONE_D2D_OPT="-a3 -z 10485760"
PARTCLONE_D2D_OPT_DD="-z 16777216"
```

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

### Define U-Boot Environment Variables

Source: https://github.com/stevenshiau/clonezilla/blob/master/setup/files/riscv64/ocs-u-boot-env-default.txt

Configuration for boot logic and system information display within the U-Boot environment.

```bash
autoboot=if test ${boot_device} = nand; then run nand_boot; \
          elif test ${boot_device} = nor; then run nor_boot; \
          elif test ${boot_device} = mmc; then run mmc_boot; \
          elif test ${boot_device} = nfs; then run nfs_boot; fi;

show_boot_info=run commonargs; run add_bootarg; run detect_dtb; \
                echo "=== SHOW U-BOOT ARGS (10 seconds) ===" ; \
                echo "u_boot_env_version:${ocs_u_boot_env_version}"; \
                echo "board             :${board}"; \
                echo "board_name        :${board_name}"; \
                echo "boot_device       :${boot_device}"; \
                echo "bootfs_devname    :${bootfs_devname}"; \
                echo "boot_devnum       :${boot_devnum}"; \
                echo "dtb_name          :${dtb_name}"; \
                echo "esp_index         :${esp_index}"; \
                echo "grub_file         :${grub_file}"; \
                echo "bootargs          :${bootargs}"; \
                echo "start_kernel ->   :bootm ${kernel_addr_r} ${ramdisk_combo} ${dtb_addr}"; \
                echo "boot_grub ->      :bootefi ${kernel_addr_r} ${dtb_addr};"; \
                echo "loaddtb ->        :load ${bootfs_devname} ${boot_devnum}:${bootfs_part} ${dtb_addr} ${dtb_name}"; \
                sleep 10;
```

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

### Troubleshoot Encrypted Image Password Errors

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/10-error-reference.md

Commands to prepare eCryptFS mounts and verify password file formats for both eCryptFS and GoCryptFS.

```bash
# For eCryptFS
ocs-prepare-ecryptfs myimage /mnt/temp

# For GoCryptFS (newer)
# Mount directory requires GoCryptFS binary

# Verify password file format
# eCryptFS: passphrase_passwd=PASSWORD
# GoCryptFS: PASSWORD (plain)
cat /path/to/password.txt
```

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

### Troubleshoot Post-Restore Boot Failures

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/10-error-reference.md

Commands to verify boot partition integrity, regenerate initramfs, and check filesystem configuration after a failed boot.

```bash
# Boot from Live USB again
# Verify boot partition exists and has kernel
ls /mnt/boot/

# Regenerate initramfs
# (varies by distribution)
update-initramfs -u -k all

# Verify BIOS boot order
# (may need to edit BIOS settings)

# Check boot partition UUID
blkid /dev/sda1
# Verify matches /etc/fstab
cat /etc/fstab
```

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

### Create DRBL Live ISO

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Builds a custom DRBL Live environment.

```bash
create-drbl-live [OPTIONS]
```

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

### Configure Compression Methods

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Sets default options for various compression algorithms used during image creation.

```bash
extra_gzip_opt="--fast $rsyncable_opt_gzip"
extra_bzip2_opt="-3"
extra_lzop_opt="-3"
extra_lzma_opt="-3"
extra_xz_opt="-3"
extra_lzip_opt="-3"
extra_lrzip_opt="-L 3"
extra_lz4_opt="-T0 -1"
extra_zstd_opt="-T0 -3"
```

```bash
# Slower gzip but better compression
extra_gzip_opt="--best"

# Maximum zstd compression
extra_zstd_opt="-T0 -19"

# Maximum bzip2
extra_bzip2_opt="-9"
```

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

### Lookup Clonezilla documentation via grep

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/README.md

Use these commands to quickly search through the local documentation files for specific script options or configuration settings.

```bash
# Check image integrity
grep -A 5 "ocs-chkimg" 06-utility-scripts.md

# See ocs-sr options
grep -B 2 -A 2 "image-size" 02-cli-ocs-sr.md

# Find compression settings
grep -i "compression" 07-configuration-reference.md
```

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

### Restore with custom post-action

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/02-cli-ocs-sr.md

Restores an image and executes a poweroff command upon completion.

```bash
ocs-sr -p poweroff restoredisk myimage sda
```

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

### Restore entire image to disk

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/02-cli-ocs-sr.md

Restores an entire image to a target disk and executes grub-install automatically.

```bash
ocs-sr -g auto restoredisk IMAGE1 sda
```

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

### Verify Post-Restore Filesystems

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/09-workflows-and-examples.md

Commands to verify partition expansion and manually resize filesystems after a restore operation.

```bash
# Check filesystems expanded to partition size
df -h
lvextend -l +100%FREE /dev/vg0/root   # If LVM
resize2fs /dev/sda1                   # ext4 expand
```

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

### Save entire disk using startdisk

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/04-cli-drbl-ocs.md

Configures clients to save an entire disk to a centralized image on the server.

```bash
drbl-ocs -b -q -z3 startdisk save 2025-01-15-img sda
```

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

### Set Additional BT Client Options

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Provides extra command-line arguments for specific BitTorrent clients.

```bash
ctorrent_extra_opt="-M 4 -m 4"
aria2c_extra_opt="--bt-max-peers 4"
```

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

### Configure Restore on Server

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/09-workflows-and-examples.md

Initiates a disk restoration process in batch mode for client machines.

```bash
drbl-ocs -b -g auto startdisk restore lab-ubuntu-standard sda
```

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

### ocs-prepare-ecryptfs

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Sets up eCryptFS encryption by mounting an encrypted image directory.

```APIDOC
## ocs-prepare-ecryptfs

### Description
Mounts an encrypted image directory.

### Usage
`ocs-prepare-ecryptfs IMAGE MOUNT_POINT`

### Parameters
- **IMAGE** (string) - Required - The encrypted image path.
- **MOUNT_POINT** (string) - Required - The directory to mount the image.
```

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

### Server Mass Deployment

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/00-index.md

Initiates a network-based mass deployment to multiple machines.

```bash
drbl-ocs -b -g auto startdisk restore myimage sda
```

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

### Command-line Disk Restore

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/00-index.md

Restores a disk image and automatically handles GRUB configuration.

```bash
ocs-sr -g auto restoredisk myimage sda
```

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

### ocs-prep-repo

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Prepares the image repository by mounting and validating the home directory.

```APIDOC
## ocs-prep-repo

### Description
Mount and validate image home directory.

### Usage
`ocs-prep-repo [OPTIONS]`

### Options
- **-l, --language** (string) - Optional - Language for prompts.
- **-s, --skip-check** (flag) - Optional - Skip validation.
```

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

### Set Partclone save options

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Configures the initial save options for Partclone.

```bash
PARTCLONE_SAVE_OPT_INIT="-a3 -z 10485760"
```

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

### Serve images to clients

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Operates in lite-server mode to serve images to connected clients.

```bash
ocs-live-feed-img [OPTIONS]
```

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

### Create Master Image

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/09-workflows-and-examples.md

Captures an entire disk image from a client machine to the server.

```bash
ocs-sr -z6 -m savedisk lab-ubuntu-standard sda
```

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

### Configure Volume Limits

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Defines default volume splitting behavior for image creation.

```bash
VOL_LIMIT_DEFAULT="0"
VOL_LIMIT_IN_INTERACTIVE="0"
split_suf_len="2"
```

```bash
VOL_LIMIT_IN_INTERACTIVE="4096"
```

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

### Clone Using Proportional Partitions

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/03-cli-ocs-onthefly.md

Clone a disk and recreate the partition table proportionally on a smaller target disk.

```bash
ocs-onthefly -k1 -lo startdisk sda sdb
```

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

### Basic ocs-onthefly command syntax

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/03-cli-ocs-onthefly.md

General structure for invoking the cloning utility with required operation modes and device arguments.

```bash
ocs-onthefly [OPTION] {startdisk|startparts|stop} [SOURCE_DEVICE] [TARGET_DEVICE]
```

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

### Update bootloaders

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Updates syslinux or initrd configurations on a specified device.

```bash
ocs-update-syslinux sda
ocs-update-initrd sda 1
```

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

### Fetch image from server

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Operates in lite-client mode to download or upload images from a server.

```bash
ocs-live-get-img [OPTIONS]
```

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

### Set Post-Action Behavior

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/05-cli-clonezilla.md

Use the -p flag to define the system state after the operation completes.

```bash
clonezilla -p poweroff
```

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

### Run interactive cloning mode

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/03-cli-ocs-onthefly.md

Prompts the user to manually select the source and target devices for the cloning operation.

```bash
ocs-onthefly -x -s ask_user -d ask_user startdisk
```

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

### Troubleshoot No DRBL Clients Found

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/10-error-reference.md

Use these commands to verify DHCP, NFS, and network connectivity when DRBL clients fail to connect.

```bash
# Check DHCP server
systemctl status dhcp3-server

# Check NFS export
showmount -e 127.0.0.1

# Verify clients on network
ping 192.168.0.10
nmap -p 22 192.168.0.0/24   # Check for clients

# Check tftp boot files
ls -la /tftpboot/

# Restart DRBL
# (platform-specific, refer to DRBL docs)
```

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

### Create Highly-Compressed Archive

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/09-workflows-and-examples.md

Uses lrzip compression and splits the image into 2GB volumes for archival purposes.

```bash
# Maximum compression
ocs-sr -z8 -i 2048 savedisk archive-myhost sda
```

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

### Set BitTorrent Client

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Specifies the default BitTorrent client to be used.

```bash
bt_client_def="ezio"
```

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

### Save entire disk with compression

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/02-cli-ocs-sr.md

Saves all partitions from a specified disk using ntfsclone and lzop compression.

```bash
ocs-sr --use-ntfsclone -z3 savedisk myimage sda
```

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

### ocs-live-feed-img

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Acts as an image server for lightweight deployments.

```APIDOC
## ocs-live-feed-img

### Description
Lite-server mode: serve images to clients.

### Usage
`ocs-live-feed-img [OPTIONS]`

### Options
- **-l, --language** (string) - Optional - UI language.
- **-s, --source** (string) - Optional - Source device to upload.
- **-i, --image** (string) - Optional - Image name to serve.
```

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

### Troubleshooting Commands

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/09-workflows-and-examples.md

Commands used to address specific restoration failures.

```bash
ocs-sr -w 300
```

```bash
smart
```

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

### Verify Clients Post-Deployment

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/09-workflows-and-examples.md

Uses SSH to verify the OS release version across a range of client IP addresses.

```bash
for ip in 192.168.0.{10..50}; do
  ssh $ip "lsb_release -a"
done
```

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

### Clone with Compression

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/03-cli-ocs-onthefly.md

Clone a disk using a specific compression algorithm, such as lzop.

```bash
ocs-onthefly -z3 -lo startdisk sda sdb
```

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

### Network-Based Backup Client Commands

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/09-workflows-and-examples.md

Commands to configure the client side for pushing backups to a remote server.

```bash
# Option A: Push to server
clonezilla -x
# Select: remote-dest
# Enter server IP: 192.168.0.100
# Enter image name: laptop-2025-01-15

# Option B: Use lite-client
ocs-live-get-img -l en -d ask_user
# Server IP: 192.168.0.100
# Image: select from list
```

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

### Handle Disk Full Errors

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/10-error-reference.md

Use proportional sizing or manual verification to address cases where the target disk is smaller than the source image requirements.

```bash
# Use proportional sizing
ocs-sr -k1 restoredisk myimage sda

# Check actual free space vs needed
fdisk -l /dev/sda
# Calculate total sector requirement

# Or accept smaller partitions (data won't fit)
```

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

### Troubleshoot Image Directory Errors

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/10-error-reference.md

Commands to verify mount status, NFS accessibility, and directory permissions for the image storage path.

```bash
# Check if mounted
mount | grep partimag

# Mount if missing
mount /home/partimag

# Check if NFS accessible
showmount -e 192.168.0.100  # For server

# Check permissions
ls -ld /home/partimag
chmod 755 /home/partimag
```

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

### Configure Piece Length

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Sets the piece length for different BitTorrent clients. Larger values improve speed but reduce granularity.

```bash
p_length_ctorrent="16777216"      # 16 MB
p_length_mktorrent="24"           # 2^24 = 16 MB
p_length_transmission="16384"     # 16 KB → 16 MB
```

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

### Tune for Storage Constraints

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Configures volume splitting and high compression ratios to save disk space.

```bash
# Split to 2GB volumes
VOL_LIMIT_IN_INTERACTIVE="2048"

# Use high compression
extra_zstd_opt="-T0 -19"
extra_bzip2_opt="-9"
```

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

### Clone from Remote Source

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/03-cli-ocs-onthefly.md

Clone data from a remote host to a local target disk.

```bash
ocs-onthefly -x -ro startdisk sourcehost sdb
```

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

### Configure Ezio Seeder Options

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Adjusts performance and connection limits for the Ezio seeder daemon.

```bash
ezio_seed_max_connect="6"
ezio_seed_max_upload="5"
ezio_upload_timeout="90"
ezio_cache_size=""
ezio_aio_threads=""
ezio_slow_start="yes"
ezio_slow_start_period=""
```

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

### Set Interface Language

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/05-cli-clonezilla.md

Use the -l flag to specify the interface language.

```bash
clonezilla -l zh_TW
```

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

### Locate Clonezilla Live USB key

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Detects the live boot device, typically used for saving logs.

```bash
ocs-find-live-key
```

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

### Clone with Verification

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/03-cli-ocs-onthefly.md

Clone a disk and verify the integrity of the data using SHA1 checksums.

```bash
ocs-onthefly -cs -lo startdisk sda sdb
```

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

### UUID Mapping File

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/08-image-format.md

Format for recording UUID mappings for partitions.

```text
sda1: UUID=0b51ce79-7bc0-4111-8a40-839461a9b12f
sda2: UUID=a2c4e6f8-0b1d-3e5f-7a9b-1c2d4e6f8a0b
```

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

### Target Client Hosts

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/04-cli-drbl-ocs.md

Commands for selecting all clients or specific IP addresses for disk operations.

```bash
drbl-ocs -b -z3 startdisk save image sda
```

```bash
drbl-ocs -h "192.168.0.10 192.168.0.11 192.168.0.12" -b -z3 startdisk save image sda
```

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

### ocs-find-live-key

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Detects the live boot device, typically used for saving logs.

```APIDOC
## ocs-find-live-key

### Description
Locates the Clonezilla Live USB key.

### Usage
`ocs-find-live-key`

### Output
- Returns the device name of the live key if found.
```

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

### Common Clonezilla command-line operations

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/README.md

Standard commands for performing backups, restores, direct disk cloning, and mass deployment tasks.

```bash
# Interactive backup (single machine)
clonezilla -x

# Command-line backup with compression
ocs-sr -z3 savedisk myimage sda

# Restore from image
ocs-sr -g auto restoredisk myimage sda

# Direct disk clone (no image)
ocs-onthefly -x -lo startdisk sda sdb

# Mass deployment (40 clients)
drbl-ocs -b -g auto startdisk restore myimage sda

# Check image integrity
ocs-chkimg myimage
```

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

### Check ext4 Filesystems

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/10-error-reference.md

Run fsck on ext4 partitions that require verification after a restore operation.

```bash
# Run fsck
fsck.ext4 -y /dev/sda1

# Or accept filesystem check on next mount
# (automatic for root filesystem on Linux boot)
```

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

### Configure Image Slicing

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Defines parameters for image slicing creation methods and buffer sizes.

```bash
partclone_make_slice_opt="extract"
bt_buffer_size="16777216"
```

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

### Symbolic Link Configuration

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/08-image-format.md

Configuration format for restoring complex symbolic link structures.

```ini
[LINKS]
path/to/symlink = target
...
```

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

### Restore to Smaller Disk

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/09-workflows-and-examples.md

Uses the -k1 flag to proportionally resize partitions when restoring an image to a smaller target device.

```bash
ocs-sr -k1 restoredisk original-image sda
```

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

### Real-time Device Clone

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/00-index.md

Performs a direct device-to-device clone without creating an intermediate image file.

```bash
ocs-onthefly -x -lo startdisk sda sdb
```

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

### Multicast Configuration

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/04-cli-drbl-ocs.md

Commands to configure network interface and duplex settings for multicast operations.

```bash
drbl-ocs --mcast-iface eth1 -b startdisk multicast_restore image sda
```

```bash
drbl-ocs -x -b startdisk multicast_restore image sda
```

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

### Configure ntfsclone extra options

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Defines additional flags for ntfsclone operations, including common overrides.

```bash
ntfsclone_save_extra_opt_def=""
ntfsclone_restore_extra_opt_def=""
```

```bash
ntfsclone_save_extra_opt_def="--ignore-fs-check"     # Skip filesystem check
ntfsclone_restore_extra_opt_def="--ignore-fs-check"  # Ignore errors
```

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

### Expected Backup Directory Structure

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/09-workflows-and-examples.md

The resulting file structure created in the image repository after a successful save operation.

```text
/media/external-usb/images/dev-workstation-2025-01-15/
├── Info-clonezilla
├── clonezilla-img-stat.txt
├── sda-pt.sf
├── sda-mbr
├── sda1.ext4-ptcl.img.z
├── sda2.ntfs-ptcl.img.z
├── *.md5
```

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

### Skip Lite Menu

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/05-cli-clonezilla.md

Use the -s flag to hide lite-server and lite-client options from the menu.

```bash
clonezilla -s
```

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

### Partition Image File Naming Convention

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/08-image-format.md

The standard naming pattern for Clonezilla partition image files.

```text
{DEVICE}{FILESYSTEM}-{TOOL}.img[.z][.aaa/.aab/...]
```

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

### Command-line Disk Save

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/00-index.md

Saves a disk image with compression enabled.

```bash
ocs-sr -z3 savedisk myimage sda
```

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

### Configure Multicast Network Settings

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Defines the multicast address, port, and TTL for network operations.

```bash
MULTICAST_ALL_ADDR="224.0.0.1"
MULTICAST_PORT="2232"
TIME_TO_LIVE_OPT="--ttl 1"
```

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

### Create temporary image

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Generates a pseudo-image file for special use cases.

```bash
ocs-create-tmp-img DEVICE
```

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

### Upgrade image format with cv-ocsimg-v1-to-v2

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Upgrades v1.x image formats to v2.x by reorganizing file structures and updating metadata.

```bash
cv-ocsimg-v1-to-v2 IMAGE
```

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

### Network-Based Backup Server Commands

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/09-workflows-and-examples.md

Commands to configure the server side for receiving backups via direct connection or SSH tunnel.

```bash
# Option A: Pull from server (source acts as server)
clonezilla -x
# Select: remote-source
# Wait for client connection

# Option B: Via SSH tunnel
ocs-live -x
# Select: device-image → Save
# Network pipe: ssh to remote
```

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

### Batch restore with checksums

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/02-cli-ocs-sr.md

Restores an image while verifying SHA1 checksums.

```bash
ocs-sr -cs restoredisk myimage sda
```

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

### Generate BitTorrent metadata

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Creates a .torrent file for BitTorrent distribution using various supported creator tools.

```bash
ocs-gen-bt-metainfo IMAGE [CREATOR]
```

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

### Perform Direct Disk-to-Disk Clone

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/03-cli-ocs-onthefly.md

Clone a source disk to a target disk locally without compression.

```bash
ocs-onthefly -lo startdisk sda sdb
```

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

### Address Disk I/O Bottlenecks

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/10-error-reference.md

Identify and mitigate high disk utilization by defragmenting filesystems or stopping competing I/O processes.

```bash
# Defragment filesystem (if applicable)
e4defrag /dev/sda1

# Reduce I/O load (stop competing processes)
ps aux | grep -E "backup|sync|fsck"

# Disable disk cache during restore
# (increases reliability but slower)
# Usually not recommended

# Plan for longer times on slow media
# Budget 1-2 hours for large HDD with compression
```

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

### Clone specific partitions

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/03-cli-ocs-onthefly.md

Maps source partitions to target partitions on a 1:1 basis.

```bash
ocs-onthefly startparts "sda1 sda2" "sdb1 sdb2"
```

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

### Configure Timeouts and Delays

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Sets wait times for operations and delays between partition cloning tasks.

```bash
TIME_TO_WAIT_DEFAULT="120"
MAX_TIME_TO_WAIT_DEFAULT="300"
PART_PREPARE_TIME="30"
SLEEP_TIME_AFTER_PART_CLONED="15"
```

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

### Clonezilla Directory Structure

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/01-overview.md

The project layout showing core executable scripts, configuration files, and hook directories.

```text
clonezilla/
├── sbin/               # 70+ main executable scripts
│   ├── clonezilla      # Entry point for live
│   ├── ocs-sr          # Save/restore single-run
│   ├── ocs-onthefly    # Real-time device cloning
│   ├── drbl-ocs        # Server mode
│   ├── ocs-live        # Live wrapper
│   └── ocs-*           # 65+ utility scripts
├── bin/                # User-accessible commands
├── conf/               # Configuration files
│   └── drbl-ocs.conf   # Main configuration
├── samples/            # Example scripts
├── prerun/             # Pre-clone hooks
├── postrun/            # Post-clone hooks
├── scripts/            # Additional scripts
├── themes/             # UI themes
├── doc/                # Documentation
└── debian/             # Debian packaging files
```

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

### Fix SSH Connection Refused

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/10-error-reference.md

Commands to test SSH connectivity, manage firewall rules, and configure SSH keys for remote operations.

```bash
# Test SSH connectivity
ssh -v user@192.168.0.100 "echo ok"

# Ensure SSH running
systemctl start ssh
systemctl enable ssh

# Check firewall
ufw allow 22/tcp

# Verify network route
traceroute 192.168.0.100

# Generate SSH key
ssh-keygen -t rsa -f ~/.ssh/id_rsa -N ""
ssh-copy-id user@192.168.0.100
```

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

### Override Configuration via CLI

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Command-line arguments take precedence over configuration file defaults.

```bash
ocs-sr -z3 savedisk image sda      # Use -z3 regardless of config default
```

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

### Configure UDP Sender and Receiver Defaults

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Sets default extra options for udpcast sender and receiver processes.

```bash
udp_sender_extra_opt_default=""
udp_receiver_extra_opt_default=""
```

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

### Convert and verify images

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Utilities for modifying image compression, encryption, and checksum verification.

```bash
ocs-cvtimg-comp myimage 0 3      # Change compression
ocs-cvtimg-enc myimage encrypt   # Encrypt
ocs-chk-chksum myimage sha1sum   # Verify
```

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

### Save specific partitions

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/02-cli-ocs-sr.md

Saves selected partitions from a target disk.

```bash
ocs-sr --use-ntfsclone -z3 saveparts myimage2 "sda1 sda2"
```

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

### Generate image checksums

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Creates checksums for image files using specified algorithms like MD5, SHA1, BLAKE2, or BLAKE3.

```bash
ocs-gen-chksum IMAGE [TYPE]
```

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

### Resolve Image Size Mismatch

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/10-error-reference.md

Commands to apply proportional sizing or manual partition mapping when restoring to smaller target disks.

```bash
# Use proportional sizing
ocs-sr -k1 restoredisk myimage sda

# OR: Custom partition mapping
ocs-sr -k2 restoredisk myimage sda  # Manual mode
```

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

### Archive Volumes to Optical Media

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/09-workflows-and-examples.md

Iterates through split image volumes and burns them to individual DVDs.

```bash
# Burn each volume to separate DVD
for file in /home/partimag/archive-myhost/*.aaa; do
  mkisofs -R -J -V "Archive-Part-1" "$file" | \
    growisofs -Z /dev/sr0 -
done
```

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

### Disk-to-Disk Clone Command

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/09-workflows-and-examples.md

Performs a direct device-to-device clone without creating an intermediate image file.

```bash
# 1. Boot from Clonezilla Live on target system
# 2. SSH/console access to target

# 3. Clone directly (device-to-device)
ocs-onthefly -x -lo startdisk sda sdb
```

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

### Clone using UUIDs

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/03-cli-ocs-onthefly.md

Use UUIDs instead of device names to ensure consistent identification across system reboots.

```bash
ocs-onthefly -lo startdisk "UUID=abc123" "UUID=def456"
```

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

### Configure Network Pipe

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/03-cli-ocs-onthefly.md

Specify a custom network transport command for the cloning process.

```bash
ocs-onthefly --net-pipe "nc -l 2222" startdisk sda sdb
```

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

### Convert partition table sector size

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/06-utility-scripts.md

Adapts partition tables between 512B and 4K sectors for modern disk compatibility.

```bash
ocs-pt-512-4k-convert DEVICE
```

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

### eCryptFS Encryption Flow

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/08-image-format.md

Shows the storage process when using the -enc flag for eCryptFS encryption.

```text
sda1.ext4-ptcl.img.z → stored in eCryptFS mount
                     → requires password to access
```

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

### Set Metadata Creator

Source: https://github.com/stevenshiau/clonezilla/blob/master/_autodocs/07-configuration-reference.md

Defines the tool used for creating torrent metainfo.

```bash
metainfo_creator_def="ezio-ptcl"
```
Tokens:
Raw