1stmfadm(1M) System Administration Commands stmfadm(1M)
2
6 stmfadm - SCSI target mode framework command line interface
7
9 stmfadm add-hg-member -g, --group-name group-name group-member...
10 stmfadm add-tg-member -g, --group-name group-name group-member...
13 stmfadm add-view [-n, --lun logical-unit-number
16 -t, --target-group group-name -h, --host-group group-name] lu-name
17 stmfadm create-hg group-name
20 stmfadm create-lu [-p, --lu-prop logical-unit-property=val
23 -s, --size size] lu-file
24 stmfadm create-tg group-name
27 stmfadm delete-hg group-name
30 stmfadm delete-lu lu-name
33 stmfadm delete-tg group-name
36 stmfadm import-lu lu-file
39 stmfadm list-hg [-v] [host-group-name...]
42 stmfadm list-tg [-v] [target-group-name...]
45 stmfadm list-lu [-v] [lu-name...]
48 stmfadm list-target [-v] [target-name...]
51 stmfadm list-view -l, --lu-name lu-name [entry-name...]
54 stmfadm list-state
57 stmfadm modify-lu [-p, --lu-prop logical-unit-property=val
60 -s, --size size, -f, --file] lu-name|lu-file
61 stmfadm online-lu lu-name
64 stmfadm offline-lu lu-name
67 stmfadm online-lu target-name
70 stmfadm offline-lu target-name
73 stmfadm remove-hg-member -g, --group-name group-name group-member...
76 stmfadm remove-tg-member -g, --group-name group-name group-member...
79 stmfadm remove-view -l, --lu-name lu-name entry-name
82
85 The stmfadm command configures logical units within the SCSI Target
86 Mode Framework (STMF) framework. The framework and this man page use
87 the following terminology:
88 initiator
90 A device responsible for issuing SCSI I/O commands to a SCSI target
92 and logical unit.
93 target
96 A device responsible for receiving SCSI I/O commands for a logical
98 unit.
99 logical unit
102 A device within a target responsible for executing SCSI I/O com‐
104 mands.
105 logical unit number
108 The identifier of a logical unit within a target.
110 initiator group
113 An initiator group is a set of one or more initiators that are com‐
115 bined for the purposes of being applied to a view (see below). An
116 initiator cannot be a member of more than one initiator group.
117 target group
120 A target group is a set of one or more SCSI target ports that are
122 treated the same when creating a view (see below). The set of logi‐
123 cal units that a particular SCSI initiator can see is determined by
124 the combined set of views.
125 Each logical unit has a set of view entries, and each view entry
127 specifies a target group, host group, and a LUN. An initiator from
128 that host group, when connecting through that target group, is able
129 to identify and connect to that logical unit using the specified
130 LUN. You can use views to restrict the set of logical units that a
131 specific initiator can see, and assign the set of LUNs that will be
132 used.
133 view
136 A view defines the association of an initiator group, a target
138 group, and a logical unit number with a specified logical unit. Any
139 view entry added to a logical unit must not be in conflict with
140 existing view entries for that logical unit. A view entry is con‐
141 sidered to be in conflict when an attempt is made to duplicate the
142 association of any given initiator, target and logical unit number.
143 As an example, logical unit LU_0 has the following view entry asso‐
144 ciated with it:
145 Logical Unit: LU_0
147 View Entry: 0
148 initiator group: HostA
149 target group: All targets
150 logical unit number: 32
151 If you attempted the following:
154 # stmf add-view -n 31 -h HostA LU_0
156 ...the operation would return an error with a message indicating
159 that the view entry is in conflict with one or more existing view
160 entries. This conflict arises because the existing view entry, 0,
161 already has mapped LU_0 to logical unit number 32 for the initiator
162 group HostA.
163
166 The stmfadm command supports the subcommands listed below.
167 add-view [-n, --lun logical-unit-number -t, --target-group group-name
169 -h, --host-group group-name] lu-name
170 Adds a logical unit view entry to a logical unit lu-name, where lu-
172 name is the STMF name for the logical unit as displayed by the
173 list-lu subcommand. The add-view subcommand provides the user with
174 a mechanism to implement access control for a logical unit and also
175 provides a means of assigning a logical unit number to a logical
176 unit for a given set of initiators and targets. A logical unit will
177 not be available to any initiators until at least one view is
178 applied. Each view entry gets assigned an entry name, which can be
179 used to reference the entry in the remove-view and list-view sub‐
180 commands.
181 add-view supports the following options:
183 -n, --lun logical-unit-number
185 logical-unit-number is an integer in the range 0-16383 to be
187 assigned to the logical unit for this view entry. If this
188 option is not specified, a logical unit number will be assigned
189 by the STMF framework.
190 -t, --target-group group-name
193 group-name is the name of a target group previously created
195 using the STMF create-tg subcommand. If this option is not
196 specified, the logical unit will be available through all tar‐
197 gets.
198 -h, -host-group group-name
201 group-name is the name of an host group previously created
203 using the STMF create-hg subcommand. If this option is not
204 specified, the logical unit will be available to all initiators
205 that log in to the STMF framework.
206 add-hg-member -g group-name group member...
210 Add a host group member to a host group. group-name must be an
212 existing group created using the create-hg subcommand. group member
213 can be specified as name_type.name_value, where name_type can be
214 one of the following:
215 wwn
217 iqn
218 eui
219 ...and name_value is the value of the initiator name. As an exam‐
222 ple, to add a fibre channel initiator port world-wide name
223 200000e08b909221 to the host group HostA, the command would be:
224 # stmfadm add-hg-member -g HostA wwn.200000e08b909221
226 To add an ISCSI initiator node member with the name
229 iqn.1986-03.com.sun:01.46f7e262 to HostA, the command would be:
230 # stmfadm add-hg-member -g HostA iqn.1986-03.com.sun:01.46f7e262
232 Alternatively, members can be specified using their SCSI name
235 string identifiers. To add the two initiators above using their
236 SCSI name string identifiers, the commands would be:
237 # stmfadm add-hg-member -g HostA eui.200000e08b909221
239 # stmfadm add-hg-member -g HostA iqn.1986-03.com.sun:01.46f7e262
240 A host group member cannot be a member of more than one host group.
243 add-tg-member -g group-name group member...
246 Add a target group member to a target group. group-name must be an
248 existing group created using the create-tg subcommand. group member
249 can be specified as name_type.name_value, where name_type can be
250 one of the following:
251 wwn
253 iqn
254 eui
255 ...and name_value is the value of the target name. As an example,
258 to add a fibre channel target port world-wide name 501000e092376af7
259 to the target group TG0, the command would be:
260 # stmfadm add-tg-member -g TG0 wwn.501000e092376af7
262 To add an ISCSI target member with the name
265 iqn.1986-03.com.sun:target.01.01110 to TG0, the command would be:
266 # stmfadm add-tg-member -g TG0 iqn.1986-03.com.sun:target.01.01110
268 Alternatively, members can be specified using their SCSI name
271 string identifiers. To add the two targets above using their SCSI
272 name string identifiers, the commands would be:
273 # stmfadm add-tg-member -g TG0 eui.501000e092376af7
275 # stmfadm add-tg-member -g TG0 iqn.1986-03.com.sun:target.01.01110
276 A target group member cannot be a member of more than one target
279 group.
280 create-hg group-name
283 Create an initiator group with the name group-name. group-name is a
285 string of Unicode characters with a maximum length of 255. The
286 group name must be unique within the STMF system.
287 create-lu [-p, --lu-prop logical-unit-property=val --s, --size size]
290 lu-file
291 Create a logical unit that can be registered with STMF. For the -p
293 option, logical-unit-property can be one of the following proper‐
294 ties:
295 alias
297 Up to 255 characters, representing a user-defined name for the
299 device. The default is the name of the backing store.
300 blk
303 Specifies the block size for the device. The default is 512.
305 guid
308 Thirty-two hexadecimal ASCII characters representing a valid
310 NAA Registered Extended Identifier. The default is set by the
311 STMF to a generated value.
312 meta
315 Metadata file name. When specified, will be used to hold the
317 SCSI metadata for the logical unit. There is no default.
318 mgmt-url
321 Up to 1024 characters representing a Management Network Address
323 URL. More than one URL can be passed as a single parameter by
324 using space-delimited URLs enclosed inside a single pair of
325 quotation marks (").
326 oui
329 Organizational Unique Identifier. Six hexadecimal ASCII charac‐
331 ters representing the IEEE OUI company ID assignment. This will
332 be used to generate the device identifier (GUID). The default
333 is 00144F.
334 pid
337 Sixteen characters of product identification SCSI SPC-3. This
339 value will be reflected in the Standard INQUIRY data returned
340 for the device. The default is COMSTAR.
341 serial
344 Serial Number. Specifies the SCSI Vital Product Data Serial
346 Number (page 80h). It is a character value up to 252 bytes in
347 length. There is no default value.
348 vid
351 Eight characters of vendor identification per SCSI SPC-3. This
353 value will be reflected in the Standard INQUIRY data returned
354 for the device. The default is SUN.
355 wcd
358 Write-back cache disable. Specify true or falseto determine
360 write-back cache disable behavior. The default is the write-
361 back cache setting of the backing store device specified by the
362 lu-file argument.
363 wp
366 Write-protect bit. Specify true or false to determine whether
368 the device reports as write-protected. The default is false.
369 For the -s option, size is an integer followed by one of the fol‐
371 lowing letters, to indicate a unit of size:
372 k kilobyte
374 m megabyte
377 g gigabyte
380 t terabyte
383 p petabyte
386 e exabyte
389 lu-file is the file to be used as the backing store for the logical
391 unit. If the -s option is not specified, the size of the specified
392 lu-file will be used as the size of the logical unit. Logical units
393 registered with the STMF require space for the metadata to be
394 stored. When a zvol is specified as the backing store device, the
395 default will be to use a special property of the zvol to contain
396 the metadata. For all other devices, the default behavior will be
397 to use the first 64k of the device. An alternative approach would
398 be to use the meta property in a create-lu command to specify an
399 alternate file to contain the metadata. It is advisable to use a
400 file that can provide sufficient storage of the logical unit meta‐
401 data, preferably 64k.
402 create-tg group-name
405 Create a target group with the name group-name. group-name is a
407 string of Unicode characters with a maximum length of 255. The
408 group name must be unique within the STMF system.
409 delete-hg group-name
412 Delete the host group that identified by group-name.
414 delete-lu lu-name
417 Deletes an existing logical unit that was created using stmfadm
419 create-lu. This effectively unloads the logical unit from the STMF
420 framework. Any existing data on the logical unit remains intact.
421 delete-tg group-name
424 Delete the target group that identified by group-name.
426 import-lu lu-file
429 Imports and loads a logical unit into the STMF that was previously
431 created using stmfadm create-lu and was then deleted from the STMF
432 using stmfadm delete-lu. On success, the logical unit is again made
433 available to the STMF. lu-file is the filename used in the stmfadm
434 create-lu command. If this logical unit is using a separate meta‐
435 data file, the filename in the meta property value that was used in
436 the stmfadm create-lu command must be used here.
437 list-hg [-v,--verbose] [host-group-name...]
440 Lists information for the host group in the system referenced by
442 host-group-name. If host-group-name is not specified, all host
443 groups in the system will be listed. If the --v or --verbose option
444 is specified, all members within a host group are displayed.
445 list-lu [-v,--verbose] [lu-name...]
448 Lists information for the logical unit in the system referenced by
450 lu-name. If lu-name is not specified, all logical units in the sys‐
451 tem will be listed. If the -v or --verbose option is specified,
452 additional information about the logical unit will be displayed.
453 list-target [-v,--verbose] [target-name...]
456 Lists information for the target port in the system referenced by
458 target-name. If target name is not specified, all target ports in
459 the system will be listed. If the -v or --verbose option is speci‐
460 fied, additional information about the target along with SCSI ses‐
461 sion information for logged-in initiators is displayed.
462 list-tg [-v,--verbose] [target-group-name...]
465 Lists information for the target group in the system referenced by
467 target-group-name. If target-group-name is not specified, all tar‐
468 get groups in the system will be listed. If the --v or --verbose
469 option is specified, all members within a target group are dis‐
470 played.
471 list-view --l, --lu-name lu-name [entry-name...]
474 Lists the view entry for the logical unit referenced by lu-name. If
476 entry-name is not specified, all view entries for the specified
477 logical unit will be listed.
478 modify-lu [-p, --lu-prop logical-unit-property=val --s, --size size,
481 -f, --file] lu-name|lu-file
482 Modifies attributes of a logical unit created using the stmfadm
484 create-lu command. For the -p option, logical-unit-property can be
485 one of the following properties:
486 alias
488 Up to 255 characters, representing a user-defined name for the
490 device. The default is the name of the backing store.
491 mgmt-url
494 Up to 1024 characters representing a Management Network Address
496 URL. More than one URL can be passed as a single parameter by
497 using space-delimited URLs enclosed inside a single pair of
498 quotation marks (").
499 wcd
502 Write-back cache disable. Specify true or falseto determine
504 write-back cache disable behavior. The default is the write-
505 back cache setting of the backing store device specified by the
506 lu-file argument.
507 wp
510 Write-protect bit. Specify true or false to determine whether
512 the device reports as write-protected. The default is false.
513 For the -s option, size is an integer followed by one of the fol‐
515 lowing letters, to indicate a unit of size:
516 k kilobyte
518 m megabyte
521 g gigabyte
524 t terabyte
527 p petabyte
530 e exabyte
533 lu-name is the guid of the logical unit to be modified. If the -f
535 option is specified, the operand is interpreted as a file name.
536 This provides the ability to modify a logical unit that is not cur‐
537 rently imported into the STMF.
538 online-lu lu-name
541 Online a logical unit currently registered with the STMF.
543 online-target target-name
546 Online the specified target.
548 offline-lu lu-name
551 Offline a logical unit currently registered with the STMF.
553 offline-target target-name
556 Online the specified target.
558 list-state
561 Lists the operational and configuration state of the STMF.
563 remove-hg-member -g group-name group member
566 Removes a host group member from a host group. group-name must be
568 an existing group created using the create-hg subcommand. group
569 member can be specified as name_type.name_value, where name_type
570 can be one of the following:
571 wwn
573 iqn
574 eui
575 ...and name_value is the value of the initiator name. As an exam‐
578 ple, to remove the fibre channel initiator port world-wide name
579 200000e08b909221 from the host group HostA, the command would be:
580 # stmfadm remove-hg-member -g HostA wwn.200000e08b909221
582 To remove the ISCSI initiator node member with the name
585 iqn.1986-03.com.sun:01.46f7e262 from HostA, the command would be:
586 # stmfadm remove-hg-member -g HostA iqn.1986-03.com.sun:01.46f7e262
588 Alternatively, members can be specified using their SCSI name
591 string identifiers. To remove the two initiators above using their
592 SCSI name string identifiers, the commands would be:
593 # stmfadm remove-hg-member -g HostA eui.200000e08b909221
595 # stmfadm remove-hg-member -g HostA iqn.1986-03.com.sun:01.46f7e262
596 remove-tg-member -g group-name group member
601 Removes a target group member from a target group. group-name must
603 be an existing group created using the create-tg subcommand. group
604 member can be specified as name_type.name_value, where name_type
605 can be one of the following:
606 wwn
608 iqn
609 eui
610 ...and name_value is the value of the target name. As an example,
613 to remove the fibre channel target port world-wide name
614 501000e092376af7 from the target group TG0, the command would be:
615 # stmfadm remove-tg-member -g TG0 wwn.501000e092376af7
617 To remove the ISCSI target member with the name
620 iqn.1986-03.com.sun:target.01.01110 from TG0, the command would be:
621 # stmfadm remove-tg-member -g TG0 iqn.1986-03.com.sun:target.01.01110
623 Alternatively, members can be specified using their SCSI name
626 string identifiers. To remove the two targets above using their
627 SCSI name string identifiers, the commands would be:
628 # stmfadm remove-tg-member -g TG0 eui.501000e092376af7
630 # stmfadm remove-tg-member -g TG0 iqn.1986-03.com.sun:target.01.01110
631 remove-view --l, --lu-name lu-name entry-name
636 Removes one or more logical unit view entries from a logical unit.
638
641 Example 1 Creating a Host group with Two Initiator Ports
642 The following commands use the create-hg and add-hg-member subcommands
645 to create a host group and add two initiator ports to that host group.
646 # stmfadm create-hg host-group-a
649 # stmfadm add-hg-member -g host-group-a wwn.210105b0000d92d0
650 Example 2 Adding a View Entry to a Logical Unit
654 The following command uses the add-view subcommand to allow access from
657 host-group-a to a logical unit.
658 # stmfadm add-view -h host-group-a 6000AE40C5000000000046FC4FEA001C
661 Example 3 Listing a View Entry
665 The following command uses the list-view subcommand to list all view
668 entries for the specified logical unit.
669 # stmfadm list-view -l 6000AE40C5000000000046FC4FEA001C
672 View Entry: 0
673 Host group : host-group-a
674 Target group : All
675 LUN : 0
676
680 See attributes(5) for descriptions of the following attributes:
681 ┌─────────────────────────────┬─────────────────────────────┐
686 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
687 ├─────────────────────────────┼─────────────────────────────┤
688 │Availability │SUNWstmfu │
689 ├─────────────────────────────┼─────────────────────────────┤
690 │Interface Stability │Committed │
691 └─────────────────────────────┴─────────────────────────────┘
692
694 sbdadm(1M), attributes(5)
695SunOS 5.11 30 Jul 2009 stmfadm(1M)