summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2016-05-30 04:28:06 +0000
committerGerrit Code Review <review@openstack.org>2016-05-30 04:28:07 +0000
commit4822bf1f53c2a5bda889050898914aa535289856 (patch)
tree4c530d419f955c48c2fbe461361bbf20abdc31b8 /doc/source/command-objects
parent416550fd3db4f215406b01da3e073593f34de69a (diff)
parent460846cef28a502a51e4d52865743aea73e2f960 (diff)
downloadpython-openstackclient-4822bf1f53c2a5bda889050898914aa535289856.tar.gz
Merge "[compute] Add server backup function"
Diffstat (limited to 'doc/source/command-objects')
-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)