-P`c@sddlmZddlmZddlmZmZddlm Z de ee fdYZ de fdYZ d e fd YZ d e fd YZd S(i(tABCMeta(tabstractmethod(tLsmErrort ErrorNumber(twith_metaclasstIPlugincBseZdZeddZeddZeddZeddZeddZeddZ eddZ edd Z ed d dd Z edd ZRS( sU Plug-in interface that all plug-ins must implement for basic operation. icCsdS(s 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((tselfturitpasswordttimeouttflags((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytplugin_registers cCsdS(ss Sets any time-outs for the plug-in (ms) Returns None on success, else LsmError exception N((RtmsR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt time_out_set(scCsdS(se Retrieves the current time-out Returns time-out in ms, else raise LsmError N((RR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt time_out_get1scCsdS(sZ 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 N((RR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytplugin_unregister:s cCsdS(s Returns the stats of the given job. Returns a tuple ( status (enumeration), percent_complete, completed item). else LsmError exception. N((Rtjob_idR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt job_statusFs cCsdS(sl Frees resources for a given job. Returns None on success, else raises an LsmError N((RRR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytjob_freeQscCsdS(sS Returns the capabilities for the selected system, raises LsmError N((RtsystemR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt capabilitiesZscCsdS(s Returns the description and version for plug-in, raises LsmError Note: Make sure plugin can handle this call before plugin_register is called. N((RR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt plugin_infoascCsdS(s 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 N((Rt search_keyt search_valueR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytpoolskscCsdS(s  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 N((RR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytsystemsus N(t__name__t __module__t__doc__t_abstractmethodR R RRRRRRtNoneRR(((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyRs*     tIStorageAreaNetworkcBseZddddZddZddZddZddZddZddZ ddZ dd Z d Z dd Z dd Zdddd ZddZddZddZddZddZddZddZddZddddZRS(icCsttjddS(sV Returns an array of volume objects Raises LsmError on error s Not supportedN(RRt NO_SUPPORT(RRRR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytvolumesscCsttjddS(s 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. s Not supportedN(RRR (Rtpoolt volume_namet size_bytest provisioningR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt volume_creates cCsttjddS(sq Deletes a volume. Returns Job id or None if completed, else raises LsmError on errors. s Not supportedN(RRR (RtvolumeR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt volume_deletescCsttjddS(s 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. s Not supportedN(RRR (RR'tnew_size_bytesR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt volume_resizescCsttjddS(sB 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. s Not supportedN(RRR (RR"trep_typet volume_srctnameR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytvolume_replicates cCsttjddS(s@ 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 s Not supportedN(RRR (RRR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt!volume_replicate_range_block_sizes cCsttjddS(s+ 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. s Not supportedN(RRR (RR+R,t volume_desttrangesR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytvolume_replicate_ranges cCsttjddS(sx Makes a volume available to the host Returns None on success, else raises LsmError on errors. s Not supportedN(RRR (RR'R ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt volume_enablescCsttjddS(sz Makes a volume unavailable to the host Returns None on success, else raises LsmError on errors. s Not supportedN(RRR (RR'R ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytvolume_disablescCsttjddS(s` 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 s Not supportedN(RRR (Rtinit_idtin_usert in_passwordtout_usert out_passwordR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytiscsi_chap_auths cCsttjddS(s~ Allows an access group to access a volume. Returns None on success, else raises LsmError on errors. s Not supportedN(RRR (Rt access_groupR'R ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt volume_maskscCsttjddS(s Revokes access for an access group for a volume Returns None on success, else raises LsmError on errors. s Not supportedN(RRR (RR;R'R ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt volume_unmaskscCsttjddS(sM Returns a list of access groups, raises LsmError on errors. s Not supportedN(RRR (RRRR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt access_groupsscCsttjddS(sM Returns a list of access groups, raises LsmError on errors. s Not supportedN(RRR (RR-R5t init_typeRR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytaccess_group_createscCsttjddS(sC Deletes an access group, Raises LsmError on error s Not supportedN(RRR (RR;R ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytaccess_group_deletescCsttjddS(sP Adds an initiator to an access group, Raises LsmError on error s Not supportedN(RRR (RR;R5R?R ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytaccess_group_initiator_add scCsttjddS(sU Deletes an initiator from an access group, Raises LsmError on error s Not supportedN(RRR (RR;R5R?R ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytaccess_group_initiator_deletescCsttjddS(so Returns the list of volumes that access group has access to. Raises LsmError on error s Not supportedN(RRR (RR;R ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt"volumes_accessible_by_access_groupscCsttjddS(sw Returns the list of access groups that have access to the specified, Raises LsmError on error s Not supportedN(RRR (RR'R ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytaccess_groups_granted_to_volume scCsttjddS(s 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. s Not supportedN(RRR (RR'R ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytvolume_child_dependency'scCsttjddS(s 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. s Not supportedN(RRR (RR'R ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytvolume_child_dependency_rm/s cCsttjddS(Ns Not supported(RRR (RRRR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt target_ports=sN(RRRR!R&R(R*R.R/R2R3R4R:R<R=R>R@RARBRCRDRERFRGRH(((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyRs,              tINetworkAttachedStoragecBseZdZddddZddZddZddZdddZdddZ ddZ dd Z dd Z e dd Zdd Zdd ZRS(sT Class the represents Network attached storage (Common NFS/CIFS operations) icCsdS(sf Returns a list of file systems on the controller. Raises LsmError on errors. N((RRRR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytfsEscCsttjddS(s WARNING: Destructive Deletes a file system and everything it contains Returns None on success, else job id s Not supportedN(RRR (RRJR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt fs_deleteLscCsttjddS(s 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. s Not supportedN(RRR (RRJR)R ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt fs_resizeUscCsttjddS(sO 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. s Not supportedN(RRR (RR"R-R$R ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt fs_create_s cCsttjddS(s# 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. s Not supportedN(RRR (Rtsrc_fst dest_fs_nametsnapshotR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytfs_cloneks cCsttjddS(s 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. s Not supportedN(RRR (RRJt src_file_nametdest_file_nameRPR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt fs_file_clonevscCsttjddS(sl Returns a list of snapshots for the supplied file system, Raises LsmError on error s Not supportedN(RRR (RRJR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt fs_snapshotsscCsttjddS(s{ 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) s Not supportedN(RRR (RRJt snapshot_nameR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytfs_snapshot_creates cCsttjddS(s Frees the re-sources for the given snapshot on the supplied filesystem. Returns Job id or None if completed, else raises LsmError on errors. s Not supportedN(RRR (RRJRPR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytfs_snapshot_deletescCsttjddS(s< 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 s Not supportedN(RRR (RRJRPtfilest restore_filest all_filesR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytfs_snapshot_restorescCsttjddS(s& 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. s Not supportedN(RRR (RRJRYR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytfs_child_dependencyscCsttjddS(s 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. s Not supportedN(RRR (RRJRYR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytfs_child_dependency_rms N(RRRRRJRKRLRMRQRTRURWRXtFalseR\R]R^(((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyRIAs      tINfscBs>eZddZddddZddZddZRS(icCsttjddS(sP Returns the types of authentication that are available for NFS s Not supportedN(RRR (RR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt export_authscCsttjddS(sL Get a list of all exported file systems on the controller. s Not supportedN(RRR (RRRR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytexportssc CsttjddS(sA Exports a filesystem as specified in the export s Not supportedN(RRR ( Rtfs_idt export_patht root_listtrw_listtro_listtanon_uidtanon_gidt auth_typetoptionsR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt export_fsscCsttjddS(s. Removes the specified export s Not supportedN(RRR (RtexportR ((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyt export_removesN(RRRaRRbRlRn(((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pyR`s  N(tabcRt_ABCMetaRRtlsmRRtsixRtobjectRRRIR`(((s0/usr/lib/python2.7/site-packages/lsm/_iplugin.pytsj