openstack/python-openstackclient
Code Issues Proposed changes
4464109c77
python-openstackclient/doc/source/cli/command-objects/snapshot.rst
Doug Hellmann 9599ffe65d reorganize existing documentation according to the new standard layout 
Move existing content around based on the doc-migration specification.

Replace :doc: markup with :ref: to have sphinx keep track of where the
files move and generate valid hyperlinks.

Add a few toctrees and index pages for the new directories.

Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-23 11:54:32 +02:00

3.4 KiB
Raw Blame History

snapshot

Block Storage v1, v2

snapshot create

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

snapshot create

openstack 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

openstack snapshot delete
    <snapshot> [<snapshot> ...]




Snapshot(s) to delete (name or ID)

snapshot list

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

snapshot list

openstack snapshot list
    [--all-projects]
    [--long]
    [--limit <num-snapshots>]
    [--marker <snapshot>]

--all-projects

Include all projects (admin only)

--long

List additional fields in output

--limit <num-snapshots>

Maximum number of snapshots to display

Volume version 2 only

--marker <snapshot>

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

openstack 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

openstack snapshot show
    <snapshot>




Snapshot to display (name or ID)

snapshot unset

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

snapshot unset

openstack 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)