Inherited by INetworkAttachedStorage, and IStorageAreaNetwork.
Public Member Functions | |
| def | plugin_register |
| def | time_out_set |
| def | time_out_get |
| def | plugin_unregister |
| def | job_status |
| def | job_free |
| def | capabilities |
| def | plugin_info |
| def | pools |
| def | systems |
Plug-in interface that all plug-ins must implement for basic operation.
Definition at line 22 of file _iplugin.py.
| def capabilities | ( | self, | ||
| system, | ||||
flags = 0 | ||||
| ) |
Returns the capabilities for the selected system, raises LsmError
Definition at line 91 of file _iplugin.py.
| def job_free | ( | self, | ||
| job_id, | ||||
flags = 0 | ||||
| ) |
Frees resources for a given job. Returns None on success, else raises an LsmError
Definition at line 82 of file _iplugin.py.
| def job_status | ( | self, | ||
| job_id, | ||||
flags = 0 | ||||
| ) |
Returns the stats of the given job.
Returns a tuple ( status (enumeration), percent_complete,
completed item).
else LsmError exception.
Definition at line 71 of file _iplugin.py.
| def plugin_info | ( | self, | ||
flags = 0 | ||||
| ) |
Returns the description and version for plug-in, raises LsmError Note: Make sure plugin can handle this call before plugin_register is called.
Definition at line 98 of file _iplugin.py.
| def plugin_register | ( | self, | ||
| uri, | ||||
| password, | ||||
| timeout, | ||||
flags = 0 | ||||
| ) |
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
Definition at line 30 of file _iplugin.py.
| def plugin_unregister | ( | self, | ||
flags = 0 | ||||
| ) |
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
Definition at line 59 of file _iplugin.py.
| def pools | ( | self, | ||
search_key = None, |
||||
search_value = None, |
||||
flags = 0 | ||||
| ) |
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
Definition at line 108 of file _iplugin.py.
| def systems | ( | self, | ||
flags = 0 | ||||
| ) |
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
Definition at line 118 of file _iplugin.py.
| def time_out_get | ( | self, | ||
flags = 0 | ||||
| ) |
Retrieves the current time-out Returns time-out in ms, else raise LsmError
Definition at line 50 of file _iplugin.py.
| def time_out_set | ( | self, | ||
| ms, | ||||
flags = 0 | ||||
| ) |
Sets any time-outs for the plug-in (ms) Returns None on success, else LsmError exception
Definition at line 41 of file _iplugin.py.
1.6.1