INetworkAttachedStorage Class Reference
Inherits lsm::_iplugin::IPlugin.
Inherited by INfs.
Collaboration diagram for INetworkAttachedStorage:
Public Member Functions | |
| def | fs |
| def | fs_delete |
| def | fs_resize |
| def | fs_create |
| def | fs_clone |
| def | fs_file_clone |
| def | fs_snapshots |
| def | fs_snapshot_create |
| def | fs_snapshot_delete |
| def | fs_snapshot_restore |
| def | fs_child_dependency |
| def | fs_child_dependency_rm |
Detailed Description
Class the represents Network attached storage (Common NFS/CIFS operations)
Definition at line 321 of file _iplugin.py.
Member Function Documentation
| def fs | ( | self, | ||
search_key = None, |
||||
search_value = None, |
||||
flags = 0 | ||||
| ) |
Returns a list of file systems on the controller. Raises LsmError on errors.
Definition at line 325 of file _iplugin.py.
| def fs_child_dependency | ( | self, | ||
| fs, | ||||
| files, | ||||
flags = 0 | ||||
| ) |
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.
Definition at line 432 of file _iplugin.py.
| def fs_child_dependency_rm | ( | self, | ||
| fs, | ||||
| files, | ||||
flags = 0 | ||||
| ) |
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.
Definition at line 441 of file _iplugin.py.
| def fs_clone | ( | self, | ||
| src_fs, | ||||
| dest_fs_name, | ||||
snapshot = None, |
||||
flags = 0 | ||||
| ) |
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.
Definition at line 363 of file _iplugin.py.
| def fs_create | ( | self, | ||
| pool, | ||||
| name, | ||||
| size_bytes, | ||||
flags = 0 | ||||
| ) |
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.
Definition at line 351 of file _iplugin.py.
| def fs_delete | ( | self, | ||
| fs, | ||||
flags = 0 | ||||
| ) |
WARNING: Destructive Deletes a file system and everything it contains Returns None on success, else job id
Definition at line 332 of file _iplugin.py.
| def fs_file_clone | ( | self, | ||
| fs, | ||||
| src_file_name, | ||||
| dest_file_name, | ||||
snapshot = None, |
||||
flags = 0 | ||||
| ) |
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.
Definition at line 374 of file _iplugin.py.
| def fs_resize | ( | self, | ||
| fs, | ||||
| new_size_bytes, | ||||
flags = 0 | ||||
| ) |
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.
Definition at line 341 of file _iplugin.py.
| def fs_snapshot_create | ( | self, | ||
| fs, | ||||
| snapshot_name, | ||||
flags = 0 | ||||
| ) |
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)
Definition at line 391 of file _iplugin.py.
| def fs_snapshot_delete | ( | self, | ||
| fs, | ||||
| snapshot, | ||||
flags = 0 | ||||
| ) |
Frees the re-sources for the given snapshot on the supplied filesystem. Returns Job id or None if completed, else raises LsmError on errors.
Definition at line 406 of file _iplugin.py.
| def fs_snapshot_restore | ( | self, | ||
| fs, | ||||
| snapshot, | ||||
| files, | ||||
| restore_files, | ||||
all_files = False, |
||||
flags = 0 | ||||
| ) |
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
Definition at line 414 of file _iplugin.py.
| def fs_snapshots | ( | self, | ||
| fs, | ||||
flags = 0 | ||||
| ) |
Returns a list of snapshots for the supplied file system, Raises LsmError on error
Definition at line 384 of file _iplugin.py.
The documentation for this class was generated from the following file:
