IStorageAreaNetwork Class Reference
Inherits lsm::_iplugin::IPlugin.
Collaboration diagram for IStorageAreaNetwork:
Public Member Functions | |
| def | volumes |
| def | volume_create |
| def | volume_delete |
| def | volume_resize |
| def | volume_replicate |
| def | volume_replicate_range_block_size |
| def | volume_replicate_range |
| def | volume_enable |
| def | volume_disable |
| def | iscsi_chap_auth |
| def | volume_mask |
| def | volume_unmask |
| def | access_groups |
| def | access_group_create |
| def | access_group_delete |
| def | access_group_initiator_add |
| def | access_group_initiator_delete |
| def | volumes_accessible_by_access_group |
| def | access_groups_granted_to_volume |
| def | volume_child_dependency |
| def | volume_child_dependency_rm |
| def | target_ports |
Detailed Description
Definition at line 129 of file _iplugin.py.
Member Function Documentation
| def access_group_create | ( | self, | ||
| name, | ||||
| init_id, | ||||
| init_type, | ||||
| system, | ||||
flags = 0 | ||||
| ) |
Returns a list of access groups, raises LsmError on errors.
Definition at line 254 of file _iplugin.py.
| def access_group_delete | ( | self, | ||
| access_group, | ||||
flags = 0 | ||||
| ) |
Deletes an access group, Raises LsmError on error
Definition at line 261 of file _iplugin.py.
| def access_group_initiator_add | ( | self, | ||
| access_group, | ||||
| init_id, | ||||
| init_type, | ||||
flags = 0 | ||||
| ) |
Adds an initiator to an access group, Raises LsmError on error
Definition at line 267 of file _iplugin.py.
| def access_group_initiator_delete | ( | self, | ||
| access_group, | ||||
| init_id, | ||||
| init_type, | ||||
flags = 0 | ||||
| ) |
Deletes an initiator from an access group, Raises LsmError on error
Definition at line 274 of file _iplugin.py.
| def access_groups | ( | self, | ||
search_key = None, |
||||
search_value = None, |
||||
flags = 0 | ||||
| ) |
Returns a list of access groups, raises LsmError on errors.
Definition at line 248 of file _iplugin.py.
| def access_groups_granted_to_volume | ( | self, | ||
| volume, | ||||
flags = 0 | ||||
| ) |
Returns the list of access groups that have access to the specified, Raises LsmError on error
Definition at line 288 of file _iplugin.py.
| def iscsi_chap_auth | ( | self, | ||
| init_id, | ||||
| in_user, | ||||
| in_password, | ||||
| out_user, | ||||
| out_password, | ||||
| flags | ||||
| ) |
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
Definition at line 218 of file _iplugin.py.
| def target_ports | ( | self, | ||
search_key = None, |
||||
search_value = None, |
||||
flags = 0 | ||||
| ) |
Definition at line 317 of file _iplugin.py.
| def volume_child_dependency | ( | self, | ||
| volume, | ||||
flags = 0 | ||||
| ) |
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.
Definition at line 295 of file _iplugin.py.
| def volume_child_dependency_rm | ( | self, | ||
| volume, | ||||
flags = 0 | ||||
| ) |
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.
Definition at line 303 of file _iplugin.py.
| def volume_create | ( | self, | ||
| pool, | ||||
| volume_name, | ||||
| size_bytes, | ||||
| provisioning, | ||||
flags = 0 | ||||
| ) |
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.
Definition at line 139 of file _iplugin.py.
| def volume_delete | ( | self, | ||
| volume, | ||||
flags = 0 | ||||
| ) |
Deletes a volume. Returns Job id or None if completed, else raises LsmError on errors.
Definition at line 150 of file _iplugin.py.
| def volume_disable | ( | self, | ||
| volume, | ||||
flags = 0 | ||||
| ) |
Makes a volume unavailable to the host Returns None on success, else raises LsmError on errors.
Definition at line 210 of file _iplugin.py.
| def volume_enable | ( | self, | ||
| volume, | ||||
flags = 0 | ||||
| ) |
Makes a volume available to the host Returns None on success, else raises LsmError on errors.
Definition at line 202 of file _iplugin.py.
| def volume_mask | ( | self, | ||
| access_group, | ||||
| volume, | ||||
flags = 0 | ||||
| ) |
Allows an access group to access a volume. Returns None on success, else raises LsmError on errors.
Definition at line 232 of file _iplugin.py.
| def volume_replicate | ( | self, | ||
| pool, | ||||
| rep_type, | ||||
| volume_src, | ||||
| name, | ||||
flags = 0 | ||||
| ) |
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.
Definition at line 168 of file _iplugin.py.
| def volume_replicate_range | ( | self, | ||
| rep_type, | ||||
| volume_src, | ||||
| volume_dest, | ||||
| ranges, | ||||
flags = 0 | ||||
| ) |
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.
Definition at line 191 of file _iplugin.py.
| def volume_replicate_range_block_size | ( | self, | ||
| system, | ||||
flags = 0 | ||||
| ) |
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
Definition at line 179 of file _iplugin.py.
| def volume_resize | ( | self, | ||
| volume, | ||||
| new_size_bytes, | ||||
flags = 0 | ||||
| ) |
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.
Definition at line 158 of file _iplugin.py.
| def volume_unmask | ( | self, | ||
| access_group, | ||||
| volume, | ||||
flags = 0 | ||||
| ) |
Revokes access for an access group for a volume Returns None on success, else raises LsmError on errors.
Definition at line 240 of file _iplugin.py.
| def volumes | ( | self, | ||
search_key = None, |
||||
search_value = None, |
||||
flags = 0 | ||||
| ) |
Returns an array of volume objects Raises LsmError on error
Definition at line 131 of file _iplugin.py.
| def volumes_accessible_by_access_group | ( | self, | ||
| access_group, | ||||
flags = 0 | ||||
| ) |
Returns the list of volumes that access group has access to. Raises LsmError on error
Definition at line 281 of file _iplugin.py.
The documentation for this class was generated from the following file:
