Commit Graph

116 Commits

Author SHA1 Message Date
Marek Marczykowski-Górecki
9061169f90
Merge branch 'devel-20181206' 2018-12-09 18:08:25 +01:00
Marek Marczykowski-Górecki
0bb35193b4
doc: fix rst syntax in documentation, including docstrings 2018-12-08 23:53:55 +01:00
Marek Marczykowski-Górecki
57a98b97cb
doc: improve qvm-device man page
Move options after action.
Make note about `qvm-block`, `qvm-usb`, `qvm-pci` more visible.

Suggested by @GammaSQ
QubesOS/qubes-issues#4530
2018-12-08 23:29:25 +01:00
GammaSQ
4ae683054f
Fixed typo in documentation 2018-12-08 14:37:59 +01:00
GammaSQ
b49f2b0768
Documentation is important! Added shortcuts to manpages 2018-12-08 13:42:17 +01:00
Marek Marczykowski-Górecki
1c82441781
doc: add 'permissive' PCI device option and 'mic' device class
QubesOS/qubes-issues#4530
2018-12-08 00:44:18 +01:00
Marek Marczykowski-Górecki
bee55a3bce
tools/qvm-device: allow detaching all devices
QubesOS/qubes-issues#4530
2018-12-08 00:44:18 +01:00
Patrik Hagara
4cd513757b
qvm-ls: add filtering by domain power state 2018-10-10 20:06:35 +02:00
Patrik Hagara
cd4424235b
qvm-ls: add filtering by tags 2018-08-26 22:08:32 +02:00
Marek Marczykowski-Górecki
b6c1c6e99c
doc: add linux-stubdom feature to man qvm-features 2018-07-19 15:25:58 +02:00
Marek Marczykowski-Górecki
87122e54c9
Merge branch 'windows-tools'
* windows-tools:
  doc: add info what properties are inherited from template
  Add 'gui-emulated' feature
  qvm-start-gui: fix handlign rpc-clipboard feature
2018-07-16 22:06:44 +02:00
Marek Marczykowski-Górecki
860102b300
doc: add info what properties are inherited from template 2018-07-16 04:25:56 +02:00
Marek Marczykowski-Górecki
4d61407f5d
Add 'gui-emulated' feature
Add an explicit method for forcing emulated VGA output. Previously it
was possible only by removing `gui` feature (setting it to false had a
different effect), or enabling debug mode.
Using lack of a feature as a third state was a bad idea.

QubesOS/qubes-issues#3585
2018-07-16 04:25:56 +02:00
Marta Marczykowska-Górecka
58820f4439
Deleted a duplicate man qvm-services entry
qubes-network entry in 'man qvm-services' was duplicated, and now it is
de-duplicated.
2018-07-16 01:37:08 +02:00
Peter Gerber
b2a70f3794
tools/qvm-firewall: improve manpage and --help output 2018-05-03 01:03:35 +02:00
Peter Gerber
00fbfdd77a
tools/qvm-firewall: add dst4 and dst6 as synonyms for dsthost 2018-05-03 00:49:43 +02:00
Marek Marczykowski-Górecki
7f79075088
tools/qvm-firewall: add 'expire' rule support 2018-04-30 04:13:45 +02:00
Marek Marczykowski-Górecki
fbd5ca4150
tools/qvm-ls: add --kernel option for compatibility with R3.2
There was such option on Qubes 3.2, so add it here too. This is
especially useful for kernel package - preun script use it to verify if
given kernel isn't needed anymore.
2018-04-21 02:51:31 +02:00
Marek Marczykowski-Górecki
f46afecfe4
Merge remote-tracking branch 'qubesos/pr/65'
* qubesos/pr/65:
  Add 'make clean' target, use it for Debian build
  doc: adjust example in qvm-pool man page
  tools/qvm-pool: add --set to modify pool properties
  tools: fix error reporing on unknown storage pool
2018-04-14 22:15:26 +02:00
Marek Marczykowski-Górecki
63d294ce92
Merge remote-tracking branch 'qubesos/pr/63'
* qubesos/pr/63:
  spec.in: add changelog placeholder
  doc: handle release definition when not being in a git repository
  Remove _builddir and useless condition on qubes_builder
  Create .spec.in and Source0
2018-04-14 21:43:41 +02:00
Marek Marczykowski-Górecki
c669e9f9f6
doc: adjust example in qvm-pool man page
'xen' driver does not even exists.
2018-04-13 00:26:30 +02:00
Marek Marczykowski-Górecki
90df051f4f
tools/qvm-pool: add --set to modify pool properties
Fixes QubesOS/qubes-issues#3256
2018-04-13 00:26:25 +02:00
Frédéric Pierret
9fe403e3c7
doc: handle release definition when not being in a git repository 2018-04-01 11:29:36 +02:00
Marek Marczykowski-Górecki
70b15c2eae
qvm-volume: refuse to shrink volume unless --force option is used
Right now Admin API backend will refuse to shrink volume anyway, but
we're planning to relax this restriction. Make sure the client side
(qvm-volume tool here, GUI VM settings already have this in place) will
employ appropriate safety check.

QubesOS/qubes-issues#3725
2018-03-20 17:53:36 +01:00
Marek Marczykowski-Górecki
25803fd6af
doc: update qvm-volume parameters
Use *VMNAME:VOLUME* instead of *POOL_NAME:VOLUME_ID*, because this is
the default form.
2018-03-20 16:51:04 +01:00
Marek Marczykowski-Górecki
034e9b3a24
qvm-volume: add 'info' and 'config' actions
This allows to get and set volumes properties.

Fixes QubesOS/qubes-issues#3256
2018-03-18 23:38:10 +01:00
Marek Marczykowski-Górecki
b9b9eb1f3b
doc: fix module index generation
Result of `sphinx-apidoc qubesadmin`
2018-03-07 01:34:42 +01:00
Marek Marczykowski-Górecki
4904d2a360
doc: typos 2018-03-07 00:34:54 +01:00
Marek Marczykowski-Górecki
fceb7ff7c0
Merge remote-tracking branch 'qubesos/pr/55'
* qubesos/pr/55:
  restore.py: add template-related debug log messages
  restory.py: restore template_for_dispvms property early
  restore.py: factor out _restore_property() helper
  restore.py: deal with DispVM templates
  restore.py: sort into three tiers in _templates_first()
  restore.py: don't try to restore dispid property
  qvm-backup: let backup core handle default VM selection
  qvm-backup-restore: really pass options
  qvm-backup-restore: remove orphaned --replace-template option
2018-02-25 01:35:09 +01:00
Marek Marczykowski-Górecki
70ac72b579
doc: add 'pci-e820-host' feature description 2018-02-25 00:13:27 +01:00
Rusty Bird
a0d6327532
qvm-backup-restore: remove orphaned --replace-template option 2018-02-23 02:09:03 +00:00
Marek Marczykowski-Górecki
b16f3ab79b
tools/qvm-ls: add --network and --disk compatibility options
Shortcuts for new --format=...
2018-01-12 05:29:39 +01:00
Marek Marczykowski-Górecki
080b563ae2
tools/qvm-ls: add --raw-list option for compatibility with R3.2
There was an option to list just VM names, useful for scripting.
Preserve that for compatibility.
2018-01-12 05:29:39 +01:00
Marek Marczykowski-Górecki
3fcae995df
doc: add info about specific qvm-device cases
The tool can be called also as qvm-DEVICE_CLASS, for example qvm-block
or qvm-pci.
2018-01-11 02:09:47 +01:00
Rusty Bird
a1171a8fa8
qvm-device.rst: Document '--ro' option 2018-01-10 21:57:54 +00:00
Marek Marczykowski-Górecki
51a89a9e77
Merge remote-tracking branch 'qubesos/pr/44'
* qubesos/pr/44:
  Fix style else-return
  tests: update qvm-template-process and qvm-remove tests
  Add --force to manpage.
  Avoid cloning installed_by_rpm
  Print vm list before prompt
  Use --force instead of --yes
  Toggle installed_by_rpm in template tool
  Fix error message grammar
  Add --yes option and confirm prompt.
2018-01-06 14:54:32 +01:00
Christopher Laprise
7a948c7f19
Add --force to manpage. 2018-01-05 18:05:17 -05:00
Marek Marczykowski-Górecki
6258eae17f
doc: update qvm-features documentation
QubesOS/qubes-issues#2488
QubesOS/qubes-issues#3432
2018-01-05 16:24:12 +01:00
Marek Marczykowski-Górecki
2fac77da6f
Document device attach options in man page
Fixes QubesOS/qubes-issues#3204
2017-10-24 03:24:43 +02:00
Marek Marczykowski-Górecki
cbdc2170b4
tools: clarify that qvm-backup needs absolute path
Fixes QubesOS/qubes-issues#3066
2017-10-16 03:09:10 +02:00
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
Marek Marczykowski-Górecki
0fa374264f
tools: add qvm-create --help-classes
List available VM classes

QubesOS/qubes-issues#3017
2017-08-30 16:54:24 +02:00
Marek Marczykowski-Górecki
10f6d96e0f
doc: add short description of VM classes to qvm-create man page 2017-08-14 09:25:09 +02:00
Marek Marczykowski-Górecki
f7b31a005e
doc: update list of properties in qvm-prefs/qubes-prefs man pages
Fixes QubesOS/qubes-issues#3011
2017-08-12 22:37:59 +02:00
Marek Marczykowski-Górecki
a260685bd1
tools: drop --delete and --unset aliases for --default option
This may be confiusing, for example one may think that
`qvm-prefs --unset vmname netvm` will make vmname network-disconnected.
This type of mistakes may have severe security consequence, so better
drop those option names.

QubesOS/qubes-issues#3002

cc @rootkovska
2017-08-12 22:33:36 +02:00
Marek Marczykowski-Górecki
51a7b4493b
doc: add default values to qvm-features man page
QubesOS/qubes-issues#
2017-08-10 15:26:55 +02:00
Marek Marczykowski-Górecki
7d476f8ba2
doc: list known features in qvm-features manual page
Fixes QubesOS/qubes-issues#2410
2017-08-08 21:31:34 +02:00
Marek Marczykowski-Górecki
37ae76823b
tools: add qvm-run --dispvm option
Add option to uniformly start new DispVM from either VM or Dom0. This
use DispVMWrapper, which translate it to either qrexec call to $dispvm,
or (in dom0) to appropriate Admin API call to create fresh DispVM
first.
This require abandoning registering --all and --exclude by
QubesArgumentParser, because we need to add --dispvm mutually exclusive
with those two. But actually handling those two options is still done by
QubesArgumentParser.

This also updates man page and tests.

Fixes QubesOS/qubes-issues#2974
2017-08-06 20:44:55 +02:00
Marek Marczykowski-Górecki
f48321dd98
Merge branch 'devel-6'
* devel-6:
  qvm-ls: fix total VM size reporting
  doc: update manpage of qvm-service
  tools: qvm-service tool
  tests: too much copy&paste
  features: serialize True as '1'
  tools/qvm-start-gui: add --force-stubdomain options
  tools/qvm-shutdown: fix help message
  tools/qvm-shutdown: drop --force option, it isn't supported anymore
2017-07-29 05:28:57 +02:00
Marek Marczykowski-Górecki
9210048673
backup/restore: add option to ignore size limit
Allow to restore backup which have miscalculated VMs size, but otherwise
is good.
2017-07-29 05:13:46 +02:00
Marek Marczykowski-Górecki
07cffc340c
doc: update qvm-backup man page 2017-07-29 00:17:07 +02:00
Marek Marczykowski-Górecki
80f1dd7d13
doc: update manpage of qvm-service
QubesOS/qubes-issues#1227
2017-07-28 14:24:08 +02:00
Marek Marczykowski-Górecki
416ee0bd22
tools/qvm-start-gui: add --force-stubdomain options
Sometimes it's useful to access emulated VGA, without rebooting the VM
in debug mode
2017-07-27 19:17:47 +02:00
Marek Marczykowski-Górecki
5d0bd4f6dc
tools/qvm-shutdown: drop --force option, it isn't supported anymore
Admin API does not allow this action.
2017-07-27 19:17:47 +02:00
Marek Marczykowski-Górecki
2d5d9d6d7d
tools: add qvm-backup tool
New qvm-backup tool can either use pre-existing backup profile
(--profile), or - when running in dom0 - can create new one based on
used options (--save-profile).

This commit add a tool itself, update its man page, and add tests for
it.

Fixes QubesOS/qubes-issues#2931
2017-07-21 03:58:18 +02:00
Marek Marczykowski-Górecki
ae0729fb53
storage: drop 'internal' volume property
Since external block devices use Devices API now, it isn't useful
anymore.

QubesOS/qubes-issues#2256
2017-07-21 03:10:01 +02:00
Marek Marczykowski-Górecki
f0151d73b3
tools: add qvm-backup-restore
Frontend tool for backup restore code.

Fixes QubesOS/qubes-issues#1214
2017-07-17 20:28:22 +02:00
Marek Marczykowski-Górecki
bcd026d141
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 01:34:18 +02:00
Marek Marczykowski-Górecki
12fd4eb035
doc: minor fixes to man pages 2017-06-20 01:34:17 +02:00
Marek Marczykowski-Górecki
90141a1bef
doc: fix skel-manpage tool 2017-06-20 01:34:17 +02:00
Marek Marczykowski-Górecki
8e5f90c273
tools: add qvm-tags tool
QubesOS/qubes-issues#2388
2017-06-20 01:34:17 +02:00
Wojtek Porczyk
57cabc395b qvm-ls: run a spinner while waiting
Since Admin API, qvm-ls takes a long time to complete. Therefore,
Corporate Headquarters commanded that a Enterprise Spinner is to be
implemented and mandated it's use unto us.

We take amusement from its endless gyrations.
2017-06-07 20:59:01 +02:00
Marek Marczykowski-Górecki
38abd81ea8
tools: add qvm-run --service
Make it convenient wrapper around qrexec-client{-vm}, which would start
a VM, wait for user session etc.
2017-05-20 03:15:23 +02:00
Marek Marczykowski-Górecki
4ceff0f8c0
Rename qubesmgmt to qubesadmin module
QubesOS/qubes-issues#853
2017-05-11 23:40:03 +02:00
Marek Marczykowski-Górecki
54d992f727
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 21:13:57 +02:00
Marek Marczykowski-Górecki
70e04eddf8
doc: Sphinx config skeleton
Some parts (especially in qubesmgmt/dochelpers.py) copied from
core-admin repo.
2017-05-11 21:13:56 +02:00