summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/snapshot.rst
blob: e75693ca18b94783aaf7aeb8e855c31f44550d90 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
========
snapshot
========

Block Storage v1, v2

snapshot create
---------------

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

.. program:: snapshot create
.. code:: bash

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

.. option:: --name <name>

    Name of the snapshot

.. option:: --description <description>

    Description of the snapshot

.. option:: --force

    Create a snapshot attached to an instance. Default is False

.. option:: --property <key=value>

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

    *Volume version 2 only*

.. _snapshot_create-snapshot:
.. describe:: <volume>

    Volume to snapshot (name or ID)

snapshot delete
---------------

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

.. program:: snapshot delete
.. code:: bash

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

.. _snapshot_delete-snapshot:
.. describe:: <snapshot>

    Snapshot(s) to delete (name or ID)

snapshot list
-------------

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

.. program:: snapshot list
.. code:: bash

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

.. option:: --all-projects

    Include all projects (admin only)

.. option:: --long

    List additional fields in output

.. option:: --limit <limit>

    Maximum number of snapshots to display

    *Volume version 2 only*

.. option:: --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)

.. program:: snapshot set
.. code:: bash

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

.. _snapshot_restore-snapshot:
.. option:: --name <name>

    New snapshot name

.. option:: --description <description>

    New snapshot description

.. option:: --property <key=value>

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

.. option:: --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*

.. describe:: <snapshot>

    Snapshot to modify (name or ID)

snapshot show
-------------

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

.. program:: snapshot show
.. code:: bash

    os snapshot show
        <snapshot>

.. _snapshot_show-snapshot:
.. describe:: <snapshot>

    Snapshot to display (name or ID)

snapshot unset
--------------

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

.. program:: snapshot unset
.. code:: bash

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

.. option:: --property <key>

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

.. describe:: <snapshot>

    Snapshot to modify (name or ID)