openstack/python-openstackclient
Code Issues Proposed changes
194a8529d9
python-openstackclient/doc/source/command-objects/backup.rst
Huanxuan Ao 39c5eb9e3f Rename backup commands in volume v1 and v2 
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>
2016-08-11 09:32:10 +08:00

2.2 KiB
Raw Blame History

backup

Block Storage v1, v2

backup create

Create new backup (Deprecated, please use volume backup create instead)

backup create

os backup create
    [--container <container>]
    [--name <name>]
    [--description <description>]
    [--snapshot <snapshot>]
    [--force]
    [--incremental]
    <volume>

--container <container>

Optional backup container name

--name <name>

Name of the backup

--description <description>

Description of the backup

--snapshot <snapshot>

Snapshot to backup (name or ID)

Volume version 2 only

--force

Allow to back up an in-use volume

Volume version 2 only

--incremental

Perform an incremental backup

Volume version 2 only

Volume to backup (name or ID)

backup delete

Delete backup(s) (Deprecated, please use volume backup delete instead)

backup delete

os backup delete
    [--force]
    <backup> [<backup> ...]

--force

Allow delete in state other than error or available

Volume version 2 only

Backup(s) to delete (name or ID)

backup list

List backups (Deprecated, please use volume backup list instead)

backup list

os backup list




List additional fields in output

backup restore

Restore backup (Deprecated, please use volume backup restore instead)

backup restore

os backup restore
    <backup>
    <volume>




Backup to restore (name or ID)

<volume>

Volume to restore to (name or ID)

backup show

Display backup details (Deprecated, please use volume backup show instead)

backup show

os backup show
    <backup>




Backup to display (name or ID)