openstack/python-openstackclient
Code Issues Proposed changes
e6fb658606
python-openstackclient/doc/source/command-objects/volume-backup.rst
Huanxuan Ao 3ebc7520a6 Add warning message for --state option of set command in volume 
There are some set commands can set object state, it maybe
a danger behavor for users, so add explanation and warning
in the help message of the "--state" option to talk users
be caution when using (cinderclient have done this too)

Change-Id: I6a902887ea98879999c9972f36b1b7ef332173c3
2016-09-26 02:42:47 +00:00

2.8 KiB
Raw Blame History

volume backup

Block Storage v1, v2

volume backup create

Create new volume backup

volume backup create

os volume 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)

volume backup delete

Delete volume backup(s)

volume backup delete

os volume 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)

volume backup list

List volume backups

volume backup list

os volume backup list




List additional fields in output

volume backup restore

Restore volume backup

volume backup restore

os volume backup restore
    <backup>
    <volume>




Backup to restore (name or ID)

<volume>

Volume to restore to (name or ID)

volume backup set

Set volume backup properties

volume backup set

os volume backup set
    [--name <name>]
    [--description <description>]
    [--state <state>]
    <backup>

--name <name>

New backup name

--description <description>

New backup description

--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 to modify (name or ID)

volume backup show

Display volume backup details

volume backup show

os volume backup show
    <backup>




Backup to display (name or ID)