[Kimchi-devel] [PATCH] Add documentation for VM suspend/resume
Crístian Deives
cristiandeives at gmail.com
Thu May 7 13:50:17 UTC 2015
Commit 82e5658 has added support for VM suspend/resume but the project
documentation hasn't been updated with the new commands.
Add documentation for the VM commands "suspend" and "resume".
Signed-off-by: Crístian Deives <cristiandeives at gmail.com>
---
docs/API.md | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/docs/API.md b/docs/API.md
index 922ded1..62e4063 100644
--- a/docs/API.md
+++ b/docs/API.md
@@ -140,6 +140,13 @@ the following general conventions:
volume, it will be created on the pool 'default'. This action returns
a Task.
+* suspend: Suspend an active domain. The process is frozen without further
+ access to CPU resources and I/O but the memory used by the domain at
+ the hypervisor level will stay allocated.
+
+* resume: Resume a suspended domain. The process is restarted from the state
+ where it was frozen by calling "suspend".
+
### Sub-resource: Virtual Machine Screenshot
**URI:** /vms/*:name*/screenshot
--
2.1.0
More information about the Kimchi-devel
mailing list