<?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.tcm</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> <a href="rtslib-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </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 rtslib</a> :: Module tcm </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 private</a>]</span></td></tr> <tr><td align="right"><span class="options" >[<a href="frames.html" target="_top">frames</a >] | <a href="rtslib.tcm-module.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== MODULE DESCRIPTION ==================== --> <h1 class="epydoc">Module tcm</h1><p class="nomargin-top"></p> <pre class="literalblock"> Implements the RTS Target backstore and storage object classes. This file is part of RTSLib. Copyright (c) 2011-2013 by Datera, Inc Copyright (c) 2011-2014 by Red Hat, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. </pre> <!-- ==================== CLASSES ==================== --> <a name="section-Classes"></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">Classes</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-Classes" 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"> </span> </td><td class="summary"> <a href="rtslib.tcm.StorageObject-class.html" class="summary-name">StorageObject</a><br /> This is an interface to storage objects in configFS. </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="rtslib.tcm.PSCSIStorageObject-class.html" class="summary-name">PSCSIStorageObject</a><br /> An interface to configFS storage objects for pscsi backstore. </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="rtslib.tcm.RDMCPStorageObject-class.html" class="summary-name">RDMCPStorageObject</a><br /> An interface to configFS storage objects for rd_mcp backstore. </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="rtslib.tcm.FileIOStorageObject-class.html" class="summary-name">FileIOStorageObject</a><br /> An interface to configFS storage objects for fileio backstore. </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="rtslib.tcm.BlockStorageObject-class.html" class="summary-name">BlockStorageObject</a><br /> An interface to configFS storage objects for block backstore. </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="rtslib.tcm.StorageObjectFactory-class.html" class="summary-name">StorageObjectFactory</a><br /> Create a storage object based on a given path. </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="rtslib.tcm._Backstore-class.html" class="summary-name" onclick="show_private();">_Backstore</a><br /> Backstore is needed as a level in the configfs hierarchy, but otherwise useless. </td> </tr> </table> <!-- ==================== FUNCTIONS ==================== --> <a name="section-Functions"></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">Functions</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-Functions" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="_test"></a><span class="summary-sig-name">_test</span>()</span></td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr> </table> <!-- ==================== VARIABLES ==================== --> <a name="section-Variables"></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">Variables</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-Variables" 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"> </span> </td><td class="summary"> <a href="rtslib.tcm-module.html#so_mapping" class="summary-name">so_mapping</a> = <code title="{'block': <class 'rtslib.tcm.BlockStorageObject'>, 'fileio': <class 'rtslib.tcm.FileIOStorageObject'>, 'iblock': <class 'rtslib.tcm.BlockStorageObject'>, 'pscsi': <class 'rtslib.tcm.PSCSIStorageObject'>, 'ramdisk': <class 'rtslib.tcm.RDMCPStorageObject'>, 'rd_mcp': <class 'rtslib.tcm.RDMCPStorageObject'>}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">block</code><code class="variable-quote">'</code><code class="variable-op">: </code><class 'rtslib.tcm.BlockStorageObject'><code class="variable-ellipsis">...</code></code> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="rtslib.tcm-module.html#bs_params" class="summary-name">bs_params</a> = <code title="{<class 'rtslib.tcm.PSCSIStorageObject'>: {'name': 'pscsi'}, <class 'rtslib.tcm.RDMCPStorageObject'>: {'alt_dirprefix': 'rd_mcp', 'name': 'ramdisk'}, <class 'rtslib.tcm.FileIOStorageObject'>: {'name': 'fileio'}, <class 'rtslib.tcm.BlockStorageObject'>: {'alt_dirprefix': 'iblock', 'name': 'block'}}"><code class="variable-group">{</code><class 'rtslib.tcm.PSCSIStorageObject'><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">name</code><code class="variable-quote">'</code><code class="variable-op">:</code><code class="variable-ellipsis">...</code></code> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="bs_cache"></a><span class="summary-name">bs_cache</span> = <code title="{}"><code class="variable-group">{</code><code class="variable-group">}</code></code> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'rtslib'"><code class="variable-quote">'</code><code class="variable-string">rtslib</code><code class="variable-quote">'</code></code> </td> </tr> </table> <!-- ==================== VARIABLES DETAILS ==================== --> <a name="section-VariablesDetails"></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">Variables Details</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-VariablesDetails" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> </table> <a name="so_mapping"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <h3 class="epydoc">so_mapping</h3> <dl class="fields"> </dl> <dl class="fields"> <dt>Value:</dt> <dd><table><tr><td><pre class="variable"> <code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">block</code><code class="variable-quote">'</code><code class="variable-op">: </code><class 'rtslib.tcm.BlockStorageObject'><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">fileio</code><code class="variable-quote">'</code><code class="variable-op">: </code><class 'rtslib.tcm.FileIOStorageObject'><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">iblock</code><code class="variable-quote">'</code><code class="variable-op">: </code><class 'rtslib.tcm.BlockStorageObject'><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">pscsi</code><code class="variable-quote">'</code><code class="variable-op">: </code><class 'rtslib.tcm.PSCSIStorageObject'><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">ramdisk</code><code class="variable-quote">'</code><code class="variable-op">: </code><class 'rtslib.tcm.RDMCPStorageObject'><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">rd_mcp</code><code class="variable-quote">'</code><code class="variable-op">: </code><class 'rtslib.tcm.RDMCPStorageObject'><code class="variable-group">}</code> </pre></td></tr></table> </dd> </dl> </td></tr></table> </div> <a name="bs_params"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <h3 class="epydoc">bs_params</h3> <dl class="fields"> </dl> <dl class="fields"> <dt>Value:</dt> <dd><table><tr><td><pre class="variable"> <code class="variable-group">{</code><class 'rtslib.tcm.PSCSIStorageObject'><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">name</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">pscsi</code><code class="variable-quote">'</code><code class="variable-group">}</code><code class="variable-op">,</code> <class 'rtslib.tcm.RDMCPStorageObject'><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">alt_dirprefix</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">rd_mcp</code><code class="variable-quote">'</code><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">name</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">ramdisk</code><code class="variable-quote">'</code><code class="variable-group">}</code><code class="variable-op">,</code> <class 'rtslib.tcm.FileIOStorageObject'><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">name</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">fileio</code><code class="variable-quote">'</code><code class="variable-group">}</code><code class="variable-op">,</code> <class 'rtslib.tcm.BlockStorageObject'><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">alt_dirprefix</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">iblock</code><code class="variable-quote">'</code><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">name</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">block</code><code class="variable-quote">'</code><code class="variable-group">}</code><code class="variable-group">}</code> </pre></td></tr></table> </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> <a href="rtslib-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </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>