2 .\" Copyright (c) 1998, 1999, 2000, 2002, 2005, 2006, 2007 Kenneth D. Merry.
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
13 .\" 3. The name of the author may not be used to endorse or promote products
14 .\" derived from this software without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .Nd CAM control program
50 .Op Fl u Ar unit_number
73 .Op Fl r Ar reporttype
105 .Aq all | bus Ns Op :target:lun
108 .Aq all | bus Ns Op :target:lun
124 .Aq Fl m Ar page[,subpage] | Fl l
132 .Aq Fl a Ar cmd Op args
133 .Aq Fl c Ar cmd Op args
136 .Op Fl i Ar len Ar fmt
138 .Op Fl o Ar len Ar fmt Op args
145 .Aq Fl r Ar len Ar fmt Op args
146 .Aq Fl R Ar len Ar fmt Op args
158 .Op Fl o Ar operation
162 .Op Fl T Ar pp_timeout
163 .Op Fl a Ar enable|disable
164 .Op Fl A Ar enable|disable
165 .Op Fl s Ar enable|disable
166 .Op Fl S Ar enable|disable
187 .Aq all|off|bus Ns Op :target Ns Op :lun
200 .Op Fl D Ar enable|disable
205 .Op Fl T Ar enable|disable
207 .Op Fl W Ar bus_width
221 .Aq Fl a Ar overwrite | block | crypto | exitfailure
271 .Op Fl l Ar high|maximum
275 .Op Fl U Ar user|master
286 .Op Fl s Ar max_sectors
293 .Aq Fl i Ar action | Fl o Ar action
299 .Op Fl R Ar rel_tgt_port
308 .Aq Fl r Ar action | Fl w Ar attrib
311 .Op Fl e Ar elem_addr
312 .Op Fl F Ar form1,form2
314 .Op Fl s Ar start_addr
315 .Op Fl T Ar elem_type
322 .Op Fl s Ar service_action
330 utility is designed to provide a way for users to access and control the
337 can cause a loss of data and/or system crashes if used improperly.
339 expert users are encouraged to exercise caution when using this command.
340 Novice users should stay away from this utility.
344 utility has a number of primary functions, many of which support an optional
346 A device identifier can take one of three forms:
349 Specify a device name and unit number combination, like "da5" or "cd3".
351 Specify a bus number and target id.
352 The bus number can be determined from
354 .Dq camcontrol devlist .
355 The lun defaults to 0.
357 Specify the bus, target and lun for a device.
361 The device identifier, if it is specified,
363 come immediately after the function name, and before any generic or
364 function-specific arguments.
369 arguments described below will override any device name or unit number
370 specified beforehand.
377 override a specified bus:target or bus:target:lun, however.
381 primary functions support these generic arguments:
384 SCSI command retry count.
385 In order for this to work, error recovery
389 Instruct the kernel to perform generic SCSI error recovery for the given
391 This is needed in order for the retry count
394 Other than retrying commands, the generic error recovery in
395 the code will generally attempt to spin up drives that are not spinning.
396 It may take some other actions, depending upon the sense code returned from
399 Specify the device type to operate on, e.g.\& "da", "cd".
401 SCSI command timeout in seconds.
402 This overrides the default timeout for
404 .It Fl u Ar unit_number
405 Specify the device unit number, e.g.\& "1", "5".
407 Be verbose, print out sense information for failed SCSI commands.
410 Primary command functions:
411 .Bl -tag -width periphlist
413 List all physical devices (logical units) attached to the CAM subsystem.
414 This also includes a list of peripheral drivers attached to each device.
417 argument, SCSI bus number, adapter name and unit numbers are printed as
419 On the other hand, with the
421 argument, only the bus adapter, and unit information will be printed, and
422 device information will be omitted.
424 List all peripheral drivers attached to a given physical device (logical
427 Send the SCSI test unit ready (0x00) command to the given device.
430 utility will report whether the device is ready or not.
432 Send a SCSI inquiry command (0x12) to a device.
435 will print out the standard inquiry data, device serial number, and
436 transfer rate information.
437 The user can specify that only certain types of
438 inquiry data be printed:
441 Get the standard inquiry data.
443 Print out the serial number.
444 If this flag is the only one specified,
446 will not print out "Serial Number" before the value returned by the drive.
447 This is to aid in script writing.
449 Print out transfer rate information.
452 Send a ATA identify command (0xec) to a device.
454 Send the SCSI REPORT LUNS (0xA0) command to the given device.
457 will print out the list of logical units (LUNs) supported by the target device.
458 There are a couple of options to modify the output:
461 Just print out a count of LUNs, not the actual LUN numbers.
463 Just print out the LUNs, and do not print out the count.
464 .It Fl r Ar reporttype
465 Specify the type of report to request from the target:
466 .Bl -tag -width 012345678
468 Return the default report.
472 Most targets will support this report if they support the REPORT LUNS
475 Return only well known LUNs.
477 Return all available LUNs.
482 will try to print out LUN numbers in a reasonable format.
483 It can understand the peripheral, flat, LUN and extended LUN formats.
485 Send the SCSI READ CAPACITY command to the given device and display
487 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
488 action will be sent to obtain the full size of the device.
491 will print out the last logical block of the device, and the blocksize of
493 To modify the output format, use the following options:
496 Just print out the blocksize, not the last block or device size.
497 This cannot be used with
502 Print out the device size in human readable (base 2, 1K == 1024) format.
505 and cannot be used with
510 Print out the device size in human readable (base 10, 1K == 1000) format.
512 Print out the number of blocks in the device instead of the last logical
515 Quiet, print out the numbers only (separated by a comma if
521 Print out the last logical block or the size of the device only, and omit
525 Note that this command only displays the information, it does not update
526 the kernel data structures.
529 reprobe subcommand to do that.
531 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
534 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
537 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
538 start bit set and the load/eject bit set.
540 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
541 start bit cleared and the load/eject bit set.
543 Tell the kernel to scan all busses in the system (with the
545 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
546 (XPT_SCAN_LUN) for new devices or devices that have gone away.
548 may specify a scan of all busses, a single bus, or a lun.
550 on a target is not supported.
552 Tell the kernel to refresh the information about the device and
553 notify the upper layer,
555 This includes sending the SCSI READ CAPACITY command and updating
556 the disk size visible to the rest of the system.
558 Tell the kernel to reset all busses in the system (with the
560 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
561 reset for that bus, or to reset the given bus:target:lun
562 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
563 connecting to that device.
564 Note that this can have a destructive impact
569 READ DEFECT DATA (10) command (0x37) or the
571 READ DEFECT DATA (12) command (0xB7) to the given device, and
572 print out any combination of: the total number of defects, the primary
573 defect list (PLIST), and the grown defect list (GLIST).
576 Specify the requested format of the defect list.
577 The format argument is
579 Most drives support the physical sector format.
581 support the logical block format.
582 Many drives, if they do not support the
583 requested format, return the data in an alternate format, along with sense
584 information indicating that the requested data format is not supported.
588 attempts to detect this, and print out whatever format the drive returns.
589 If the drive uses a non-standard sense code to report that it does not
590 support the requested format,
592 will probably see the error as a failure to complete the request.
594 The format options are:
597 Print out the list as logical blocks.
598 This is limited to 32-bit block sizes, and isn't supported by many modern
601 Print out the list as logical blocks.
602 This option uses a 64-bit block size.
604 Print out the list in bytes from index format.
606 Print out the list in extended bytes from index format.
607 The extended format allows for ranges of blocks to be printed.
609 Print out the list in physical sector format.
610 Most drives support this format.
612 Print out the list in extended physical sector format.
613 The extended format allows for ranges of blocks to be printed.
617 Print out the grown defect list.
618 This is a list of bad blocks that have
619 been remapped since the disk left the factory.
621 Print out the primary defect list.
622 This is the list of defects that were present in the factory.
624 When printing status information with
626 only print the number of defects.
628 Just print the number of defects, not the list of defects.
630 Specify the starting offset into the defect list.
631 This implies using the
633 READ DEFECT DATA (12) command, as the 10 byte version of the command
634 doesn't support the address descriptor index field.
635 Not all drives support the 12 byte command, and some drives that support
636 the 12 byte command don't support the address descriptor index field.
638 Print out defects in hexadecimal (base 16) form instead of base 10 form.
647 will print out the number of defects given in the READ DEFECT DATA header
648 returned from the drive.
649 Some drives will report 0 defects if neither the primary or grown defect
652 Allows the user to display and optionally edit a SCSI mode page.
654 page formats are located in
655 .Pa /usr/share/misc/scsi_modes .
656 This can be overridden by specifying a different file in the
658 environment variable.
661 command takes several arguments:
664 Disable block descriptors for mode sense.
666 Displays mode page data in binary format.
668 This flag allows the user to edit values in the mode page.
670 either edit mode page values with the text editor pointed to by his
672 environment variable, or supply mode page values via standard input, using
675 uses to display mode page values.
676 The editor will be invoked if
678 detects that standard input is terminal.
680 Lists all available mode pages.
681 If specified more then once, also lists subpages.
682 .It Fl m Ar page[,subpage]
683 This specifies the number of the mode page and optionally subpage the user
684 would like to view and/or edit.
685 This argument is mandatory unless
689 This allows the user to specify the page control field.
691 .Bl -tag -width xxx -compact
703 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
706 function requires the
708 argument to specify SCSI CDB or the
710 argument to specify ATA Command Block registers values.
711 Other arguments are optional, depending on
713 The command and data specification syntax is documented
716 NOTE: If the CDB specified causes data to be transferred to or from the
717 SCSI device in question, you MUST specify either
722 .It Fl a Ar cmd Op args
723 This specifies the content of 12 ATA Command Block registers (command,
724 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
725 lba_high_exp, features_exp, sector_count, sector_count_exp).
726 .It Fl c Ar cmd Op args
727 This specifies the SCSI CDB.
728 SCSI CDBs may be 6, 10, 12 or 16 bytes.
730 Specifies DMA protocol to be used for ATA command.
732 Specifies FPDMA (NCQ) protocol to be used for ATA command.
733 .It Fl i Ar len Ar fmt
734 This specifies the amount of data to read, and how it should be displayed.
738 bytes of data will be read from the device and written to standard output.
739 .It Fl o Ar len Ar fmt Op args
740 This specifies the amount of data to be written to a device, and the data
741 that is to be written.
745 bytes of data will be read from standard input and written to the device.
747 This specifies that 11 result ATA Command Block registers should be displayed
748 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
749 lba_high_exp, sector_count, sector_count_exp), and how.
752 11 result registers will be written to standard output in hex.
755 Allows the user to send an arbitrary Serial
756 Management Protocol (SMP) command to a device.
759 function requires the
761 argument to specify the SMP request to be sent, and the
763 argument to specify the format of the SMP response.
764 The syntax for the SMP request and response arguments is documented in
767 Note that SAS adapters that support SMP passthrough (at least the currently
768 known adapters) do not accept CRC bytes from the user in the request and do
769 not pass CRC bytes back to the user in the response.
770 Therefore users should not include the CRC bytes in the length of the
771 request and not expect CRC bytes to be returned in the response.
773 .It Fl r Ar len Ar fmt Op args
774 This specifies the size of the SMP request, without the CRC bytes, and the
779 bytes of data will be read from standard input and written as the SMP
781 .It Fl R Ar len Ar fmt Op args
782 This specifies the size of the buffer allocated for the SMP response, and
783 the SMP response format.
787 bytes of data will be allocated for the response and the response will be
788 written to standard output.
791 Allows the user to send the Serial Management Protocol (SMP) Report General
794 will display the data returned by the Report General command.
795 If the SMP target supports the long response format, the additional data
796 will be requested and displayed automatically.
799 Request the long response format only.
800 Not all SMP targets support the long response format.
803 to skip sending the initial report general request without the long bit set
804 and only issue a report general request with the long bit set.
807 Allows the user to issue the Serial Management Protocol (SMP) PHY Control
809 This function should be used with some caution, as it can render devices
810 inaccessible, and could potentially cause data corruption as well.
813 argument is required to specify the PHY to operate on.
816 Specify the PHY to operate on.
817 This argument is required.
819 Request the long request/response format.
820 Not all SMP targets support the long response format.
821 For the PHY Control command, this currently only affects whether the
822 request length is set to a value other than 0.
823 .It Fl o Ar operation
824 Specify a PHY control operation.
827 operation may be specified.
828 The operation may be specified numerically (in decimal, hexadecimal, or octal)
829 or one of the following operation names may be specified:
833 It is not necessary to specify this argument.
835 Send the LINK RESET command to the phy.
837 Send the HARD RESET command to the phy.
839 Send the DISABLE command to the phy.
840 Note that the LINK RESET or HARD RESET commands should re-enable the phy.
842 Send the CLEAR ERROR LOG command.
843 This clears the error log counters for the specified phy.
845 Send the CLEAR AFFILIATION command.
846 This clears the affiliation from the STP initiator port with the same SAS
847 address as the SMP initiator that requests the clear operation.
849 Send the TRANSMIT SATA PORT SELECTION SIGNAL command to the phy.
850 This will cause a SATA port selector to use the given phy as its active phy
851 and make the other phy inactive.
853 Send the CLEAR STP I_T NEXUS LOSS command to the PHY.
855 Send the SET ATTACHED DEVICE NAME command to the PHY.
858 argument to specify the device name.
861 Specify the attached device name.
862 This option is needed with the
865 The name is a 64-bit number, and can be specified in decimal, hexadecimal
868 Set the minimum physical link rate for the phy.
869 This is a numeric argument.
870 Currently known link rates are:
873 Do not change current value.
882 Other values may be specified for newer physical link rates.
884 Set the maximum physical link rate for the phy.
885 This is a numeric argument.
888 argument description for known link rate arguments.
889 .It Fl T Ar pp_timeout
890 Set the partial pathway timeout value, in microseconds.
895 specification for more information on this field.
896 .It Fl a Ar enable|disable
897 Enable or disable SATA slumber phy power conditions.
898 .It Fl A Ar enable|disable
899 Enable or disable SATA partial power conditions.
900 .It Fl s Ar enable|disable
901 Enable or disable SAS slumber phy power conditions.
902 .It Fl S Ar enable|disable
903 Enable or disable SAS partial phy power conditions.
906 List phys attached to a SAS expander, the address of the end device
907 attached to the phy, and the inquiry data for that device and peripheral
908 devices attached to that device.
909 The inquiry data and peripheral devices are displayed if available.
912 Turn on the long response format for the underlying SMP commands used for
915 Only print out phys that are attached to a device in the CAM EDT (Existing
919 Send the SMP Report Manufacturer Information command to the device and
920 display the response.
923 Turn on the long response format for the underlying SMP commands used for
927 Turn on CAM debugging printfs in the kernel.
928 This requires options CAMDEBUG
929 in your kernel config file.
930 WARNING: enabling debugging printfs currently
931 causes an EXTREME number of kernel printfs.
932 You may have difficulty
933 turning off the debugging printfs once they start, since the kernel will be
934 busy printing messages and unable to service other requests quickly.
937 function takes a number of arguments:
940 Enable CAM_DEBUG_INFO printfs.
942 Enable CAM_DEBUG_PERIPH printfs.
944 Enable CAM_DEBUG_TRACE printfs.
946 Enable CAM_DEBUG_SUBTRACE printfs.
948 Enable CAM_DEBUG_XPT printfs.
950 Enable CAM_DEBUG_CDB printfs.
951 This will cause the kernel to print out the
952 SCSI CDBs sent to the specified device(s).
954 Enable CAM_DEBUG_PROBE printfs.
956 Enable debugging for all devices.
958 Turn off debugging for all devices
959 .It bus Ns Op :target Ns Op :lun
960 Turn on debugging for the given bus, target or lun.
962 and lun are not specified, they are wildcarded.
963 (i.e., just specifying a
964 bus turns on debugging printfs for all devices on that bus.)
967 Show or set the number of "tagged openings" or simultaneous transactions
968 we attempt to queue to a particular device.
971 command, with no command-specific arguments (i.e., only generic arguments)
972 prints out the "soft" maximum number of transactions that can be queued to
973 the device in question.
974 For more detailed information, use the
976 argument described below.
979 Set the number of tags for the given device.
980 This must be between the
981 minimum and maximum number set in the kernel quirk table.
983 most devices that support tagged queueing is a minimum of 2 and a maximum
985 The minimum and maximum values for a given device may be
986 determined by using the
993 subcommand is described below.
995 Be quiet, and do not report the number of tags.
996 This is generally used when
997 setting the number of tags.
999 The verbose flag has special functionality for the
1004 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
1007 This is the amount of capacity for transactions queued to a given device.
1009 This is the number of transactions currently queued to a device.
1011 This is the kernel queue space for transactions.
1012 This count usually mirrors
1013 dev_openings except during error recovery operations when
1014 the device queue is frozen (device is not allowed to receive
1015 commands), the number of dev_openings is reduced, or transaction
1016 replay is occurring.
1018 This is the number of transactions waiting in the kernel queue for capacity
1020 This number is usually zero unless error recovery is in
1023 The held count is the number of CCBs held by peripheral drivers that have
1024 either just been completed or are about to be released to the transport
1025 layer for service by a device.
1026 Held CCBs reserve capacity on a given
1029 This is the current "hard" minimum number of transactions that can be
1030 queued to a device at once.
1033 value above cannot go below this number.
1034 The default value for
1036 is 2, although it may be set higher or lower for various devices.
1038 This is the "hard" maximum number of transactions that can be queued to a
1042 value cannot go above this number.
1043 The default value for
1045 is 255, although it may be set higher or lower for various devices.
1049 Show or negotiate various communication parameters.
1050 Some controllers may
1051 not support setting or changing some of these values.
1053 Adaptec 174x controllers do not support changing a device's sync rate or
1058 will not attempt to set the parameter if the controller indicates that it
1059 does not support setting the parameter.
1060 To find out what the controller
1068 command is described below.
1069 Also, some controller drivers do not support
1070 setting negotiation parameters, even if the underlying controller supports
1071 negotiation changes.
1072 Some controllers, such as the Advansys wide
1073 controllers, support enabling and disabling synchronous negotiation for
1074 a device, but do not support setting the synchronous negotiation rate.
1077 Attempt to make the negotiation settings take effect immediately by sending
1078 a Test Unit Ready command to the device.
1080 Show or set current negotiation settings.
1081 This is the default.
1082 .It Fl D Ar enable|disable
1083 Enable or disable disconnection.
1087 Set the command delay offset.
1089 Be quiet, do not print anything.
1090 This is generally useful when you want to
1091 set a parameter, but do not want any status information.
1092 .It Fl R Ar syncrate
1093 Change the synchronization rate for a device.
1094 The sync rate is a floating
1095 point value specified in MHz.
1098 is a legal value, as is
1100 .It Fl T Ar enable|disable
1101 Enable or disable tagged queueing for a device.
1103 Show or set user negotiation settings.
1104 The default is to show or set
1105 current negotiation settings.
1107 The verbose switch has special meaning for the
1112 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
1114 .It Fl W Ar bus_width
1115 Specify the bus width to negotiate with a device.
1118 The only useful values to specify are 8, 16, and 32
1120 The controller must support the bus width in question in order for
1121 the setting to take effect.
1124 In general, sync rate and offset settings will not take effect for a
1125 device until a command has been sent to the device.
1128 switch above will automatically send a Test Unit Ready to the device so
1129 negotiation parameters will take effect.
1133 FORMAT UNIT command to the named device.
1135 .Em WARNING! WARNING! WARNING!
1137 Low level formatting a disk will destroy ALL data on the disk.
1139 extreme caution when issuing this command.
1140 Many users low-level format
1141 disks that do not really need to be low-level formatted.
1143 relatively few scenarios that call for low-level formatting a disk.
1145 low-level formatting a disk is to initialize the disk after changing
1146 its physical sector size.
1147 Another reason for low-level formatting a disk
1148 is to revive the disk if you are getting "medium format corrupted" errors
1149 from the disk in response to read and write requests.
1151 Some disks take longer than others to format.
1152 Users should specify a
1153 timeout long enough to allow the format to complete.
1155 timeout is 3 hours, which should be long enough for most disks.
1157 disks will complete a format operation in a very short period of time
1158 (on the order of 5 minutes or less).
1159 This is often because the drive
1160 does not really support the FORMAT UNIT command -- it just accepts the
1161 command, waits a few minutes and then returns it.
1165 subcommand takes several arguments that modify its default behavior.
1170 arguments can be useful for scripts.
1173 Be quiet, do not print any status messages.
1174 This option will not disable
1175 the questions, however.
1176 To disable questions, use the
1183 This will report status on a format that is already running on the drive.
1185 Issue a non-immediate format command.
1188 issues the FORMAT UNIT command with the immediate bit set.
1190 device to immediately return the format command, before the format has
1196 sense information from the device every second to determine how far along
1197 in the format process it is.
1200 argument is specified,
1202 will issue a non-immediate format command, and will be unable to print any
1203 information to let the user know what percentage of the disk has been
1206 Do not ask any questions.
1209 will ask the user if he/she really wants to format the disk in question,
1210 and also if the default format command timeout is acceptable.
1212 will not be asked about the timeout if a timeout is specified on the
1218 SANITIZE command to the named device.
1220 .Em WARNING! WARNING! WARNING!
1222 ALL data in the cache and on the disk will be destroyed or made inaccessible.
1223 Recovery of the data is not possible.
1224 Use extreme caution when issuing this command.
1228 subcommand takes several arguments that modify its default behavior.
1233 arguments can be useful for scripts.
1235 .It Fl a Ar operation
1236 Specify the sanitize operation to perform.
1239 Perform an overwrite operation by writing a user supplied
1240 data pattern to the device one or more times.
1241 The pattern is given by the
1244 The number of times is given by the
1248 Perform a block erase operation.
1249 All the device's blocks are set to a vendor defined
1250 value, typically zero.
1252 Perform a cryptographic erase operation.
1253 The encryption keys are changed to prevent the decryption
1256 Exits a previously failed sanitize operation.
1257 A failed sanitize operation can only be exited if it was
1258 run in the unrestricted completion mode, as provided by the
1263 The number of passes when performing an
1266 Valid values are between 1 and 31.
1271 operation, the pattern is inverted between consecutive passes.
1273 Path to the file containing the pattern to use when
1277 The pattern is repeated as needed to fill each block.
1279 Be quiet, do not print any status messages.
1280 This option will not disable
1281 the questions, however.
1282 To disable questions, use the
1286 Perform the sanitize in the unrestricted completion mode.
1287 If the operation fails, it can later be exited with the
1294 This will report status on a sanitize that is already running on the drive.
1296 Issue a non-immediate sanitize command.
1299 issues the SANITIZE command with the immediate bit set.
1301 device to immediately return the sanitize command, before
1302 the sanitize has actually completed.
1307 sense information from the device every second to determine how far along
1308 in the sanitize process it is.
1311 argument is specified,
1313 will issue a non-immediate sanitize command, and will be unable to print any
1314 information to let the user know what percentage of the disk has been
1317 Do not ask any questions.
1320 will ask the user if he/she really wants to sanitize the disk in question,
1321 and also if the default sanitize command timeout is acceptable.
1323 will not be asked about the timeout if a timeout is specified on the
1327 Put ATA device into IDLE state.
1330 specifies automatic standby timer value in seconds.
1331 Value 0 disables timer.
1333 Put ATA device into STANDBY state.
1336 specifies automatic standby timer value in seconds.
1337 Value 0 disables timer.
1339 Put ATA device into SLEEP state.
1340 Note that the only way get device out of
1341 this state may be reset.
1343 It optional parameter
1345 specified, enables and sets advanced power management level, where
1346 1 -- minimum power, 127 -- maximum performance with standby,
1347 128 -- minimum power without standby, 254 -- maximum performance.
1348 If not specified -- APM is disabled.
1350 It optional parameter
1352 specified, enables and sets automatic acoustic management level, where
1353 1 -- minimum noise, 254 -- maximum performance.
1354 If not specified -- AAM is disabled.
1356 Update or report security settings, using an ATA identify command (0xec).
1359 will print out the security support and associated settings of the device.
1362 command takes several arguments:
1366 Disable device security using the given password for the selected user according
1367 to the devices configured security level.
1370 Erase the device using the given password for the selected user.
1372 .Em WARNING! WARNING! WARNING!
1374 Issuing a secure erase will
1376 user data on the device and may take several hours to complete.
1378 When this command is used against an SSD drive all its cells will be marked as
1379 empty, restoring it to factory default write performance.
1380 For SSD's this action
1381 usually takes just a few seconds.
1384 Freeze the security configuration of the specified device.
1386 After command completion any other commands that update the device lock mode
1387 shall be command aborted.
1388 Frozen mode is disabled by power-off or hardware reset.
1391 Enhanced erase the device using the given password for the selected user.
1393 .Em WARNING! WARNING! WARNING!
1395 Issuing an enhanced secure erase will
1397 user data on the device and may take several hours to complete.
1399 An enhanced erase writes predetermined data patterns to all user data areas,
1400 all previously written user data shall be overwritten, including sectors that
1401 are no longer in use due to reallocation.
1404 Unlock the device using the given password for the selected user according to
1405 the devices configured security level.
1406 .It Fl l Ar high|maximum
1408 Specifies which security level to set when issuing a
1411 The security level determines device behavior when the master
1412 password is used to unlock the device.
1413 When the security level is set to high
1414 the device requires the unlock command and the master password to unlock.
1415 When the security level is set to maximum the device requires a secure erase
1416 with the master password to unlock.
1418 This option must be used in conjunction with one of the security action commands.
1424 Be quiet, do not print any status messages.
1425 This option will not disable the questions, however.
1426 To disable questions, use the
1431 Password the device (enable security) using the given password for the selected
1433 This option can be combined with other options such as
1436 A master password may be set in a addition to the user password. The purpose of
1437 the master password is to allow an administrator to establish a password that
1438 is kept secret from the user, and which may be used to unlock the device if the
1439 user password is lost.
1442 Setting the master password does not enable device security.
1444 If the master password is set and the drive supports a Master Revision Code
1445 feature the Master Password Revision Code will be decremented.
1448 Overrides the default timeout, specified in seconds, used for both
1452 this is useful if your system has problems processing long timeouts correctly.
1454 Usually the timeout is calculated from the information stored on the drive if
1455 present, otherwise it defaults to 2 hours.
1456 .It Fl U Ar user|master
1458 Specifies which user to set / use for the running action command, valid values
1459 are user or master and defaults to master if not set.
1461 This option must be used in conjunction with one of the security action commands.
1467 Confirm yes to dangerous options such as
1469 without prompting for confirmation.
1472 If the password specified for any action commands does not match the configured
1473 password for the specified user the command will fail.
1475 The password in all cases is limited to 32 characters, longer passwords will
1478 Update or report Host Protected Area details.
1481 will print out the HPA support and associated settings of the device.
1484 command takes several optional arguments:
1488 Freeze the HPA configuration of the specified device.
1490 After command completion any other commands that update the HPA configuration
1491 shall be command aborted.
1492 Frozen mode is disabled by power-off or hardware reset.
1495 Lock the HPA configuration of the device until a successful call to unlock or
1496 the next power-on reset occurs.
1499 Make the HPA max sectors persist across power-on reset or a hardware reset.
1500 This must be used in combination with
1501 .Fl s Ar max_sectors
1505 Set the HPA configuration password required for unlock calls.
1508 Be quiet, do not print any status messages.
1509 This option will not disable the questions.
1510 To disable questions, use the
1513 .It Fl s Ar max_sectors
1515 Configures the maximum user accessible sectors of the device.
1516 This will change the number of sectors the device reports.
1518 .Em WARNING! WARNING! WARNING!
1520 Changing the max sectors of a device using this option will make the data on
1521 the device beyond the specified value inaccessible.
1524 .Fl s Ar max_sectors
1525 call can be made without a power-on reset or a hardware reset of the device.
1528 Unlock the HPA configuration of the specified device using the given password.
1529 If the password specified does not match the password configured via
1531 the command will fail.
1533 After 5 failed unlock calls, due to password miss-match, the device will refuse
1534 additional unlock calls until after a power-on reset.
1537 Confirm yes to dangerous options such as
1539 without prompting for confirmation
1542 The password for all HPA commands is limited to 32 characters, longer passwords
1545 Program firmware of the named
1547 or ATA device using the image file provided.
1551 device and it provides a recommended timeout for the WRITE BUFFER command
1554 opcodes subcommand), that timeout will be used for the firmware download.
1555 The drive-recommended timeout value may be overridden on the command line
1560 Current list of supported vendors for SCSI/SAS drives:
1563 Tested with 4TB SAS drives, model number HUS724040ALS640.
1567 Tested with LTO-5 (ULTRIUM-HH5) and LTO-6 (ULTRIUM-HH6) tape drives.
1568 There is a separate table entry for hard drives, because the update method
1569 for hard drives is different than the method for tape drives.
1574 Tested with SM1625 SSDs.
1576 Tested with Constellation ES (ST32000444SS), ES.2 (ST33000651SS) and
1577 ES.3 (ST1000NM0023) drives.
1579 Tested with 400GB Optimus SSDs (TXA2D20400GA6001).
1582 .Em WARNING! WARNING! WARNING!
1584 Little testing has been done to make sure that different device models from
1585 each vendor work correctly with the fwdownload command.
1586 A vendor name appearing in the supported list means only that firmware of at
1587 least one device type from that vendor has successfully been programmed with
1588 the fwdownload command.
1589 Extra caution should be taken when using this command since there is no
1590 guarantee it will not break a device from the listed vendors.
1591 Ensure that you have a recent backup of the data on the device before
1592 performing a firmware update.
1596 protocol devices will not be programmed, since there is little chance of
1597 the firmware download succeeding.
1600 will currently attempt a firmware download to any
1604 device, since the standard
1606 DOWNLOAD MICROCODE command may work.
1607 Firmware downloads to
1611 devices are supported for devices connected
1616 controllers, and devices connected to SAS controllers
1621 translation capability.
1627 PASS-THROUGH command to send the
1629 DOWNLOAD MICROCODE command to the drive.
1634 translation implementations don't work fully when translating
1636 WRITE BUFFER commands to
1638 DOWNLOAD MICROCODE commands, but do support
1640 passthrough well enough to do a firmware download.
1642 .It Fl f Ar fw_image
1643 Path to the firmware image file to be downloaded to the specified device.
1645 Do not print informational messages, only print errors.
1646 This option should be used with the
1648 option to suppress all output.
1650 Run in simulation mode.
1651 Device checks are run and the confirmation dialog is shown, but no firmware
1652 download will occur.
1658 errors in the event of a failure.
1660 In simulation mode, print out the
1665 register values that would be used for the firmware download command.
1667 Do not ask for confirmation.
1670 Persistent reservation support.
1671 Persistent reservations are a way to reserve a particular
1673 LUN for use by one or more
1678 option is specified,
1682 PERSISTENT RESERVE IN
1683 command using the requested service action.
1686 option is specified,
1690 PERSISTENT RESERVE OUT
1691 command using the requested service action.
1692 One of those two options is required.
1694 Persistent reservations are complex, and fully explaining them is outside
1695 the scope of this manual.
1698 and download the latest SPC spec for a full explanation of persistent
1702 Specify the service action for the PERSISTENT RESERVE IN command.
1703 Supported service actions:
1706 Report the current persistent reservation generation (PRgeneration) and any
1708 .It read_reservation
1709 Report the persistent reservation, if any.
1710 .It report_capabilities
1711 Report the persistent reservation capabilities of the LUN.
1712 .It read_full_status
1713 Report the full status of persistent reservations on the LUN.
1716 Specify the service action for the PERSISTENT RESERVE OUT command.
1717 For service actions like register that are components of other service
1718 action names, the entire name must be specified.
1719 Otherwise, enough of the service action name must be specified to
1720 distinguish it from other possible service actions.
1721 Supported service actions:
1724 Register a reservation key with the LUN or unregister a reservation key.
1725 To register a key, specify the requested key as the Service Action
1727 To unregister a key, specify the previously registered key as the
1729 To change a key, specify the old key as the Reservation Key and the new
1730 key as the Service Action Reservation Key.
1732 This is similar to the register subcommand, except that the Reservation Key
1734 The Service Action Reservation Key will overwrite any previous key
1735 registered for the initiator.
1737 Create a reservation.
1738 A key must be registered with the LUN before the LUN can be reserved, and
1739 it must be specified as the Reservation Key.
1740 The type of reservation must also be specified.
1741 The scope defaults to LUN scope (LU_SCOPE), but may be changed.
1743 Release a reservation.
1744 The Reservation Key must be specified.
1746 Release a reservation and remove all keys from the device.
1747 The Reservation Key must be specified.
1749 Remove a reservation belonging to another initiator.
1750 The Reservation Key must be specified.
1751 The Service Action Reservation Key may be specified, depending on the
1752 operation being performed.
1754 Remove a reservation belonging to another initiator and abort all
1755 outstanding commands from that initiator.
1756 The Reservation Key must be specified.
1757 The Service Action Reservation Key may be specified, depending on the
1758 operation being performed.
1760 Register another initiator with the LUN, and establish a reservation on the
1761 LUN for that initiator.
1762 The Reservation Key and Service Action Reservation Key must be specified.
1764 Replace Lost Reservation information.
1767 Set the All Target Ports (ALL_TG_PT) bit.
1768 This requests that the key registration be applied to all target ports and
1769 not just the particular target port that receives the command.
1770 This only applies to the register and register_ignore actions.
1772 Specify a Transport ID.
1773 This only applies to the Register and Register and Move service actions for
1774 Persistent Reserve Out.
1775 Multiple Transport IDs may be specified with multiple
1778 With the Register service action, specifying one or more Transport IDs
1779 implicitly enables the
1781 option which turns on the SPEC_I_PT bit.
1782 Transport IDs generally have the format protocol,id.
1785 A SAS Transport ID consists of
1787 followed by a 64-bit SAS address.
1790 .Dl sas,0x1234567812345678
1792 A Fibre Channel Transport ID consists of
1794 followed by a 64-bit Fibre Channel World Wide Name.
1797 .Dl fcp,0x1234567812345678
1799 A Parallel SCSI address consists of
1801 followed by a SCSI target ID and a relative target port identifier.
1806 An IEEE 1394 (Firewire) Transport ID consists of
1808 followed by a 64-bit EUI-64 IEEE 1394 node unique identifier.
1811 .Dl sbp,0x1234567812345678
1813 A SCSI over RDMA Transport ID consists of
1815 followed by a 128-bit RDMA initiator port identifier.
1816 The port identifier must be exactly 32 or 34 (if the leading 0x is
1817 included) hexadecimal digits.
1818 Only hexadecimal (base 16) numbers are supported.
1821 .Dl srp,0x12345678123456781234567812345678
1823 An iSCSI Transport ID consists an iSCSI name and optionally a separator and
1825 For example, if only the iSCSI name is specified:
1827 .Dl iqn.2012-06.com.example:target0
1829 If the iSCSI separator and initiator session ID are specified:
1831 .Dl iqn.2012-06.com.example:target0,i,0x123
1833 A SCSI over PCIe Transport ID consists of
1835 followed by a PCIe Routing ID.
1836 The Routing ID consists of a bus, device and function or in the alternate
1837 form, a bus and function.
1838 The bus must be in the range of 0 to 255 inclusive and the device must be
1839 in the range of 0 to 31 inclusive.
1840 The function must be in the range of 0 to 7 inclusive if the standard form
1841 is used, and in the range of 0 to 255 inclusive if the alternate form is
1843 For example, if a bus, device and function are specified for the standard
1848 If the alternate Routing ID form is used:
1853 Specify the Reservation Key.
1854 This may be in decimal, octal or hexadecimal format.
1855 The value is zero by default if not otherwise specified.
1856 The value must be between 0 and 2^64 - 1, inclusive.
1858 Specify the Service Action Reservation Key.
1859 This may be in decimal, octal or hexadecimal format.
1860 The value is zero by default if not otherwise specified.
1861 The value must be between 0 and 2^64 - 1, inclusive.
1863 Enable the Activate Persist Through Power Loss bit.
1864 This is only used for the register and register_ignore actions.
1865 This requests that the reservation persist across power loss events.
1867 Specify the scope of the reservation.
1868 The scope may be specified by name or by number.
1869 The scope is ignored for register, register_ignore and clear.
1870 If the desired scope isn't available by name, you may specify the number.
1874 This encompasses the entire LUN.
1876 Extent scope (0x01).
1878 Element scope (0x02).
1881 Specify the Relative Target Port.
1882 This only applies to the Register and Move service action of the Persistent
1883 Reserve Out command.
1885 Enable the SPEC_I_PT bit.
1886 This only applies to the Register service action of Persistent Reserve Out.
1887 You must also specify at least one Transport ID with
1889 if this option is set.
1890 If you specify a Transport ID, this option is automatically set.
1891 It is an error to specify this option for any service action other than
1894 Specify the reservation type.
1895 The reservation type may be specified by name or by number.
1896 If the desired reservation type isn't available by name, you may specify
1898 Supported reservation type names:
1903 Write Exclusive mode.
1904 May also be specified as
1905 .Dq write_exclusive .
1907 Read Exclusive mode.
1908 May also be specified as
1909 .Dq read_exclusive .
1911 Exclusive access mode.
1912 May also be specified as
1913 .Dq exclusive_access .
1915 Write Exclusive Registrants Only mode.
1916 May also be specified as
1917 .Dq write_exclusive_reg_only .
1919 Exclusive Access Registrants Only mode.
1920 May also be specified as
1921 .Dq exclusive_access_reg_only .
1923 Write Exclusive All Registrants mode.
1924 May also be specified as
1925 .Dq write_exclusive_all_regs .
1927 Exclusive Access All Registrants mode.
1928 May also be specified as
1929 .Dq exclusive_access_all_regs .
1932 Specify that the target should unregister the initiator that sent
1933 the Register and Move request.
1934 By default, the target will not unregister the initiator that sends the
1935 Register and Move request.
1936 This option only applies to the Register and Move service action of the
1937 Persistent Reserve Out command.
1942 READ or WRITE ATTRIBUTE commands.
1943 These commands are used to read and write attributes in Medium Auxiliary
1945 The most common place Medium Auxiliary Memory is found is small flash chips
1946 included tape cartriges.
1954 option must be specified.
1957 Specify the READ ATTRIBUTE service action.
1960 Issue the ATTRIBUTE VALUES service action.
1961 Read and decode the available attributes and their values.
1963 Issue the ATTRIBUTE LIST service action.
1964 List the attributes that are available to read and write.
1966 Issue the LOGICAL VOLUME LIST service action.
1967 List the available logical volumes in the MAM.
1969 Issue the PARTITION LIST service action.
1970 List the available partitions in the MAM.
1972 Issue the SUPPORTED ATTRIBUTES service action.
1973 List attributes that are supported for reading or writing.
1974 These attributes may or may not be currently present in the MAM.
1977 Specify an attribute to write to the MAM.
1978 This option is not yet implemented.
1980 Specify the attribute number to display.
1981 This option only works with the attr_values, attr_list and supp_attr
1985 Display cached attributes.
1986 If the device supports this flag, it allows displaying attributes for the
1987 last piece of media loaded in the drive.
1989 Specify the element address.
1990 This is used for specifying which element number in a medium changer to
1991 access when reading attributes.
1992 The element number could be for a picker, portal, slot or drive.
1993 .It Fl F Ar form1,form2
1994 Specify the output format for the attribute values (attr_val) display as a
1995 comma separated list of options.
1996 The default output is currently set to field_all,nonascii_trim,text_raw.
1997 Once this code is ported to FreeBSD 10, any text fields will be converted
1998 from their codeset to the user's native codeset with
2001 The text options are mutually exclusive; if you specify more than one, you
2002 will get unpredictable results.
2003 The nonascii options are also mutually exclusive.
2004 Most of the field options may be logically ORed together.
2007 Print text fields with non-ASCII characters escaped.
2009 Print text fields natively, with no codeset conversion.
2011 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2012 escape the non-ASCII characters.
2014 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2015 omit the non-ASCII characters.
2017 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2018 print them as they are.
2020 Print all of the prefix fields: description, attribute number, attribute
2021 size, and the attribute's readonly status.
2022 If field_all is specified, specifying any other field options will not have
2025 Print none of the prefix fields, and only print out the attribute value.
2026 If field_none is specified, specifying any other field options will result
2027 in those fields being printed.
2029 Print out the attribute description.
2031 Print out the attribute number.
2033 Print out the attribute size.
2035 Print out the attribute's readonly status.
2038 Specify the partition.
2039 When the media has multiple partitions, specifying different partition
2040 numbers allows seeing the values for each individual partition.
2041 .It Fl s Ar start_num
2042 Specify the starting attribute number.
2043 This requests that the target device return attribute information starting
2044 at the given number.
2045 .It Fl T Ar elem_type
2046 Specify the element type.
2047 For medium changer devices, this allows specifying the type the element
2048 referenced in the element address (
2059 Specify the number of the logical volume to operate on.
2060 If the media has multiple logical volumes, this will allow displaying
2061 or writing attributes on the given logical volume.
2063 Issue the REPORT SUPPORTED OPCODES service action of the
2067 Without arguments, this command will return a list of all
2069 commands supported by the device, including service actions of commands
2070 that support service actions.
2071 It will also include the
2073 CDB (Command Data Block) length for each command, and the description of
2074 each command if it is known.
2077 Request information on a specific opcode instead of the list of supported
2079 If supported, the target will return a CDB-like structure that indicates
2080 the opcode, service action (if any), and a mask of bits that are supported
2082 .It Fl s Ar service_action
2083 For commands that support a service action, specify the service action to
2086 If a service action is specified for a given opcode, and the device does
2087 not support the given service action, the device should not return a
2089 error, but rather indicate in the returned parameter data that the command
2091 By default, if a service action is specified for an opcode, and service
2092 actions are not supported for the opcode in question, the device will
2095 Include timeout values.
2096 This option works with the default display, which includes all commands
2097 supported by the device, and with the
2101 options, which request information on a specific command and service
2103 This requests that the device report Nominal and Recommended timeout values
2104 for the given command or commands.
2105 The timeout values are in seconds.
2106 The timeout descriptor also includes a command-specific
2109 Print out verbose usage information.
2114 variable allows the user to specify an alternate mode page format file.
2118 variable determines which text editor
2120 starts when editing mode pages.
2122 .Bl -tag -width /usr/share/misc/scsi_modes -compact
2123 .It Pa /usr/share/misc/scsi_modes
2124 is the SCSI mode format database.
2126 is the transport layer device.
2128 are the CAM application passthrough devices.
2131 .Dl camcontrol eject -n cd -u 1 -v
2133 Eject the CD from cd1, and print SCSI sense information if the command
2136 .Dl camcontrol tur da0
2138 Send the SCSI test unit ready command to da0.
2141 utility will report whether the disk is ready, but will not display sense
2142 information if the command fails since the
2144 switch was not specified.
2145 .Bd -literal -offset indent
2146 camcontrol tur da1 -E -C 4 -t 50 -v
2149 Send a test unit ready command to da1.
2150 Enable kernel error recovery.
2151 Specify a retry count of 4, and a timeout of 50 seconds.
2155 flag) if the command fails.
2156 Since error recovery is turned on, the
2157 disk will be spun up if it is not currently spinning.
2160 utility will report whether the disk is ready.
2161 .Bd -literal -offset indent
2162 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
2163 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
2166 Issue a READ BUFFER command (0x3C) to cd1.
2167 Display the buffer size of cd1,
2168 and display the first 10 bytes from the cache on cd1.
2170 information if the command fails.
2171 .Bd -literal -offset indent
2172 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
2173 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
2176 Issue a WRITE BUFFER (0x3B) command to cd1.
2177 Write out 10 bytes of data,
2178 not including the (reserved) 4 byte header.
2179 Print out sense information if
2181 Be very careful with this command, improper use may
2182 cause data corruption.
2183 .Bd -literal -offset indent
2184 camcontrol modepage da3 -m 1 -e -P 3
2187 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
2188 settings on the drive.
2189 Mode page 1 contains a disk drive's auto read and
2190 write reallocation settings, among other things.
2192 .Dl camcontrol rescan all
2194 Rescan all SCSI busses in the system for devices that have been added,
2197 .Dl camcontrol rescan 0
2199 Rescan SCSI bus 0 for devices that have been added, removed or changed.
2201 .Dl camcontrol rescan 0:1:0
2203 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
2206 .Dl camcontrol tags da5 -N 24
2208 Set the number of concurrent transactions for da5 to 24.
2209 .Bd -literal -offset indent
2210 camcontrol negotiate -n da -u 4 -T disable
2213 Disable tagged queueing for da4.
2214 .Bd -literal -offset indent
2215 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
2218 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
2220 Test Unit Ready command to make the settings take effect.
2221 .Bd -literal -offset indent
2222 camcontrol smpcmd ses0 -v -r 4 "40 0 00 0" -R 1020 "s9 i1"
2225 Send the SMP REPORT GENERAL command to ses0, and display the number of PHYs
2227 Display SMP errors if the command fails.
2228 .Bd -literal -offset indent
2229 camcontrol security ada0
2232 Report security support and settings for ada0
2233 .Bd -literal -offset indent
2234 camcontrol security ada0 -U user -s MyPass
2237 Enable security on device ada0 with the password MyPass
2238 .Bd -literal -offset indent
2239 camcontrol security ada0 -U user -e MyPass
2242 Secure erase ada0 which has had security enabled with user password MyPass
2244 .Em WARNING! WARNING! WARNING!
2248 data from the device, so backup your data before using!
2250 This command can be used against an SSD drive to restoring it to
2251 factory default write performance.
2252 .Bd -literal -offset indent
2256 Report HPA support and settings for ada0 (also reported via
2258 .Bd -literal -offset indent
2259 camcontrol hpa ada0 -s 10240
2262 Enables HPA on ada0 setting the maximum reported sectors to 10240.
2264 .Em WARNING! WARNING! WARNING!
2268 to all data on the device beyond this limit until HPA is disabled by setting
2269 HPA to native max sectors of the device, which can only be done after a
2270 power-on or hardware reset!
2273 use this on a device which has an active filesystem!
2275 .Bd -literal -offset indent
2276 camcontrol persist da0 -v -i read_keys
2279 This will read any persistent reservation keys registered with da0, and
2280 display any errors encountered when sending the PERSISTENT RESERVE IN
2283 .Bd -literal -offset indent
2284 camcontrol persist da0 -v -o register -a -K 0x12345678
2287 This will register the persistent reservation key 0x12345678 with da0,
2288 apply that registration to all ports on da0, and display any errors that
2289 occur when sending the PERSISTENT RESERVE OUT command.
2290 .Bd -literal -offset indent
2291 camcontrol persist da0 -v -o reserve -s lun -k 0x12345678 -T ex_ac
2294 This will reserve da0 for the exlusive use of the initiator issuing the
2296 The scope of the reservation is the entire LUN.
2297 Any errors sending the PERSISTENT RESERVE OUT command will be displayed.
2298 .Bd -literal -offset indent
2299 camcontrol persist da0 -v -i read_full
2302 This will display the full status of all reservations on da0 and print out
2303 status if there are any errors.
2304 .Bd -literal -offset indent
2305 camcontrol persist da0 -v -o release -k 0x12345678 -T ex_ac
2308 This will release a reservation on da0 of the type ex_ac
2310 The Reservation Key for this registration is 0x12345678.
2311 Any errors that occur will be displayed.
2312 .Bd -literal -offset indent
2313 camcontrol persist da0 -v -o register -K 0x12345678 -S \e
2314 -I sas,0x1234567812345678 -I sas,0x8765432187654321
2317 This will register the key 0x12345678 with da0, specifying that it applies
2318 to the SAS initiators with SAS addresses 0x1234567812345678 and
2320 .Bd -literal -offset indent
2321 camcontrol persist da0 -v -o register_move -k 0x87654321 \e
2322 -K 0x12345678 -U -p -R 2 -I fcp,0x1234567812345678
2325 This will move the registration from the current initiator, whose
2326 Registration Key is 0x87654321, to the Fibre Channel initiator with the
2327 Fiber Channel World Wide Node Name 0x1234567812345678.
2328 A new registration key, 0x12345678, will be registered for the initiator
2329 with the Fibre Channel World Wide Node Name 0x1234567812345678, and the
2330 current initiator will be unregistered from the target.
2331 The reservation will be moved to relative target port 2 on the target
2333 The registration will persist across power losses.
2335 .Bd -literal -offset indent
2336 camcontrol attrib sa0 -v -i attr_values -p 1
2339 This will read and decode the attribute values from partition 1 on the tape
2340 in tape drive sa0, and will display any
2345 .Xr cam_cdbparse 3 ,
2352 utility first appeared in
2355 The mode page editing code and arbitrary SCSI command code are based upon
2360 library, written by Julian Elischer and Peter Dufault.
2363 program first appeared in
2365 and first appeared in
2370 .An Kenneth Merry Aq Mt ken@FreeBSD.org
2372 The code that parses the generic command line arguments does not know that
2373 some of the subcommands take multiple arguments.
2374 So if, for instance, you
2375 tried something like this:
2376 .Bd -literal -offset indent
2377 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
2380 The sense information from the test unit ready command would not get
2381 printed out, since the first
2385 bails out when it sees the second argument to
2389 Fixing this behavior would take some gross code, or changes to the
2392 The best way to circumvent this problem is to always make sure
2395 arguments before any command-specific arguments.
projects / FreeBSD / stable / 10.git / blob