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_volume(self, payload):
"""Create a volume.
:param payload: The payload representing the new volume to create.
:raises: ConnectionError
:raises: HTTPError
"""
r = self._conn.post(self._path, data=payload)
location = r.headers.get('Location')
new_volume = None
if r.status_code == 201:
if location:
self.refresh()
new_volume = self.get_member(location)
elif r.status_code == 202:
# TODO(billdodd): TaskMonitor support to be added in subsequent PR
pass
return new_volume
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_maps.VOLUME_TYPE_TYPE_MAP)
"""The type of this volume."""
raid_type = base.MappedField('RAIDType', store_maps.RAID_TYPE_TYPE_MAP)
"""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_maps.VOLUME_INIT_TYPE_MAP_REV)
return set([
store_maps.VOLUME_INIT_TYPE_MAP[v]
for v in set(store_maps.VOLUME_INIT_TYPE_MAP).intersection(
action.allowed_values)
])
def _initialize(self,
value=store_cons.VOLUME_INIT_TYPE_FAST,
apply_time=None,
timeout=500):
valid_values = self.get_allowed_initialize_volume_values()
if value not in valid_values:
raise exceptions.InvalidParameterValueError(
parameter='value', value=value, valid_values=valid_values)
value = store_maps.VOLUME_INIT_TYPE_MAP_REV[value]
payload = {'InitializeType': value}
blocking = False
oat_prop = '@Redfish.OperationApplyTime'
if apply_time:
payload[oat_prop] = res_maps.APPLY_TIME_VALUE_MAP_REV[apply_time]
if (payload
and payload.get(oat_prop) == res_maps.APPLY_TIME_VALUE_MAP_REV[
res_cons.APPLY_TIME_IMMEDIATE]):
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.VOLUME_INIT_TYPE_FAST,
apply_time=None,
timeout=500):
"""Initialize the volume.
:param value: The InitializeType value.
:param apply_time: When to update the attributes. Optional.
APPLY_TIME_IMMEDIATE - Immediate,
APPLY_TIME_ON_RESET - On reset,
APPLY_TIME_MAINT_START - During specified maintenance time
APPLY_TIME_MAINT_RESET - On reset during specified maintenance time
: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 initialize_volume(self,
value=store_cons.VOLUME_INIT_TYPE_FAST,
apply_time=None,
timeout=500):
"""Initialize the volume.
Deprecated: Use initialize
:param value: The InitializeType value.
:param apply_time: When to update the attributes. Optional.
APPLY_TIME_IMMEDIATE - Immediate,
APPLY_TIME_ON_RESET - On reset,
APPLY_TIME_MAINT_START - During specified maintenance time
APPLY_TIME_MAINT_RESET - On reset during specified maintenance time
: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, _ = self._initialize(value, apply_time, timeout)
if r.status_code == 202:
return (TaskMonitorDepr(self,
r.headers.get('location')).set_retry_after(
r.headers.get('retry-after')))
def _delete(self, payload=None, apply_time=None, timeout=500):
blocking = False
oat_prop = '@Redfish.OperationApplyTime'
if apply_time:
if payload is None:
payload = {}
payload[oat_prop] = res_maps.APPLY_TIME_VALUE_MAP_REV[apply_time]
if (payload
and payload.get(oat_prop) == res_maps.APPLY_TIME_VALUE_MAP_REV[
res_cons.APPLY_TIME_IMMEDIATE]):
blocking = True
r = self._conn.delete(self._path,
data=payload,
blocking=blocking,
timeout=timeout)
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.
APPLY_TIME_IMMEDIATE - Immediate,
APPLY_TIME_ON_RESET - On reset,
APPLY_TIME_MAINT_START - During specified maintenance time
APPLY_TIME_MAINT_RESET - On reset during specified maintenance time
: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)
def delete_volume(self, payload=None, apply_time=None, timeout=500):
"""Delete the volume.
Deprecated: Use delete
:param payload: May contain @Redfish.OperationApplyTime property
:param apply_time: When to update the attributes. Optional.
APPLY_TIME_IMMEDIATE - Immediate,
APPLY_TIME_ON_RESET - On reset,
APPLY_TIME_MAINT_START - During specified maintenance time
APPLY_TIME_MAINT_RESET - On reset during specified maintenance time
: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 (TaskMonitorDepr(self._conn,
r.headers.get('location')).set_retry_after(
r.headers.get('retry-after')))
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
oat_prop = '@Redfish.OperationApplyTime'
if apply_time:
if payload is None:
payload = {}
payload[oat_prop] = res_maps.APPLY_TIME_VALUE_MAP_REV[apply_time]
if (payload
and payload.get(oat_prop) == res_maps.APPLY_TIME_VALUE_MAP_REV[
res_cons.APPLY_TIME_IMMEDIATE]):
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.
APPLY_TIME_IMMEDIATE - Immediate,
APPLY_TIME_ON_RESET - On reset,
APPLY_TIME_MAINT_START - During specified maintenance time
APPLY_TIME_MAINT_RESET - On reset during specified maintenance time
: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)
def create_volume(self, payload, apply_time=None, timeout=500):
"""Create a volume.
Deprecated: Use create.
:param payload: The payload representing the new volume to create.
:param apply_time: When to update the attributes. Optional.
APPLY_TIME_IMMEDIATE - Immediate,
APPLY_TIME_ON_RESET - On reset,
APPLY_TIME_MAINT_START - During specified maintenance time
APPLY_TIME_MAINT_RESET - On reset during specified maintenance time
: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 (TaskMonitorDepr(self._conn, location).set_retry_after(
r.headers.get('retry-after')))
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_maps.VOLUME_TYPE_TYPE_MAP)
"""The type of this volume."""
raid_type = base.MappedField('RAIDType', store_maps.RAID_TYPE_TYPE_MAP)
"""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', required=True)
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_maps.VOLUME_INIT_TYPE_MAP_REV)
return set([
store_maps.VOLUME_INIT_TYPE_MAP[v]
for v in set(store_maps.VOLUME_INIT_TYPE_MAP).intersection(
action.allowed_values)
])
def initialize_volume(self, value):
"""Initialize the volume.
:param value: The InitializeType value.
:raises: InvalidParameterValueError, if the target value is not
allowed.
"""
valid_values = self.get_allowed_initialize_volume_values()
if value not in valid_values:
raise exceptions.InvalidParameterValueError(
parameter='value', value=value, valid_values=valid_values)
value = store_maps.VOLUME_INIT_TYPE_MAP_REV[value]
target_uri = self._get_initialize_action_element().target_uri
self._conn.post(target_uri,
data={'InitializeType': value},
blocking=True)
def delete_volume(self, payload=None):
"""Delete the volume.
:param payload: May contain @Redfish.OperationApplyTime property
:raises: ConnectionError
:raises: HTTPError
"""
self._conn.delete(self._path, data=payload, blocking=True)