python-openstackclient/doc/source/command-objects/snapshot.rst
Huanxuan Ao 23ee2fd8f0 Refactor "snapshot" commands
1.change the command name ``snapshot create/delete/list/
show/set/unset`` to ``volume snapshot create/delete/list/
show/set/unset``.

2.change the optional parameter "--name <name>" to a
positional parameter "<snapshot-name>"; Change the
positional parameter "<volume>" to a optional
parameter "--volume <volume>"

Change-Id: If03276ecdf6f0d96893d5ecf91c2aaa64929cff3
Implements: bp backup-snapshot-renamed-for-volume-resource
Co-Authored-By: Sheel Rana <ranasheel2000@gmail.com>
2016-11-03 16:15:02 +08:00

3.3 KiB

snapshot

Block Storage v1, v2

snapshot create

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

snapshot create

os snapshot create
    [--name <name>]
    [--description <description>]
    [--force]
    [--property <key=value> [...] ]
    <volume>

--name <name>

Name of the snapshot

--description <description>

Description of the snapshot

--force

Create a snapshot attached to an instance. Default is False

--property <key=value>

Set a property to this snapshot (repeat option to set multiple properties)

Volume version 2 only

Volume to snapshot (name or ID)

snapshot delete

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

snapshot delete

os snapshot delete
    <snapshot> [<snapshot> ...]




Snapshot(s) to delete (name or ID)

snapshot list

List snapshots (Deprecated, please use volume snapshot list instead)

snapshot list

os snapshot list
    [--all-projects]
    [--long]
    [--limit <limit>]
    [--marker <marker>]

--all-projects

Include all projects (admin only)

--long

List additional fields in output

--limit <limit>

Maximum number of snapshots to display

Volume version 2 only

--marker <marker>

The last snapshot ID of the previous page

Volume version 2 only

snapshot set

Set snapshot properties (Deprecated, please use volume snapshot set instead)

snapshot set

os snapshot set
    [--name <name>]
    [--description <description>]
    [--property <key=value> [...] ]
    [--state <state>]
    <snapshot>




New snapshot name

--description <description>

New snapshot description

--property <key=value>

Property to add or modify for this snapshot (repeat option to set multiple properties)

--state <state>

New snapshot state. ("available", "error", "creating", "deleting", or "error_deleting") (admin only) (This option simply changes the state of the snapshot in the database with no regard to actual status, exercise caution when using)

Volume version 2 only

<snapshot>

Snapshot to modify (name or ID)

snapshot show

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

snapshot show

os snapshot show
    <snapshot>




Snapshot to display (name or ID)

snapshot unset

Unset snapshot properties (Deprecated, please use volume snapshot unset instead)

snapshot unset

os snapshot unset
    [--property <key>]
    <snapshot>

--property <key>

Property to remove from snapshot (repeat option to remove multiple properties)

<snapshot>

Snapshot to modify (name or ID)