Home       Trees       Indices       Help   
Package rtslib :: Module root :: Class RTSRoot
[hide private]
[frames] | no frames]

Class RTSRoot

source code

  object --+    
           |    
node.CFSNode --+
               |
              RTSRoot

This is an interface to the root of the configFS object tree. Is allows one to start browsing Target and StorageObjects, as well as helper methods to return arbitrary objects from the configFS tree.

>>> import rtslib.root as root
>>> rtsroot = root.RTSRoot()
>>> rtsroot.path
'/sys/kernel/config/target'
>>> rtsroot.exists
True
>>> rtsroot.targets # doctest: +ELLIPSIS
[...]
>>> rtsroot.tpgs # doctest: +ELLIPSIS
[...]
>>> rtsroot.storage_objects # doctest: +ELLIPSIS
[...]
>>> rtsroot.network_portals # doctest: +ELLIPSIS
[...]
Instance Methods [hide private]
 
__init__(self)
Instantiate an RTSRoot object.		 source code
 
_list_targets(self) source code
 
_list_storage_objects(self) source code
 
_list_tpgs(self) source code
 
_list_node_acls(self) source code
 
_list_mapped_luns(self) source code
 
_list_network_portals(self) source code
 
_list_luns(self) source code
 
_list_sessions(self) source code
 
_list_fabric_modules(self) source code
 
__str__(self)
str(x)		 source code
 
dump(self)
Returns a dict representing the complete state of the target config, suitable for serialization/deserialization, and then handing to restore().		 source code
 
clear_existing(self, confirm=False)
Remove entire current configuration.		 source code
 
restore(self, config, clear_existing=False, abort_on_error=False)
Takes a dict generated by dump() and reconfigures the target to match.		 source code
 
save_to_file(self, save_file=None)
Write the configuration in json format to a file.		 source code
 
restore_from_file(self, restore_file=None, clear_existing=True, abort_on_error=False)
Restore the configuration from a file in json format.		 source code

Inherited from node.CFSNode: delete, 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__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Variables [hide private]

Inherited from node.CFSNode: configfs_dir

Properties [hide private]
  targets
Get the list of Target objects.
  tpgs
Get the list of all the existing TPG objects.
  node_acls
Get the list of all the existing NodeACL objects.
  mapped_luns
Get the list of all the existing MappedLUN objects.
  sessions
Get the list of all the existing sessions.
  network_portals
Get the list of all the existing Network Portal objects.
  storage_objects
Get the list of all the existing Storage objects.
  luns
Get the list of all existing LUN objects.
  fabric_modules
Get the list of all FabricModule objects.

Inherited from node.CFSNode: exists, path

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 

Instantiate an RTSRoot object. Basically checks for configfs setup and base kernel modules (tcm)

Overrides: object.__init__

__str__(self)
(Informal representation operator)

source code 

str(x)

Overrides: object.__str__
(inherited documentation)

dump(self)

source code 

Returns a dict representing the complete state of the target config, suitable for serialization/deserialization, and then handing to restore().

Overrides: node.CFSNode.dump

restore(self, config, clear_existing=False, abort_on_error=False)

source code 

Takes a dict generated by dump() and reconfigures the target to match. Returns list of non-fatal errors that were encountered.

restore_from_file(self, restore_file=None, clear_existing=True, abort_on_error=False)

source code  

Restore the configuration from a file in json format.
Returns a list of non-fatal errors. If abort_on_error is set,
  it will raise the exception instead of continuing.

Property Details [hide private]

targets

Get the list of Target objects.

Get Method:
_list_targets(self)

tpgs

Get the list of all the existing TPG objects.

Get Method:
_list_tpgs(self)

node_acls

Get the list of all the existing NodeACL objects.

Get Method:
_list_node_acls(self)

mapped_luns

Get the list of all the existing MappedLUN objects.

Get Method:
_list_mapped_luns(self)

sessions

Get the list of all the existing sessions.

Get Method:
_list_sessions(self)

network_portals

Get the list of all the existing Network Portal objects.

Get Method:
_list_network_portals(self)

storage_objects

Get the list of all the existing Storage objects.

Get Method:
_list_storage_objects(self)

luns

Get the list of all existing LUN objects.

Get Method:
_list_luns(self)

fabric_modules

Get the list of all FabricModule objects.

Get Method:
_list_fabric_modules(self)

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Wed Apr 16 22:40:11 2014 http://epydoc.sourceforge.net