Sophie

Sophie

distrib > Mageia > 5 > x86_64 > media > core-release > by-pkgid > 1314a0a306be8f76ce5f18ecd071f564 > files > 16

python-rtslib-doc-2.1.fb49-5.mga5.noarch.rpm

<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>rtslib.fabric.FCoEFabricModule</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="rtslib-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >rtslib</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="rtslib-module.html">Package&nbsp;rtslib</a> ::
        <a href="rtslib.fabric-module.html">Module&nbsp;fabric</a> ::
        Class&nbsp;FCoEFabricModule
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="rtslib.fabric.FCoEFabricModule-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class FCoEFabricModule</h1><p class="nomargin-top"></p>
<pre class="base-tree">
   object --+        
            |        
 <a href="rtslib.node.CFSNode-class.html">node.CFSNode</a> --+    
                |    
<a href="rtslib.fabric._BaseFabricModule-class.html" onclick="show_private();">_BaseFabricModule</a> --+
                    |
                   <strong class="uidshort">FCoEFabricModule</strong>
</pre>

<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="rtslib.fabric.FCoEFabricModule-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Instantiate a FabricModule object, according to the provided name.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="rtslib.fabric.FCoEFabricModule-class.html#to_fabric_wwn" class="summary-sig-name">to_fabric_wwn</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">wwn</span>)</span><br />
      Some fabrics need WWNs in a format different than rtslib's internal 
      format.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="rtslib.fabric.FCoEFabricModule-class.html#from_fabric_wwn" class="summary-sig-name">from_fabric_wwn</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">wwn</span>)</span><br />
      Converts from WWN format used in this fabric's LIO configfs to 
      canonical format.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="rtslib.fabric._BaseFabricModule-class.html" onclick="show_private();">_BaseFabricModule</a></code></b>:
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#clear_discovery_auth_settings">clear_discovery_auth_settings</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#dump">dump</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#has_feature">has_feature</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#needs_wwn">needs_wwn</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#setup">setup</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#to_normalized_wwn">to_normalized_wwn</a></code>
      </p>
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="rtslib.fabric._BaseFabricModule-class.html" onclick="show_private();">_BaseFabricModule</a></code></b> (private):
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#_assert_feature" onclick="show_private();">_assert_feature</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#_check_self" onclick="show_private();">_check_self</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#_get_disc_attr" onclick="show_private();">_get_disc_attr</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#_get_discovery_authenticate_target" onclick="show_private();">_get_discovery_authenticate_target</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#_get_discovery_enable_auth" onclick="show_private();">_get_discovery_enable_auth</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#_get_version" onclick="show_private();">_get_version</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#_get_wwns" onclick="show_private();">_get_wwns</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#_list_targets" onclick="show_private();">_list_targets</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#_set_disc_attr" onclick="show_private();">_set_disc_attr</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#_set_discovery_enable_auth" onclick="show_private();">_set_discovery_enable_auth</a></code>
      </p></div>
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="rtslib.node.CFSNode-class.html">node.CFSNode</a></code></b>:
      <code><a href="rtslib.node.CFSNode-class.html#delete">delete</a></code>,
      <code><a href="rtslib.node.CFSNode-class.html#get_attribute">get_attribute</a></code>,
      <code><a href="rtslib.node.CFSNode-class.html#get_parameter">get_parameter</a></code>,
      <code><a href="rtslib.node.CFSNode-class.html#list_attributes">list_attributes</a></code>,
      <code><a href="rtslib.node.CFSNode-class.html#list_parameters">list_parameters</a></code>,
      <code><a href="rtslib.node.CFSNode-class.html#set_attribute">set_attribute</a></code>,
      <code><a href="rtslib.node.CFSNode-class.html#set_parameter">set_parameter</a></code>
      </p>
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="rtslib.node.CFSNode-class.html">node.CFSNode</a></code></b> (private):
      <code><a href="rtslib.node.CFSNode-class.html#_create_in_cfs_ine" onclick="show_private();">_create_in_cfs_ine</a></code>,
      <code><a href="rtslib.node.CFSNode-class.html#_exists" onclick="show_private();">_exists</a></code>,
      <code><a href="rtslib.node.CFSNode-class.html#_get_path" onclick="show_private();">_get_path</a></code>,
      <code><a href="rtslib.node.CFSNode-class.html#_list_files" onclick="show_private();">_list_files</a></code>
      </p></div>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Class Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassVariables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="rtslib.node.CFSNode-class.html">node.CFSNode</a></code></b>:
      <code><a href="rtslib.node.CFSNode-class.html#configfs_dir">configfs_dir</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="rtslib.fabric.FCoEFabricModule-class.html#wwns" class="summary-name">wwns</a><br />
      iterable of WWNs present for this fabric
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="rtslib.fabric._BaseFabricModule-class.html" onclick="show_private();">_BaseFabricModule</a></code></b>:
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#discovery_authenticate_target">discovery_authenticate_target</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#discovery_enable_auth">discovery_enable_auth</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#discovery_mutual_password">discovery_mutual_password</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#discovery_mutual_userid">discovery_mutual_userid</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#discovery_password">discovery_password</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#discovery_userid">discovery_userid</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#targets">targets</a></code>,
      <code><a href="rtslib.fabric._BaseFabricModule-class.html#version">version</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="rtslib.node.CFSNode-class.html">node.CFSNode</a></code></b>:
      <code><a href="rtslib.node.CFSNode-class.html#exists">exists</a></code>,
      <code><a href="rtslib.node.CFSNode-class.html#path">path</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <p>Instantiate a FabricModule object, according to the provided name.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>name</code></strong> - the name of the FabricModule object. It must match an existing 
          target fabric module specfile (name.spec).</li>
    </ul></dd>
    <dt>Overrides:
        object.__init__
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="to_fabric_wwn"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">to_fabric_wwn</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">wwn</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <p>Some fabrics need WWNs in a format different than rtslib's internal 
  format. These fabrics should override this method.</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="rtslib.fabric._BaseFabricModule-class.html#to_fabric_wwn">_BaseFabricModule.to_fabric_wwn</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="from_fabric_wwn"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">from_fabric_wwn</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">wwn</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <p>Converts from WWN format used in this fabric's LIO configfs to 
  canonical format. Note: Do not call from wwns(). There's no guarantee 
  fabric wwn format is the same as wherever wwns() is reading from.</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="rtslib.fabric._BaseFabricModule-class.html#from_fabric_wwn">_BaseFabricModule.from_fabric_wwn</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Property Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-PropertyDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="wwns"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">wwns</h3>
  <p>iterable of WWNs present for this fabric</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.wwns(<span class="summary-sig-arg">self</span>)</span>
    </dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="rtslib-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >rtslib</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Oct 17 15:23:48 2014
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>