python-openstackclient/doc/source/command-objects/snapshot.rst

snapshot

Block Storage v1, v2

snapshot create

Create new snapshot

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)

snapshot delete

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




Snapshot(s) to delete (name or ID)

snapshot list

List snapshots

snapshot list

os snapshot list
    [--all-projects]

--all-projects

Include all projects (admin only)

--long

List additional fields in output

snapshot set

Set snapshot properties

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. Valid values are "available", "error", "creating", "deleting", and "error_deleting".

Volume version 2 only

<snapshot>

Snapshot to modify (name or ID)

snapshot show

Display snapshot details

snapshot show

os snapshot show
    <snapshot>




Snapshot to display (name or ID)

snapshot unset

Unset snapshot properties

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)