summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2016-08-11 04:36:52 +0000
committerGerrit Code Review <review@openstack.org>2016-08-11 04:36:52 +0000
commitc9cf6c4eb29b4dff41fc949b6a288ed2f4a69592 (patch)
tree0062628a4e0d574d54c2b96aaace7b3931b9a5d2 /doc/source/command-objects
parent5b724fc88b92eda6c801a6a561b2cf034e471a03 (diff)
parent39c5eb9e3fe89bf177e513e447f22b62f5e4785c (diff)
downloadpython-openstackclient-c9cf6c4eb29b4dff41fc949b6a288ed2f4a69592.tar.gz
Merge "Rename backup commands in volume v1 and v2"
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/backup.rst5
-rw-r--r--doc/source/command-objects/volume-backup.rst132
2 files changed, 137 insertions, 0 deletions
diff --git a/doc/source/command-objects/backup.rst b/doc/source/command-objects/backup.rst
index 4abc155f..ac887086 100644
--- a/doc/source/command-objects/backup.rst
+++ b/doc/source/command-objects/backup.rst
@@ -8,6 +8,7 @@ backup create
-------------
Create new backup
+(Deprecated, please use ``volume backup create`` instead)
.. program:: backup create
.. code:: bash
@@ -60,6 +61,7 @@ backup delete
-------------
Delete backup(s)
+(Deprecated, please use ``volume backup delete`` instead)
.. program:: backup delete
.. code:: bash
@@ -83,6 +85,7 @@ backup list
-----------
List backups
+(Deprecated, please use ``volume backup list`` instead)
.. program:: backup list
.. code:: bash
@@ -98,6 +101,7 @@ backup restore
--------------
Restore backup
+(Deprecated, please use ``volume backup restore`` instead)
.. program:: backup restore
.. code:: bash
@@ -119,6 +123,7 @@ backup show
-----------
Display backup details
+(Deprecated, please use ``volume backup show`` instead)
.. program:: backup show
.. code:: bash
diff --git a/doc/source/command-objects/volume-backup.rst b/doc/source/command-objects/volume-backup.rst
new file mode 100644
index 00000000..3a8f0213
--- /dev/null
+++ b/doc/source/command-objects/volume-backup.rst
@@ -0,0 +1,132 @@
+=============
+volume backup
+=============
+
+Block Storage v1, v2
+
+volume backup create
+--------------------
+
+Create new volume backup
+
+.. program:: volume backup create
+.. code:: bash
+
+ os volume backup create
+ [--container <container>]
+ [--name <name>]
+ [--description <description>]
+ [--snapshot <snapshot>]
+ [--force]
+ [--incremental]
+ <volume>
+
+.. option:: --container <container>
+
+ Optional backup container name
+
+.. option:: --name <name>
+
+ Name of the backup
+
+.. option:: --description <description>
+
+ Description of the backup
+
+.. option:: --snapshot <snapshot>
+
+ Snapshot to backup (name or ID)
+
+ *Volume version 2 only*
+
+.. option:: --force
+
+ Allow to back up an in-use volume
+
+ *Volume version 2 only*
+
+.. option:: --incremental
+
+ Perform an incremental backup
+
+ *Volume version 2 only*
+
+.. _volume_backup_create-backup:
+.. describe:: <volume>
+
+ Volume to backup (name or ID)
+
+volume backup delete
+--------------------
+
+Delete volume backup(s)
+
+.. program:: volume backup delete
+.. code:: bash
+
+ os volume backup delete
+ [--force]
+ <backup> [<backup> ...]
+
+.. option:: --force
+
+ Allow delete in state other than error or available
+
+ *Volume version 2 only*
+
+.. _volume_backup_delete-backup:
+.. describe:: <backup>
+
+ Backup(s) to delete (name or ID)
+
+volume backup list
+------------------
+
+List volume backups
+
+.. program:: volume backup list
+.. code:: bash
+
+ os volume backup list
+
+.. _volume_backup_list-backup:
+.. option:: --long
+
+ List additional fields in output
+
+volume backup restore
+---------------------
+
+Restore volume backup
+
+.. program:: volume backup restore
+.. code:: bash
+
+ os volume backup restore
+ <backup>
+ <volume>
+
+.. _volume_backup_restore-backup:
+.. describe:: <backup>
+
+ Backup to restore (name or ID)
+
+.. describe:: <volume>
+
+ Volume to restore to (name or ID)
+
+volume backup show
+------------------
+
+Display volume backup details
+
+.. program:: volume backup show
+.. code:: bash
+
+ os volume backup show
+ <backup>
+
+.. _volume_backup_show-backup:
+.. describe:: <backup>
+
+ Backup to display (name or ID)