NexentaStor Class Reference
Detailed Description
Definition at line 52 of file nstor.py.
Member Function Documentation
def access_group_create |
( |
|
self, |
|
|
|
name, |
|
|
|
init_id, |
|
|
|
init_type, |
|
|
|
system, |
|
|
|
flags = 0 | |
|
) |
| | |
def access_group_delete |
( |
|
self, |
|
|
|
access_group, |
|
|
|
flags = 0 | |
|
) |
| | |
def access_group_initiator_add |
( |
|
self, |
|
|
|
access_group, |
|
|
|
init_id, |
|
|
|
init_type, |
|
|
|
flags = 0 | |
|
) |
| | |
Adds an initiator to an access group
Definition at line 787 of file nstor.py.
def access_group_initiator_delete |
( |
|
self, |
|
|
|
access_group, |
|
|
|
init_id, |
|
|
|
init_type, |
|
|
|
flags = 0 | |
|
) |
| | |
Deletes an initiator from an access group
Definition at line 809 of file nstor.py.
def access_groups |
( |
|
self, |
|
|
|
search_key = None , |
|
|
|
search_value = None , |
|
|
|
flags = 0 | |
|
) |
| | |
Returns a list of access groups
Definition at line 713 of file nstor.py.
def access_groups_granted_to_volume |
( |
|
self, |
|
|
|
volume, |
|
|
|
flags = 0 | |
|
) |
| | |
Returns the list of access groups that have access to the specified
Definition at line 839 of file nstor.py.
def capabilities |
( |
|
self, |
|
|
|
system, |
|
|
|
flags = 0 | |
|
) |
| | |
def export_auth |
( |
|
self, |
|
|
|
flags = 0 | |
|
) |
| | |
Returns the types of authentication that are available for NFS
Definition at line 395 of file nstor.py.
def export_fs |
( |
|
self, |
|
|
|
fs_id, |
|
|
|
export_path, |
|
|
|
root_list, |
|
|
|
rw_list, |
|
|
|
ro_list, |
|
|
|
anon_uid, |
|
|
|
anon_gid, |
|
|
|
auth_type, |
|
|
|
options, |
|
|
|
flags = 0 | |
|
) |
| | |
Exports a filesystem as specified in the export
Definition at line 427 of file nstor.py.
def export_remove |
( |
|
self, |
|
|
|
export, |
|
|
|
flags = 0 | |
|
) |
| | |
Removes the specified export
Definition at line 460 of file nstor.py.
def exports |
( |
|
self, |
|
|
|
search_key = None , |
|
|
|
search_value = None , |
|
|
|
flags = 0 | |
|
) |
| | |
Get a list of all exported file systems on the controller.
Definition at line 408 of file nstor.py.
def fs |
( |
|
self, |
|
|
|
search_key = None , |
|
|
|
search_value = None , |
|
|
|
flags = 0 | |
|
) |
| | |
def fs_child_dependency |
( |
|
self, |
|
|
|
fs, |
|
|
|
files, |
|
|
|
flags = 0 | |
|
) |
| | |
def fs_child_dependency_rm |
( |
|
self, |
|
|
|
fs, |
|
|
|
files, |
|
|
|
flags = 0 | |
|
) |
| | |
def fs_clone |
( |
|
self, |
|
|
|
src_fs, |
|
|
|
dest_fs_name, |
|
|
|
snapshot = None , |
|
|
|
flags = 0 | |
|
) |
| | |
def fs_create |
( |
|
self, |
|
|
|
pool, |
|
|
|
name, |
|
|
|
size_bytes, |
|
|
|
flags = 0 | |
|
) |
| | |
Consider you have 'data' pool and folder 'a' in it (data/a)
If you want create 'data/a/b', command line should look like:
--create-fs=a/b --pool=data --size=1G
Definition at line 200 of file nstor.py.
def fs_delete |
( |
|
self, |
|
|
|
fs, |
|
|
|
flags = 0 | |
|
) |
| | |
def fs_resize |
( |
|
self, |
|
|
|
fs, |
|
|
|
new_size_bytes, |
|
|
|
flags = 0 | |
|
) |
| | |
def fs_snapshot_create |
( |
|
self, |
|
|
|
fs, |
|
|
|
snapshot_name, |
|
|
|
flags = 0 | |
|
) |
| | |
def fs_snapshot_delete |
( |
|
self, |
|
|
|
fs, |
|
|
|
snapshot, |
|
|
|
flags = 0 | |
|
) |
| | |
def fs_snapshot_restore |
( |
|
self, |
|
|
|
fs, |
|
|
|
snapshot, |
|
|
|
files, |
|
|
|
restore_files, |
|
|
|
all_files = False , |
|
|
|
flags = 0 | |
|
) |
| | |
def fs_snapshots |
( |
|
self, |
|
|
|
fs, |
|
|
|
flags = 0 | |
|
) |
| | |
def iscsi_chap_auth |
( |
|
self, |
|
|
|
init_id, |
|
|
|
in_user, |
|
|
|
in_password, |
|
|
|
out_user, |
|
|
|
out_password, |
|
|
|
flags = 0 | |
|
) |
| | |
Register a user/password for the specified initiator for CHAP
authentication.
Definition at line 629 of file nstor.py.
def job_free |
( |
|
self, |
|
|
|
job_id, |
|
|
|
flags = 0 | |
|
) |
| | |
def job_status |
( |
|
self, |
|
|
|
job_id, |
|
|
|
flags = 0 | |
|
) |
| | |
def plugin_info |
( |
|
self, |
|
|
|
flags = 0 | |
|
) |
| | |
def plugin_register |
( |
|
self, |
|
|
|
uri, |
|
|
|
password, |
|
|
|
timeout, |
|
|
|
flags = 0 | |
|
) |
| | |
def plugin_unregister |
( |
|
self, |
|
|
|
flags = 0 | |
|
) |
| | |
def pools |
( |
|
self, |
|
|
|
search_key = None , |
|
|
|
search_value = None , |
|
|
|
flags = 0 | |
|
) |
| | |
def systems |
( |
|
self, |
|
|
|
flags = 0 | |
|
) |
| | |
def time_out_get |
( |
|
self, |
|
|
|
flags = 0 | |
|
) |
| | |
def time_out_set |
( |
|
self, |
|
|
|
ms, |
|
|
|
flags = 0 | |
|
) |
| | |
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 853 of file nstor.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 862 of file nstor.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 509 of file nstor.py.
def volume_delete |
( |
|
self, |
|
|
|
volume, |
|
|
|
flags = 0 | |
|
) |
| | |
Deletes a volume.
Returns None on success, else raises an LsmError
Definition at line 544 of file nstor.py.
def volume_mask |
( |
|
self, |
|
|
|
access_group, |
|
|
|
volume, |
|
|
|
flags = 0 | |
|
) |
| | |
Allows an access group to access a volume.
Definition at line 678 of file nstor.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 579 of file nstor.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 561 of file nstor.py.
def volume_unmask |
( |
|
self, |
|
|
|
access_group, |
|
|
|
volume, |
|
|
|
flags = 0 | |
|
) |
| | |
Revokes access for an access group for a volume
Definition at line 694 of file nstor.py.
def volumes |
( |
|
self, |
|
|
|
search_key = None , |
|
|
|
search_value = None , |
|
|
|
flags = 0 | |
|
) |
| | |
Returns an array of volume objects
Definition at line 475 of file nstor.py.
def volumes_accessible_by_access_group |
( |
|
self, |
|
|
|
access_group, |
|
|
|
flags = 0 | |
|
) |
| | |
Returns the list of volumes that access group has access to.
Definition at line 826 of file nstor.py.
Field Documentation
The documentation for this class was generated from the following file: