The cinder.volume.drivers.netapp.eseries.client
Module¶
Client classes for web services.
-
class
RestClient
(scheme, host, port, service_path, username, password, **kwargs)¶ Bases:
cinder.volume.drivers.netapp.eseries.client.WebserviceClient
REST client specific to e-series storage service.
-
ASUP_VALID_VERSION
= (1, 52, 9000, 3)¶
-
ID
= 'id'¶
-
NAME
= 'label'¶
-
RESOURCE_PATHS
= {'volume': '/storage-systems/{system-id}/volumes/{object-id}', 'ssc_volumes': '/storage-systems/{system-id}/ssc/volumes', 'ssc_volume': '/storage-systems/{system-id}/ssc/volumes/{object-id}', 'volumes': '/storage-systems/{system-id}/volumes'}¶
-
SSC_VALID_VERSIONS
= ((1, 53, 9000, 1), (1, 53, 9010, 17))¶
-
WWN
= 'worldWideName'¶
-
add_autosupport_data
(key, data)¶ Register driver statistics via autosupport log.
-
control_volume_copy_job
(obj_id, control='start')¶ Controls a volume copy job.
-
create_host
(label, host_type, ports=None, group_id=None)¶ Creates host on array.
-
create_host_group
(label)¶ Creates a host group on the array.
-
create_host_with_ports
(label, host_type, port_ids, port_type='iscsi', group_id=None)¶ Creates host on array with given port information.
-
create_snapshot_group
(label, object_id, storage_pool_id, repo_percent=99, warn_thres=99, auto_del_limit=0, full_policy='failbasewrites')¶ Creates snapshot group on array.
-
create_snapshot_image
(group_id)¶ Creates snapshot image in snapshot group.
-
create_snapshot_volume
(image_id, label, base_object_id, storage_pool_id, repo_percent=99, full_thres=99, view_mode='readOnly')¶ Creates snapshot volume.
-
create_volume
(pool, label, size, unit='gb', seg_size=0, read_cache=None, write_cache=None, flash_cache=None, data_assurance=None, thin_provision=False)¶ Creates a volume on array with the configured attributes
- Note: if read_cache, write_cache, flash_cache, or data_assurance
- are not provided, the default will be utilized by the Webservice.
Parameters: - pool – The pool unique identifier
- label – The unqiue label for the volume
- size – The capacity in units
- unit – The unit for capacity
- seg_size – The segment size for the volume, expressed in KB.
Default will allow the Webservice to choose. :param read_cache: If true, enable read caching, if false, explicitly disable it. :param write_cache: If true, enable write caching, if false, explicitly disable it. :param flash_cache: If true, add the volume to a Flash Cache :param data_assurance: If true, enable the Data Assurance capability :return The created volume
-
create_volume_copy_job
(src_id, tgt_id, priority='priority4', tgt_wrt_protected='true')¶ Creates a volume copy job.
-
create_volume_mapping
(object_id, target_id, lun)¶ Creates volume mapping on array.
-
delete_snapshot_group
(object_id)¶ Deletes given snapshot group from array.
-
delete_snapshot_image
(object_id)¶ Deletes given snapshot image in snapshot group.
-
delete_snapshot_volume
(object_id)¶ Deletes given snapshot volume.
-
delete_vol_copy_job
(object_id)¶ Delete volume copy job.
-
delete_volume
(object_id)¶ Deletes given volume from array.
-
delete_volume_mapping
(map_object_id)¶ Deletes given volume mapping from array.
-
expand_volume
(object_id, new_capacity, capacity_unit='gb')¶ Increase the capacity of a volume
-
get_eseries_api_info
(verify=False)¶ Get E-Series API information from the array.
-
get_firmware_version
()¶ Get firmware version information from the array.
-
get_host
(host_ref)¶ Gets a single host from the array.
-
get_host_group
(host_group_ref)¶ Gets a single host group from the array.
-
get_host_group_by_name
(name)¶ Gets a single host group by name from the array.
-
get_model_name
()¶ Get Model Name from the array.
-
get_serial_numbers
()¶ Get the list of Serial Numbers from the array.
-
get_ssc_storage_pool
(volume_group_ref)¶ Get storage pool service quality information from the array.
-
get_storage_pool
(volume_group_ref)¶ Get storage pool information from the array.
-
get_system_id
()¶ Get the storage system id.
-
get_volume_mappings
()¶ Creates volume mapping on array.
-
get_volume_mappings_for_host
(host_ref)¶ Gets all volume mappings for given host from array.
-
get_volume_mappings_for_host_group
(hg_ref)¶ Gets all volume mappings for given host group from array.
-
get_volume_mappings_for_volume
(volume)¶ Gets all host mappings for given volume from array.
-
list_drives
()¶ Lists drives in the array.
-
list_hardware_inventory
()¶ Lists objects in the hardware inventory.
-
list_host_groups
()¶ Lists host groups on the array.
-
list_host_types
()¶ Lists host types in storage system.
-
list_hosts
()¶ Lists host objects in the system.
-
list_snapshot_groups
()¶ Lists snapshot groups.
-
list_snapshot_images
()¶ Lists snapshot images.
-
list_ssc_storage_pools
()¶ Lists pools and their service quality defined on the array.
-
list_storage_pools
()¶ Lists storage pools in the array.
-
list_storage_system
()¶ List current storage system registered with web service.
-
list_storage_systems
()¶ Lists managed storage systems registered with web service.
-
list_target_wwpns
()¶ Lists the world-wide port names of the target.
-
list_vol_copy_job
(object_id)¶ List volume copy job.
-
list_volume
(object_id)¶ Retrieve the given volume from array.
Parameters: object_id – The volume id, label, or wwn :return The volume identified by object_id :raise VolumeNotFound if the volume could not be found
-
list_volumes
()¶ Lists all volumes in storage array.
-
move_volume_mapping_via_symbol
(map_ref, to_ref, lun_id)¶ Moves a map from one host/host_group object to another.
-
register_storage_system
(controller_addresses, password=None, wwn=None)¶ Registers storage system with web service.
-
set_counter
(key, value)¶
-
set_host_group_for_host
(host_ref, host_group_ref='0000000000000000000000000000000000000000')¶ Sets or clears which host group a host is in.
-
set_system_id
(system_id)¶ Set the storage system id.
-
update_host
(host_ref, data)¶ Updates host type for a given host.
-
update_host_type
(host_ref, host_type)¶ Updates host type for a given host.
-
update_stored_system_password
(password)¶ Update array password stored on web service.
-
update_volume
(object_id, label)¶ Renames given volume on array.
-