Skip to content

Instantly share code, notes, and snippets.

@gotbletu gotbletu/ocs-sr
Last active Oct 11, 2019

Embed
What would you like to do?
Clonezilla ocs-sr commandline options manpage
Clonezilla (v2.5.0) "ocs-sr" Options
(Reformated for easier reading)
To save or restore image
ocs-sr [OPTION] {MODE} IMAGE_NAME DEVICE
Where MODE is one of
savedisk
saveparts
restoredisk
restoreparts
Options for saving:
-noabo, --not-only-access-by-owner
Make the image of partition can be accessed by others, not only by owner.
By default the image of partition will be changed as 600. With this
option, it will be 644.
-senc, --skip-enc-ocs-img
Skip encrypting the image with passphrase.
-enc, --enc-ocs-img
To encrypt the image with passphrase.
-sfsck, --skip-fsck-src-part
Skip running fsck on the source file system before saving it.
-fsck, -fsck-src-part, --fsck-src-part
Run fsck interactively on the source file system before saving it.
-fsck-y, -fsck-src-part-y, --fsck-src-part-y
Run fsck automatically on the source file system before saving it. This
option will always attempt to fix any detected filesystem corruption
automatically. //NOTE// Use this option in caution.
-gm, --gen-md5sum
Generate the MD5 checksum for the image. Later you can use -cm or
--check-md5sum option to check the image when restoring the image.
Note! It might take a lot of time to generate if the image size is
large.
-gs, --gen-sha1sum
Generate the SHA1 checksum for the image. Later you can use -cs or
--check-sha1sum option to check the image when restoring the image.
Note! It might take a lot of time to generate if the image size is
large.
-gmf, --gen-chksum-for-files-in-dev
Generate the checksum for files in the source device. Later you can use
-cmf or --chk-chksum-for-files-in-dev to check the files in the
destination device after they are restored. Note! It might take a lot of
time to inspect the checksum if there are many files in the destination
device.
-i, --image-size SIZE
Set the split image file volume size SIZE (MB). When ocs-sr is run with
-x, the default SIZE is set as 4096, if without -x, we will not split
it. For storing on FAT32 filesystems, the SIZE should not be larger
than 4096.
-j2, --clone-hidden-data
Use dd to clone the image of the data between MBR (1st sector, i.e. 512
bytes) and 1st partition, which might be useful for some recovery tool.
-ntfs-ok, --ntfs-ok
Assume the NTFS integrity is OK, do NOT check again (for ntfsclone only)
-rm-win-swap-hib, --rm-win-swap-hib
Try to remove the MS windows swap file in the source partition.
-q, --use-ntfsclone
If the partition to be saved is NTFS, use program ntfsclone instead of
partimage (i.e. Priority: ntfsclone > partimage > dd)
-q1, --force-to-use-dd
Force to use dd to save partition(s) (inefficient method, very slow, but
works for all the file system).
-q2, --use-partclone
Use partclone to save partition(s) (i.e. partclone > partimage > dd).
-rescue, --rescue
Turn on rescue mode, i.e. try to skip bad sectors.
-sc, -scs, --skip-check-restorable, --skip-check-restorable-s
By default Clonezilla will check the image if restorable after it is
created. This option allows you to skip that.
-z0, --no-compress
Don't compress when saving: fast but very big image file
-z1, --gzip-compress
Compress using gzip when saving (default)
-z1p, --smp-gzip-compress
Compress using parallel gzip program (pigz) for multi-cpu machines
-z2, --bz2-compress
Compress using bzip2 when saving: slow but smallest image file
-z2p, --smp-bzip2-compress
Compress using parallel bzip2 program (pbzip2) for multi-cpu machines
-z3, --lzo-compress
Compress using lzop when saving: similar to gzip but faster
-z4, --lzma-compress
Compress using lzma when saving: similar to bzip but faster
-z5, --xz-compress
Compress using xz when saving: faster decompression than bzip2.
-z5p, --smp-xz-compress
Compress using parallel xz when saving
-z6, --lzip-compress
Compress using lzip when saving: faster decompression than bzip2.
-z6p, --smp-lzip-compress
Compress using parallel lzip when saving
-z7, --lrzip-compress
Compress using lrzip when saving.
Some words are reserved for IMAGE_NAME, "ask_user" is used to let user to
input a name when saving an image. "autoname" is used to automatically
generate the image name based on network card MAC address and time.
"autohostname" is used to automatically generate the image name based on
hostname. "autoproductname" is used to automatically generate the image name
based on hardware product model gotten from dmidecode.
A word is reserved for DEVICE, "ask_user" could be used to let user to select
the source device when saving an image.
Options for restoring:
-f, --from-part-in-img PARTITION
Restore the partition from image. This is especially for "restoreparts"
to restore the image of partition (only works for one) to different
partition, e.g. sda1 of image to sdb6.
-g, --grub-install GRUB_PARTITION
Install grub in the MBR of the disk containing partition GRUB_PARTITION
with root grub directory in the same GRUB_PARTITION when restoration
finishes, GRUB_PARTITION can be one of "/dev/sda1", "/dev/sda2"... or
"auto" ("auto" will let clonezilla detect the grub root partition
automatically). If "auto" is assigned, it will work if grub partition
and root partition are not in the same partition.
-r, --resize-partition
Resize the partition when restoration finishes, this will resize the
file system size to fit the partition size. It is normally used when
when a small partition image is restored to a larger partition.
-k, --no-fdisk, --no-create-partition
Do NOT create partition in target harddisk. If this option is set, you
must make sure there is an existing partition table in the current
restored harddisk. Default is to create the partition table.
-icrc, --icrc
Skip Partclone CRC checking.
-irhr, --irhr
Skip removing the Linux udev hardware records on the restored GNU/Linux.
-irvd, --irvd
Skip removing the NTFS volume dirty flag after file system is restored.
-ius, --ius
Skip updating syslinux-related files on the restored GNU/Linux.
-icds, --ignore-chk-dsk-size-pt
Skip checking destination disk size before creating the partition table
on it. By default it will be checked and if the size is smaller than the
source disk, quit.
-iefi, --ignore-update-efi-nvram
Skip updating boot entries in EFI NVRAM after restoring.
-k1
Create partition table in the target disk proportionally.
-k2
Enter command line prompt to create partition table manually before
restoring image.
-t, --no-restore-mbr
Do NOT restore the MBR (Mater Boot Record) when restoring image. If this
option is set, you must make sure there is an existing MBR in the
current restored harddisk. Default is Yes. See -g above
-u, --select-img-in-client
Input the image name in clients
-e, --load-geometry
Force to use the saved CHS (cylinders, heads, sectors) when using sfdisk
-e1, --change-geometry NTFS-BOOT-PARTITION
Force to change the CHS (cylinders, heads, sectors) value of NTFS boot
partition after image is restored. NTFS-BOOT-PARTITION can be one of
"/dev/sda1", "/dev/sda2"... or "auto" ("auto" will let clonezilla detect
the NTFS boot partition automatically)
-e2, --load-geometry-from-edd
Force to use the CHS (cylinders, heads, sectors) from EDD (Enhanced Disk
Device) when creating partition table by sfdisk
-y, -y0, --always-restore, --always-restore-default-local
Let Clonezilla server as restore server, i.e. client will always has
restore mode to choose (However default mode in PXE menu is local boot)
-y1, --always-restore-default-clone
Let Clonezilla server as restore server, i.e. client will always has
restore mode to choose (The default mode in PXE menu is clone, so if
client boots, it will enter clone always, i.e. clone forever)
-j, --create-part-by-sfdisk
Use sfdisk to create partition table instead of using dd to dump the
partition table from saved image (This is default)
-j0, --create-part-by-dd
Use dd to dump the partition table from saved image instead of sfdisk.
///Note/// This does NOT work when logical drives exist.
-j1, --dump-mbr-in-the-end
Use dd to dump the MBR (total 512 bytes, i.e. 446 bytes (executable code
area) + 64 bytes (table of primary partitions) + 2 bytes (MBR signature;
# 0xAA55) = 512 bytes) after disk image was restored. This is an
insurance for some hard drive has different numbers of cylinder, head and
sector between image was saved and restored.
-j2, --clone-hidden-data
Use dd to clone the image of the data between MBR (1st sector, i.e. 512
bytes) and 1st partition, which might be useful for some recovery tool.
-hn0 PREFIX
Change the hostname of M$ Windows based on the combination of hostname
prefix and IP address, i.e. PREFIX-IP
-hn1 PREFIX
Change the hostname of M$ Windows based on the combination of hostname
prefix and NIC MAC address, i.e. PREFIX-MAC
--max-time-to-wait TIME
When not enough clients have connected (but at least one), start anyways
when TIME seconds since first client connection have pased. This option
is used with --clients-to-wait
-scr, --skip-check-restorable-r
By default Clonezilla will check the image if restorable before
restoring. This option allows you to skip that.
-cm, --check-md5sum
Check the MD5 checksum for the image. To use this option, you must enable
-gm|--gen-md5sum option when the image is saved. Note! It might take
a lot of time to check if the image size is large.
-cs, --check-sha1sum
Check the SHA1 checksum for the image. To use this option, you must
enable -gs or --gen-sha1sum option when the image is saved. Note! It
might take a lot of time to check if the image size is large.
-cmf, --chk-chksum-for-files-in-dev
Check the checksum for the files in the device. To use this option, you
must enable -gmf or --gen-chksum-for-files-in-dev when the image is saved.
Note! (1) The file system must be supported by Linux kernel so that it
can be mounted as read-only to check the files. (2) It might take a lot
of time to check if there are many files in the source device.
-srel, --save-restore-error-log
Save the error log file in the image dir. By default the log file won't
be saved when error occurs.
--mcast-port NO
Assign the udp port number for multicast restore. This is used by
clonezilla server. Normally it's not necessary to manually assign this
option.
Some words are reserved for IMAGE_NAME, "ask_user" is used to let user to
input a name when saving an image. "autoproductname" is used to automatically
get the image name based on hardware product model from dmidecode.
A word is reserved for DEVICE, "ask_user" could be used to let user to select
the source device when saving an image.
General options:
-l, --language
INDEX Set the language to be shown by index number:
[0|en_US.UTF-8]: English,
[2|zh_TW.UTF-8]: Traditional Chinese (UTF-8, Unicode) - Taiwan
[a|ask]: Prompt to ask the language index
-b, -batch, --batch
(DANGEROUS!) Run program in batch mode, i.e. without any prompt or wait
for pressing enter key. //NOTE// You have to use '-batch' instead of
'-b' when you want to use it in the boot parameters. Otherwise the
program init on system will honor '-b', too.
-c, --confirm
Wait for confirmation before saving or restoring
-d, --debug-mode
Enter command mode to debug before saving/restoring
--debug=LEVEL
Output the partimage debug log in directory /var/log/ with debug LEVEL
(0,1,2... default=0)
-m, --module MODULE
Force to load kernel module MODULE, this is useful when some SCSI device
is not detected. NOTE! Use only one module, more than one may cause
parsing problem.
-o0, --run-prerun-dir
Run the script in the directory /usr/share/drbl/postrun/ocs/ before
clone is started. The command will be run before MBR is created or
saved.
-o1, -o, --run-postrun-dir
Run the script in the directory /usr/share/drbl/postrun/ocs/ when clone
is finished. The command will be run before that assigned in -p or
--postaction.
-w, --wait-time TIME
Wait for TIME secs before saving/restoring
-nogui, --nogui
Do not show GUI (TUI) of Partclone or Partimage, use text only
-a, --no-force-dma-on
Do not force to turn on HD DMA
-mp, --mount-point MOUNT_POINT
Use NFS to mount MOUNT_POINT as directory ocsroot (ocsroot is assigned
in drbl.conf)
-or, --ocsroot DIR
Specify DIR (absolute path) as directory ocsroot (i.e. overwrite the
ocsroot assigned in drbl.conf)
-p, --postaction [choose|poweroff|reboot|command|CMD]
When save/restoration finishes, choose action in the client, poweroff,
reboot (default), in command prompt or run CMD
-ns, --ntfs-progress-in-image-dir
Save the ntfsclone progress tmp file in the image dir so that if cloning
is in DRBL client, the progress can be check in the server (Default in
to be put in local /tmp/, which is local tmpfs).
-um, --user-mode [beginner|expert]
Specify the mode to use. If not specified, default mode is for a beginner.
-v, --verbose
Prints verbose information
-d0, --dialog Use dialog
-d1, --Xdialog Use Xdialog
-d2, --whiptail Use whiptail
-d3, --gdialog Use gdialog
-d4, --kdialog Use kdialog
-x, --interactive
Interactive mode to save or restore.
Example:
To save or restore image in client (Only that DRBL client will join, and its
local partitions is NOT mounted). NOTE!!! You should run the command in DRBL
client or you have to make sure the target device is NOT busy!.
To save all the data in local first IDE harddrive 'hda' as image 'IMAGE1', use
ntfsclone instead of partimage, and lzop compression (NOTE!!! You should run
the command in DRBL client or make sure hda is NOT busy/mounted!):
ocs-sr --use-ntfsclone -z3 savedisk IMAGE1 hda
To save the data in first and second partitions in local first IDE harddrive
'hda' as image 'IMAGE2', use ntfsclone instead of partimage, and lzop
compression (NOTE!!! You should run the command in DRBL client, or make sure
hda is NOT busy/mounted!):
ocs-sr --use-ntfsclone -z3 saveparts IMAGE2 "hda1 hda2"
To restore image IMAGE1 to local hda. grub-install will be run after cloning
(image IMAGE1 is already in DRBL server. NOTE!!! You should run the command
in DRBL client or make sure hda is NOT busy/mounted!):
ocs-sr -g auto restoredisk IMAGE1 hda
To restore image first and second partitions from IMAGE2 to local hda1 and
hda2. grub-install will be run after cloning (image IMAGE2 is already in DRBL
server. NOTE!!! You should run the command in DRBL client or make sure hda is
NOT busy/mounted!):
ocs-sr -g auto restoreparts IMAGE2 "hda1 hda2"
To save disk(s)/partitition(s) as an image or restore an image to
disk(s)/partitition(s) interactively, use:
ocs-sr -x
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.