core-admin-client/doc/manpages/qvm-start.rst
Marek Marczykowski-Górecki 5e2638ab5e
tools: restore qvm-start --cdrom and similar options
Booting a VM from cdrom require attaching the device before VM startup,
which is possible only in persistent mode. But for qvm-start --cdrom
adding a cdrom only temporarily, use new update_persistence() function
to convert the assignment to temporary one.

Fixes QubesOS/qubes-issues#3055
2017-09-05 08:33:47 +02:00

85 lines
2.1 KiB
ReStructuredText

.. program:: qvm-start
:program:`qvm-start` -- start a domain
======================================
.. warning::
This page was autogenerated from command-line parser. It shouldn't be 1:1
conversion, because it would add little value. Please revise it and add
more descriptive help, which normally won't fit in standard ``--help``
option.
After rewrite, please remove this admonition.
Synopsis
--------
:command:`qvm-start` [-h] [options] *VMNAME*
Options
-------
.. option:: --help, -h
Show help message and exit.
.. option:: --verbose, -v
Increase verbosity.
.. option:: --quiet, -q
Decrease verbosity.
.. option:: --skip-if-running
Do not fail if the qube is already runnning
.. option:: --all
perform the action on all qubes
.. option:: --exclude
exclude the qube from --all
.. option:: --drive=DRIVE
Temporarily attach specified drive as CD/DVD or hard disk (can be specified with prefix "hd:" or "cdrom:", default is cdrom).
The syntax for the device itself is "qube_name:device_name", meaning *device_name* served by *qube_name*.
See `qvm-block` output for a list of available devices.
Additionally, "qube_name:path" syntax can be used. This
will setup loop device inside *qube_name*, pointing at *path*, and will use
it as device. You need to clean up that loop device yourself, but it will
also cleanup itself at next qube restart. This syntax is available only when
calling this tool from dom0.
.. option:: --hddisk=DRIVE
Temporarily attach specified drive as hard disk. This is equivalent with
`--drive=hd:DRIVE`.
.. option:: --cdrom=DRIVE
Temporarily attach specified drive as CD/DVD. This is equivalent with
`--drive=cdrom:DRIVE`.
.. option:: --install-windows-tools
Temporarily attach Windows tools CDROM to the domain. This is equivalent with
`--cdrom=dom0:/usr/lib/qubes/qubes-windows-tools.iso`.
Authors
-------
| Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com>
| Marek Marczykowski <marmarek at invisiblethingslab dot com>
| Wojtek Porczyk <woju at invisiblethingslab dot com>
.. vim: ts=3 sw=3 et tw=80