Qubes/core-admin-client
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
416532ba42
core-admin-client/doc/manpages/qvm-clone.rst

60 lines
1.7 KiB
ReStructuredText
Raw Normal View History

doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
.. program:: qvm-clone
:program:`qvm-clone` -- Clones an existing VM by copying all its disk files
===========================================================================
.. 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
--------
Implement VM clone as create + copy data+metadata This way we don't need separate admin.vm.Clone call, which is tricky to handler properly with policy. A VM may not have access to all the properties and other metadata, so add ignore_errors argument, for best-effort approach (copy what is possible). In any case, failure of cloning VM data fails the whole operation. When operation fails, VM is removed. While at it, allow to specify alternative VM class - this allows morphing one VM into another (for example AppVM -> StandaloneVM). Adjust qvm-clone tool and tests accordingly. QubesOS/qubes-issues#2622
2017-06-20 00:02:20 +02:00
:command:`qvm-clone` [*options*] *VMNAME* *NEWVM*
doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
Options
-------
.. option:: --help, -h
Show this help message and exit
Implement VM clone as create + copy data+metadata This way we don't need separate admin.vm.Clone call, which is tricky to handler properly with policy. A VM may not have access to all the properties and other metadata, so add ignore_errors argument, for best-effort approach (copy what is possible). In any case, failure of cloning VM data fails the whole operation. When operation fails, VM is removed. While at it, allow to specify alternative VM class - this allows morphing one VM into another (for example AppVM -> StandaloneVM). Adjust qvm-clone tool and tests accordingly. QubesOS/qubes-issues#2622
2017-06-20 00:02:20 +02:00
.. option:: --class=CLASS, -C CLASS
Create VM of different class than source VM. The tool will try to copy as
much as possible data/metadata from source VM, but some information may be
impossible to preserve (for example target VM have no matching properties).
doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
.. option:: -P POOL
Pool to use for the new domain. All volumes besides snapshots volumes are
imported in to the specified POOL. THIS IS WHAT YOU WANT TO USE NORMALLY.
.. option:: --pool=POOL:VOLUME, -p POOL:VOLUME
Specify the pool to use for the specific volume
Adds docs for clone ignore_errors, feeds linter Addresses review comments, specifically: * updates qvm-clone tests to handle ignore_errors option * adds manpage reference to new --ignore-errors option * trims line length in qvm-clone changes All tests should now be passing, including the new qvm-clone functionality.
2019-04-16 18:25:36 +02:00
.. option:: --ignore-errors
Log errors encountered when creating metadata, but continue with clone
operation. Useful if qvm-appmenus call fails from an AdminVM during clone.
doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
.. option:: --quiet, -q
Be quiet
.. option:: --verbose, -v
Increase verbosity
Authors
-------
| Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com>
| Marek Marczykowski <marmarek at invisiblethingslab dot com>
| Bahtiar `kalkin-` Gadimov <bahtiar at gadimov dot de>
Reference in New Issue Copy Permalink