]> CyberLeo.Net >> Repos - FreeBSD/releng/10.2.git/blob - usr.sbin/ctladm/ctladm.8
- Copy stable/10@285827 to releng/10.2 in preparation for 10.2-RC1
[FreeBSD/releng/10.2.git] / usr.sbin / ctladm / ctladm.8
1 .\"
2 .\" Copyright (c) 2003 Silicon Graphics International Corp.
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions, and the following disclaimer,
10 .\"    without modification.
11 .\" 2. Redistributions in binary form must reproduce at minimum a disclaimer
12 .\"    substantially similar to the "NO WARRANTY" disclaimer below
13 .\"    ("Disclaimer") and any redistribution must be conditioned upon
14 .\"    including a substantially similar Disclaimer requirement for further
15 .\"    binary redistribution.
16 .\"
17 .\" NO WARRANTY
18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
21 .\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 .\" HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
27 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGES.
29 .\"
30 .\" ctladm utility man page.
31 .\"
32 .\" Author: Ken Merry <ken@FreeBSD.org>
33 .\"
34 .\" $Id: //depot/users/kenm/FreeBSD-test2/usr.sbin/ctladm/ctladm.8#3 $
35 .\" $FreeBSD$
36 .\"
37 .Dd May 22, 2015
38 .Dt CTLADM 8
39 .Os
40 .Sh NAME
41 .Nm ctladm
42 .Nd CAM Target Layer control utility
43 .Sh SYNOPSIS
44 .Nm
45 .Aq Ar command
46 .Op target:lun
47 .Op generic args
48 .Op command args
49 .Nm
50 .Ic tur
51 .Aq target:lun
52 .Op general options
53 .Nm
54 .Ic inquiry
55 .Aq target:lun
56 .Op general options
57 .Nm
58 .Ic reqsense
59 .Aq target:lun
60 .Op general options
61 .Nm
62 .Ic reportluns
63 .Aq target:lun
64 .Op general options
65 .Nm
66 .Ic read
67 .Aq target:lun
68 .Op general options
69 .Aq Fl l Ar lba
70 .Aq Fl d Ar datalen
71 .Aq Fl f Ar file|-
72 .Aq Fl b Ar blocksize_bytes
73 .Op Fl c Ar cdbsize
74 .Op Fl N
75 .Nm
76 .Ic write
77 .Aq target:lun
78 .Op general options
79 .Aq Fl l Ar lba
80 .Aq Fl d Ar datalen
81 .Aq Fl f Ar file|-
82 .Aq Fl b Ar blocksize_bytes
83 .Op Fl c Ar cdbsize
84 .Op Fl N
85 .Nm
86 .Ic bbrread
87 .Aq target:lun
88 .Op general options
89 .Aq Fl -l Ar lba
90 .Aq Fl -d Ar datalen
91 .Nm
92 .Ic readcap
93 .Aq target:lun
94 .Op general options
95 .Op Fl c Ar cdbsize
96 .Nm
97 .Ic modesense
98 .Aq target:lun
99 .Aq Fl m Ar page | Fl l
100 .Op Fl P Ar pc
101 .Op Fl d
102 .Op Fl S Ar subpage
103 .Op Fl c Ar size
104 .Nm
105 .Ic start
106 .Aq target:lun
107 .Op general options
108 .Op Fl i
109 .Op Fl o
110 .Nm
111 .Ic stop
112 .Aq target:lun
113 .Op general options
114 .Op Fl i
115 .Op Fl o
116 .Nm
117 .Ic synccache
118 .Aq target:lun
119 .Op general options
120 .Op Fl l Ar lba
121 .Op Fl b Ar blockcount
122 .Op Fl r
123 .Op Fl i
124 .Op Fl c Ar cdbsize
125 .Nm
126 .Ic shutdown
127 .Op general options
128 .Nm
129 .Ic startup
130 .Op general options
131 .Nm
132 .Ic hardstop
133 .Nm
134 .Ic hardstart
135 .Nm
136 .Ic lunlist
137 .Nm
138 .Ic delay
139 .Aq target:lun
140 .Aq Fl l Ar datamove|done
141 .Aq Fl t Ar secs
142 .Op Fl T Ar oneshot|cont
143 .Nm
144 .Ic realsync Aq on|off|query
145 .Nm
146 .Ic setsync interval
147 .Aq target:lun
148 .Aq Fl i Ar interval
149 .Nm
150 .Ic getsync
151 .Aq target:lun
152 .Nm
153 .Ic inject
154 .Aq Fl i Ar action
155 .Aq Fl p Ar pattern
156 .Op Fl r Ar lba,len
157 .Op Fl s Ar len fmt Op Ar args
158 .Op Fl c
159 .Op Fl d Ar delete_id
160 .Nm
161 .Ic create
162 .Aq Fl b Ar backend
163 .Op Fl B Ar blocksize
164 .Op Fl d Ar device_id
165 .Op Fl l Ar lun_id
166 .Op Fl o Ar name=value
167 .Op Fl s Ar size_bytes
168 .Op Fl S Ar serial_num
169 .Op Fl t Ar device_type
170 .Nm
171 .Ic remove
172 .Aq Fl b Ar backend
173 .Aq Fl l Ar lun_id
174 .Op Fl o Ar name=value
175 .Nm
176 .Ic modify
177 .Aq Fl b Ar backend
178 .Aq Fl l Ar lun_id
179 .Aq Fl s Ar size_bytes
180 .Nm
181 .Ic devlist
182 .Op Fl b Ar backend
183 .Op Fl v
184 .Op Fl x
185 .Nm
186 .Ic port
187 .Op Fl l
188 .Op Fl o Ar on|off
189 .Op Fl w Ar wwpn
190 .Op Fl W Ar wwnn
191 .Op Fl p Ar targ_port
192 .Op Fl t Ar fe_type
193 .Op Fl q
194 .Op Fl x
195 .Nm
196 .Ic portlist
197 .Op Fl f Ar frontend
198 .Op Fl i
199 .Op Fl l
200 .Op Fl p Ar targ_port
201 .Op Fl q
202 .Op Fl v
203 .Op Fl x
204 .Nm
205 .Ic lunmap
206 .Aq Fl p Ar targ_port
207 .Op Fl l Ar pLUN
208 .Op Fl L Ar cLUN
209 .Nm
210 .Ic dumpooa
211 .Nm
212 .Ic dumpstructs
213 .Nm
214 .Ic islist
215 .Op Fl v
216 .Op Fl x
217 .Nm
218 .Ic islogout
219 .Aq Fl a | Fl c Ar connection-id | Fl i Ar name | Fl p Ar portal
220 .Nm
221 .Ic isterminate
222 .Aq Fl a | Fl c Ar connection-id | Fl i Ar name | Fl p Ar portal
223 .Nm
224 .Ic help
225 .Sh DESCRIPTION
226 The
227 .Nm
228 utility is designed to provide a way to access and control the CAM Target
229 Layer (CTL).
230 It provides a way to send
231 .Tn SCSI
232 commands to the CTL layer, and also provides
233 some meta-commands that utilize
234 .Tn SCSI
235 commands.
236 (For instance, the
237 .Ic lunlist
238 command is implemented using the
239 .Tn SCSI
240 REPORT LUNS and INQUIRY commands.)
241 .Pp
242 The
243 .Nm
244 utility has a number of primary functions, many of which require a device
245 identifier.
246 The device identifier takes the following form:
247 .Bl -tag -width 14n
248 .It target:lun
249 Specify the target (almost always 0) and LUN number to operate on.
250 .El
251 Many of the primary functions of the
252 .Nm
253 utility take the following optional arguments:
254 .Bl -tag -width 10n
255 .It Fl C Ar retries
256 Specify the number of times to retry a command in the event of failure.
257 .It Fl D Ar device
258 Specify the device to open.  This allows opening a device other than the
259 default device,
260 .Pa /dev/cam/ctl ,
261 to be opened for sending commands.
262 .It Fl I Ar id
263 Specify the initiator number to use.
264 By default,
265 .Nm
266 will use 7 as the initiator number.
267 .El
268 .Pp
269 Primary commands:
270 .Bl -tag -width 11n
271 .It Ic tur
272 Send the
273 .Tn SCSI
274 TEST UNIT READY command to the device and report whether or not it is
275 ready.
276 .It Ic inquiry
277 Send the
278 .Tn SCSI
279 INQUIRY command to the device and display some of the returned inquiry
280 data.
281 .It Ic reqsense
282 Send the
283 .Tn SCSI
284 REQUEST SENSE command to the device and display the returned sense
285 information.
286 .It Ic reportluns
287 Send the
288 .Tn SCSI
289 REPORT LUNS command to the device and display supported LUNs.
290 .It Ic read
291 Send a
292 .Tn SCSI
293 READ command to the device, and write the requested data to a file or
294 stdout.
295 .Bl -tag -width 12n
296 .It Fl l Ar lba
297 Specify the starting Logical Block Address for the READ.  This can be
298 specified in decimal, octal (starting with 0), hexadecimal (starting with
299 0x) or any other base supported by
300 .Xr strtoull 3 .
301 .It Fl d Ar datalen
302 Specify the length, in 512 byte blocks, of the READ request.
303 .It Fl f Ar file
304 Specify the destination for the data read by the READ command.  Either a
305 filename or
306 .Sq -
307 for stdout may be specified.
308 .It Fl c Ar cdbsize
309 Specify the minimum
310 .Tn SCSI
311 CDB (Command Data Block) size to be used for the READ request.  Allowable
312 values are 6, 10, 12 and 16.  Depending upon the LBA and amount of data
313 requested, a larger CDB size may be used to satisfy the request.  (e.g.,
314 for LBAs above 0xffffffff, READ(16) must be used to satisfy the request.)
315 .It Fl b Ar blocksize
316 Specify the blocksize of the underlying
317 .Tn SCSI
318 device, so the transfer length
319 can be calculated accurately.  The blocksize can be obtained via the
320 .Tn SCSI
321 READ CAPACITY command.
322 .It Fl N
323 Do not copy data to
324 .Nm
325 from the kernel when doing a read, just execute the command without copying
326 data.
327 This is to be used for performance testing.
328 .El
329 .It Ic write
330 Read data from a file or stdin, and write the data to the device using the
331 .Tn SCSI
332 WRITE command.
333 .Bl -tag -width 12n
334 .It Fl l Ar lba
335 Specify the starting Logical Block Address for the WRITE.  This can be
336 specified in decimal, octal (starting with 0), hexadecimal (starting with
337 0x) or any other base supported by
338 .Xr strtoull 3 .
339 .It Fl d Ar atalen
340 Specify the length, in 512 byte blocks, of the WRITE request.
341 .It Fl f Ar file
342 Specify the source for the data to be written by the WRITE command.  Either a
343 filename or
344 .Sq -
345 for stdin may be specified.
346 .It Fl c Ar cdbsize
347 Specify the minimum
348 .Tn SCSI
349 CDB (Command Data Block) size to be used for the READ request.  Allowable
350 values are 6, 10, 12 and 16.  Depending upon the LBA and amount of data
351 requested, a larger CDB size may be used to satisfy the request.  (e.g.,
352 for LBAs above 0xffffffff, READ(16) must be used to satisfy the request.)
353 .It Fl b Ar blocksize
354 Specify the blocksize of the underlying
355 .Tn SCSI
356 device, so the transfer length
357 can be calculated accurately.  The blocksize can be obtained via the
358 .Tn SCSI
359 READ CAPACITY command.
360 .It Fl N
361 Do not copy data to
362 .Nm
363 to the kernel when doing a write, just execute the command without copying
364 data.
365 This is to be used for performance testing.
366 .El
367 .It Ic bbrread
368 Issue a SCSI READ command to the logical device to potentially force a bad
369 block on a disk in the RAID set to be reconstructed from the other disks in
370 the array.  This command should only be used on an array that is in the
371 normal state.  If used on a critical array, it could cause the array to go
372 offline if the bad block to be remapped is on one of the disks that is
373 still active in the array.
374 .Pp
375 The data for this particular command will be discarded, and not returned to
376 the user.
377 .Pp
378 In order to determine which LUN to read from, the user should first
379 determine which LUN the disk with a bad block belongs to.  Then he should
380 map the bad disk block back to the logical block address for the array in
381 order to determine which LBA to pass in to the
382 .Ic bbrread
383 command.
384 .Pp
385 This command is primarily intended for testing.  In practice, bad block
386 remapping will generally be triggered by the in-kernel Disk Aerobics and
387 Disk Scrubbing code.
388 .Bl -tag -width 10n
389 .It Fl l Ar lba
390 Specify the starting Logical Block Address.
391 .It Fl d Ar datalen
392 Specify the amount of data in bytes to read from the LUN.  This must be a
393 multiple of the LUN blocksize.
394 .El
395 .It Ic readcap
396 Send the
397 .Tn SCSI
398 READ CAPACITY command to the device and display the device size and device
399 block size.  By default, READ CAPACITY(10) is
400 used.  If the device returns a maximum LBA of 0xffffffff, however,
401 .Nm
402 will automatically issue a READ CAPACITY(16), which is implemented as a
403 service action of the SERVICE ACTION IN(16) opcode.  The user can specify
404 the minimum CDB size with the
405 .Fl c
406 argument.  Valid values for the
407 .Fl c
408 option are 10 and 16.  If a 10 byte CDB is specified, the request will be
409 automatically reissued with a 16 byte CDB if the maximum LBA returned is
410 0xffffffff.
411 .It Ic modesense
412 Send a
413 .Tn SCSI
414 MODE SENSE command to the device, and display the requested mode page(s) or
415 page list.
416 .Bl -tag -width 10n
417 .It Fl m Ar page
418 Specify the mode page to display.  This option and the
419 .Fl l
420 option are mutually exclusive.  One of the two must be specified, though.
421 Mode page numbers may be specified in decimal or hexadecimal.
422 .It Fl l
423 Request that the list of mode pages supported by the device be returned.
424 This option and the
425 .Fl m
426 option are mutually exclusive.  One of the two must be specified, though.
427 .It Fl P Ar pc
428 Specify the mode page control value.  Possible values are:
429 .Bl -tag -width 2n -compact
430 .It 0
431 Current values.
432 .It 1
433 Changeable value bitmask.
434 .It 2
435 Default values.
436 .It 3
437 Saved values.
438 .El
439 .It Fl d
440 Disable block descriptors when sending the mode sense request.
441 .It Fl S Ar subpage
442 Specify the subpage used with the mode sense request.
443 .It Fl c Ar cdbsize
444 Specify the CDB size used for the mode sense request.  Supported values are
445 6 and 10.
446 .El
447 .It Ic start
448 Send the
449 .Tn SCSI
450 START STOP UNIT command to the specified LUN with the start
451 bit set.
452 .Bl -tag -width 4n
453 .It Fl i
454 Set the immediate bit in the CDB.  Note that CTL does not support the
455 immediate bit, so this is primarily useful for making sure that CTL returns
456 the proper error.
457 .It Fl o
458 Set the Copan proprietary on/offline bit in the CDB.  When this flag is
459 used, the LUN will be marked online again (see the description of the
460 .Ic shutdown
461 and
462 .Ic startup
463 commands).  When this flag is used with a
464 start command, the LUN will NOT be spun up.  You need to use a start
465 command without the
466 .Fl o
467 flag to spin up the disks in the LUN.
468 .El
469 .It Ic stop
470 Send the
471 .Tn SCSI
472 START STOP UNIT command to the specified LUN with the start
473 bit cleared.  We use an ordered tag to stop the LUN, so we can guarantee
474 that all pending I/O executes before it is stopped.  (CTL guarantees this
475 anyway, but
476 .Nm
477 sends an ordered tag for completeness.)
478 .Bl -tag -width 4n
479 .It Fl i
480 Set the immediate bit in the CDB.  Note that CTL does not support the
481 immediate bit, so this is primarily useful for making sure that CTL returns
482 the proper error.
483 .It Fl o
484 Set the Copan proprietary on/offline bit in the CDB.  When this flag is
485 used, the LUN will be spun down and taken offline ("Logical unit not ready,
486 manual intervention required").  See the description of the
487 .Ic shutdown
488 and
489 .Ic startup
490 options.
491 .El
492 .It Ic synccache
493 Send the
494 .Tn SCSI
495 SYNCHRONIZE CACHE command to the device.  By default, SYNCHRONIZE
496 CACHE(10) is used.  If the specified starting LBA is greater than
497 0xffffffff or the length is greater than 0xffff, though,
498 SYNCHRONIZE CACHE(16) will be used.  The 16 byte command will also be used
499 if the user specifies a 16 byte CDB with the
500 .Fl c
501 argument.
502 .Bl -tag -width 14n
503 .It Fl l Ar lba
504 Specify the starting LBA of the cache region to synchronize.  This option is a
505 no-op for CTL.  If you send a SYNCHRONIZE CACHE command, it will sync the
506 cache for the entire LUN.
507 .It Fl b Ar blockcount
508 Specify the length of the cache region to synchronize.  This option is a
509 no-op for CTL.  If you send a SYNCHRONIZE CACHE command, it will sync the
510 cache for the entire LUN.
511 .It Fl r
512 Specify relative addressing for the starting LBA.  CTL does not support
513 relative addressing, since it only works for linked commands, and CTL
514 does not support linked commands.
515 .It Fl i
516 Tell the target to return status immediately after issuing the SYNCHRONIZE CACHE
517 command rather than waiting for the cache to finish syncing.  CTL does not
518 support this bit.
519 .It Fl c Ar cdbsize
520 Specify the minimum CDB size.  Valid values are 10 and 16 bytes.
521 .El
522 .It Ic shutdown
523 Issue a
524 .Tn SCSI
525 START STOP UNIT command with the start bit cleared and the on/offline bit
526 set to all direct access LUNs.  This will spin down all direct access LUNs,
527 and mark them offline ("Logical unit not ready, manual intervention
528 required").  Once marked offline, the state can only be cleared by sending
529 a START STOP UNIT command with the start bit set and the on/offline bit
530 set.  The
531 .Nm
532 commands
533 .Ic startup
534 and
535 .Ic start
536 will accomplish this.  Note that the
537 on/offline bit is a non-standard Copan extension to the
538 .Tn SCSI
539 START STOP UNIT command, so merely sending a normal start command from an
540 initiator will not clear the condition.  (This is by design.)
541 .It Ic startup
542 Issue a
543 .Tn SCSI
544 START STOP UNIT command with the start bit set and the on/offline bit set
545 to all direct access LUNs.  This will mark all direct access LUNs "online"
546 again.  It will not cause any LUNs to start up.  A separate start command
547 without the on/offline bit set is necessary for that.
548 .It Ic hardstop
549 Use the kernel facility for stopping all direct access LUNs and setting the
550 offline bit.  Unlike the
551 .Ic shutdown
552 command above, this command allows shutting down LUNs with I/O active.  It
553 will also issue a LUN reset to any reserved LUNs to break the reservation
554 so that the LUN can be stopped.
555 .Ic shutdown
556 command instead.
557 .It Ic hardstart
558 This command is functionally identical to the
559 .Ic startup
560 command described above.  The primary difference is that the LUNs are
561 enumerated and commands sent by the in-kernel Front End Target Driver
562 instead of by
563 .Nm .
564 .It Ic lunlist
565 List all LUNs registered with CTL.
566 Because this command uses the ioctl port, it will only work when the FETDs
567 (Front End Target Drivers) are enabled.
568 This command is the equivalent of doing a REPORT LUNS on one LUN and then
569 an INQUIRY on each LUN in the system.
570 .It Ic delay
571 Delay commands at the given location.  There are two places where commands
572 may be delayed currently: before data is transferred
573 .Pq Dq datamove
574 and just prior to sending status to the host
575 .Pq Dq done .
576 One of the two must be supplied as an argument to the
577 .Fl l
578 option.  The
579 .Fl t
580 option must also be specified.
581 .Bl -tag -width 12n
582 .It Fl l Ar delayloc
583 Delay command(s) at the specified location.
584 This can either be at the data movement stage (datamove) or prior to
585 command completion (done).
586 .It Fl t Ar delaytime
587 Delay command(s) for the specified number of seconds.  This must be
588 specified.  If set to 0, it will clear out any previously set delay for
589 this particular location (datamove or done).
590 .It Fl T Ar delaytype
591 Specify the delay type.
592 By default, the
593 .Ic delay
594 option will delay the next command sent to the given LUN.
595 With the
596 .Fl T Ar cont
597 option, every command will be delayed by the specified period of time.
598 With the
599 .Fl T Ar oneshot
600 the next command sent to the given LUN will be delayed and all subsequent
601 commands will be completed normally.
602 This is the default.
603 .El
604 .It Ic realsync
605 Query and control CTL's SYNCHRONIZE CACHE behavior.  The
606 .Sq query
607 argument
608 will show whether SYNCHRONIZE CACHE commands are being sent to the backend
609 or not.
610 The default is to send SYNCHRONIZE CACHE commands to the backend.
611 The
612 .Sq on
613 argument will cause all SYNCHRONIZE CACHE commands sent to all LUNs to be
614 sent to the backend.
615 The
616 .Sq off
617 argument will cause all SYNCHRONIZE CACHE commands sent to all LUNs to be
618 immediately returned to the initiator with successful status.
619 .It Ic setsync
620 For a given lun, only actually service every Nth SYNCHRONIZE CACHE command
621 that is sent.  This can be used for debugging the optimal time period for
622 sending SYNCHRONIZE cache commands.  An interval of 0 means that the cache
623 will be flushed for this LUN every time a SYNCHRONIZE CACHE command is
624 received.
625 .Pp
626 You must specify the target and LUN you want to modify.
627 .It Ic getsync
628 Get the interval at which we actually service the SYNCHRONIZE CACHE
629 command, as set by the
630 .Ic setsync
631 command above.
632 The reported number means that we will actually flush the cache on every
633 Nth SYNCHRONIZE CACHE command.  A value of 0 means that we will flush the
634 cache every time.
635 .Pp
636 You must specify the target and LUN you want to query.
637 .It Ic inject
638 Inject the specified type of error for the LUN specified, when a command
639 that matches the given pattern is seen.
640 The sense data returned is in either fixed or descriptor format, depending
641 upon the status of the D_SENSE bit in the control mode page (page 0xa) for
642 the LUN.
643 .Pp
644 Errors are only injected for commands that have not already failed for
645 other reasons.
646 By default, only the first command matching the pattern specified is
647 returned with the supplied error.
648 .Pp
649 If the
650 .Fl c
651 flag is specified, all commands matching the pattern will be returned with
652 the specified error until the error injection command is deleted with
653 .Fl d
654 flag.
655 .Bl -tag -width 17n
656 .It Fl i Ar action
657 Specify the error to return:
658 .Bl -tag -width 10n
659 .It aborted
660 Return the next matching command on the specified LUN with the sense key
661 ABORTED COMMAND (0x0b), and the ASC/ASCQ 0x45,0x00 ("Select or reselect
662 failure").
663 .It mediumerr
664 Return the next matching command on the specified LUN with the sense key
665 MEDIUM ERROR (0x03) and the ASC/ASCQ 0x11,0x00 ("Unrecovered read error") for
666 reads, or ASC/ASCQ 0x0c,0x02 ("Write error - auto reallocation failed")
667 for write errors.
668 .It ua
669 Return the next matching command on the specified LUN with the sense key
670 UNIT ATTENTION (0x06) and the ASC/ASCQ 0x29,0x00 ("POWER ON, RESET, OR BUS
671 DEVICE RESET OCCURRED").
672 .It custom
673 Return the next matching command on the specified LUN with the supplied
674 sense data.
675 The
676 .Fl s
677 argument must be specified.
678 .El
679 .It Fl p Ar pattern
680 Specify which commands should be returned with the given error.
681 .Bl -tag -width 10n
682 .It read
683 The error should apply to READ(6), READ(10), READ(12), READ(16), etc.
684 .It write
685 The error should apply to WRITE(6), WRITE(10), WRITE(12), WRITE(16), WRITE
686 AND VERIFY(10), etc.
687 .It rw
688 The error should apply to both read and write type commands.
689 .It readcap
690 The error should apply to READ CAPACITY(10) and READ CAPACITY(16) commands.
691 .It tur
692 The error should apply to TEST UNIT READY commands.
693 .It any
694 The error should apply to any command.
695 .El
696 .It Fl r Ar lba,len
697 Specify the starting lba and length of the range of LBAs which should
698 trigger an error.
699 This option is only applies when read and/or write patterns are specified.
700 If used with other command types, the error will never be triggered.
701 .It Fl s Ar len fmt Op Ar args
702 Specify the sense data that is to be returned for custom actions.
703 If the format is
704 .Sq - ,
705 len bytes of sense data will be read from standard input and written to the
706 sense buffer.
707 If len is longer than 252 bytes (the maximum allowable
708 .Tn SCSI
709 sense data length), it will be truncated to that length.
710 The sense data format is described in
711 .Xr cam_cdparse 3 .
712 .It Fl c
713 The error injection should be persistent, instead of happening once.
714 Persistent errors must be deleted with the
715 .Fl d
716 argument.
717 .It Fl d Ar delete_id
718 Delete the specified error injection serial number.
719 The serial number is returned when the error is injected.
720 .El
721 .It Ic port
722 Perform one of several CTL frontend port operations.
723 Either get a list of frontend ports
724 .Pq Fl l ,
725 turn one or more frontends on
726 or off
727 .Pq Fl o Ar on|off ,
728 or set the World Wide Node Name
729 .Pq Fl w Ar wwnn
730 or World Wide Port Name
731 .Pq Fl W Ar wwpn
732 for a given port.
733 One of
734 .Fl l ,
735 .Fl o ,
736 or
737 .Fl w
738 or
739 .Fl W
740 must be specified.
741 The WWNN and WWPN may both be specified at the same time, but cannot be
742 combined with enabling/disabling or listing ports.
743 .Bl -tag -width 12n
744 .It Fl l
745 List all CTL frontend ports or a specific port type or number.
746 .It Fl o Ar on|off
747 Turn the specified CTL frontend ports off or on.
748 If no port number or port type is specified, all ports are turned on or
749 off.
750 .It Fl p Ar targ_port
751 Specify the frontend port number.
752 The port numbers can be found in the frontend port list.
753 .It Fl q
754 Omit the header in the port list output.
755 .It Fl t Ar fe_type
756 Specify the frontend type.
757 Currently defined port types are
758 .Dq fc
759 (Fibre Channel),
760 .Dq scsi
761 (Parallel SCSI),
762 .Dq ioctl
763 (CTL ioctl interface),
764 and
765 .Dq internal
766 (CTL CAM SIM).
767 .It Fl w Ar wwnn
768 Set the World Wide Node Name for the given port.
769 The
770 .Fl n
771 argument must be specified, since this is only possible to implement on a
772 single port.
773 As a general rule, the WWNN should be the same across all ports on the
774 system.
775 .It Fl W Ar wwpn
776 Set the World Wide Port Name for the given port.
777 The
778 .Fl n
779 argument must be specified, since this is only possible to implement on a
780 single port.
781 As a general rule, the WWPN must be different for every port in the system.
782 .It Fl x
783 Output the port list in XML format.
784 .El
785 .It Ic portlist
786 List CTL frontend ports.
787 .Bl -tag -width 12n
788 .It Fl f Ar frontend
789 Specify the frontend type.
790 .It Fl i
791 Report target and connected initiators addresses.
792 .It Fl l
793 Report LUN mapping.
794 .It Fl p Ar targ_port
795 Specify the frontend port number.
796 .It Fl q
797 Omit the header in the port list output.
798 .It Fl v
799 Enable verbose output (report all port options).
800 .It Fl x
801 Output the port list in XML format.
802 .El
803 .It Ic lunmap
804 Change LUN mapping for specified port.
805 If both
806 .Ar pLUN
807 and
808 .Ar cLUN
809 are specified -- LUN will be mapped.
810 If
811 .Ar pLUN
812 is specified, but
813 .Ar cLUN
814 is not -- LUN will be unmapped.
815 If neither
816 .Ar pLUN
817 nor
818 .Ar cLUN
819 are specified -- LUN mapping will be disabled, exposing all CTL LUNs.
820 .Bl -tag -width 12n
821 .It Fl p Ar targ_port
822 Specify the frontend port number.
823 .It Fl l Ar pLUN
824 LUN number visible by specified port.
825 .It Fl L Ar cLUN
826 CTL LUN number.
827 .El
828 .It Ic dumpooa
829 Dump the OOA (Order Of Arrival) queue for each LUN registered with CTL.
830 .It Ic dumpstructs
831 Dump the CTL structures to the console.
832 .It Ic create
833 Create a new LUN.
834 The backend must be specified, and depending upon the backend requested,
835 some of the other options may be required.
836 If the LUN is created successfully, the LUN configuration will be
837 displayed.
838 If LUN creation fails, a message will be displayed describing the failure.
839 .Bl -tag -width 14n
840 .It Fl b Ar backend
841 The
842 .Fl b
843 flag is required.
844 This specifies the name backend to use when creating the LUN.
845 Examples are
846 .Dq ramdisk
847 and
848 .Dq block .
849 .It Fl B Ar blocksize
850 Specify the blocksize of the backend in bytes.
851 .It Fl d Ar device_id
852 Specify the LUN-associated string to use in the
853 .Tn SCSI
854 INQUIRY VPD page 0x83 data.
855 .It Fl l Ar lun_id
856 Request that a particular LUN number be assigned.
857 If the requested LUN number is not available, the request will fail.
858 .It Fl o Ar name=value
859 Specify a backend-specific name/value pair.
860 Multiple
861 .Fl o
862 arguments may be specified.
863 Refer to the backend documentation for arguments that may be used.
864 .It Fl s Ar size_bytes
865 Specify the size of the LUN in bytes.
866 Some backends may allow setting the size (e.g. the ramdisk backend) and for
867 others the size may be implicit (e.g. the block backend).
868 .It Fl S Ar serial_num
869 Specify the serial number to be used in the
870 .Tn SCSI
871 INQUIRY VPD page 0x80 data.
872 .It Fl t Ar device_type
873 Specify the numeric SCSI device type to use when creating the LUN.
874 For example, the Direct Access type is 0.
875 If this flag is not used, the type of LUN created is backend-specific.
876 Not all LUN types are supported.
877 Currently CTL only supports Direct Access (type 0) and Processor (type 3)
878 LUNs.
879 The backend requested may or may not support all of the LUN types that CTL
880 supports.
881 .El
882 .It Ic remove
883 Remove a LUN.
884 The backend must be specified, and the LUN number must also be specified.
885 Backend-specific options may also be specified with the
886 .Fl o
887 flag.
888 .Bl -tag -width 14n
889 .It Fl b Ar backend
890 Specify the backend that owns the LUN to be removed.
891 Examples are
892 .Dq ramdisk
893 and
894 .Dq block .
895 .It Fl l Ar lun_id
896 Specify the LUN number to remove.
897 .It Fl o Ar name=value
898 Specify a backend-specific name/value pair.
899 Multiple
900 .Fl o
901 arguments may be specified.
902 Refer to the backend documentation for arguments that may be used.
903 .El
904 .It Ic modify
905 Modify a LUN size.
906 The backend, the LUN number, and the size must be specified.
907 .Bl -tag -width 14n
908 .It Fl b Ar backend
909 Specify the backend that owns the LUN to be removed.
910 Examples are
911 .Dq ramdisk
912 and
913 .Dq block .
914 .It Fl l Ar lun_id
915 Specify the LUN number to remove.
916 .It Fl s Ar size_bytes
917 Specify the size of the LUN in bytes.
918 For the
919 .Dq block
920 backend, an
921 .Dq auto
922 keyword may be passed instead; this will make CTL use the size of backing
923 file or device.
924 .El
925 .It Ic devlist
926 Get a list of all configured LUNs.
927 This also includes the LUN size and blocksize, serial number and device ID.
928 .Bl -tag -width 11n
929 .It Fl b Ar backend
930 Specify the backend.
931 This restricts the LUN list to the named backend.
932 Examples are
933 .Dq ramdisk
934 and
935 .Dq block .
936 .It Fl v
937 Be verbose.
938 This will also display any backend-specific LUN attributes in addition to
939 the standard per-LUN information.
940 .It Fl x
941 Dump the raw XML.
942 The LUN list information from the kernel comes in XML format, and this
943 option allows the display of the raw XML data.
944 This option and the
945 .Fl v
946 and
947 .Fl b
948 options are mutually exclusive.
949 If you specify
950 .Fl x ,
951 the entire LUN database is displayed in XML format.
952 .El
953 .It Ic islist
954 Get a list of currently running iSCSI connections.
955 This includes initiator and target names and the unique connection IDs.
956 .Bl -tag -width 11n
957 .It Fl v
958 Verbose mode.
959 .It Fl x
960 Dump the raw XML.
961 The connections list information from the kernel comes in XML format, and this
962 option allows the display of the raw XML data.
963 .El
964 .It Ic islogout
965 Ask the initiator to log out iSCSI connections matching criteria.
966 .Bl -tag -width 11n
967 .It Fl a
968 Log out all connections.
969 .It Fl c
970 Specify connection ID.
971 .It Fl i
972 Specify initiator name.
973 .It Fl p
974 Specify initiator portal (hostname or IP address).
975 .El
976 .It Ic isterminate
977 Forcibly terminate iSCSI connections matching criteria.
978 .Bl -tag -width 11n
979 .It Fl a
980 Terminate all connections.
981 .It Fl c
982 Specify connection ID.
983 .It Fl i
984 Specify initiator name.
985 .It Fl p
986 Specify initiator portal (hostname or IP address).
987 .El
988 .It Ic help
989 Display
990 .Nm
991 usage information.
992 .El
993 .Sh OPTIONS
994 Number of additional configuration options may be specified for LUNs.
995 Some options are global, others are backend-specific.
996 .Pp
997 Global options:
998 .Bl -tag -width 12n
999 .It Va vendor
1000 Specifies LUN vendor string up to 8 chars.
1001 .It Va product
1002 Specifies LUN product string up to 16 chars.
1003 .It Va revision
1004 Specifies LUN revision string up to 4 chars.
1005 .It Va scsiname
1006 Specifies LUN SCSI name string.
1007 .It Va eui
1008 Specifies LUN EUI-64 identifier.
1009 .It Va naa
1010 Specifies LUN NAA identifier.
1011 Either EUI or NAA identifier should be set to UNIQUE value to allow
1012 EXTENDED COPY command access the LUN.
1013 Non-unique LUN identifiers may lead to data corruption.
1014 .It Va insecure_tpc
1015 Setting to "on" allows EXTENDED COPY command sent to this LUN access
1016 other LUNs on this host, not accessible otherwise.
1017 This allows to offload copying between different iSCSI targets residing
1018 on the same host in trusted environments.
1019 .It Va readcache
1020 Set to "off", disables read caching for the LUN, if supported by the backend.
1021 .It Va readonly
1022 Set to "on", blocks all media write operations to the LUN, reporting it
1023 as write protected.
1024 .It Va reordering
1025 Set to "unrestricted", allows target to process commands with SIMPLE task
1026 attribute in arbitrary order.  Any data integrity exposures related to
1027 command sequence order shall be explicitly handled by the application
1028 client through the selection of appropriate commands and task attributes.
1029 The default value is "restricted".  It improves data integrity, but may
1030 introduce some additional delays.
1031 .It Va serseq
1032 Set to "on" to serialize conseсutive reads/writes.
1033 Set to "read" to serialize conseсutive reads.
1034 Set to "off" to allow them be issued in parallel.
1035 Parallel issue of consecutive operations may confuse logic of the
1036 backing file system, hurting performance; but it may improve performance
1037 of backing stores without prefetch/write-back.
1038 .It Va pblocksize
1039 .It Va pblockoffset
1040 Specify physical block size and offset of the device.
1041 .It Va ublocksize
1042 .It Va ublockoffset
1043 Specify UNMAP block size and offset of the device.
1044 .It Va rpm
1045 .It Va rpm
1046 Specifies medium rotation rate of the device: 0 -- not reported,
1047 1 -- non-rotating (SSD), >1024 -- value in revolutions per minute.
1048 .It Va formfactor
1049 Specifies nominal form factor of the device: 0 -- not reported, 1 -- 5.25",
1050 2 -- 3.5", 3 -- 2.5", 4 -- 1.8", 5 -- less then 1.8".
1051 .It Va unmap
1052 Set to "on", enables UNMAP support for the LUN, if supported by the backend.
1053 .It Va avail-threshold
1054 .It Va used-threshold
1055 .It Va pool-avail-threshold
1056 .It Va pool-used-threshold
1057 Set per-LUN/-pool thin provisioning soft thresholds.
1058 LUN will establish UNIT ATTENTION condition if its or pool available space
1059 get below configured avail values, or its or pool used space get above
1060 configured used values.
1061 Pool thresholds are working only for ZVOL-backed LUNs.
1062 .It Va writecache
1063 Set to "off", disables write caching for the LUN, if supported by the backend.
1064 .El
1065 .Pp
1066 Options specific for block backend:
1067 .Bl -tag -width 12n
1068 .It Va file
1069 Specifies file or device name to use for backing store.
1070 .It Va num_threads
1071 Specifies number of backend threads to use for this LUN.
1072 .El
1073 .Sh EXAMPLES
1074 .Dl ctladm tur 0:1
1075 .Pp
1076 Send a
1077 .Tn SCSI
1078 TEST UNIT READY command to LUN 1.
1079 .Pp
1080 .Dl ctladm modesense 0:1 -l
1081 .Pp
1082 Display the list of mode pages supported by LUN 1.
1083 .Pp
1084 .Dl ctladm modesense 0:0 -m 10 -P 3 -d -c 10
1085 .Pp
1086 Display the saved version of the Control mode page (page 10) on LUN 0.
1087 Disable fetching block descriptors, and use a 10 byte MODE SENSE command
1088 instead of the default 6 byte command.
1089 .Bd -literal
1090 ctladm read 0:2 -l 0 -d 1 -b 512 -f - > foo
1091 .Ed
1092 .Pp
1093 Read the first 512 byte block from LUN 2 and dump it to the file
1094 .Pa foo .
1095 .Bd -literal
1096 ctladm write 0:3 -l 0xff432140 -d 20 -b 512 -f /tmp/bar
1097 .Ed
1098 .Pp
1099 Read 10240 bytes from the file
1100 .Pa /tmp/bar
1101 and write it to target 0, LUN 3.
1102 starting at LBA 0xff432140.
1103 .Pp
1104 .Dl ctladm create -b ramdisk -s 10485760000000000
1105 .Pp
1106 Create a LUN with the
1107 .Dq fake
1108 ramdisk as a backing store.
1109 The LUN will claim to have a size of approximately 10 terabytes.
1110 .Pp
1111 .Dl ctladm create -b block -o file=src/usr.sbin/ctladm/ctladm.8
1112 .Pp
1113 Create a LUN using the block backend, and specify the file
1114 .Pa src/usr.sbin/ctladm/ctladm.8
1115 as the backing store.
1116 The size of the LUN will be derived from the size of the file.
1117 .Pp
1118 .Dl ctladm create -b block -o file=src/usr.sbin/ctladm/ctladm.8 -S MYSERIAL321 -d MYDEVID123
1119 .Pp
1120 Create a LUN using the block backend, specify the file
1121 .Pa src/usr.sbin/ctladm/ctladm.8
1122 as the backing store, and specify the
1123 .Tn SCSI
1124 VPD page 0x80 and 0x83 serial number
1125 .Fl ( S )
1126 and device ID
1127 .Fl ( d ) .
1128 .Pp
1129 .Dl ctladm remove -b block -l 12
1130 .Pp
1131 Remove LUN 12, which is handled by the block backend, from the system.
1132 .Pp
1133 .Dl ctladm devlist
1134 .Pp
1135 List configured LUNs in the system, along with their backend and serial
1136 number.
1137 This works when the Front End Target Drivers are enabled or disabled.
1138 .Pp
1139 .Dl ctladm lunlist
1140 .Pp
1141 List all LUNs in the system, along with their inquiry data and device type.
1142 This only works when the FETDs are enabled, since the commands go through the
1143 ioctl port.
1144 .Pp
1145 .Dl ctladm inject 0:6 -i mediumerr -p read -r 0,512 -c
1146 .Pp
1147 Inject a medium error on LUN 6 for every read that covers the first 512
1148 blocks of the LUN.
1149 .Bd -literal -offset indent
1150 ctladm inject 0:6 -i custom -p tur -s 18 "f0 0 02 s12 04 02"
1151 .Ed
1152 .Pp
1153 Inject a custom error on LUN 6 for the next TEST UNIT READY command only.
1154 This will result in a sense key of NOT READY (0x02), and an ASC/ASCQ of
1155 0x04,0x02 ("Logical unit not ready, initializing command required").
1156 .Sh SEE ALSO
1157 .Xr cam 3 ,
1158 .Xr cam_cdbparse 3 ,
1159 .Xr cam 4 ,
1160 .Xr ctl 4 ,
1161 .Xr xpt 4 ,
1162 .Xr camcontrol 8 ,
1163 .Xr ctld 8 ,
1164 .Xr ctlstat 8
1165 .Sh HISTORY
1166 The
1167 .Nm
1168 utility was originally written during the Winter/Spring of 2003 as an
1169 interface to CTL.
1170 .Sh AUTHORS
1171 .An Ken Merry Aq ken@FreeBSD.org