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
|
# 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.
# This is referred from Redfish standard schema.
# http://redfish.dmtf.org/schemas/v1/Volume.v1_0_3.json
import logging
from sushy import exceptions
from sushy.resources import base
from sushy.resources import common
from sushy.resources import constants as res_cons
from sushy.resources.system.storage import constants as store_cons
from sushy.taskmonitor import TaskMonitor
from sushy import utils
LOG = logging.getLogger(__name__)
_OAT_PROP = '@Redfish.OperationApplyTime'
class ActionsField(base.CompositeField):
initialize = common.InitializeActionField('#Volume.Initialize')
class Volume(base.ResourceBase):
"""This class adds the Storage Volume resource"""
identity = base.Field('Id', required=True)
"""The Volume identity string"""
name = base.Field('Name')
"""The name of the resource"""
capacity_bytes = base.Field('CapacityBytes', adapter=utils.int_or_none)
"""The size in bytes of this Volume."""
volume_type = base.MappedField('VolumeType', store_cons.VolumeType)
"""The type of this volume."""
raid_type = base.MappedField('RAIDType', store_cons.RAIDType)
"""The RAID type of this volume."""
encrypted = base.Field('Encrypted', adapter=bool)
"""Is this Volume encrypted."""
identifiers = common.IdentifiersListField('Identifiers', default=[])
"""The Durable names for the volume."""
block_size_bytes = base.Field('BlockSizeBytes', adapter=int)
"""The size of the smallest addressable unit of this volume in bytes."""
operation_apply_time_support = common.OperationApplyTimeSupportField()
"""Indicates if a client is allowed to request for a specific apply
time of a create, delete, or action operation of a given resource"""
_actions = ActionsField('Actions')
def _get_initialize_action_element(self):
initialize_action = self._actions.initialize
if not initialize_action:
raise exceptions.MissingActionError(action='#Volume.Initialize',
resource=self._path)
return initialize_action
def get_allowed_initialize_volume_values(self):
"""Get the allowed values for initializing the volume.
:returns: A set with the allowed values.
"""
action = self._get_initialize_action_element()
if not action.allowed_values:
LOG.warning('Could not figure out the allowed values for the '
'initialize volume action for Volume %s',
self.identity)
return set(store_cons.VolumeInitializeType)
return {v for v in store_cons.VolumeInitializeType
if v.value in action.allowed_values}
def _initialize(self, value=store_cons.VolumeInitializeType.FAST,
apply_time=None, timeout=500):
valid_values = self.get_allowed_initialize_volume_values()
value = store_cons.VolumeInitializeType(value)
if value not in valid_values:
raise exceptions.InvalidParameterValueError(
parameter='value', value=value, valid_values=valid_values)
payload = {'InitializeType': value.value}
blocking = False
if apply_time:
payload[_OAT_PROP] = res_cons.ApplyTime(apply_time).value
if (payload and payload.get(_OAT_PROP)
== res_cons.ApplyTime.IMMEDIATE.value):
blocking = True
target_uri = self._get_initialize_action_element().target_uri
r = self._conn.post(target_uri, data=payload, blocking=blocking,
timeout=timeout)
return r, target_uri
def initialize(self, value=store_cons.VolumeInitializeType.FAST,
apply_time=None, timeout=500):
"""Initialize the volume.
:param value: The InitializeType value.
:param apply_time: When to update the attributes. Optional.
An :py:class:`sushy.ApplyTime` value.
:param timeout: Max time in seconds to wait for blocking async call.
:raises: InvalidParameterValueError, if the target value is not
allowed.
:raises: ConnectionError
:raises: HTTPError
:returns: TaskMonitor if async task or None if successful init
"""
r, target_uri = self._initialize(value, apply_time, timeout)
if r.status_code == 202:
return TaskMonitor.from_response(
self._conn, r, target_uri, self.redfish_version,
self.registries)
def _delete(self, payload=None, apply_time=None, timeout=500):
blocking = False
if apply_time:
if payload is None:
payload = {}
payload[_OAT_PROP] = res_cons.ApplyTime(apply_time).value
if (payload and payload.get(_OAT_PROP)
== res_cons.ApplyTime.IMMEDIATE.value):
blocking = True
try:
r = self._conn.delete(self._path, data=payload,
blocking=blocking, timeout=timeout)
except exceptions.ServerSideError as exc:
if (_OAT_PROP in str(exc.message)
and 'SYS029' in str(exc.message)):
LOG.debug('Retry volume delete without %(prop)s for %(path)s '
'because got error: %(err)s',
{'prop': _OAT_PROP,
'path': self._path,
'err': exc})
payload.pop(_OAT_PROP)
r = self._conn.delete(self._path, data=payload,
blocking=blocking, timeout=timeout)
else:
raise exc
return r
def delete(self, payload=None, apply_time=None, timeout=500):
"""Delete the volume.
:param payload: May contain @Redfish.OperationApplyTime property
:param apply_time: When to update the attributes. Optional.
An :py:class:`sushy.ApplyTime` value.
:param timeout: Max time in seconds to wait for blocking async call.
:raises: ConnectionError
:raises: HTTPError
:returns: TaskMonitor if async task or None if successful deletion
"""
r = self._delete(payload, apply_time, timeout)
if r.status_code == 202:
return TaskMonitor.from_response(
self._conn, r, self._path, self.redfish_version,
self.registries)
class VolumeCollection(base.ResourceCollectionBase):
"""This class represents the Storage Volume collection"""
@property
def _resource_type(self):
return Volume
@property
@utils.cache_it
def volumes_sizes_bytes(self):
"""Sizes of all Volumes in bytes in VolumeCollection resource.
Returns the list of cached values until it (or its parent resource)
is refreshed.
"""
return sorted(vol.capacity_bytes for vol in self.get_members())
@property
def max_volume_size_bytes(self):
"""Max size available (in bytes) among all Volume resources.
Returns the cached value until it (or its parent resource) is
refreshed.
"""
return utils.max_safe(self.volumes_sizes_bytes)
# NOTE(etingof): for backward compatibility
max_size_bytes = max_volume_size_bytes
operation_apply_time_support = common.OperationApplyTimeSupportField()
"""Indicates if a client is allowed to request for a specific apply
time of a create, delete, or action operation of a given resource"""
def _create(self, payload, apply_time=None, timeout=500):
blocking = False
if apply_time:
if payload is None:
payload = {}
payload[_OAT_PROP] = res_cons.ApplyTime(apply_time).value
if (payload and payload.get(_OAT_PROP)
== res_cons.ApplyTime.IMMEDIATE.value):
blocking = True
r = self._conn.post(self._path, data=payload, blocking=blocking,
timeout=timeout)
location = r.headers.get('Location')
return r, location
def create(self, payload, apply_time=None, timeout=500):
"""Create a volume.
:param payload: The payload representing the new volume to create.
:param apply_time: When to update the attributes. Optional.
An :py:class:`sushy.ApplyTime` value.
:param timeout: Max time in seconds to wait for blocking async call.
:raises: ConnectionError
:raises: HTTPError
:returns: Newly created Volume resource or TaskMonitor if async task
"""
r, location = self._create(payload, apply_time, timeout)
if r.status_code == 201:
if location:
self.refresh()
return self.get_member(location)
elif r.status_code == 202:
return TaskMonitor.from_response(
self._conn, r, self._path, self.redfish_version,
self.registries)
|
