/usr/share/doc/zfcp-hbaapi-dev/html/index.html is in zfcp-hbaapi-dev 2.1.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>ZFCP HBA API Library: ZFCP HBA API Library</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ZFCP HBA API Library
 <span id="projectnumber">1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li class="current"><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">ZFCP HBA API Library </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="introduction"></a>
Introduction</h1>
<p>ZFCP HBA API Library is part of an implementation of <a class="el" href="index.html#FCHBA">FC-HBA</a> for the ZFCP device driver. The ZFCP device driver is a FCP device driver for Linux on zSeries. The whole implementation of <a class="el" href="index.html#FCHBA">FC-HBA</a> for the ZFCP device driver is called ZFCP HBA API. Its implementation consists of ZFCP HBA API Library - a shared library which provides the API defined in <a class="el" href="index.html#FCHBA">FC-HBA</a>.</p>
<h1><a class="anchor" id="compatibility"></a>
Compatibility</h1>
<p>ZFCP HBA API Library supports the API functions listed in <a class="el" href="group__SupportedHBAAPIs.html">Supported HBA API Functions</a>. All other API functions of <a class="el" href="index.html#FCHBA">FC-HBA</a> return the status HBA_STATUS_ERROR_NOT_SUPPORTED if possible and are listed in <a class="el" href="group__UnSupportedHBAAPIs.html">Not Supported HBA API Functions</a>.</p>
<h1><a class="anchor" id="restriction"></a>
Restrictions and Peculiarities</h1>
<p>For ZFCP HBA API the following restrictions and pecularities apply: </p><pre class="fragment"> - Only adapters, ports and units can be accessed that are configured in
the ZFCP device dirver. This is due to internal restrictions of
the ZFCP device driver and due to the fact that the adapter might be
shared between several VM guests.
- If SCSI command REPORT LUNS is send to a target port a unit with
FCP LUN 0xc101000000000000 is implicitly created if not yet existent.
Lifetime of that implicitly created unit is temporary. It is the
report luns "well known lun".
- The function HBA_GetFcpTargetMapping() does not return an OSDeviceName
in struct HBA_FCPTargetMapping. This is conform to @ref FCHBA since this
field is optional.
- Because the ZFCP device driver does not support Single Byte Command
Code Sets Connections, the functions HBA_GetSBTargetMapping(),
HBA_GetSBStatistics() and HBA_SBDskGetCapacity() are not supported
by ZFCP HBA API Library.
</pre><h1><a class="anchor" id="installation"></a>
Installation</h1>
<p>A source RPM and/or binary RPM "lib-zfcp-hbaapi" should be provided which will install the ZFCP HBA API Library called libzfcphbaapi.so and the corresponding header file <a class="el" href="hbaapi_8h.html" title="C header file descriping the HBA API. ">hbaapi.h</a>.</p>
<h1><a class="anchor" id="logging"></a>
Logging</h1>
<p>To log error situations in ZFCP HBA API Library two environment variables are used: </p><pre class="fragment"> - LIB_ZFCP_HBAAPI_LOG_LEVEL - specifies log level
- if not set or set to 0, logging is disabled (default)
- if set to value > 0, logging is enabled
- LIB_ZFCP_HBAAPI_LOG_FILE - specifies file where log output is
written to
- if not set, stderr is used
- if set, specified file is used for log output
</pre><h1><a class="anchor" id="bibliography"></a>
Bibliography</h1>
<h2><a class="anchor" id="FCHBA"></a>
FC-HBA</h2>
<p>The T11 Technical Committee. Information Technology - Fibre Channel HBA API (FC-HBA). Working Draft, Revision 14, 2004. URL <a href="http://www.t11.org">http://www.t11.org</a> </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
|