From c4f41c20216c1f6b983744472c6b7f5ad3055ee3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Marczykowski-G=C3=B3recki?= Date: Tue, 4 Jul 2017 02:51:41 +0200 Subject: [PATCH] admin-api: clarify that CloneFrom/CloneTo tokens are one time use --- services/admin-api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/services/admin-api.md b/services/admin-api.md index 91badd74..53d19bad 100644 --- a/services/admin-api.md +++ b/services/admin-api.md @@ -113,7 +113,7 @@ to set the policy using current mechanism. | `admin.pool.volume.Revert` | `dom0` | pool | ` ` | - | | `admin.pool.volume.Resize` | `dom0` | pool | ` ` | - | | `admin.pool.volume.Import` | `dom0` | pool | `\n` | - | -| `admin.pool.volume.CloneFrom` | `dom0` | pool | vid | token, to be used in `admin.vm.volume.CloneTo` | obtain a token to copy volume `vid` in `pool` | +| `admin.pool.volume.CloneFrom` | `dom0` | pool | vid | 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 | | `admin.pool.volume.CloneTo` | `dom0` | pool | ` ` | - | copy volume pointed by a token to volume `vid` in `pool` | | `admin.vm.volume.List` | vm | - | - | `\n` | `` is per-VM volume name (`root`, `private`, etc), `` is pool-unique volume id | `admin.vm.volume.Info` | vm | volume | - | `=\n` | @@ -122,7 +122,7 @@ to set the policy using current mechanism. | `admin.vm.volume.Revert` | vm | volume | snapshot | - | id. | | `admin.vm.volume.Resize` | vm | volume | size_in_bytes | - | id. | | `admin.vm.volume.Import` | vm | volume | raw volume data | - | id. | -| `admin.vm.volume.CloneFrom` | vm | volume | - | token, to be used in `admin.vm.volume.CloneTo` | obtain a token to copy `volume` of `vm` | +| `admin.vm.volume.CloneFrom` | vm | volume | - | 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 | | `admin.vm.volume.CloneTo` | vm | volume | token, obtained with `admin.vm.volume.CloneFrom` | - | copy volume pointed by a token to `volume` of `vm` | | `admin.vm.Start` | vm | - | - | - | | `admin.vm.Shutdown` | vm | - | - | - |