The rsd_lib.resources.v2_3.storage_service.volume
Module¶
- class rsd_lib.resources.v2_3.storage_service.volume.CapacitySourcesField(*args, **kwargs)¶
Bases:
sushy.resources.base.ListField
- allocated_Bytes = <sushy.resources.base.Field object>¶
- providing_pools = <sushy.resources.base.Field object>¶
- class rsd_lib.resources.v2_3.storage_service.volume.IdentifiersField(*args, **kwargs)¶
Bases:
sushy.resources.base.ListField
- durable_name = <sushy.resources.base.Field object>¶
- durable_name_format = <sushy.resources.base.Field object>¶
- class rsd_lib.resources.v2_3.storage_service.volume.InitializeActionField(*args, **kwargs)¶
Bases:
sushy.resources.base.CompositeField
- target_uri = <sushy.resources.base.Field object>¶
- class rsd_lib.resources.v2_3.storage_service.volume.LinksField(*args, **kwargs)¶
Bases:
sushy.resources.base.CompositeField
- endpoints = <sushy.resources.base.Field object>¶
Link to related endpoints of this volume
- metrics = <sushy.resources.base.Field object>¶
Link to telemetry metrics of this volume
- class rsd_lib.resources.v2_3.storage_service.volume.ReplicaInfosField(*args, **kwargs)¶
Bases:
sushy.resources.base.ListField
- replica = <sushy.resources.base.Field object>¶
- replica_readonly_access = <sushy.resources.base.Field object>¶
- replica_role = <sushy.resources.base.Field object>¶
- replica_type = <sushy.resources.base.Field object>¶
- class rsd_lib.resources.v2_3.storage_service.volume.Volume(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None)¶
Bases:
rsd_lib.base.ResourceBase
- access_capabilities = <sushy.resources.base.Field object>¶
The access capabilities of volume
- allocated_Bytes = <sushy.resources.base.Field object>¶
The allocated capacity of volume in bytes
- bootable = <sushy.resources.base.Field object>¶
The bootable info of this volume
- capacity_bytes = <sushy.resources.base.Field object>¶
The capacity of volume in bytes
- capacity_sources = <rsd_lib.resources.v2_3.storage_service.volume.CapacitySourcesField object>¶
The logical drive status
- description = <sushy.resources.base.Field object>¶
The volume description string
- erase_on_detach = <sushy.resources.base.Field object>¶
The rrase on detach info of this volume
- erased = <sushy.resources.base.Field object>¶
The erased info of this volume
- identifiers = <rsd_lib.resources.v2_3.storage_service.volume.IdentifiersField object>¶
These identifiers list of this volume
- identity = <sushy.resources.base.Field object>¶
The volume identity string
- initialize(init_type)¶
Change initialize type of this volume
- Parameters
type – volume initialize type
- Raises
InvalidParameterValueError if invalid “type” parameter
- links = <rsd_lib.resources.v2_3.storage_service.volume.LinksField object>¶
These links to related components of this volume
- manufacturer = <sushy.resources.base.Field object>¶
The volume manufacturer
- property metrics¶
Property to provide reference to Metrics instance
It is calculated once when it is queried for the first time. On refresh, this property is reset.
- model = <sushy.resources.base.Field object>¶
The volume model
- name = <sushy.resources.base.Field object>¶
The volume name string
- replica_infos = <rsd_lib.resources.v2_3.storage_service.volume.ReplicaInfosField object>¶
These replica related info of this volume
- status = <rsd_lib.common.StatusField object>¶
The volume status
- update(bootable=None, erased=None)¶
Update volume properties
- Parameters
bootable – Change bootable ability of the volume
erased – Provide information if the drive was erased
- Raises
BadRequestError if at least one param isn’t specified
- class rsd_lib.resources.v2_3.storage_service.volume.VolumeActionsField(*args, **kwargs)¶
Bases:
sushy.resources.base.CompositeField
- initialize = <rsd_lib.resources.v2_3.storage_service.volume.InitializeActionField object>¶
- class rsd_lib.resources.v2_3.storage_service.volume.VolumeCollection(connector, path, redfish_version=None, registries=None)¶
Bases:
rsd_lib.base.ResourceCollectionBase
- create_volume(capacity, access_capabilities=None, capacity_sources=None, replica_infos=None, bootable=None)¶
Create a new volume
- Parameters
capacity – Requested volume capacity in bytes
access_capabilities – List of volume access capabilities
capacity_sources – JSON for volume providing source
replica_infos – JSON for volume replica infos
bootable – Determines if the volume should be bootable
- Returns
The uri of the new volume