Package rtslib :: Module tcm :: Class PSCSIStorageObject

Class PSCSIStorageObject

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

An interface to configFS storage objects for pscsi backstore.

Instance Methods

[hide private]

__init__(self, name, dev=None, index=None)
A PSCSIStorageObject can be instantiated in two ways:

_configure(self, dev)

_set_wwn(self, wwn)

_get_model(self)

_get_vendor(self)

_get_revision(self)

_get_channel_id(self)

_get_target_id(self)

_get_lun(self)

_get_host_id(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, _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]

wwn = property(StorageObject._get_wwn, _set_wwn, doc= "Get the...

model = property(_get_model, doc= "Get the SCSI device model s...

vendor = property(_get_vendor, doc= "Get the SCSI device vendo...

revision = property(_get_revision, doc= "Get the SCSI device r...

host_id = property(_get_host_id, doc= "Get the SCSI device hos...

channel_id = property(_get_channel_id, doc= "Get the SCSI devi...

target_id = property(_get_target_id, doc= "Get the SCSI device...

lun = property(_get_lun, doc= "Get the SCSI device LUN")

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

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

Inherited from node.CFSNode: configfs_dir, exists, path

Method Details

[hide private]

init(self, name, dev=None, index=None)
(Constructor)

A PSCSIStorageObject can be instantiated in two ways:

Creation mode: If dev is specified, the underlying configFS object will be created with that parameter. No PSCSIStorageObject with the same name can pre-exist in the parent PSCSIBackstore in that mode, or instantiation will fail.
Lookup mode: If dev is not set, then the PSCSIStorageObject will be bound to the existing configFS object in the parent PSCSIBackstore having the specified name. The underlying configFS object must already exist in that mode, or instantiation will fail.

Parameters:

name (string) - The name of the PSCSIStorageObject.
dev (string) - You have two choices:
- Use the SCSI id of the device: dev="H:C:T:L".
- Use the path to the SCSI device: dev="/path/to/dev".

Returns:

A PSCSIStorageObject object.

Overrides: node.CFSNode.__init__

_configure(self, dev)

Overrides: StorageObject._configure

_set_wwn(self, wwn)

Overrides: StorageObject._set_wwn

_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]

wwn

Value:

property(StorageObject._get_wwn, _set_wwn, doc= "Get the StorageObject
 T10 WWN Unit Serial as a string."+ " You cannot set it for pscsi-back
ed StorageObjects.")

model

Value:

property(_get_model, doc= "Get the SCSI device model string")

vendor

Value:

property(_get_vendor, doc= "Get the SCSI device vendor string")

revision

Value:

property(_get_revision, doc= "Get the SCSI device revision string")

host_id

Value:

property(_get_host_id, doc= "Get the SCSI device host id")

channel_id

Value:

property(_get_channel_id, doc= "Get the SCSI device channel id")

target_id

Value:

property(_get_target_id, doc= "Get the SCSI device target id")

alua_supported

Value:

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

Class PSCSIStorageObject

__init__(self, name, dev=None, index=None) (Constructor)

_configure(self, dev)

_set_wwn(self, wwn)

_get_alua_supported(self)

dump(self)

wwn

model

vendor

revision

host_id

channel_id

target_id

alua_supported

init(self, name, dev=None, index=None)
(Constructor)