1libSMHBAAPI(3LIB) Interface Libraries libSMHBAAPI(3LIB)
2
6 libSMHBAAPI, libsmhbaapi, SMHBA_GetAdapterAttributes, SMHBA_GetAdapter‐
7 PortAttributes, SMHBA_GetBindingCapability, SMHBA_GetBindingSupport,
8 SMHBA_GetDiscoveredPortAttributes, SMHBA_GetFCPhyAttributes,
9 SMHBA_GetLUNStatistics, SMHBA_GetNumberofPorts, SMHBA_GetPersistent‐
10 Binding, SMHBA_GetPhyStatistics, SMHBA_GetPortAttributesByWWN,
11 SMHBA_GetPortType, SMHBA_GetProtocolStatistics, SMHBA_GetSASPhyAt‐
12 tributes, SMHBA_GetTargetMapping, SMHBA_GetVendorLibraryAttributes,
13 SMHBA_GetVersion, SMHBA_GetWrapperLibraryAttributes, SMHBA_Register‐
14 ForAdapterAddEvents, SMHBA_RegisterForAdapterEvents, SMHBA_Register‐
15 ForAdapterPhyStatEvents, SMHBA_RegisterForAdapterPortEvents, SMHBA_Reg‐
16 isterForAdapterPortStatEvents, SMHBA_RegisterForTargetEvents,
17 SMHBA_RegisterLibrary, SMHBA_RemoveAllPersistentBindings,
18 SMHBA_RemovePersistentBinding, SMHBA_ScsiInquiry, SMHBA_ScsiReadCapac‐
19 ity, SMHBA_ScsiReportLuns, SMHBA_SendECHO, SMHBA_SendSMPPassThru,
20 SMHBA_SendTEST, SMHBA_SetBindingSupport, SMHBA_SetPersistentBinding -
21 Common Storage Management HBA information library
22
24 cc [ flag... ] file... -lSMHBAAPI [ library... ]
25 #include <smhbaapi.h>
26
29 The functions in this library access Fibre Channel and/or Sereal
30 Attached SCSI HBA data depending on vendor provided implementation
31 underneath.
32 HBA information is provided through a standard interface in a vendor
35 independent manner. This common interface provides access to the fol‐
36 lowing information:
37 o Local HBA attributes
39 o Local HBA port attributes and statistics
41 o Mapping between discovered devices and operating system SCSI
43 information
44 o Discovered devices port attributes
46 o SCSI commands for discovered devices (Report LUNS, Read
48 Capacity, and Inquiry)
49 o Storage Managment Protocol commands to discover Serial
51 Attached SCSI configuration details
52 o Common Transport commands to discover Fibre Channel Fabric
54 details
55
57 The shared object libSMHBAAPI.so.1 provides the public interfaces
58 defined below. See Intro(3) for additional information on shared object
59 interfaces.
60 HBA_CloseAdapter HBA_FreeLibrary
65 HBA_GetAdapterName HBA_GetNumberOfAdapters
66 HBA_GetRNIDMgmtInfo HBA_LoadLibrary
68 HBA_OpenAdapter HBA_RefreshAdapterConfiguration
69 HBA_RefreshInformation HBA_RegisterForLinkEvents
70 HBA_RemoveCallback HBA_SendCTPassThruV2
71 HBA_SendLIRR HBA_SendRLS
72 HBA_SendRNIDV2 HBA_SendRPL
73 HBA_SendRPS HBA_SendSRL
74 HBA_SetRNIDMgmtInfo SMHBA_GetAdapterAttributes
75 SMHBA_GetAdapterPortAttributes SMHBA_GetBindingCapability
76 SMHBA_GetBindingSupport SMHBA_GetDiscoveredPortAttributes
77 SMHBA_GetFCPhyAttributes SMHBA_GetLUNStatistics
78 SMHBA_GetNumberofPorts SMHBA_GetPersistentBinding
79 SMHBA_GetPhyStatistics SMHBA_GetPortAttributesByWWN
80 SMHBA_GetPortType SMHBA_GetProtocolStatistics
81 SMHBA_GetSASPhyAttributes SMHBA_GetTargetMapping
82 SMHBA_GetVendorLibraryAttributes SMHBA_GetVersion
83 SMHBA_GetWrapperLibraryAttributes SMHBA_RegisterForAdapterAddEvents
84 SMHBA_RegisterForAdapterEvents SMHBA_RegisterForAdapterPhyStatEvents
85 SMHBA_RegisterForAdapterPortEvents SMHBA_RegisterForAdapterPortStatEvents
86 SMHBA_RegisterForTargetEvents SMHBA_RegisterLibrary
87 SMHBA_RemoveAllPersistentBindings SMHBA_RemovePersistentBinding
88 SMHBA_ScsiInquiry SMHBA_ScsiReadCapacity
89 SMHBA_ScsiReportLuns SMHBA_SendECHO
90 SMHBA_SendSMPPassThru SMHBA_SendTEST
91 SMHBA_SetBindingSupport SMHBA_SetPersistentBinding
92
95 Client applications link with the Common Library (using -lSMHBAAPI) to
96 access the interfaces. The Common Library dynamically loads individual
97 Vendor-Specific Libraries (VSL) listed in /etc/smhba.conf and described
98 on smhba.conf(4).
99 Using the libSMHBAAPI involves the following steps:
102 1. Optionally determining the version of the library by calling
104 SMHBA_GetVersion().
105 2. Initializing the Common Library by calling HBA_LoadLi‐
107 brary().
108 3. Determine the number of HBAs known to the common library by
110 calling HBA_GetNumberOfAdapters().
111 4. Determine each HBA name in turn by calling HBA_GetAdapter‐
113 Name().
114 5. Open each HBA in turn by calling HBA_OpenAdapter().
116 6. Operate on a given HBA by calling the following:
118 o SMHBA_GetAdapterAttributes()
120 o SMHBA_GetAdapterPortAttributes()
122 o SMHBA_GetDiscoveredPortAttributes()
124 o SMHBA_GetPortAttributesByWWN()
126 o SMHBA_GetNumberofPorts()
128 o SMHBA_GetPortType()
130 o SMHBA_GetProtocolStatistics()
132 o SMHBA_GetPhyStatistics()
134 o SMHBA_GetBindingCapability()
136 o SMHBA_GetBindingSupport()
138 o SMHBA_SetBindingSupport()
140 o SMHBA_GetTargetMapping()
142 o SMHBA_GetPersistentBinding()
144 o SMHBA_SetPersistentBinding()
146 o SMHBA_RemoveAllPersistentBindings()
148 o SMHBA_GetLUNStatistics()
150 o SMHBA_SendScsiInquiry()
152 o SMHBA_SendReportLuns()
154 o SMHBA_SendReadCapacity()
156 o SMHBA_RegisterForAdapterAddEvents()
158 o SMHBA_RegisterForAdapterEvents()
160 o SMHBA_RegisterForAdapterPortEvents()
162 o SMHBA_RegisterForAdapterPortStatEvents()
164 o SMHBA_RegisterForAdapterPhyStatEvents()
166 o SMHBA_RegisterForTargetEvents()
168 o HBA_RegisterForLinkEvents()
170 o HBA_RemoveCallback()
172 For Serial Attached HBA
173 o SMHBA_GetSASPhyAttributes()
175 o SMHBA_SendSMPPassThru()
177 For Fibre Channle HBA
178 o SMHBA_GetFCPhyAttributes()
180 o HBA_SendCTPassThruV2()
182 o HBA_SetRNIDMgmtInfo()
184 o HBA_GetRNIDMgmtInfo()
186 o HBA_SendRNIDV2()
188 o HBA_SendRPL()
190 o HBA_SendRPS()
192 o HBA_SendSRL()
194 o HBA_SendLIRR()
196 o HBA_SendRLS()
198 o HBA_SendTEST()
200 o HBA_SendECHO()
202 7. Close open HBAs by calling HBA_CloseAdapter().
204 8. Unload the library by calling HBA_FreeLibrary().
206
208 See attributes(5) for descriptions of the following attributes:
209 ┌─────────────────────────────┬─────────────────────────────┐
214 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
215 ├─────────────────────────────┼─────────────────────────────┤
216 │Availability │SUNWsmhba, SUNWsmhbar │
217 ├─────────────────────────────┼─────────────────────────────┤
218 │Interface Stability │Committed │
219 ├─────────────────────────────┼─────────────────────────────┤
220 │MT-Level │MT-Safe │
221 ├─────────────────────────────┼─────────────────────────────┤
222 │Standard │ANSI INCITS 428 Storage │
223 │ │Management Host Bus Adapter │
224 │ │Application Programming │
225 │ │Interface (SM-HBA) │
226 └─────────────────────────────┴─────────────────────────────┘
227
229 smhba.conf(4), attributes(5)
230SunOS 5.11 28 Sep 2009 libSMHBAAPI(3LIB)