Package rtslib :: Module tcm :: Class UserBackedStorageObject

Class UserBackedStorageObject

  object --+        
           |        
node.CFSNode --+    
               |    
   StorageObject --+
                   |
                  UserBackedStorageObject

An interface to configFS storage objects for userspace-backed backstore.

Instance Methods

[hide private]

__init__(self, name, config=None, size=None, wwn=None, hw_max_sectors=None, control=None)
Returns: A UserBackedStorageObject object.

_configure(self, config, size, wwn, hw_max_sectors, control)

_get_size(self)

_get_hw_max_sectors(self)

_get_control_tuples(self)

_get_config(self)

_get_alua_supported(self)
Children should override if the backend did not always support ALUA

dump(self)

Inherited from StorageObject: __eq__, __ne__, __repr__, delete, is_configured

Inherited from StorageObject (private): _config_pr_aptpl, _control, _enable, _gen_attached_luns, _get_name, _get_status, _get_udev_path, _get_version, _get_wwn, _list_alua_tpgs, _list_attached_luns, _parse_info, _set_udev_path, _set_wwn, _write_fd

Inherited from node.CFSNode: get_attribute, get_parameter, list_attributes, list_parameters, set_attribute, set_parameter

Inherited from node.CFSNode (private): _check_self, _create_in_cfs_ine, _exists, _get_path, _list_files

Class Methods

[hide private]

Inherited from StorageObject: all, so_from_path

Class Variables

[hide private]

hw_max_sectors = property(_get_hw_max_sectors, doc= "Get the m...

control_tuples = property(_get_control_tuples, doc= "Get the c...

size = property(_get_size, doc= "Get the size in bytes.")

config = property(_get_config, doc= "Get the TCMU config.")

alua_supported = property(_get_alua_supported, doc= "Returns t...

Inherited from StorageObject: alua_tpgs, attached_luns, name, status, udev_path, version, wwn

Inherited from node.CFSNode: configfs_dir, exists, path

Method Details

[hide private]

init(self, name, config=None, size=None, wwn=None, hw_max_sectors=None, control=None)
(Constructor)

Parameters:

name (string) - The name of the UserBackedStorageObject.
config (string) - user-handler-specific config string.
- e.g. "rbd/machine1@snap4"
size (int) - The size of the device to create, in bytes.
wwn (string) - T10 WWN Unit Serial, will generate if None
hw_max_sectors (int)

Returns:

A UserBackedStorageObject object.

Overrides: node.CFSNode.__init__

_configure(self, config, size, wwn, hw_max_sectors, control)

Overrides: StorageObject._configure

_get_alua_supported(self)

Children should override if the backend did not always support ALUA

Overrides: StorageObject._get_alua_supported: (inherited documentation)

dump(self)

Overrides: node.CFSNode.dump

Class Variable Details

[hide private]

hw_max_sectors

Value:

property(_get_hw_max_sectors, doc= "Get the max sectors per command.")

control_tuples

Value:

property(_get_control_tuples, doc= "Get the comma separated string con
taining control=value tuples.")

alua_supported

Value:

property(_get_alua_supported, doc= "Returns true if ALUA can be setup.
 False if not supported.")

Class UserBackedStorageObject

__init__(self, name, config=None, size=None, wwn=None, hw_max_sectors=None, control=None) (Constructor)

_configure(self, config, size, wwn, hw_max_sectors, control)

_get_alua_supported(self)

dump(self)

hw_max_sectors

control_tuples

alua_supported

init(self, name, config=None, size=None, wwn=None, hw_max_sectors=None, control=None)
(Constructor)