Package rtslib_fb :: Module tcm :: Class StorageObject

Class StorageObject

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

Known Subclasses:

This is an interface to storage objects in configFS. A StorageObject is identified by its backstore and its name.

Instance Methods

[hide private]

__repr__(self)
repr(x)

__init__(self, name, mode)
x.__init__(...) initializes x; see help(type(x)) for signature

_configure(self, wwn=None)

__eq__(self, other)

__ne__(self, other)

_config_pr_aptpl(self)
LIO actually *writes* pr aptpl info to the filesystem, so we need to read it in and squirt it back into configfs when we configure the storage object.

_get_wwn(self)

_set_wwn(self, wwn)

_set_udev_path(self, udev_path)

_get_udev_path(self)

_get_version(self)

_get_name(self)

_enable(self)

_control(self, command)

_write_fd(self, contents)

_parse_info(self, key)

_get_status(self)

_gen_attached_luns(self)
Fast scan of luns attached to a storage object.

_list_attached_luns(self)
Generates all luns attached to a storage object.

_list_alua_tpgs(self)
Generate all ALUA groups attach to a storage object.

_get_alua_supported(self)
Children should override and return false if ALUA setup is not supported.

delete(self)
Recursively deletes a StorageObject object.

is_configured(self)
Returns: True if the StorageObject is configured, else returns False

dump(self)

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

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods

[hide private]

all(cls)

so_from_path(cls, path)
Build a StorageObject of the correct type from a configfs path.

Class Variables

[hide private]

Inherited from node.CFSNode: configfs_dir

Properties

[hide private]

version
Get the version of the StorageObject's backstore

name
Get the StorageObject name as a string.

udev_path
Get the StorageObject udev_path as a string.

wwn
Get or set the StorageObject T10 WWN Serial as a string.

status
Get the storage object status, depending on whether or not itis used by any LUN

attached_luns
Get the list of all LUN objects attached.

alua_tpgs
Get list of ALUA Target Port Groups attached.

alua_supported
Returns true if ALUA can be setup.

Inherited from node.CFSNode: exists, path

Inherited from object: __class__

Method Details

[hide private]

repr(self)
(Representation operator)

repr(x)

Overrides: object.__repr__: (inherited documentation)

init(self, name, mode)
(Constructor)

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

eq(self, other)
(Equality operator)

Overrides: node.CFSNode.__eq__

ne(self, other)

Overrides: node.CFSNode.__ne__

_config_pr_aptpl(self)

LIO actually *writes* pr aptpl info to the filesystem, so we need to read it in and squirt it back into configfs when we configure the storage object. BLEH.

_gen_attached_luns(self)

Fast scan of luns attached to a storage object. This is an order of magnitude faster than using root.luns and matching path on them.

delete(self)

Recursively deletes a StorageObject object. This will delete all attached LUNs currently using the StorageObject object, and then the StorageObject itself. The underlying file and block storages will not be touched, but all ramdisk data will be lost.

Overrides: node.CFSNode.delete

is_configured(self)

Returns:: True if the StorageObject is configured, else returns False

dump(self)

Overrides: node.CFSNode.dump

Property Details

[hide private]

version

Get the version of the StorageObject's backstore

Get Method:: _get_version(self)

name

Get the StorageObject name as a string.

Get Method:: _get_name(self)

udev_path

Get the StorageObject udev_path as a string.

Get Method:: _get_udev_path(self)

wwn

Get or set the StorageObject T10 WWN Serial as a string.

Get Method:: _get_wwn(self)
Set Method:: _set_wwn(self, wwn)

status

Get the storage object status, depending on whether or not itis used by any LUN

Get Method:: _get_status(self)

attached_luns

Get the list of all LUN objects attached.

Get Method:: _list_attached_luns(self) - Generates all luns attached to a storage object.

alua_tpgs

Get list of ALUA Target Port Groups attached.

Get Method:: _list_alua_tpgs(self) - Generate all ALUA groups attach to a storage object.

alua_supported

Returns true if ALUA can be setup. False if not supported.

Get Method:: _get_alua_supported(self) - Children should override and return false if ALUA setup is not supported.

Class StorageObject

__repr__(self) (Representation operator)

__init__(self, name, mode) (Constructor)

__eq__(self, other) (Equality operator)

__ne__(self, other)

_config_pr_aptpl(self)

_gen_attached_luns(self)

delete(self)

is_configured(self)

dump(self)

version

name

udev_path

wwn

status

attached_luns

alua_tpgs

alua_supported

repr(self)
(Representation operator)

init(self, name, mode)
(Constructor)

eq(self, other)
(Equality operator)

ne(self, other)