Package rtslib :: Module target :: Class NodeACL

[hide private]
[frames] | no frames]

# Class NodeACL

      object --+
               |
    node.CFSNode --+
                   |
                  NodeACL

This is an interface to node ACLs in configFS. A NodeACL is identified by the initiator node wwn and parent TPG.

Instance Methods | [hide private]

__repr__(self) repr(x) |

__init__(self, parent_tpg, node_wwn, mode=`'``any``'`) Returns: A NodeACL object. |

_get_node_wwn(self) |

_get_parent_tpg(self) |

_get_tcq_depth(self) |

_set_tcq_depth(self, depth) |

_get_tag(self) |

_set_tag(self, tag_str) |

_list_mapped_luns(self) |

_get_session(self) |

has_feature(self, feature) Whether or not this NodeACL has a certain feature. |

delete(self) Delete the NodeACL, including all MappedLUN objects. |

mapped_lun(self, mapped_lun, tpg_lun=None, write_protect=None) Same as MappedLUN() but without the parent_nodeacl parameter. |

_get_authenticate_target(self) |

dump(self) |

Inherited from `node.CFSNode`: `__eq__`, `__ne__`, `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]

setup(cls, tpg_obj, acl, err_func) |

Class Variables | [hide private]

Inherited from `node.CFSNode`: `configfs_dir`

Properties | [hide private]

| tcq_depth Set or get the TCQ depth for the initiator sessions matching this NodeACL.
| tag Set or get the NodeACL tag.
| parent_tpg Get the parent TPG object.
| node_wwn Get the node wwn.
| mapped_luns Get the list of all MappedLUN objects in this NodeACL.
| session Gives a snapshot of the current session or `None`
| chap_userid Set or get the initiator CHAP auth userid.
| chap_password Set or get the initiator CHAP auth password.
| chap_mutual_userid Set or get the initiator CHAP auth userid.
| chap_mutual_password Set or get the initiator CHAP auth password.
| authenticate_target Get the boolean authenticate target flag.
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, parent_tpg, node_wwn, mode=`'``any``'`)
(Constructor)

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

Parameters:
  - `parent_tpg` (TPG) - The parent TPG object.
  - `node_wwn` (string) - The wwn of the initiator node for which the ACL is created.
  - `mode` (string) - An optionnal string containing the object creation mode:
    - 'any' means the configFS object will be either looked up or created.
    - 'lookup' means the object MUST already exist configFS.
    - 'create' means the object must NOT already exist in configFS.
Returns:
  A NodeACL object.
Overrides: object.__init__

### delete(self)

Delete the NodeACL, including all MappedLUN objects. If the underlying configFS object does not exist, this method does nothing.

Overrides: node.CFSNode.delete

### dump(self)

Overrides: node.CFSNode.dump

Property Details | [hide private]

### tcq_depth

Set or get the TCQ depth for the initiator sessions matching this NodeACL.

Get Method:
  _get_tcq_depth(self)
Set Method:
  _set_tcq_depth(self, depth)

### tag

Set or get the NodeACL tag. If not supported, return None

Get Method:
  _get_tag(self)
Set Method:
  _set_tag(self, tag_str)

### parent_tpg

Get the parent TPG object.

Get Method:
  _get_parent_tpg(self)

### node_wwn

Get the node wwn.

Get Method:
  _get_node_wwn(self)

### mapped_luns

Get the list of all MappedLUN objects in this NodeACL.

Get Method:
  _list_mapped_luns(self)

### session

Gives a snapshot of the current session or `None`

Get Method:
  _get_session(self)

### chap_userid

Set or get the initiator CHAP auth userid.

Get Method:

      <functools.partial object>

Set Method:

      <functools.partial object>

### chap_password

Set or get the initiator CHAP auth password.

Get Method:

      <functools.partial object>

Set Method:

      <functools.partial object>

### chap_mutual_userid

Set or get the initiator CHAP auth userid.

Get Method:

      <functools.partial object>

Set Method:

      <functools.partial object>

### chap_mutual_password

Set or get the initiator CHAP auth password.

Get Method:

      <functools.partial object>

Set Method:

      <functools.partial object>

### authenticate_target

Get the boolean authenticate target flag.

Get Method:
  _get_authenticate_target(self)