summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects
diff options
context:
space:
mode:
authorSean McGinnis <sean.mcginnis@gmail.com>2018-10-23 10:36:34 -0500
committerSean McGinnis <sean.mcginnis@gmail.com>2018-11-10 02:11:04 -0600
commitb90c780d2b99a91dd479bcc5f20caddcfb652f76 (patch)
tree0c172c7eb98ee2a38ae5d9bb763186603d30d481 /doc/source/cli/command-objects
parent097b45686e74d7f3ef086a1684e745cf83e73767 (diff)
downloadpython-openstackclient-b90c780d2b99a91dd479bcc5f20caddcfb652f76.tar.gz
Add volume backup import/export commands
This adds commands to import and export volume backup records so they can be imported and restored on other Cinder instances or to the original instance if the service or database has been lost and had to be rebuilt. I know this is a commonly used process by some users, so it would be good to have this functionality in osc so they do not have to switch clients. More details about the export and import process can be found here: https://docs.openstack.org/cinder/latest/admin/blockstorage-volume-backups-export-import.html Change-Id: Ic95f87b36a416a2b50cb2193fd5759ab59336975 Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
Diffstat (limited to 'doc/source/cli/command-objects')
-rw-r--r--doc/source/cli/command-objects/volume-backup.rst198
1 files changed, 3 insertions, 195 deletions
diff --git a/doc/source/cli/command-objects/volume-backup.rst b/doc/source/cli/command-objects/volume-backup.rst
index 585f47d4..632e215e 100644
--- a/doc/source/cli/command-objects/volume-backup.rst
+++ b/doc/source/cli/command-objects/volume-backup.rst
@@ -2,200 +2,8 @@
volume backup
=============
-Block Storage v1, v2
+Volume v1, v2
-volume backup create
---------------------
+.. autoprogram-cliff:: openstack.volume.v2
+ :command: volume backup *
-Create new volume backup
-
-.. program:: volume backup create
-.. code:: bash
-
- openstack 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
-
- openstack 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
-
- openstack volume backup list
- [--long]
- [--name <name>]
- [--status <status>]
- [--volume <volume>]
- [--marker <volume-backup>]
- [--limit <num-backups>]
- [--all-projects]
-
-.. _volume_backup_list-backup:
-.. option:: --long
-
- List additional fields in output
-
-.. option:: --name <name>
-
- Filters results by the backup name
-
-.. option:: --status <status>
-
- Filters results by the backup status
- ('creating', 'available', 'deleting', 'error', 'restoring' or 'error_restoring')
-
-.. option:: --volume <volume>
-
- Filters results by the volume which they backup (name or ID)"
-
-.. option:: --marker <volume-backup>
-
- The last backup of the previous page (name or ID)
-
- *Volume version 2 only*
-
-.. option:: --limit <num-backups>
-
- Maximum number of backups to display
-
- *Volume version 2 only*
-
-.. option:: --all-projects
-
- Include all projects (admin only)
-
-volume backup restore
----------------------
-
-Restore volume backup
-
-.. program:: volume backup restore
-.. code:: bash
-
- openstack 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 set
------------------
-
-Set volume backup properties
-
-.. program:: volume backup set
-.. code:: bash
-
- openstack volume backup set
- [--name <name>]
- [--description <description>]
- [--state <state>]
- <backup>
-
-.. option:: --name <name>
-
- New backup name
-
-.. option:: --description <description>
-
- New backup description
-
-.. option:: --state <state>
-
- New backup state ("available" or "error") (admin only)
- (This option simply changes the state of the backup in the database with
- no regard to actual status, exercise caution when using)
-
-.. _backup_set-volume-backup:
-.. describe:: <backup>
-
- Backup to modify (name or ID)
-
-volume backup show
-------------------
-
-Display volume backup details
-
-.. program:: volume backup show
-.. code:: bash
-
- openstack volume backup show
- <backup>
-
-.. _volume_backup_show-backup:
-.. describe:: <backup>
-
- Backup to display (name or ID)