39c5eb9e3f
Backup commands are used only in volume service now, but "backup" is too generic, users may not know the commands are used for volume from the commands name. By seeing the command name, users can only see the "backup" but do not know which object the backup commands work for. It may confuse users. I think rename "backup" to "volume backup" can depict resource relation and will be helpful for users to know the commands clearly. So add new commands ``volume backup create/delete/ list/show/restore`` to replace the old commands ``backup create/delete/list/show/restore``. And also deprecate old commands. Change-Id: I4f844d9bc48573eb4d17288ce6b8a90cea00d16a Implements: bp backup-snapshot-renamed-for-volume-resource Co-Authored-By: Sheel Rana <ranasheel2000@gmail.com>
138 lines
2.2 KiB
ReStructuredText
138 lines
2.2 KiB
ReStructuredText
======
|
|
backup
|
|
======
|
|
|
|
Block Storage v1, v2
|
|
|
|
backup create
|
|
-------------
|
|
|
|
Create new backup
|
|
(Deprecated, please use ``volume backup create`` instead)
|
|
|
|
.. program:: backup create
|
|
.. code:: bash
|
|
|
|
os 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*
|
|
|
|
.. _backup_create-backup:
|
|
.. describe:: <volume>
|
|
|
|
Volume to backup (name or ID)
|
|
|
|
backup delete
|
|
-------------
|
|
|
|
Delete backup(s)
|
|
(Deprecated, please use ``volume backup delete`` instead)
|
|
|
|
.. program:: backup delete
|
|
.. code:: bash
|
|
|
|
os backup delete
|
|
[--force]
|
|
<backup> [<backup> ...]
|
|
|
|
.. option:: --force
|
|
|
|
Allow delete in state other than error or available
|
|
|
|
*Volume version 2 only*
|
|
|
|
.. _backup_delete-backup:
|
|
.. describe:: <backup>
|
|
|
|
Backup(s) to delete (name or ID)
|
|
|
|
backup list
|
|
-----------
|
|
|
|
List backups
|
|
(Deprecated, please use ``volume backup list`` instead)
|
|
|
|
.. program:: backup list
|
|
.. code:: bash
|
|
|
|
os backup list
|
|
|
|
.. _backup_list-backup:
|
|
.. option:: --long
|
|
|
|
List additional fields in output
|
|
|
|
backup restore
|
|
--------------
|
|
|
|
Restore backup
|
|
(Deprecated, please use ``volume backup restore`` instead)
|
|
|
|
.. program:: backup restore
|
|
.. code:: bash
|
|
|
|
os backup restore
|
|
<backup>
|
|
<volume>
|
|
|
|
.. _backup_restore-backup:
|
|
.. describe:: <backup>
|
|
|
|
Backup to restore (name or ID)
|
|
|
|
.. describe:: <volume>
|
|
|
|
Volume to restore to (name or ID)
|
|
|
|
backup show
|
|
-----------
|
|
|
|
Display backup details
|
|
(Deprecated, please use ``volume backup show`` instead)
|
|
|
|
.. program:: backup show
|
|
.. code:: bash
|
|
|
|
os backup show
|
|
<backup>
|
|
|
|
.. _backup_show-backup:
|
|
.. describe:: <backup>
|
|
|
|
Backup to display (name or ID)
|