summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/server-backup.rst
diff options
context:
space:
mode:
authorjichenjc <jichenjc@cn.ibm.com>2016-02-20 22:33:18 +0800
committerDean Troyer <dtroyer@gmail.com>2016-05-27 11:47:25 -0500
commit460846cef28a502a51e4d52865743aea73e2f960 (patch)
treed440dfeeb4425f28c8073b7d3f3da1ee5ddd1031 /doc/source/command-objects/server-backup.rst
parent9da02d14eadc39da6f97b3df095af8b0c452a5b4 (diff)
downloadpython-openstackclient-460846cef28a502a51e4d52865743aea73e2f960.tar.gz
[compute] Add server backup function
Add server backup function There is no return value for this command per following doc http://developer.openstack.org/api-ref-compute-v2.1.html#createBackup, also novaclient can't be updated now due to backward compatible issue http://lists.openstack.org/pipermail/openstack-dev/2016-March/089376.html, so we have to get the information ourselves. The Image tests were not using warlock images, so that needed to be fixed before we could completely test things like --wait. Change-Id: I30159518c4d3fdec89f15963bda641a0b03962d1
Diffstat (limited to 'doc/source/command-objects/server-backup.rst')
-rw-r--r--doc/source/command-objects/server-backup.rst44
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/source/command-objects/server-backup.rst b/doc/source/command-objects/server-backup.rst
new file mode 100644
index 00000000..23e17d5f
--- /dev/null
+++ b/doc/source/command-objects/server-backup.rst
@@ -0,0 +1,44 @@
+=============
+server backup
+=============
+
+A server backup is a disk image created in the Image store from a running server
+instance. The backup command manages the number of archival copies to retain.
+
+Compute v2
+
+server backup create
+--------------------
+
+Create a server backup image
+
+.. program:: server create
+.. code:: bash
+
+ os server backup create
+ [--name <image-name>]
+ [--type <backup-type>]
+ [--rotate <count>]
+ [--wait]
+ <server>
+
+.. option:: --name <image-name>
+
+ Name of the backup image (default: server name)
+
+.. option:: --type <backup-type>
+
+ Used to populate the ``backup_type`` property of the backup
+ image (default: empty)
+
+.. option:: --rotate <count>
+
+ Number of backup images to keep (default: 1)
+
+.. option:: --wait
+
+ Wait for operation to complete
+
+.. describe:: <server>
+
+ Server to back up (name or ID)