1libstmf(3LIB) Interface Libraries libstmf(3LIB)
2
6 libstmf - SCSI Target Mode Framework library
7
9 cc [ flag... ] file... -lstmf [ library... ]
10 #include <libstmf.h>
11
14 Functions in this library provide configuration management of the SCSI
15 Target Mode Framework (STMF), allowing clients to manage the provision‐
16 ing of logical units and targets to the initiator clients of the frame‐
17 work.
18 Definitions
20 Host Group
21 A Host Group is a set of one or more initiator ports that are com‐
23 bined together for the purposes of applying access controls to a
24 Logical Unit object and assigning a logical unit number to the Log‐
25 ical Unit. The assigned logical unit number will be reported to the
26 members of that Host Group via the SCSI REPORT LUN command. Host
27 Groups can contain initiator ports that are not visible to the SCSI
28 Target Mode Framework. Initiator ports might not be a member in
29 more than one group. A Host Group is associated with a given Logi‐
30 cal Unit via a view entry. Host Group names are unique within the
31 framework.
32 Logical Unit
35 A Logical Unit object is provided to the SCSI Target Mode Framework
37 for the purposes of executing SCSI commands. Library clients can
38 manage a Logical Unit object's accessibility to one or more SCSI
39 initiator clients. libstmf library clients cannot add or remove
40 Logical Unit objects from the system. Every Logical Unit object
41 within the SCSI Target Mode Framework is owned by a logical unit
42 provider whose identity is available via the properties on the Log‐
43 ical Unit object.
44 Logical Unit Number
47 A Logical Unit Number is the SCSI identifier of a logical unit
49 within a target.
50 Target Port
53 A Target port object is provided to the SCSI Target Mode Framework
55 for the purposes of receiving SCSI commands on a particular logical
56 unit. Library clients can manage a Logical Unit object's availabil‐
57 ity to one or more Target port objects. Library clients cannot add
58 or remove Target objects from the system. Every Target port object
59 within the SCSI Target Mode Framework is owned by a Local Port
60 provider whose identity is available via the properties on the Tar‐
61 get port object.
62 Target Port Group
65 A Target Port Group is a set of one or more Target ports that are
67 combined together for the purposes of applying availability to a
68 Logical Unit object. A Target Port Group may be applied to any
69 given Logical Unit via a view entry. Target ports may not be a mem‐
70 ber in more than one Target Port Group. Target Port Group names are
71 unique within the framework.
72 View
75 A View is a list of logical units exposed to a list of initiator
77 ports through a list of targets.
78 View Entry
81 A View Entry object defines the association of an host group, a
83 target group and a logical unit number with a specified logical
84 unit. When a view entry is created for a logical unit, a caller can
85 assign all targets and/or all initiator ports to the logical unit
86 thus making the logical unit accessible to all target ports and/or
87 all initiator ports. A logical unit may have one or more view
88 entries associated with it. Any two view entries are considered to
89 be in conflict when an attempt is made to duplicate the association
90 of any given initiator port, target port and logical unit. Attempt‐
91 ing this will result in an error returned from the call to stmfAd‐
92 dViewEntry(3STMF).
93
96 The shared object libstmf.so.1 provides the public interfaces defined
97 below. See Intro(3) for additional information on shared object inter‐
98 faces.
99 stmfAddToHostGroup stmfAddToTargetGroup
104 stmfAddViewEntry stmfClearProviderData
105 stmfCreateHostGroup stmfCreateLu
106 stmfCreateLuResource stmfCreateTargetGroup
107 stmfDeleteHostGroup stmfDeleteLu
108 stmfDeleteTargetGroup stmfDevidFromIscsiName
109 stmfDevidFromWwn stmfFreeLuResource
110 stmfFreeMemory stmfGetHostGroupList
111 stmfGetHostGroupMembers stmfGetLogicalUnitList
112 stmfGetLogicalUnitProperties stmfGetLuProp
113 stmfGetLuResource stmfGetPersistMethod
114 stmfGetProviderData stmfGetProviderDataProt
115 stmfGetState stmfGetTargetGroupList
116 stmfGetTargetGroupMembers stmfGetTargetList
117 stmfGetTargetProperties stmfGetViewEntryList
118 stmfModifyLu stmfModifyLuByFname
119 stmfOfflineLogicalUnit stmfOfflineTarget
120 stmfOnlineLogicalUnit stmfOnlineTarget
121 stmfRemoveFromHostGroup stmfRemoveFromTargetGroup
122 stmfRemoveViewEntry stmfSetLuProp
123 stmfSetPersistMethod stmfSetProviderData
124 stmfSetProviderDataProt
125
128 /lib/libstmf.so.1 shared object
129 /lib/64/libstmf.so.1 64-bit shared object
132
135 See attributes(5) for descriptions of the following attributes:
136 ┌─────────────────────────────┬─────────────────────────────┐
141 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
142 ├─────────────────────────────┼─────────────────────────────┤
143 │Availability │SUNWstmf │
144 ├─────────────────────────────┼─────────────────────────────┤
145 │Interface Stability │Committed │
146 ├─────────────────────────────┼─────────────────────────────┤
147 │MT-Level │Safe │
148 └─────────────────────────────┴─────────────────────────────┘
149
151 Intro(3), stmfAddViewEntry(3STMF), attributes(5)
152SunOS 5.11 8 May 2009 libstmf(3LIB)