summaryrefslogtreecommitdiff
path: root/doc/source/cli
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/cli')
-rw-r--r--doc/source/cli/command-objects/volume-backup.rst198
-rw-r--r--doc/source/cli/commands.rst2
-rw-r--r--doc/source/cli/data/cinder.csv4
3 files changed, 7 insertions, 197 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)
diff --git a/doc/source/cli/commands.rst b/doc/source/cli/commands.rst
index d7c91240..cdd5e63c 100644
--- a/doc/source/cli/commands.rst
+++ b/doc/source/cli/commands.rst
@@ -158,6 +158,8 @@ referring to both Compute and Volume quotas.
* ``volume backup``: (**Volume**) backup for volumes
* ``volume backend capability``: (**volume**) volume backend storage capabilities
* ``volume backend pool``: (**volume**) volume backend storage pools
+* ``volume backup record``: (**Volume**) volume record that can be imported or exported
+* ``volume backend``: (**volume**) volume backend storage
* ``volume host``: (**Volume**) the physical computer for volumes
* ``volume qos``: (**Volume**) quality-of-service (QoS) specification for volumes
* ``volume snapshot``: (**Volume**) a point-in-time copy of a volume
diff --git a/doc/source/cli/data/cinder.csv b/doc/source/cli/data/cinder.csv
index cc8ef2d9..22fb84cf 100644
--- a/doc/source/cli/data/cinder.csv
+++ b/doc/source/cli/data/cinder.csv
@@ -2,8 +2,8 @@ absolute-limits,limits show --absolute,Lists absolute limits for a user.
availability-zone-list,availability zone list --volume,Lists all availability zones.
backup-create,volume backup create,Creates a volume backup.
backup-delete,volume backup delete,Removes a backup.
-backup-export,volume backup export,Export backup metadata record.
-backup-import,volume backup import,Import backup metadata record.
+backup-export,volume backup record export,Export backup metadata record.
+backup-import,volume backup record import,Import backup metadata record.
backup-list,volume backup list,Lists all backups.
backup-reset-state,volume backup set --state,Explicitly updates the backup state.
backup-restore,volume backup restore,Restores a backup.