usr/src/man/man3lib/libstmf.3lib

   1 '\" te
   2 .\" Copyright (c) 2009, Sun Microsystems, Inc.  All rights reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH LIBSTMF 3LIB "May 8, 2009"
   7 .SH NAME
   8 libstmf \- SCSI Target Mode Framework library
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
  13 #include <libstmf.h>
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 Functions in this library provide configuration management of the SCSI Target
  20 Mode Framework (STMF), allowing clients to manage the provisioning of logical
  21 units and targets to the initiator clients of the framework.
  22 .SS "Definitions"
  23 .sp
  24 .ne 2
  25 .na
  26 \fBHost Group\fR
  27 .ad
  28 .sp .6
  29 .RS 4n
  30 A Host Group is a set of one or more initiator ports that are combined together
  31 for the purposes of applying access controls to a Logical Unit object and
  32 assigning a logical unit number to the Logical Unit. The assigned logical unit
  33 number will be reported to the members of that Host Group via the SCSI REPORT
  34 LUN command. Host Groups can contain initiator ports that are not visible to
  35 the SCSI Target Mode Framework. Initiator ports might not be a member in more
  36 than one group. A Host Group is associated with a given Logical Unit via a view
  37 entry. Host Group names are unique within the framework.
  38 .RE
  39
  40 .sp
  41 .ne 2
  42 .na
  43 \fBLogical Unit\fR
  44 .ad
  45 .sp .6
  46 .RS 4n
  47 A Logical Unit object is provided to the SCSI Target Mode Framework for the
  48 purposes of executing SCSI commands. Library clients can manage a Logical Unit
  49 object's accessibility to one or more SCSI initiator clients. \fBlibstmf\fR
  50 library clients cannot add or remove Logical Unit objects from the system.
  51 Every Logical Unit object within the SCSI Target Mode Framework is owned by a
  52 logical unit provider whose identity is available via the properties on the
  53 Logical Unit object.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fBLogical Unit Number\fR
  60 .ad
  61 .sp .6
  62 .RS 4n
  63 A Logical Unit Number is the SCSI identifier of a logical unit within a target.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fBTarget Port\fR
  70 .ad
  71 .sp .6
  72 .RS 4n
  73 A Target port object is provided to the SCSI Target Mode Framework for the
  74 purposes of receiving SCSI commands on a particular logical unit. Library
  75 clients can manage a Logical Unit object's availability to one or more Target
  76 port objects. Library clients cannot add or remove Target objects from the
  77 system. Every Target port object within the SCSI Target Mode Framework is owned
  78 by a Local Port provider whose identity is available via the properties on the
  79 Target port object.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fBTarget Port Group\fR
  86 .ad
  87 .sp .6
  88 .RS 4n
  89 A Target Port Group is a set of one or more Target ports that are combined
  90 together for the purposes of applying availability to a Logical Unit object. A
  91 Target Port Group may be applied to any given Logical Unit via a view entry.
  92 Target ports may not be a member in more than one Target Port Group. Target
  93 Port Group names are unique within the framework.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fBView\fR
 100 .ad
 101 .sp .6
 102 .RS 4n
 103 A View is a list of logical units exposed to a list of initiator ports through
 104 a list of targets.
 105 .RE
 106
 107 .sp
 108 .ne 2
 109 .na
 110 \fBView Entry\fR
 111 .ad
 112 .sp .6
 113 .RS 4n
 114 A View Entry object defines the association of an host group, a target group
 115 and a logical unit number with a specified logical unit. When a view entry is
 116 created for a logical unit, a caller can assign all targets and/or all
 117 initiator ports to the logical unit thus making the logical unit accessible to
 118 all target ports and/or all initiator ports. A logical unit may have one or
 119 more view entries associated with it. Any two view entries are considered to be
 120 in conflict when an attempt is made to duplicate the association of any given
 121 initiator port, target port and logical unit. Attempting this will result in an
 122 error returned from the call to \fBstmfAddViewEntry\fR(3STMF).
 123 .RE
 124
 125 .SH INTERFACES
 126 .sp
 127 .LP
 128 The shared object \fBlibstmf.so.1\fR provides the public interfaces defined
 129 below. See \fBIntro\fR(3) for additional information on shared object
 130 interfaces.
 131 .sp
 132
 133 .sp
 134 .TS
 135 l l
 136 l l .
 137 \fBstmfAddToHostGroup\fR        \fBstmfAddToTargetGroup\fR
 138 \fBstmfAddViewEntry\fR  \fBstmfClearProviderData\fR
 139 \fBstmfCreateHostGroup\fR       \fBstmfCreateLu\fR
 140 \fBstmfCreateLuResource\fR      \fBstmfCreateTargetGroup\fR
 141 \fBstmfDeleteHostGroup\fR       \fBstmfDeleteLu\fR
 142 \fBstmfDeleteTargetGroup\fR     \fBstmfDevidFromIscsiName\fR
 143 \fBstmfDevidFromWwn\fR  \fBstmfFreeLuResource\fR
 144 \fBstmfFreeMemory\fR    \fBstmfGetHostGroupList\fR
 145 \fBstmfGetHostGroupMembers\fR   \fBstmfGetLogicalUnitList\fR
 146 \fBstmfGetLogicalUnitProperties\fR      \fBstmfGetLuProp\fR
 147 \fBstmfGetLuResource\fR \fBstmfGetPersistMethod\fR
 148 \fBstmfGetProviderData\fR       \fBstmfGetProviderDataProt\fR
 149 \fBstmfGetState\fR      \fBstmfGetTargetGroupList\fR
 150 \fBstmfGetTargetGroupMembers\fR \fBstmfGetTargetList\fR
 151 \fBstmfGetTargetProperties\fR   \fBstmfGetViewEntryList\fR
 152 \fBstmfModifyLu\fR      \fBstmfModifyLuByFname\fR
 153 \fBstmfOfflineLogicalUnit\fR    \fBstmfOfflineTarget\fR
 154 \fBstmfOnlineLogicalUnit\fR     \fBstmfOnlineTarget\fR
 155 \fBstmfRemoveFromHostGroup\fR   \fBstmfRemoveFromTargetGroup\fR
 156 \fBstmfRemoveViewEntry\fR       \fBstmfSetLuProp\fR
 157 \fBstmfSetPersistMethod\fR      \fBstmfSetProviderData\fR
 158 \fBstmfSetProviderDataProt\fR
 159 .TE
 160
 161 .SH FILES
 162 .sp
 163 .ne 2
 164 .na
 165 \fB\fB/lib/libstmf.so.1\fR\fR
 166 .ad
 167 .RS 24n
 168 shared object
 169 .RE
 170
 171 .sp
 172 .ne 2
 173 .na
 174 \fB\fB/lib/64/libstmf.so.1\fR\fR
 175 .ad
 176 .RS 24n
 177 64-bit shared object
 178 .RE
 179
 180 .SH ATTRIBUTES
 181 .sp
 182 .LP
 183 See \fBattributes\fR(5) for descriptions of the following attributes:
 184 .sp
 185
 186 .sp
 187 .TS
 188 box;
 189 c | c
 190 l | l .
 191 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 192 _
 193 Interface Stability     Committed
 194 _
 195 MT-Level        Safe
 196 .TE
 197
 198 .SH SEE ALSO
 199 .sp
 200 .LP
 201 \fBIntro\fR(3), \fBstmfAddViewEntry\fR(3STMF), \fBattributes\fR(5)