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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
"""Block Storage Volume/Snapshot Management implementations"""
import argparse
from cinderclient import api_versions
from osc_lib.command import command
from osc_lib import exceptions
from osc_lib import utils
from openstackclient.i18n import _
SORT_MANAGEABLE_KEY_VALUES = ('size', 'reference')
class BlockStorageManageVolumes(command.Lister):
"""List manageable volumes.
Supported by --os-volume-api-version 3.8 or greater.
"""
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
host_group = parser.add_mutually_exclusive_group()
host_group.add_argument(
"host",
metavar="<host>",
nargs='?',
help=_(
'Cinder host on which to list manageable volumes. '
'Takes the form: host@backend-name#pool'
),
)
host_group.add_argument(
"--cluster",
metavar="<cluster>",
help=_(
'Cinder cluster on which to list manageable volumes. '
'Takes the form: cluster@backend-name#pool. '
'(supported by --os-volume-api-version 3.17 or later)'
),
)
parser.add_argument(
'--long',
action='store_true',
default=False,
help=_('List additional fields in output'),
)
# TODO(stephenfin): Remove this in a future major version bump
parser.add_argument(
'--detailed',
metavar='<detailed>',
default=None,
help=argparse.SUPPRESS,
)
parser.add_argument(
'--marker',
metavar='<marker>',
default=None,
help=_(
'Begin returning volumes that appear later in the volume '
'list than that represented by this reference. This '
'reference should be json like. Default=None.'
),
)
parser.add_argument(
'--limit',
metavar='<limit>',
default=None,
help=_('Maximum number of volumes to return. Default=None.'),
)
parser.add_argument(
'--offset',
metavar='<offset>',
default=None,
help=_('Number of volumes to skip after marker. Default=None.'),
)
parser.add_argument(
'--sort',
metavar='<key>[:<direction>]',
default=None,
help=(
_(
'Comma-separated list of sort keys and directions in the '
'form of <key>[:<asc|desc>]. '
'Valid keys: %s. '
'Default=None.'
)
% ', '.join(SORT_MANAGEABLE_KEY_VALUES)
),
)
return parser
def take_action(self, parsed_args):
volume_client = self.app.client_manager.volume
if parsed_args.host is None and parsed_args.cluster is None:
msg = _(
"Either <host> or '--cluster <cluster>' needs to be provided "
"to run the 'block storage volume manageable list' command"
)
raise exceptions.CommandError(msg)
if volume_client.api_version < api_versions.APIVersion('3.8'):
msg = _(
"--os-volume-api-version 3.8 or greater is required to "
"support the 'block storage volume manageable list' command"
)
raise exceptions.CommandError(msg)
if parsed_args.cluster:
if volume_client.api_version < api_versions.APIVersion('3.17'):
msg = _(
"--os-volume-api-version 3.17 or greater is required to "
"support the '--cluster' option"
)
raise exceptions.CommandError(msg)
detailed = parsed_args.long
if parsed_args.detailed is not None:
detailed = parsed_args.detailed.lower().strip() in {
'1',
't',
'true',
'on',
'y',
'yes',
}
if detailed:
# if the user requested e.g. '--detailed true' then they should
# not request '--long'
msg = _(
"The --detailed option has been deprecated. "
"Use --long instead."
)
self.log.warning(msg)
else:
# if the user requested e.g. '--detailed false' then they
# should simply stop requesting this since the default has
# changed
msg = _("The --detailed option has been deprecated. Unset it.")
self.log.warning(msg)
columns = [
'reference',
'size',
'safe_to_manage',
]
if detailed:
columns.extend(
[
'reason_not_safe',
'cinder_id',
'extra_info',
]
)
data = volume_client.volumes.list_manageable(
host=parsed_args.host,
detailed=detailed,
marker=parsed_args.marker,
limit=parsed_args.limit,
offset=parsed_args.offset,
sort=parsed_args.sort,
cluster=parsed_args.cluster,
)
return (
columns,
(
utils.get_item_properties(
s,
columns,
)
for s in data
),
)
class BlockStorageManageSnapshots(command.Lister):
"""List manageable snapshots.
Supported by --os-volume-api-version 3.8 or greater.
"""
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
host_group = parser.add_mutually_exclusive_group()
host_group.add_argument(
"host",
metavar="<host>",
nargs='?',
help=_(
'Cinder host on which to list manageable snapshots. '
'Takes the form: host@backend-name#pool'
),
)
host_group.add_argument(
"--cluster",
metavar="<cluster>",
help=_(
'Cinder cluster on which to list manageable snapshots. '
'Takes the form: cluster@backend-name#pool. '
'(supported by --os-volume-api-version 3.17 or later)'
),
)
parser.add_argument(
'--long',
action='store_true',
default=False,
help=_('List additional fields in output'),
)
# TODO(stephenfin): Remove this in a future major version bump
parser.add_argument(
'--detailed',
metavar='<detailed>',
default=None,
help=argparse.SUPPRESS,
)
parser.add_argument(
'--marker',
metavar='<marker>',
default=None,
help=_(
'Begin returning snapshots that appear later in the '
'snapshot list than that represented by this reference. '
'This reference should be json like. Default=None.'
),
)
parser.add_argument(
'--limit',
metavar='<limit>',
default=None,
help=_('Maximum number of snapshots to return. Default=None.'),
)
parser.add_argument(
'--offset',
metavar='<offset>',
default=None,
help=_('Number of snapshots to skip after marker. Default=None.'),
)
parser.add_argument(
'--sort',
metavar='<key>[:<direction>]',
default=None,
help=(
_(
'Comma-separated list of sort keys and directions in the '
'form of <key>[:<asc|desc>]. '
'Valid keys: %s. '
'Default=None.'
)
% ', '.join(SORT_MANAGEABLE_KEY_VALUES)
),
)
return parser
def take_action(self, parsed_args):
volume_client = self.app.client_manager.volume
if parsed_args.host is None and parsed_args.cluster is None:
msg = _(
"Either <host> or '--cluster <cluster>' needs to be provided "
"to run the 'block storage volume snapshot manageable list' "
"command"
)
raise exceptions.CommandError(msg)
if volume_client.api_version < api_versions.APIVersion('3.8'):
msg = _(
"--os-volume-api-version 3.8 or greater is required to "
"support the 'block storage volume snapshot manageable list' "
"command"
)
raise exceptions.CommandError(msg)
if parsed_args.cluster:
if volume_client.api_version < api_versions.APIVersion('3.17'):
msg = _(
"--os-volume-api-version 3.17 or greater is required to "
"support the '--cluster' option"
)
raise exceptions.CommandError(msg)
detailed = parsed_args.long
if parsed_args.detailed is not None:
detailed = parsed_args.detailed.lower().strip() in {
'1',
't',
'true',
'on',
'y',
'yes',
}
if detailed:
# if the user requested e.g. '--detailed true' then they should
# not request '--long'
msg = _(
"The --detailed option has been deprecated. "
"Use --long instead."
)
self.log.warning(msg)
else:
# if the user requested e.g. '--detailed false' then they
# should simply stop requesting this since the default has
# changed
msg = _(
"The --detailed option has been deprecated. " "Unset it."
)
self.log.warning(msg)
columns = [
'reference',
'size',
'safe_to_manage',
'source_reference',
]
if detailed:
columns.extend(
[
'reason_not_safe',
'cinder_id',
'extra_info',
]
)
data = volume_client.volume_snapshots.list_manageable(
host=parsed_args.host,
detailed=detailed,
marker=parsed_args.marker,
limit=parsed_args.limit,
offset=parsed_args.offset,
sort=parsed_args.sort,
cluster=parsed_args.cluster,
)
return (
columns,
(
utils.get_item_properties(
s,
columns,
)
for s in data
),
)
|
