← Back
Editing: _iplugin.cpython-312.pyc
� V��dGC � � � d dl mZ d dl mZ d dlmZmZ d dlm Z G d� d e ee � � Z G d� de � Z G d � d e � Z G d � d e � Zy )� )�ABCMeta)�abstractmethod)�LsmError� ErrorNumber)�with_metaclassc �� � e Zd ZdZed d�� Zed d�� Zed d�� Zed d�� Zed d�� Z ed d�� Z ed d�� Z ed d �� Z edd �� Z ed d �� Zy )�IPluginzU Plug-in interface that all plug-ins must implement for basic operation. c � � y)z� Method first called to setup the plug-in (except for plugin_info) This would be the place to make a connection to the array. Returns None on success, else LsmError exception N� )�self�uri�password�timeout�flagss �3/usr/lib64/python3.12/site-packages/lsm/_iplugin.py�plugin_registerzIPlugin.plugin_register � � � � c � � y)zs Sets any time-outs for the plug-in (ms) Returns None on success, else LsmError exception Nr )r �msr s r � time_out_setzIPlugin.time_out_set � � � r c � � y)ze Retrieves the current time-out Returns time-out in ms, else raise LsmError Nr �r r s r � time_out_getzIPlugin.time_out_get' r r c � � y)aZ Called when the client wants to finish up or the socket goes eof. Plug-in should clean up all resources. Note: In the case where the socket goes EOF and the plugin_unregister runs into errors the exception(s) will not be delivered to the client! Returns None on success, else LsmError exception Nr r s r �plugin_unregisterzIPlugin.plugin_unregister0 s � � r c � � y)z� Returns the stats of the given job. Returns a tuple ( status (enumeration), percent_complete, completed item). else LsmError exception. Nr �r �job_idr s r � job_statuszIPlugin.job_status< r r c � � y)zl Frees resources for a given job. Returns None on success, else raises an LsmError Nr r s r �job_freezIPlugin.job_freeG r r c � � y)zS Returns the capabilities for the selected system, raises LsmError Nr �r �systemr s r � capabilitieszIPlugin.capabilitiesP � � � r c � � y)z� Returns the description and version for plug-in, raises LsmError Note: Make sure plugin can handle this call before plugin_register is called. Nr r s r � plugin_infozIPlugin.plugin_infoW � � � r Nc � � y)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. Raises LsmError on error Nr �r � search_key� search_valuer s r �poolsz IPlugin.poolsa r+ r c � � y)a 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 Raises LsmError on error Nr r s r �systemszIPlugin.systemsk r r �r �NNr )�__name__� __module__� __qualname__�__doc__�_abstractmethodr r r r r! r# r' r* r0 r2 r r r r r s� � �� � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � r r c �� � e Zd Zdd�Z dd�Zdd�Zdd�Zdd�Zdd�Z dd�Z dd �Z dd �Z d � Z dd �Z dd �Zdd�Zdd�Zdd�Z dd�Z dd�Zdd�Zdd�Zdd�Zdd�Zdd�Zy)�IStorageAreaNetworkNc �6 � t t j d� �)zV Returns an array of volume objects Raises LsmError on error � Not supported�r r � NO_SUPPORTr- s r �volumeszIStorageAreaNetwork.volumesy � � � �{�-�-��?�?r c �6 � t t j d� �)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. r= r> )r �pool� volume_name� size_bytes� provisioningr s r � volume_createz!IStorageAreaNetwork.volume_create� � � � �{�-�-��?�?r c �6 � t t j d� �)zq Deletes a volume. Returns Job id or None if completed, else raises LsmError on errors. r= r> �r �volumer s r � volume_deletez!IStorageAreaNetwork.volume_delete� rA r c �6 � t t j d� �)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. r= r> )r rK �new_size_bytesr s r � volume_resizez!IStorageAreaNetwork.volume_resize� � � � �{�-�-��?�?r c �6 � t t j d� �)aB Replicates a volume from the specified pool. In this library, to replicate means to create a new volume which is a copy of the source. Returns a tuple (job_id, replicated volume) Note: Tuple return values are mutually exclusive, when one is None the other must be valid. r= r> )r rC �rep_type� volume_src�namer s r �volume_replicatez$IStorageAreaNetwork.volume_replicate� � � � �{�-�-��?�?r c �6 � t t j d� �)a@ Returns the number of bytes per block for volume_replicate_range call. Callers of volume_replicate_range need to use this when calculating start and block lengths. Note: bytes per block may not match volume blocksize. Returns bytes per block, Raises LsmError on error r= r> r% s r �!volume_replicate_range_block_sizez5IStorageAreaNetwork.volume_replicate_range_block_size� � � � �{�-�-��?�?r c �6 � t t j d� �)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 if completed, else raises LsmError on errors. r= r> )r rR rS � volume_dest�rangesr s r �volume_replicate_rangez*IStorageAreaNetwork.volume_replicate_range� rH r c �6 � t t j d� �)zx Makes a volume available to the host Returns None on success, else raises LsmError on errors. r= r> rJ s r � volume_enablez!IStorageAreaNetwork.volume_enable� rA r c �6 � t t j d� �)zz Makes a volume unavailable to the host Returns None on success, else raises LsmError on errors. r= r> rJ s r �volume_disablez"IStorageAreaNetwork.volume_disable� rA r c �6 � t t j d� �)a` Register a user/password for the specified initiator for CHAP authentication. in_user & in_password are for inbound CHAP, out_user & out_password are for outbound CHAP. Note: Setting in_user, in_password or out_user, out_password to None will disable authentication. Raises LsmError on error r= r> )r �init_id�in_user� in_password�out_user� out_passwordr s r �iscsi_chap_authz#IStorageAreaNetwork.iscsi_chap_auth� � � � �{�-�-��?�?r c �6 � t t j d� �)z~ Allows an access group to access a volume. Returns None on success, else raises LsmError on errors. r= r> �r � access_grouprK r s r � volume_maskz IStorageAreaNetwork.volume_mask� rA r c �6 � t t j d� �)z� Revokes access for an access group for a volume Returns None on success, else raises LsmError on errors. r= r> rk s r � volume_unmaskz!IStorageAreaNetwork.volume_unmask� rA r c �6 � t t j d� ��zM Returns a list of access groups, raises LsmError on errors. r= r> r- s r � access_groupsz!IStorageAreaNetwork.access_groups� � � � �{�-�-��?�?r c �6 � t t j d� �rq r> )r rT rc � init_typer& r s r �access_group_createz'IStorageAreaNetwork.access_group_create� rs r c �6 � t t j d� �)zC Deletes an access group, Raises LsmError on error r= r> �r rl r s r �access_group_deletez'IStorageAreaNetwork.access_group_delete rs r c �6 � t t j d� �)zP Adds an initiator to an access group, Raises LsmError on error r= r> �r rl rc ru r s r �access_group_initiator_addz.IStorageAreaNetwork.access_group_initiator_add rP r c �6 � t t j d� �)zU Deletes an initiator from an access group, Raises LsmError on error r= r> r{ s r � access_group_initiator_deletez1IStorageAreaNetwork.access_group_initiator_delete rP r c �6 � t t j d� �)zo Returns the list of volumes that access group has access to. Raises LsmError on error r= r> rx s r �"volumes_accessible_by_access_groupz6IStorageAreaNetwork.volumes_accessible_by_access_group � � � �{�-�-��?�?r c �6 � t t j d� �)zw Returns the list of access groups that have access to the specified, Raises LsmError on error r= r> rJ s r � access_groups_granted_to_volumez3IStorageAreaNetwork.access_groups_granted_to_volume# r� r c �6 � t t j d� �)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. r= r> rJ s r �volume_child_dependencyz+IStorageAreaNetwork.volume_child_dependency* rA r c �6 � t t j d� �)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. r= r> rJ s r �volume_child_dependency_rmz.IStorageAreaNetwork.volume_child_dependency_rm2 ri r c �6 � t t j d� �)Nr= r> r- s r � target_portsz IStorageAreaNetwork.target_ports@ s � ��{�-�-��?�?r r4 r3 )r5 r6 r7 r@ rG rL rO rU rX r] r_ ra rh rm ro rr rv ry r| r~ r� r� r� r� r� r r r r; r; w s� � �@� � @� @�@� @� @�" &'� @� @�@� @� @�@�@� @� @� *+� @� -.� @�@�@�@� @� @r r; c �x � e Zd ZdZdd�Zdd�Zdd�Zdd�Zdd�Z dd�Z dd �Z dd �Z dd �Z dd �Z dd �Zdd�Zy)�INetworkAttachedStoragezT Class the represents Network attached storage (Common NFS/CIFS operations) Nc � � y)zf Returns a list of file systems on the controller. Raises LsmError on errors. Nr r- s r �fszINetworkAttachedStorage.fsI r( r c �6 � t t j d� �)z� WARNING: Destructive Deletes a file system and everything it contains Returns None on success, else job id r= r> �r r� r s r � fs_deletez!INetworkAttachedStorage.fs_deleteP � � � �{�-�-��?�?r c �6 � t t j d� �)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. r= r> )r r� rN r s r � fs_resizez!INetworkAttachedStorage.fs_resizeY rP r c �6 � t t j d� �)aO Creates a file system given a pool, name and size. Note: size is limited to 2**64 bytes so max size of a single volume at this time is 16 Exabytes Returns a tuple (job_id, file system) Note: Tuple return values are mutually exclusive, when one is None the other must be valid. r= r> )r rC rT rE r s r � fs_createz!INetworkAttachedStorage.fs_createc rY r c �6 � t t j d� �)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. r= r> )r �src_fs� dest_fs_name�snapshotr s r �fs_clonez INetworkAttachedStorage.fs_cloneo rV r c �6 � t t j d� �)z� Creates a thinly provisioned clone of src to dest. Note: Source and Destination are required to be on same filesystem Returns Job id or None if completed, else raises LsmError on errors. r= r> )r r� � src_file_name�dest_file_namer� r s r � fs_file_clonez%INetworkAttachedStorage.fs_file_clonez ri r c �6 � t t j d� �)zl Returns a list of snapshots for the supplied file system, Raises LsmError on error r= r> r� s r � fs_snapshotsz$INetworkAttachedStorage.fs_snapshots� r� r c �6 � t t j d� �)a{ Snapshot is a point in time read-only copy Create a snapshot on the chosen file system Returns a tuple (job_id, snap shot created) Note: Tuple return values are mutually exclusive, when one is None the other must be valid. Note: Snapshot name may not match what was passed in (depends on array implementation) r= r> )r r� � snapshot_namer s r �fs_snapshot_createz*INetworkAttachedStorage.fs_snapshot_create� rH r c �6 � t t j d� �)z� Frees the re-sources for the given snapshot on the supplied filesystem. Returns Job id or None if completed, else raises LsmError on errors. r= r> )r r� r� r s r �fs_snapshot_deletez*INetworkAttachedStorage.fs_snapshot_delete� rA r c �6 � t t j d� �)a< 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 not 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 r= r> )r r� r� �files� restore_files� all_filesr s r �fs_snapshot_restorez+INetworkAttachedStorage.fs_snapshot_restore� s � �* �{�-�-��?�?r c �6 � t t j d� �)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. r= r> �r r� r� r s r �fs_child_dependencyz+INetworkAttachedStorage.fs_child_dependency� r� r c �6 � t t j d� �)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 Job id or None if completed, else raises LsmError on errors. r= r> r� s r �fs_child_dependency_rmz.INetworkAttachedStorage.fs_child_dependency_rm� ri r r4 r3 )Nr )Fr )r5 r6 r7 r8 r� r� r� r� r� r� r� r� r� r� r� r� r r r r� r� D s^ � �� �@�@� @� @� $� � @� @� @� @� ',�"#� @�.@� @r r� c �. � e Zd Zdd�Zdd�Z dd�Zdd�Zy)�INfsc �6 � t t j d� �)zP Returns the types of authentication that are available for NFS r= r> r s r � export_authzINfs.export_auth� rs r Nc �6 � t t j d� �)zL Get a list of all exported file systems on the controller. r= r> r- s r �exportsz INfs.exports� rs r c �6 � t t j d� �)zA Exports a filesystem as specified in the export r= r> ) r �fs_id� export_path� root_list�rw_list�ro_list�anon_uid�anon_gid� auth_type�optionsr s r � export_fszINfs.export_fs� s � � �{�-�-��?�?r c �6 � t t j d� �)z. Removes the specified export r= r> )r �exportr s r � export_removezINfs.export_remove� rs r r3 r4 )r5 r6 r7 r� r� r� r� r r r r� r� � s � �@� @� �@� @r r� N)�abcr �_ABCMetar r9 �lsmr r �sixr �objectr r; r� r� r r r �<module>r� sZ �� $� 1� %� �g �n�X�v�.� g �TJ@�'� J@�ZN@�g� N@�b"@� "� "@r
Save File
Cancel