File: //lib64/python3.9/site-packages/lsm/__pycache__/_client.cpython-39.pyc
a
V��d@ � @ s� d dl Z d dlZd dlZd dlmZ d dlmZmZmZm Z m
Z
m Z m Z m
Z
mZmZmZmZmZmZmZ d dlmZ d dlmZ d dlmZ d dl m Z d dl Z dd � Z!d
d � Z"d d
� Z#G dd� de�Z$dS )� N)�S_ISSOCK)�Volume� NfsExport� Capabilities�Pool�System�Battery�Disk� AccessGroup�
FileSystem�
FsSnapshot� uri_parse�LsmError� ErrorNumber�INetworkAttachedStorage�
TargetPort)�return_requires)�UDS_PATH)� TransPort)�IDatac C s
| d= | S )z�
Used to remove the self key from the dict d. Self is included when calling
the function locals() in a class method.
�self� )�dr r �1/usr/lib64/python3.9/site-packages/lsm/_client.py� _del_self s r c C s | r | |vr t tjd| ��d S )Nz Unsupported search_key: '%s')r r ZUNSUPPORTED_SEARCH_KEY)�
search_keyZsupported_keysr r r �_check_search_key# s
�r c C s t tjd��d S )NzRThe libStorageMgmt daemon is not running (process name lsmd), please start service)r r ZDAEMON_NOT_RUNNINGr r r r �_raise_no_daemon+ s �r c @ s2 e Zd ZdZdZdZdZdZd�dd�Zd�dd �Z e
d
d � �Z e
d d
� �Z d�dd�Z
ed�efdd��Zed�efdd��Ze
eejd g�defdd���Zed�efdd��Zee�efdd ��Zeeee�efd d ��Zed�efd d ��Zee�efd!d"��Zeejd ejd �efd#d$��Z ee g�ddefd%d&��Z ee g�efd'd(��Z ed�efd)d*��Z!ed�efd+d,��Z"ee#g�ddefd-d.��Z$eejd e#�efd/d0��Z%eejd e#�efd1d2��Z&eejd e#�efd3d4��Z'ee�efd5d6��Z(eejd �efd7d8��Z)eejd �efd9d:��Z*ed�efd;d<��Z+ed�efd=d>��Z,ee-g�ddefd?d@��Z.ed�efdAdB��Z/ed�efdCdD��Z0ee1g�ddefdEdF��Z2ee1�efdGdH��Z3ed�efdIdJ��Z4ee1�efdKdL��Z5ee1�efdMdN��Z6ee#g�efdOdP��Z7ee1g�efdQdR��Z8ee9�efdSdT��Z:eejd �efdUdV��Z;ee<g�ddefdWdX��Z=eejd �efdYdZ��Z>eejd e<�efd[d\��Z?eejd e<�efd]d^��Z@eejd e<�defd_d`��ZAeejd �defdadb��ZBeeCg�efdcdd��ZDeejd eC�efdedf��ZEeejd �efdgdh��ZFeejd �diefdjdk��ZGee9�efdldm��ZHeejd �efdndo��ZIeejd g�efdpdq��ZJeeKg�ddefdrds��ZLeeK�eKjMeKjMddefdtdu��ZNed�efdvdw��ZOeePg�ddefdxdy��ZQeeeeeeg�efdzd{��ZReeeejd gg�efd|d}��ZSeegegg�efd~d��ZTee#�efd�d���ZUed�efd�d���ZVed�efd�d���ZWeeXg�ddefd�d���ZYeeeeeeg�efd�d���ZZed�efd�d���Z[ed�efd�d���Z\ed�efd�d���Z]dS )��Clientr � � � � c C s t d��d S )NzDo not call directly!)� RuntimeError)r �uri�plain_text_password�
timeout_ms�flagsr r r �plugin_registerJ s zClient.plugin_registerc C s | j �dtt� �� dS )z3
Instruct the plug-in to get ready
r( N��_tp�rpcr �locals)r r$ �password�timeoutr' r r r Z__startT s zClient.__startc
C sx t �� } tj�| �rtt�| �D ]R\}}}|D ]B}tj�||�}z t�|�}|� � W dS t
yl Y q,0 q,q n dS )NTF) r �_plugin_uds_path�os�path�exists�walk�join�
_TransPort�
get_socket�closer )�uds_path�root� sub_folders�files�filename�uds�sr r r �_check_daemon_exists^ s
zClient._check_daemon_existsc C s t } dtjv rtjd } | S )NZ LSM_UDS_PATH)� _UDS_PATHr0 �environ)�rcr r r r/ r s
zClient._plugin_uds_pathN�0u c
C s || _ || _|| _t�� | _t|dg�}|d }d|v rJ|�d�\}}|}t� d�} | r�z t
t � t
| �t jt j��| _W n8 ty� }
z ttjdt|
� ��W Y d }
~
n
d }
~
0 0 nXtj�| j|�| _tj�| j�r�t
t
�| j��| _n$t�� �rttj d| j ��nt � | � ||||� d S )N�scheme�+ZLSMCLI_DEBUG_FDzLSMCLI_DEBUG_FD: %szPlug-in %s not found!) Z_uriZ _password�_timeoutr r/ Z _uds_pathr
�splitr0 �getenvr5 �socketZfromfd�intZAF_UNIXZ SOCK_STREAMr* � Exceptionr r �INVALID_ARGUMENT�strr1 r4 Z plugin_pathr2 r6 r? ZPLUGIN_NOT_EXISTr �_Client__start) r r$ r% r& r' �urD Zplug�protoZdebug_fd�er r r �__init__� s<
��
�
�zClient.__init__c C s | � |� dS )z$
Synonym for close.
N)r7 �r r' r r r �plugin_unregister� s zClient.plugin_unregisterc C s( | j �dtt� �� | j �� d| _ dS )zB
Does an orderly plugin_unregister of the plug-in
rT N)r* r+ r r, r7 rS r r r r7 � s
z Client.close�:c
C s� g }t �� st� t �� }t�|�D ]x\}}}|D ]h}tj�||�}t�|�j } t
| �sZq2t t � |��}
|
�
dt|d��\} } |�d| | | f � |
�� q2q$|S )z�
Retrieves all the available plug-ins
Return list of strings of available plug-ins with the
"desc<sep>version"
� plugin_info)r' z%s%s%s)r r? r r/ r0 r3 r1 r4 �stat�st_moder r5 r6 r+ �dict�appendr7 )
Z field_sepr' rB r8 r9 r: r; r< r= �mode�tp�i�vr r r �available_plugins� s zClient.available_pluginsc C s | j �dtt� ��S )zr
Sets any time-outs for the plug-in (ms)
Return None on success, else LsmError exception
� time_out_setr) )r �msr' r r r r` � s zClient.time_out_setc C s | j �dtt� ��S )zd
Retrieves the current time-out
Return time-out in ms, else raise LsmError
� time_out_getr) rS r r r rb � s zClient.time_out_getc C s | j �dtt� ��S )z�
Returns the stats of the given job.
Returns a tuple ( status (enumeration), percent_complete,
completed item).
else LsmError exception.
�
job_statusr) �r Zjob_idr' r r r rc s zClient.job_statusc C s | j �dtt� ��S )zs
Frees resources for a given job number.
Returns None on success, else raises an LsmError
�job_freer) rd r r r re s zClient.job_freec C s | j �dtt� ��S )zv
Fetches the capabilities of the array
Returns a capability object, see data,py for details.
� capabilitiesr) �r �systemr' r r r rf " s zClient.capabilitiesc C s | j �dtt� ��S )z>
Returns a description and version of plug-in
rV r) rS r r r rV / s zClient.plugin_infoc C s t |tj� | j�dtt� ��S )z�
Returns an array of pool objects. Pools are used in both block and
file system interfaces, thus the reason they are in the base class.
�pools)r r �SUPPORTED_SEARCH_KEYSr* r+ r r, �r r Z search_valuer' r r r ri < s z Client.poolsc C s | j �dtt� ��S )z�
Returns an array of system objects. System information is used to
distinguish resources from on storage array to another when the plug=in
supports the ability to have more than one array managed by it
�systemsr) rS r r r rl I s zClient.systemsc C sp t jd dkr*t|ttf�s@ttjd��nt|t�s@ttjd��|dksP|dk r\ttjd��| j� dt
t � ��S )a�
lsm.Client.system_read_cache_pct_update(self, system, read_pct,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
This method updates the read cache percentage on a system if
supported
Parameters:
system(lsm.System)
an lsm.System object.
read_pct(int)
the desired read cache percentage.
flags (int)
Optional. Reserved for future use.
Should be set as lsm.Client.FLAG_RSVD.
Returns:
returns None on success, else raises LsmError on errors.
SpecialExceptions:
r r z&Invalid read_pct, should be an integer�d z,Invalid read_pct, should be in range 0 - 100� system_read_cache_pct_update) �sys� version_info�
isinstancerJ Zlongr r rL r* r+ r r, )r rh Zread_pctr' r r r rn X s �
���z#Client.system_read_cache_pct_updatec C s& t j|t jdd� | j�dtt� ��S )zg
Register a user/password for the specified initiator for CHAP
authentication.
T�Zraise_exception�iscsi_chap_auth)r
�initiator_id_verifyZINIT_TYPE_ISCSI_IQNr* r+ r r, )r �init_idZin_userZ in_passwordZout_userZ out_passwordr' r r r rs � s
�zClient.iscsi_chap_authc C s t |tj� | j�dtt� ��S )z4
Returns an array of volume objects
�volumes)r r rj r* r+ r r, rk r r r rv � s zClient.volumesc C s | j �dtt� ��S )z�
Creates a volume, given a pool, volume name, size and provisioning
returns a tuple (job_id, new volume)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
�
volume_creater) )r �poolZ volume_name�
size_bytesZ provisioningr' r r r rw � s zClient.volume_createc C s | j �dtt� ��S )z�
Re-sizes a volume.
Returns a tuple (job_id, re-sized_volume)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
�
volume_resizer) )r �volume�new_size_bytesr' r r r rz � s zClient.volume_resizec C s | j �dtt� ��S )z�
Replicates a volume from the specified pool.
Returns a tuple (job_id, replicated volume)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
�volume_replicater) )r rx �rep_type�
volume_src�namer' r r r r} � s zClient.volume_replicatec C s | j �dtt� ��S )zB
Returns the size of a replicated block in bytes.
�!volume_replicate_range_block_sizer) rg r r r r� � s �z(Client.volume_replicate_range_block_sizec C s | j �dtt� ��S )a-
Replicates a portion of a volume to itself or another volume. The src,
dest and number of blocks values change with vendor, call
volume_replicate_range_block_size to get block unit size.
Returns Job id or None when completed, else raises LsmError on errors.
�volume_replicate_ranger) )r r~ r Z volume_destZrangesr' r r r r� s z Client.volume_replicate_rangec C s | j �dtt� ��S )zQ
Deletes a volume.
Returns None on success, else job id
�
volume_deleter) �r r{ r' r r r r� s zClient.volume_deletec C s | j �dtt� ��S )zx
Makes a volume available to the host
returns None on success, else raises LsmError on errors.
�
volume_enabler) r� r r r r� ( s zClient.volume_enablec C s | j �dtt� ��S )zz
Makes a volume unavailable to the host
returns None on success, else raises LsmError on errors.
�volume_disabler) r� r r r r� 6 s zClient.volume_disablec C s t |tj� | j�dtt� ��S )z2
Returns an array of disk objects
�disks)r r rj r* r+ r r, rk r r r r� H s z Client.disksc C s | j �dtt� ��S )z<
Allows an access group to access a volume.
� volume_maskr) �r � access_groupr{ r' r r r r� V s zClient.volume_maskc C s | j �dtt� ��S )zA
Revokes access for an access group for a volume
�
volume_unmaskr) r� r r r r� c s zClient.volume_unmaskc C s t |tj� | j�dtt� ��S )z1
Returns a list of access groups
�
access_groups)r r
rj r* r+ r r, rk r r r r� p s zClient.access_groupsc C s0 t j||dd�dd� \}}| j�dtt� ��S )zs
Creates an access group and add the specified initiator id,
init_type and desired access.
Trr r N�access_group_create�r
rt r* r+ r r, )r r� ru � init_typerh r' r r r r� � s ��zClient.access_group_createc C s | j �dtt� ��S )z)
Deletes an access group
�access_group_deleter) �r r� r' r r r r� � s zClient.access_group_deletec C s0 t j||dd�dd� \}}| j�dtt� ��S )z6
Adds an initiator to an access group
Trr r N�access_group_initiator_addr� �r r� ru r� r' r r r r� � s ��z!Client.access_group_initiator_addc C s( t j|ddd�d }| j�dtt� ��S )z;
Deletes an initiator from an access group
NTrr r � access_group_initiator_deleter� r� r r r r� � s ���z$Client.access_group_initiator_deletec C s | j �dtt� ��S )zN
Returns the list of volumes that access group has access to.
�"volumes_accessible_by_access_groupr) r� r r r r� � s �z)Client.volumes_accessible_by_access_groupc C s | j �dtt� ��S )ze
Returns the list of access groups that have access to the specified
volume.
� access_groups_granted_to_volumer) r� r r r r� � s �z&Client.access_groups_granted_to_volumec C s | j �dtt� ��S )z�
Returns True if this volume has other volumes which are dependant on
it. Implies that this volume cannot be deleted or possibly modified
because it would affect its children.
�volume_child_dependencyr) r� r r r r� � s z Client.volume_child_dependencyc C s | j �dtt� ��S )a�
If this volume has child dependency, this method call will fully
replicate the blocks removing the relationship between them. This
should return None (success) if volume_child_dependency would return
False.
Note: This operation could take a very long time depending on the size
of the volume and the number of child dependencies.
Returns None if complete else job id, raises LsmError on errors.
�volume_child_dependency_rmr) r� r r r r� � s
z!Client.volume_child_dependency_rmc C s t |tj� | j�dtt� ��S )zC
Returns a list of file systems on the controller.
�fs)r r rj r* r+ r r, rk r r r r� s z Client.fsc C s | j �dtt� ��S )z�
WARNING: Destructive
Deletes a file system and everything it contains
Returns None on success, else job id
� fs_deleter) �r r� r' r r r r� s zClient.fs_deletec C s | j �dtt� ��S )z�
Re-size a file system
Returns a tuple (job_id, re-sized file system)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
� fs_resizer) )r r� r| r' r r r r� , s zClient.fs_resizec C s | j �dtt� ��S )a
Creates a file system given a pool, name and size.
Note: size is limited to 2**64 bytes
Returns a tuple (job_id, file system)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
� fs_creater) )r rx r� ry r' r r r r� ? s
zClient.fs_createc C s | j �dtt� ��S )a#
Creates a thin, point in time read/writable copy of src to dest.
Optionally uses snapshot as backing of src_fs
Returns a tuple (job_id, file system)
Note: Tuple return values are mutually exclusive, when one
is None the other must be valid.
�fs_cloner) )r Zsrc_fsZ dest_fs_name�snapshotr' r r r r� R s
zClient.fs_clonec C s | j �dtt� ��S )z�
Creates a thinly provisioned clone of src to dest.
Note: Source and Destination are required to be on same filesystem and
all directories in destination path need to exist.
Returns None on success, else job id
�
fs_file_cloner) )r r� Z
src_file_nameZdest_file_namer� r' r r r r� g s zClient.fs_file_clonec C s | j �dtt� ��S )zO
Returns a list of snapshot names for the supplied file system
� fs_snapshotsr) r� r r r r� | s zClient.fs_snapshotsc C s | j �dtt� ��S )a|
Snapshot is a point in time read-only copy
Create a snapshot on the chosen file system.
Returns a tuple (job_id, snapshot)
Notes:
- Snapshot name may not match what was passed in
(depends on array implementation)
- Tuple return values are mutually exclusive, when one
is None the other must be valid.
�fs_snapshot_creater) )r r� Z
snapshot_namer' r r r r� � s zClient.fs_snapshot_createc C s | j �dtt� ��S )z�
Frees the re-sources for the given snapshot on the supplied filesystem.
Returns None on success else job id, LsmError exception on error
�fs_snapshot_deleter) )r r� r� r' r r r r� � s zClient.fs_snapshot_deleteFc C s | j �dtt� ��S )a6
WARNING: Destructive!
Reverts a file-system or just the specified files from the snapshot.
If a list of files is supplied but the array cannot restore just them
then the operation will fail with an LsmError raised. If files == None
and all_files = True then all files on the file-system are restored.
Restore_file if None none must be the same length as files with each
index in each list referring to the associated file.
Returns None on success, else job id, LsmError exception on error
�fs_snapshot_restorer) )r r� r� r; Z
restore_filesZ all_filesr' r r r r� � s zClient.fs_snapshot_restorec C s | j �dtt� ��S )a&
Returns True if the specified filesystem or specified file on this
file system has child dependencies. This implies that this filesystem
or specified file on this file system cannot be deleted or possibly
modified because it would affect its children.
�fs_child_dependencyr) �r r� r; r' r r r r� � s zClient.fs_child_dependencyc C s | j �dtt� ��S )a�
If this filesystem or specified file on this filesystem has child
dependency this method will fully replicate the blocks removing the
relationship between them. This should return None(success) if
fs_child_dependency would return False.
Note: This operation could take a very long time depending on the size
of the filesystem and the number of child dependencies.
Returns None if completed, else job id. Raises LsmError on errors.
�fs_child_dependency_rmr) r� r r r r� � s
z Client.fs_child_dependency_rmc C s | j �dtt� ��S )zH
What types of NFS client authentication are supported.
� export_authr) rS r r r r� � s zClient.export_authc C s t |tj� | j�dtt� ��S )zL
Get a list of all exported file systems on the controller.
�exports)r r rj r* r+ r r, rk r r r r� � s zClient.exportsc C s8 t |�t |�t |� r$ttjd��| j�dtt� ��S )zD
Exports a filesystem as specified in the arguments
z(Host cannot both in rw_list and ro_list.� export_fs)�setr r rL r* r+ r r, ) r Zfs_idZ export_pathZ root_listZrw_listZro_listZanon_uidZanon_gidZ auth_type�optionsr' r r r r� s
�zClient.export_fsc C s | j �dtt� ��S )z.
Removes the specified export
�
export_remover) )r Zexportr' r r r r� , s zClient.export_removec C s t |tj� | j�dtt� ��S )z0
Returns a list of target ports
� target_ports)r r rj r* r+ r r, rk r r r r� 9 s zClient.target_portsc C s | j �dtt� ��S )a Query the RAID information of certain volume.
New in version 1.2.
Query the RAID type, strip size, extents count, minimum I/O size,
optimal I/O size of given volume.
This method requires this capability:
lsm.Capabilities.VOLUME_RAID_INFO
Args:
volume (Volume object): Volume to query
flags (int): Reserved for future use. Should be set as
lsm.Client.FLAG_RSVD
Returns:
[raid_type, strip_size, disk_count, min_io_size, opt_io_size]
raid_type (int): RAID Type of requested volume.
Could be one of these values:
Volume.RAID_TYPE_RAID0
Stripe
Volume.RAID_TYPE_RAID1
Two disks Mirror
Volume.RAID_TYPE_RAID3
Byte-level striping with dedicated parity
Volume.RAID_TYPE_RAID4
Block-level striping with dedicated parity
Volume.RAID_TYPE_RAID5
Block-level striping with distributed parity
Volume.RAID_TYPE_RAID6
Block-level striping with two distributed parities,
aka, RAID-DP
Volume.RAID_TYPE_RAID10
Stripe of mirrors
Volume.RAID_TYPE_RAID15
Parity of mirrors
Volume.RAID_TYPE_RAID16
Dual parity of mirrors
Volume.RAID_TYPE_RAID50
Stripe of parities
Volume.RAID_TYPE_RAID60
Stripe of dual parities
Volume.RAID_TYPE_RAID51
Mirror of parities
Volume.RAID_TYPE_RAID61
Mirror of dual parities
Volume.RAID_TYPE_JBOD
Just bunch of disks, no parity, no striping.
Volume.RAID_TYPE_UNKNOWN
The plugin failed to detect the volume's RAID type.
Volume.RAID_TYPE_MIXED
This volume contains multiple RAID settings.
Volume.RAID_TYPE_OTHER
Vendor specific RAID type
strip_size(int): The size of strip on each disk or other storage
extent.
For RAID1/JBOD, it should be set as sector size.
If plugin failed to detect strip size, it should be set
as Volume.STRIP_SIZE_UNKNOWN(0).
disk_count(int): The count of disks used for assembling the RAID
group(s) where this volume allocated from.
For any RAID system using the slice of disk, this value
indicate how many disk slices are used for the RAID.
For example, on LVM RAID, the 'disk_count' here indicate the
count of PVs used for certain volume.
Another example, on EMC VMAX, the 'disk_count' here indicate
how many hyper volumes are used for this volume.
For any RAID system using remote LUN for data storing, each
remote LUN should be count as a disk.
If the plugin failed to detect disk_count, it should be set
as Volume.DISK_COUNT_UNKNOWN(0).
min_io_size(int): The minimum I/O size, device preferred I/O
size for random I/O. Any I/O size not equal to a multiple
of this value may get significant speed penalty.
Normally it refers to strip size of each disk(extent).
If plugin failed to detect min_io_size, it should try these
values in the sequence of:
logical sector size -> physical sector size ->
Volume.MIN_IO_SIZE_UNKNOWN(0).
opt_io_size(int): The optimal I/O size, device preferred I/O
size for sequential I/O. Normally it refers to RAID group
stripe size.
If plugin failed to detect opt_io_size, it should be set
to Volume.OPT_IO_SIZE_UNKNOWN(0).
Raises:
LsmError:
ErrorNumber.NO_SUPPORT
No support.
�volume_raid_infor) r� r r r r� J s [zClient.volume_raid_infoc C s | j �dtt� ��S )a?
lsm.Client.pool_member_info(self, pool, flags=lsm.Client.FLAG_RSVD)
Version:
1.2
Usage:
Query the membership information of certain pool:
RAID type, member type and member ids.
Currently, LibStorageMgmt supports two types of pool:
* Sub-pool -- Pool.MEMBER_TYPE_POOL
Pool space is allocated from parent pool.
Example:
* NetApp ONTAP volume
* Disk RAID pool -- Pool.MEMBER_TYPE_DISK
Pool is a RAID group assembled by disks.
Example:
* LSI MegaRAID disk group
* EMC VNX pool
* NetApp ONTAP aggregate
Parameters:
pool (lsm.Pool object)
Pool to query
flags (int)
Optional. Reserved for future use.
Should be set as lsm.Client.FLAG_RSVD.
Returns:
[raid_type, member_type, member_ids]
raid_type (int)
RAID Type of requested pool.
Could be one of these values:
Volume.RAID_TYPE_RAID0
Stripe
Volume.RAID_TYPE_RAID1
Two disks Mirror
Volume.RAID_TYPE_RAID3
Byte-level striping with dedicated parity
Volume.RAID_TYPE_RAID4
Block-level striping with dedicated parity
Volume.RAID_TYPE_RAID5
Block-level striping with distributed parity
Volume.RAID_TYPE_RAID6
Block-level striping with two distributed parities,
aka, RAID-DP
Volume.RAID_TYPE_RAID10
Stripe of mirrors
Volume.RAID_TYPE_RAID15
Parity of mirrors
Volume.RAID_TYPE_RAID16
Dual parity of mirrors
Volume.RAID_TYPE_RAID50
Stripe of parities Volume.RAID_TYPE_RAID60
Stripe of dual parities
Volume.RAID_TYPE_RAID51
Mirror of parities
Volume.RAID_TYPE_RAID61
Mirror of dual parities
Volume.RAID_TYPE_JBOD
Just bunch of disks, no parity, no striping.
Volume.RAID_TYPE_UNKNOWN
The plugin failed to detect the volume's RAID type.
Volume.RAID_TYPE_MIXED
This pool contains multiple RAID settings.
Volume.RAID_TYPE_OTHER
Vendor specific RAID type
member_type (int)
Could be one of these values:
Pool.MEMBER_TYPE_POOL
Current pool(also known as sub-pool) is allocated from
other pool(parent pool). The 'raid_type' will set to
RAID_TYPE_OTHER unless certain RAID system support RAID
using space of parent pools.
Pool.MEMBER_TYPE_DISK
Pool is created from RAID group using whole disks.
Pool.MEMBER_TYPE_OTHER
Vendor specific RAID member type.
Pool.MEMBER_TYPE_UNKNOWN
Plugin failed to detect the RAID member type.
member_ids (list of strings)
When 'member_type' is Pool.MEMBER_TYPE_POOL,
the 'member_ids' will contain a list of parent Pool IDs.
When 'member_type' is Pool.MEMBER_TYPE_DISK,
the 'member_ids' will contain a list of disk IDs.
When 'member_type' is Pool.MEMBER_TYPE_OTHER or
Pool.MEMBER_TYPE_UNKNOWN, the member_ids should be an empty
list.
SpecialExceptions:
LsmError
ErrorNumber.NO_SUPPORT
ErrorNumber.NOT_FOUND_POOL
Capability:
lsm.Capabilities.POOL_MEMBER_INFO
�pool_member_infor) )r rx r' r r r r� � s `zClient.pool_member_infoc C s | j �dtt� ��S )a�
lsm.Client.volume_raid_create_cap_get(
self, system, flags=lsm.Client.FLAG_RSVD)
Version:
1.2
Usage:
This method is dedicated to local hardware RAID cards.
Query out all supported RAID types and strip sizes which could
be used by lsm.Client.volume_raid_create() method.
Parameters:
system (lsm.System)
Instance of lsm.System
flags (int)
Optional. Reserved for future use.
Should be set as lsm.Client.FLAG_RSVD.
Returns:
[raid_types, strip_sizes]
raid_types ([int])
List of integer, possible values are:
Volume.RAID_TYPE_RAID0
Volume.RAID_TYPE_RAID1
Volume.RAID_TYPE_RAID5
Volume.RAID_TYPE_RAID6
Volume.RAID_TYPE_RAID10
Volume.RAID_TYPE_RAID50
Volume.RAID_TYPE_RAID60
strip_sizes ([int])
List of integer. Stripe size in bytes.
SpecialExceptions:
LsmError
lsm.ErrorNumber.NO_SUPPORT
Method not supported.
Sample:
lsm_client = lsm.Client('sim://')
lsm_sys = lsm_client.systems()[0]
disks = lsm_client.disks(
search_key='system_id', search_value=lsm_sys.id)
free_disks = [d for d in disks if d.status == Disk.STATUS_FREE]
supported_raid_types, supported_strip_sizes = lsm_client.volume_raid_create_cap_get(lsm_sys)
new_vol = lsm_client.volume_raid_create(
'test_volume_raid_create', supported_raid_types[0],
free_disks, supported_strip_sizes[0])
Capability:
lsm.Capabilities.VOLUME_CREATE_RAID
This method is mandatory when volume_raid_create() is
supported.
�volume_raid_create_cap_getr) rg r r r r� s 5z!Client.volume_raid_create_cap_getc C s" t |�dkrttjd��|tjkr:t |�dkr:ttjd��|tjkr\t |�dk r\ttjd��|tjkr~t |�dk r~ttjd��|tjkr�t |�d s�t |�dk r�ttjd ��|tj kr�t |�d s�t |�d
k r�ttjd ��|tj
k�rt |�d �st |�d k �rttjd
��| j � dt
t� ��S )a
lsm.Client.volume_raid_create(self, name, raid_type, disks,
strip_size, flags=lsm.Client.FLAG_RSVD)
Version:
1.2
Usage:
This method is dedicated to local hardware RAID cards.
Create a disk RAID pool and allocate entire storage space to
new volume using requested volume name.
When dealing with RAID10, 50 or 60, the first half part of
'disks' will be located in one bottom layer RAID group.
The new volume and new pool will created within the same system
of provided disks.
This method does not allow duplicate call, when duplicate call
was issued, LsmError with ErrorNumber.DISK_NOT_FREE will be raise.
User should check disk.status for Disk.STATUS_FREE before
invoking this method.
Parameters:
name (string)
The name for new volume.
The requested volume name might be ignored due to restriction
of hardware RAID vendors.
The pool name will be automatically chosen by plugin.
raid_type (int)
The RAID type for the RAID group, possible values are:
Volume.RAID_TYPE_RAID0
Volume.RAID_TYPE_RAID1
Volume.RAID_TYPE_RAID5
Volume.RAID_TYPE_RAID6
Volume.RAID_TYPE_RAID10
Volume.RAID_TYPE_RAID15
Volume.RAID_TYPE_RAID16
Volume.RAID_TYPE_RAID50
Please check volume_raid_create_cap_get() returns to get
supported all raid types of current hardware RAID card.
disks ([lsm.Disks,])
A list of lsm.Disk objects. Free disks used for new RAID group.
strip_size (int)
The size in bytes of strip.
When setting strip_size to Volume.VCR_STRIP_SIZE_DEFAULT, it
allow hardware RAID cards to choose their default value.
Please use volume_raid_create_cap_get() method to get all
supported strip size of current hardware RAID card.
The Volume.VCR_STRIP_SIZE_DEFAULT is always supported when
lsm.Capabilities.VOLUME_CREATE_RAID is supported.
flags (int)
Optional. Reserved for future use.
Should be set as lsm.Client.FLAG_RSVD.
Returns:
lsm.Volume
The lsm.Volume object for newly created volume.
SpecialExceptions:
LsmError
lsm.ErrorNumber.NO_SUPPORT
Method not supported or RAID type not supported.
lsm.ErrorNumber.DISK_NOT_FREE
Disk is not in Disk.STATUS_FREE status.
lsm.ErrorNumber.NOT_FOUND_DISK
Disk not found
lsm.ErrorNumber.INVALID_ARGUMENT
1. Invalid input argument data.
2. Disks are not from the same system.
3. Disks are not from the same enclosure.
4. Invalid strip_size.
5. Disk count are meet the minimum requirement:
RAID1: len(disks) == 2
RAID5: len(disks) >= 3
RAID6: len(disks) >= 4
RAID10: len(disks) % 2 == 0 and len(disks) >= 4
RAID50: len(disks) % 2 == 0 and len(disks) >= 6
RAID60: len(disks) % 2 == 0 and len(disks) >= 8
lsm.ErrorNumber.NAME_CONFLICT
Requested name is already be used by other volume.
Sample:
lsm_client = lsm.Client('sim://')
disks = lsm_client.disks()
free_disks = [d for d in disks if d.status == Disk.STATUS_FREE]
new_vol = lsm_client.volume_raid_create(
'raid0_vol1', Volume.RAID_TYPE_RAID0, free_disks)
Capability:
lsm.Capabilities.VOLUME_CREATE_RAID
Indicate current system support volume_raid_create() method.
At least one RAID type should be supported.
The strip_size == Volume.VCR_STRIP_SIZE_DEFAULT is supported.
r z.Illegal input disks argument: no disk includedr z7Illegal input disks argument: RAID 1 only allow 2 disks� z<Illegal input disks argument: RAID 5 require 3 or more disksr! z<Illegal input disks argument: RAID 6 require 4 or more diskszRIllegal input disks argument: RAID 10 require even disks count and 4 or more disks� zRIllegal input disks argument: RAID 50 require even disks count and 6 or more disksr" zRIllegal input disks argument: RAID 60 require even disks count and 8 or more disks�volume_raid_create)�lenr r rL r ZRAID_TYPE_RAID1ZRAID_TYPE_RAID5ZRAID_TYPE_RAID6ZRAID_TYPE_RAID10ZRAID_TYPE_RAID50ZRAID_TYPE_RAID60r* r+ r r, )r r� Z raid_typer� Z
strip_sizer' r r r r� S sL ] ����
�
� �zClient.volume_raid_createc C s | j �dtt� ��S )aF
lsm.Client.volume_ident_led_on(self, volume,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
This method enables the IDENT LED on a volume if supported
Parameters:
volume (lsm.Volume)
An lsm.Volume object.
flags (int)
Optional. Reserved for future use.
Should be set as lsm.Client.FLAG_RSVD.
Returns:
returns None on success, else raises LsmError on errors.
SpecialExceptions:
�volume_ident_led_onr) r� r r r r� � s zClient.volume_ident_led_onc C s | j �dtt� ��S )aK
lsm.Client.volume_ident_led_off(self, volume,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
This method disables the IDENT LED on a volume if supported
Parameters:
volume (lsm.Volume)
An lsm.Volume object.
flags (int)
Optional. Reserved for future use.
Should be set as lsm.Client.FLAG_RSVD.
Returns:
returns None on success, else raises LsmError on errors.
SpecialExceptions:
�volume_ident_led_offr) r� r r r r� � s zClient.volume_ident_led_offc C s t |tj� | j�dtt� ��S )a~
lsm.Client.batteries(self, search_key=None, search_value=None,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
Query batteries. When present, super capacitors will also be
included.
Parameters:
search_key (string, optional)
The key name for the search. Valid search keys are stored in
lsm.Battery.SUPPORTED_SEARCH_KEYS
search_value (string, optional)
The value of search_key to match.
flags (int, optional):
Reserved for future use. Should be set as lsm.Client.FLAG_RSVD
Returns:
[lsm.Battery]
lsm.Battery (object)
lsm.Battery.id (string)
Unique ID for this cache hardware.
lsm.Battery.name (string)
Human friendly name, might include physical location, model
name and etc.
lsm.Battery.type (int)
The hardware type of cache. Could be one of these values:
lsm.Battery.TYPE_CHEMICAL
Chemical battery.
lsm.Battery.TYPE_CAPACITOR
Supper capacitor.
lsm.Battery.TYPE_OTHER
Vendor specific battery type.
lsm.Battery.TYPE_UNKNOWN
Unknown type.
lsm.Battery.status (int, bitmap)
Could be any combination of these values:
lsm.Battery.STATUS_OK
Battery is fully charged, health and not in use
currently.
lsm.Battery.STATUS_DISCHARGING
Battery is in use.
lsm.Battery.STATUS_CHARGING
Battery is charging.
lsm.Battery.STATUS_LEARNING
Battery is calibrating itself by discharging
battery and recharging again.
lsm.Battery.STATUS_DEGRADED
Battery is in degraded mode, need attention.
For example, battery is near end of life.
lsm.Battery.STATUS_ERROR
Battery is having hardware error or end of life.
lsm.Battery.STATUS_OTHER
Vendor specific status.
lsm.Battery.STATUS_UNKNOWN
Unknown.
lsm.Battery.system_id (string)
The id of system which current battery belong to.
SpecialExceptions:
LsmError
ErrorNumber.NO_SUPPORT
Capability:
lsm.Capabilities.BATTERIES
� batteries)r r rj r* r+ r r, rk r r r r� s B zClient.batteriesc C s | j �dtt� ��S )a�
lsm.Client.volume_cache_info(self, volume,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
Query RAM cache setting and status of specified volume on read
and write I/O.
Parameters:
volume (Lsm.Volume)
The lsm.Volume instance.
flags (int, optional):
Reserved for future use. Should be set as lsm.Client.FLAG_RSVD
Returns:
[int, int, int, int, int]
write_cache_policy (int)
The write cache policy. Valid values are:
* lsm.Volume.WRITE_CACHE_POLICY_WRITE_BACK
The storage system will use write back mode if cache
hardware found.
* lsm.Volume.WRITE_CACHE_POLICY_AUTO
The controller will use write back mode when
battery/capacitor is in good health, otherwise,
write through mode.
* lsm.Volume.WRITE_CACHE_POLICY_WRITE_THROUGH
The storage system will use write through mode.
* lsm.Volume.WRITE_CACHE_POLICY_UNKNOWN
Plugin failed to detect this setting.
write_cache_status (int)
The status of write cache. Valid values are:
* lsm.Volume.WRITE_CACHE_STATUS_WRITE_THROUGH
* lsm.Volume.WRITE_CACHE_STATUS_WRITE_BACK
* lsm.Volume.WRITE_CACHE_STATUS_UNKNOWN
read_cache_policy (int)
The policy for read cache. Valid values are:
* lsm.Volume.READ_CACHE_POLICY_ENABLED
Read cache is enabled, when reading I/O on previous
unchanged written I/O or read I/O in cache will be
returned to I/O initiator immediately without checking
backing store(normally disk).
* lsm.Volume.READ_CACHE_POLICY_DISABLED
Read cache is disabled.
* lsm.Volume.READ_CACHE_POLICY_UNKNOWN
Plugin failed to detect the read cache policy.
read_cache_status (int)
The status of read cache. Valid values are:
* lsm.Volume.READ_CACHE_STATUS_ENABLED
* lsm.Volume.READ_CACHE_STATUS_DISABLED
* lsm.Volume.READ_CACHE_STATUS_UNKNOWN
physical_disk_cache (int)
Whether physical disk's cache is enabled or not.
Please be advised, HDD's physical disk ram cache might be not
protected by storage system's battery or capacitor on sudden
power loss, you could lose data if a power failure occurs
during a write process.
For SSD's physical disk cache, please check with the vendor of
your hardware RAID card and SSD disk.
Valid values are:
* lsm.Volume.PHYSICAL_DISK_CACHE_ENABLED
Physical disk cache enabled.
* lsm.Volume.PHYSICAL_DISK_CACHE_DISABLED
Physical disk cache disabled.
* lsm.Volume.PHYSICAL_DISK_CACHE_USE_DISK_SETTING
Physical disk cache is determined by the disk vendor
via physical disks' SCSI caching mode page(0x08 page).
It is strongly suggested to change this value to
lsm.Volume.PHYSICAL_DISK_CACHE_ENABLED or
lsm.Volume.PHYSICAL_DISK_CACHE_DISABLED
* lsm.Volume.PHYSICAL_DISK_CACHE_UNKNOWN
Plugin failed to detect the physical disk status.
SpecialExceptions:
LsmError
ErrorNumber.NO_SUPPORT
ErrorNumber.NOT_FOUND_VOLUME
Capability:
lsm.Capabilities.VOLUME_CACHE_INFO
�volume_cache_infor) r� r r r r� U s RzClient.volume_cache_infoc C s4 |t jkr |t jkr ttjd��| j�dtt � ��S )a�
lsm.Client.volume_physical_disk_cache_update(self, volume, pdc,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
Change the setting of RAM physical disk cache of specified volume.
On some product(like HPE SmartArray), this action will be effective
at system level which means that even you are requesting a change
on a specified volume, this change will apply to all other volumes
on the same controller(system).
Parameters:
volume (Lsm.Volume)
The lsm.Volume instance.
pdc (int)
lsm.Volume.PHYSICAL_DISK_CACHE_ENABLED
Enable physical disk cache.
lsm.Volume.PHYSICAL_DISK_CACHE_DISABLED
Disable physical disk cache
flags (int, optional):
Reserved for future use. Should be set as lsm.Client.FLAG_RSVD
Returns:
N/A
SpecialExceptions:
LsmError
ErrorNumber.NO_SUPPORT
You might also get NO_SUPPORT error when trying
to change SSD physical disk cache on MegaRAID.
ErrorNumber.NOT_FOUND_VOLUME
Capability:
lsm.Capabilities.VOLUME_PHYSICAL_DISK_CACHE_SET
Allow changing physical disk cache.
lsm.Capabilities.VOLUME_PHYSICAL_DISK_CACHE_SET_SYSTEM_LEVEL
Indicate that this action will change system settings which
are effective on all volumes in this storage system.
For example, on HPE SmartArray, the physical disk cache
setting is a controller level setting.
z`Argument pdc should be Volume.PHYSICAL_DISK_CACHE_ENABLED or Volume.PHYSICAL_DISK_CACHE_DISABLED�!volume_physical_disk_cache_update)
r ZPHYSICAL_DISK_CACHE_ENABLEDZ PHYSICAL_DISK_CACHE_DISABLEDr r rL r* r+ r r, )r r{ Zpdcr' r r r r� � s )
���z(Client.volume_physical_disk_cache_updatec C s> |t jkr*|t jkr*|t jkr*ttjd��| j�dt t
� ��S )a�
lsm.Client.volume_write_cache_policy_update(self, volume, wcp,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
Change the RAM write cache policy on specified volume.
If lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_IMPACT_READ
is supported(e.g. HPE SmartArray), the changes on write cache
policy might also impact read cache policy.
If lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_WB_IMPACT_OTHER
is supported(e.g. HPE SmartArray), changing write cache policy
to write back mode might impact other volumes in the same system.
Parameters:
volume (Lsm.Volume)
The lsm.Volume instance.
wcp (int)
Could be one of these value:
* lsm.Volume.WRITE_CACHE_POLICY_WRITE_BACK
Change to write back mode.
* lsm.Volume.WRITE_CACHE_POLICY_AUTO
Change to auto mode: use write back mode when
battery/capacitor is healthy, otherwise use write
through.
* lsm.Volume.WRITE_CACHE_POLICY_WRITE_THROUGH
Change to write through mode.
flags (int, optional):
Reserved for future use. Should be set as lsm.Client.FLAG_RSVD
Returns:
N/A
SpecialExceptions:
LsmError
ErrorNumber.NO_SUPPORT
ErrorNumber.NOT_FOUND_VOLUME
Capability:
lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_WRITE_BACK
Allow changing to always mode.
lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_AUTO
Allow changing to auto mode.
lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_WRITE_THROUGH
Allow changing to disable mode.
lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_IMPACT_READ
Indicate this action might impact read cache policy.
lsm.Capabilities.VOLUME_WRITE_CACHE_POLICY_SET_WB_IMPACT_OTHER
Indicate that changing to write back mode might impact other
volumes. For example, on HPE SmartArray, changing to write back
mode will change all other volumes with auto write cache policy
to write back mode.
z�Argument wcp should be Volume.WRITE_CACHE_POLICY_WRITE_BACK or Volume.WRITE_CACHE_POLICY_AUTO or Volume.WRITE_CACHE_POLICY_WRITE_THROUGH� volume_write_cache_policy_update) r Z WRITE_CACHE_POLICY_WRITE_BACKZWRITE_CACHE_POLICY_AUTOZ WRITE_CACHE_POLICY_WRITE_THROUGHr r rL r* r+ r r, )r r{ Zwcpr' r r r r� � s 4
����z'Client.volume_write_cache_policy_updatec C s4 |t jkr |t jkr ttjd��| j�dtt � ��S )a
lsm.Client.volume_read_cache_policy_update(self, volume, rcp,
flags=lsm.Client.FLAG_RSVD)
Version:
1.3
Usage:
Change the RAM read cache policy of specified volume.
If lsm.Capabilities.VOLUME_READ_CACHE_POLICY_SET_IMPACT_WRITE
is supported(like HPE SmartArray), the change on write cache policy
might also impact read cache policy.
Parameters:
volume (Lsm.Volume)
The lsm.Volume instance.
rcp (int)
Could be one of these value:
* lsm.Volume.READ_CACHE_POLICY_ENABLED
Enable read cache.
* lsm.Volume.READ_CACHE_POLICY_DISABLED
Disable read cache.
flags (int, optional):
Reserved for future use. Should be set as lsm.Client.FLAG_RSVD
Returns:
N/A
SpecialExceptions:
LsmError
ErrorNumber.NO_SUPPORT
ErrorNumber.NOT_FOUND_VOLUME
Capability:
lsm.Capabilities.VOLUME_READ_CACHE_POLICY_SET
Allow enabling or disabling read cache policy.
lsm.Capabilities.VOLUME_READ_CACHE_POLICY_SET_IMPACT_WRITE
Indicate that changing read cache policy might impact write
cache policy. For example, on HPE SmartArray, disabling read
cache will also change write cache policy to write through.
z\Argument rcp should be Volume.READ_CACHE_POLICY_ENABLED or Volume.READ_CACHE_POLICY_DISABLED� volume_read_cache_policy_update)
r ZREAD_CACHE_POLICY_ENABLEDZREAD_CACHE_POLICY_DISABLEDr r rL r* r+ r r, )r r{ Zrcpr' r r r r� s &
���z&Client.volume_read_cache_policy_update)r )r )NrC r )^�__name__�
__module__� __qualname__Z FLAG_RSVDZ#FLAG_VOLUME_CREATE_USE_SYSTEM_CACHEZ%FLAG_VOLUME_CREATE_USE_IO_PASSTHROUGHZ'FLAG_VOLUME_CREATE_DISABLE_SYSTEM_CACHEZ)FLAG_VOLUME_CREATE_DISABLE_IO_PASSTHROUGHr( rN � staticmethodr? r/ rR �_return_requiresrT r7 �sixZ string_typesr_ r` rJ rb �_IDatarc re r rf rV r ri r rl rn rs r rv rw rz r} r� r� r� r� r� r r� r� r� r
r� r� r� r� r� r� r� �boolr� r� r r� r� r� r� r� r� r r� r� r� r� r� r� r� r r� ZANON_UID_GID_NAr� r� r r� r� r� r� r� r� r� r r� r� r� r� r� r r r r r 9 sJ
�
- "
1� � � �
� �
� � �
� � � � ag>� DS2>r )%r0 ro rI rW r Zlsmr r r r r r r r
r r r
r r r r Z lsm._commonr r� r r@ Zlsm._transportr r5 Z lsm._datar r� r� r r r r r r r r �<module> s D