Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2025-10-13 11:00:42 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add newlines where present in Markdown version

Browse source
This commit is contained in:
Tobias Killer 2025-08-23 11:31:46 +02:00
parent 140789e7fc
commit 3e683cda68
1 changed files with 23 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

34
developer/services/admin-api.rst
View file

@ -91,9 +91,11 @@ it easy to set the policy using current mechanism.
* - ``admin.vm.CreateInPool.<class>`` * - ``admin.vm.CreateInPool.<class>``
- ``dom0`` - ``dom0``
- template - template
- ``name=<name> label=<label>``, ``pool=<pool> pool:<volume>=<pool>`` - | ``name=<name> label=<label>``
| ``pool=<pool> pool:<volume>=<pool>``
- `-` - `-`
- either use ``pool=`` to put all volumes there, or ``pool:<volume>=`` for individual volumes - both forms are not allowed at the same time - | either use ``pool=`` to put all volumes there,
| or ``pool:<volume>=`` for individual volumes - both forms are not allowed at the same time
* - ``admin.vm.CreateDisposable`` * - ``admin.vm.CreateDisposable``
- template - template
- `-` - `-`
@ -146,7 +148,8 @@ it easy to set the policy using current mechanism.
- ``dom0`` - ``dom0``
- property - property
- `-` - `-`
- ``default={True|False}`` ``type={str|int|bool|vm|label|list} <value>`` - | ``default={True|False}``
| ``type={str|int|bool|vm|label|list} <value>``
- Type ``list`` is added in R4.1. Values are of type ``str`` and each entry is suffixed with newline character. - Type ``list`` is added in R4.1. Values are of type ``str`` and each entry is suffixed with newline character.
* - ``admin.property.GetAll`` * - ``admin.property.GetAll``
- ``dom0`` - ``dom0``
@ -194,7 +197,8 @@ it easy to set the policy using current mechanism.
- vm - vm
- property - property
- `-` - `-`
- ``default={True|False}`` ``type={str|int|bool|vm|label|list} <value>`` - | ``default={True|False}``
| ``type={str|int|bool|vm|label|list} <value>``
- Type ``list`` is added in R4.1. Each list entry is suffixed with a newline character. - Type ``list`` is added in R4.1. Each list entry is suffixed with a newline character.
* - ``admin.vm.property.GetAll`` * - ``admin.vm.property.GetAll``
- vm - vm
@ -339,7 +343,9 @@ it easy to set the policy using current mechanism.
- device - device
- assignment-serialization - assignment-serialization
- `-` - `-`
- ``device`` is in form ``<backend-name>+<device-ident>``; optional options given in ``key=value`` format, separated with spaces; options can include ``persistent=True`` to "persistently" attach the device (default is temporary) - | ``device`` is in form ``<backend-name>+<device-ident>``
| optional options given in ``key=value`` format, separated with spaces;
| options can include ``persistent=True`` to "persistently" attach the device (default is temporary)
* - ``admin.vm.device.<class>.Detach`` * - ``admin.vm.device.<class>.Detach``
- vm - vm
- device - device
@ -351,7 +357,8 @@ it easy to set the policy using current mechanism.
- device - device
- assignment-serialization - assignment-serialization
- `-` - `-`
- ``device`` is in form ``<backend-name>+<device-ident>``; ``assignment-serialization`` is specified in the section Device Serialization. - | ``device`` is in form ``<backend-name>+<device-ident>``
| ``assignment-serialization`` is specified in the section Device Serialization.
* - ``admin.vm.device.<class>.Unassign`` * - ``admin.vm.device.<class>.Unassign``
- vm - vm
- device - device
@ -375,19 +382,22 @@ it easy to set the policy using current mechanism.
- device-ident - device-ident
- `-` - `-`
- ``<device-ident> <device-serialization>\n`` - ``<device-ident> <device-serialization>\n``
- optional service argument may be used to get info about a single device, ``device-serialization`` is specified in the section Device Serialization. - | optional service argument may be used to get info about a single device,
| ``device-serialization`` is specified in the section Device Serialization.
* - ``admin.vm.device.<class>.Assigned`` * - ``admin.vm.device.<class>.Assigned``
- vm - vm
- device-ident - device-ident
- `-` - `-`
- ``<device-ident> <assignment-serialization>\n`` - ``<device-ident> <assignment-serialization>\n``
- optional service argument may be used to get info about a single device, ``assignment-serialization`` is specified in the section Device Serialization. - | optional service argument may be used to get info about a single device,
| ``assignment-serialization`` is specified in the section Device Serialization.
* - ``admin.vm.device.<class>.Attached`` * - ``admin.vm.device.<class>.Attached``
- vm - vm
- device-ident - device-ident
- `-` - `-`
- ``<device-ident> <assignment-serialization>\n`` - ``<device-ident> <assignment-serialization>\n``
- optional service argument may be used to get info about a single device, ``assignment-serialization`` is specified in the section Device Serialization. - | optional service argument may be used to get info about a single device,
| ``assignment-serialization`` is specified in the section Device Serialization.
* - ``admin.pool.List`` * - ``admin.pool.List``
- ``dom0`` - ``dom0``
- `-` - `-`
@ -477,7 +487,8 @@ it easy to set the policy using current mechanism.
- pool - pool
- vid - vid
- token, to be used in ``admin.pool.volume.CloneTo`` - token, to be used in ``admin.pool.volume.CloneTo``
- obtain a token to copy volume ``vid`` in ``pool``; the token is one time use only, it's invalidated by ``admin.pool.volume.CloneTo``, even if the operation fails - | obtain a token to copy volume ``vid`` in ``pool``;
| the token is one time use only, it's invalidated by ``admin.pool.volume.CloneTo``, even if the operation fails
* - ``admin.pool.volume.CloneTo`` * - ``admin.pool.volume.CloneTo``
- ``dom0`` - ``dom0``
- pool - pool
@ -549,7 +560,8 @@ it easy to set the policy using current mechanism.
- volume - volume
- `-` - `-`
- token, to be used in ``admin.vm.volume.CloneTo`` - token, to be used in ``admin.vm.volume.CloneTo``
- obtain a token to copy ``volume`` of ``vm``; the token is one time use only, it's invalidated by ``admin.vm.volume.CloneTo``, even if the operation fails - | obtain a token to copy ``volume`` of ``vm``;
| the token is one time use only, it's invalidated by ``admin.vm.volume.CloneTo``, even if the operation fails
* - ``admin.vm.volume.CloneTo`` * - ``admin.vm.volume.CloneTo``
- vm - vm
- volume - volume