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 | 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 .It Fl m Ar mode_page
682 This specifies the number of the mode page the user would like to view
684 This argument is mandatory unless
688 This allows the user to specify the page control field.
690 .Bl -tag -width xxx -compact
702 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
705 function requires the
707 argument to specify SCSI CDB or the
709 argument to specify ATA Command Block registers values.
710 Other arguments are optional, depending on
712 The command and data specification syntax is documented
715 NOTE: If the CDB specified causes data to be transferred to or from the
716 SCSI device in question, you MUST specify either
721 .It Fl a Ar cmd Op args
722 This specifies the content of 12 ATA Command Block registers (command,
723 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
724 lba_high_exp, features_exp, sector_count, sector_count_exp).
725 .It Fl c Ar cmd Op args
726 This specifies the SCSI CDB.
727 SCSI CDBs may be 6, 10, 12 or 16 bytes.
729 Specifies DMA protocol to be used for ATA command.
731 Specifies FPDMA (NCQ) protocol to be used for ATA command.
732 .It Fl i Ar len Ar fmt
733 This specifies the amount of data to read, and how it should be displayed.
737 bytes of data will be read from the device and written to standard output.
738 .It Fl o Ar len Ar fmt Op args
739 This specifies the amount of data to be written to a device, and the data
740 that is to be written.
744 bytes of data will be read from standard input and written to the device.
746 This specifies that 11 result ATA Command Block registers should be displayed
747 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
748 lba_high_exp, sector_count, sector_count_exp), and how.
751 11 result registers will be written to standard output in hex.
754 Allows the user to send an arbitrary Serial
755 Management Protocol (SMP) command to a device.
758 function requires the
760 argument to specify the SMP request to be sent, and the
762 argument to specify the format of the SMP response.
763 The syntax for the SMP request and response arguments is documented in
766 Note that SAS adapters that support SMP passthrough (at least the currently
767 known adapters) do not accept CRC bytes from the user in the request and do
768 not pass CRC bytes back to the user in the response.
769 Therefore users should not include the CRC bytes in the length of the
770 request and not expect CRC bytes to be returned in the response.
772 .It Fl r Ar len Ar fmt Op args
773 This specifies the size of the SMP request, without the CRC bytes, and the
778 bytes of data will be read from standard input and written as the SMP
780 .It Fl R Ar len Ar fmt Op args
781 This specifies the size of the buffer allocated for the SMP response, and
782 the SMP response format.
786 bytes of data will be allocated for the response and the response will be
787 written to standard output.
790 Allows the user to send the Serial Management Protocol (SMP) Report General
793 will display the data returned by the Report General command.
794 If the SMP target supports the long response format, the additional data
795 will be requested and displayed automatically.
798 Request the long response format only.
799 Not all SMP targets support the long response format.
802 to skip sending the initial report general request without the long bit set
803 and only issue a report general request with the long bit set.
806 Allows the user to issue the Serial Management Protocol (SMP) PHY Control
808 This function should be used with some caution, as it can render devices
809 inaccessible, and could potentially cause data corruption as well.
812 argument is required to specify the PHY to operate on.
815 Specify the PHY to operate on.
816 This argument is required.
818 Request the long request/response format.
819 Not all SMP targets support the long response format.
820 For the PHY Control command, this currently only affects whether the
821 request length is set to a value other than 0.
822 .It Fl o Ar operation
823 Specify a PHY control operation.
826 operation may be specified.
827 The operation may be specified numerically (in decimal, hexadecimal, or octal)
828 or one of the following operation names may be specified:
832 It is not necessary to specify this argument.
834 Send the LINK RESET command to the phy.
836 Send the HARD RESET command to the phy.
838 Send the DISABLE command to the phy.
839 Note that the LINK RESET or HARD RESET commands should re-enable the phy.
841 Send the CLEAR ERROR LOG command.
842 This clears the error log counters for the specified phy.
844 Send the CLEAR AFFILIATION command.
845 This clears the affiliation from the STP initiator port with the same SAS
846 address as the SMP initiator that requests the clear operation.
848 Send the TRANSMIT SATA PORT SELECTION SIGNAL command to the phy.
849 This will cause a SATA port selector to use the given phy as its active phy
850 and make the other phy inactive.
852 Send the CLEAR STP I_T NEXUS LOSS command to the PHY.
854 Send the SET ATTACHED DEVICE NAME command to the PHY.
857 argument to specify the device name.
860 Specify the attached device name.
861 This option is needed with the
864 The name is a 64-bit number, and can be specified in decimal, hexadecimal
867 Set the minimum physical link rate for the phy.
868 This is a numeric argument.
869 Currently known link rates are:
872 Do not change current value.
881 Other values may be specified for newer physical link rates.
883 Set the maximum physical link rate for the phy.
884 This is a numeric argument.
887 argument description for known link rate arguments.
888 .It Fl T Ar pp_timeout
889 Set the partial pathway timeout value, in microseconds.
894 specification for more information on this field.
895 .It Fl a Ar enable|disable
896 Enable or disable SATA slumber phy power conditions.
897 .It Fl A Ar enable|disable
898 Enable or disable SATA partial power conditions.
899 .It Fl s Ar enable|disable
900 Enable or disable SAS slumber phy power conditions.
901 .It Fl S Ar enable|disable
902 Enable or disable SAS partial phy power conditions.
905 List phys attached to a SAS expander, the address of the end device
906 attached to the phy, and the inquiry data for that device and peripheral
907 devices attached to that device.
908 The inquiry data and peripheral devices are displayed if available.
911 Turn on the long response format for the underlying SMP commands used for
914 Only print out phys that are attached to a device in the CAM EDT (Existing
918 Send the SMP Report Manufacturer Information command to the device and
919 display the response.
922 Turn on the long response format for the underlying SMP commands used for
926 Turn on CAM debugging printfs in the kernel.
927 This requires options CAMDEBUG
928 in your kernel config file.
929 WARNING: enabling debugging printfs currently
930 causes an EXTREME number of kernel printfs.
931 You may have difficulty
932 turning off the debugging printfs once they start, since the kernel will be
933 busy printing messages and unable to service other requests quickly.
936 function takes a number of arguments:
939 Enable CAM_DEBUG_INFO printfs.
941 Enable CAM_DEBUG_PERIPH printfs.
943 Enable CAM_DEBUG_TRACE printfs.
945 Enable CAM_DEBUG_SUBTRACE printfs.
947 Enable CAM_DEBUG_XPT printfs.
949 Enable CAM_DEBUG_CDB printfs.
950 This will cause the kernel to print out the
951 SCSI CDBs sent to the specified device(s).
953 Enable CAM_DEBUG_PROBE printfs.
955 Enable debugging for all devices.
957 Turn off debugging for all devices
958 .It bus Ns Op :target Ns Op :lun
959 Turn on debugging for the given bus, target or lun.
961 and lun are not specified, they are wildcarded.
962 (i.e., just specifying a
963 bus turns on debugging printfs for all devices on that bus.)
966 Show or set the number of "tagged openings" or simultaneous transactions
967 we attempt to queue to a particular device.
970 command, with no command-specific arguments (i.e., only generic arguments)
971 prints out the "soft" maximum number of transactions that can be queued to
972 the device in question.
973 For more detailed information, use the
975 argument described below.
978 Set the number of tags for the given device.
979 This must be between the
980 minimum and maximum number set in the kernel quirk table.
982 most devices that support tagged queueing is a minimum of 2 and a maximum
984 The minimum and maximum values for a given device may be
985 determined by using the
992 subcommand is described below.
994 Be quiet, and do not report the number of tags.
995 This is generally used when
996 setting the number of tags.
998 The verbose flag has special functionality for the
1003 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
1006 This is the amount of capacity for transactions queued to a given device.
1008 This is the number of transactions currently queued to a device.
1010 This is the kernel queue space for transactions.
1011 This count usually mirrors
1012 dev_openings except during error recovery operations when
1013 the device queue is frozen (device is not allowed to receive
1014 commands), the number of dev_openings is reduced, or transaction
1015 replay is occurring.
1017 This is the number of transactions waiting in the kernel queue for capacity
1019 This number is usually zero unless error recovery is in
1022 The held count is the number of CCBs held by peripheral drivers that have
1023 either just been completed or are about to be released to the transport
1024 layer for service by a device.
1025 Held CCBs reserve capacity on a given
1028 This is the current "hard" minimum number of transactions that can be
1029 queued to a device at once.
1032 value above cannot go below this number.
1033 The default value for
1035 is 2, although it may be set higher or lower for various devices.
1037 This is the "hard" maximum number of transactions that can be queued to a
1041 value cannot go above this number.
1042 The default value for
1044 is 255, although it may be set higher or lower for various devices.
1048 Show or negotiate various communication parameters.
1049 Some controllers may
1050 not support setting or changing some of these values.
1052 Adaptec 174x controllers do not support changing a device's sync rate or
1057 will not attempt to set the parameter if the controller indicates that it
1058 does not support setting the parameter.
1059 To find out what the controller
1067 command is described below.
1068 Also, some controller drivers do not support
1069 setting negotiation parameters, even if the underlying controller supports
1070 negotiation changes.
1071 Some controllers, such as the Advansys wide
1072 controllers, support enabling and disabling synchronous negotiation for
1073 a device, but do not support setting the synchronous negotiation rate.
1076 Attempt to make the negotiation settings take effect immediately by sending
1077 a Test Unit Ready command to the device.
1079 Show or set current negotiation settings.
1080 This is the default.
1081 .It Fl D Ar enable|disable
1082 Enable or disable disconnection.
1086 Set the command delay offset.
1088 Be quiet, do not print anything.
1089 This is generally useful when you want to
1090 set a parameter, but do not want any status information.
1091 .It Fl R Ar syncrate
1092 Change the synchronization rate for a device.
1093 The sync rate is a floating
1094 point value specified in MHz.
1097 is a legal value, as is
1099 .It Fl T Ar enable|disable
1100 Enable or disable tagged queueing for a device.
1102 Show or set user negotiation settings.
1103 The default is to show or set
1104 current negotiation settings.
1106 The verbose switch has special meaning for the
1111 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
1113 .It Fl W Ar bus_width
1114 Specify the bus width to negotiate with a device.
1117 The only useful values to specify are 8, 16, and 32
1119 The controller must support the bus width in question in order for
1120 the setting to take effect.
1123 In general, sync rate and offset settings will not take effect for a
1124 device until a command has been sent to the device.
1127 switch above will automatically send a Test Unit Ready to the device so
1128 negotiation parameters will take effect.
1132 FORMAT UNIT command to the named device.
1134 .Em WARNING! WARNING! WARNING!
1136 Low level formatting a disk will destroy ALL data on the disk.
1138 extreme caution when issuing this command.
1139 Many users low-level format
1140 disks that do not really need to be low-level formatted.
1142 relatively few scenarios that call for low-level formatting a disk.
1144 low-level formatting a disk is to initialize the disk after changing
1145 its physical sector size.
1146 Another reason for low-level formatting a disk
1147 is to revive the disk if you are getting "medium format corrupted" errors
1148 from the disk in response to read and write requests.
1150 Some disks take longer than others to format.
1151 Users should specify a
1152 timeout long enough to allow the format to complete.
1154 timeout is 3 hours, which should be long enough for most disks.
1156 disks will complete a format operation in a very short period of time
1157 (on the order of 5 minutes or less).
1158 This is often because the drive
1159 does not really support the FORMAT UNIT command -- it just accepts the
1160 command, waits a few minutes and then returns it.
1164 subcommand takes several arguments that modify its default behavior.
1169 arguments can be useful for scripts.
1172 Be quiet, do not print any status messages.
1173 This option will not disable
1174 the questions, however.
1175 To disable questions, use the
1182 This will report status on a format that is already running on the drive.
1184 Issue a non-immediate format command.
1187 issues the FORMAT UNIT command with the immediate bit set.
1189 device to immediately return the format command, before the format has
1195 sense information from the device every second to determine how far along
1196 in the format process it is.
1199 argument is specified,
1201 will issue a non-immediate format command, and will be unable to print any
1202 information to let the user know what percentage of the disk has been
1205 Do not ask any questions.
1208 will ask the user if he/she really wants to format the disk in question,
1209 and also if the default format command timeout is acceptable.
1211 will not be asked about the timeout if a timeout is specified on the
1217 SANITIZE command to the named device.
1219 .Em WARNING! WARNING! WARNING!
1221 ALL data in the cache and on the disk will be destroyed or made inaccessible.
1222 Recovery of the data is not possible.
1223 Use extreme caution when issuing this command.
1227 subcommand takes several arguments that modify its default behavior.
1232 arguments can be useful for scripts.
1234 .It Fl a Ar operation
1235 Specify the sanitize operation to perform.
1238 Perform an overwrite operation by writing a user supplied
1239 data pattern to the device one or more times.
1240 The pattern is given by the
1243 The number of times is given by the
1247 Perform a block erase operation.
1248 All the device's blocks are set to a vendor defined
1249 value, typically zero.
1251 Perform a cryptographic erase operation.
1252 The encryption keys are changed to prevent the decryption
1255 Exits a previously failed sanitize operation.
1256 A failed sanitize operation can only be exited if it was
1257 run in the unrestricted completion mode, as provided by the
1262 The number of passes when performing an
1265 Valid values are between 1 and 31.
1270 operation, the pattern is inverted between consecutive passes.
1272 Path to the file containing the pattern to use when
1276 The pattern is repeated as needed to fill each block.
1278 Be quiet, do not print any status messages.
1279 This option will not disable
1280 the questions, however.
1281 To disable questions, use the
1285 Perform the sanitize in the unrestricted completion mode.
1286 If the operation fails, it can later be exited with the
1293 This will report status on a sanitize that is already running on the drive.
1295 Issue a non-immediate sanitize command.
1298 issues the SANITIZE command with the immediate bit set.
1300 device to immediately return the sanitize command, before
1301 the sanitize has actually completed.
1306 sense information from the device every second to determine how far along
1307 in the sanitize process it is.
1310 argument is specified,
1312 will issue a non-immediate sanitize command, and will be unable to print any
1313 information to let the user know what percentage of the disk has been
1316 Do not ask any questions.
1319 will ask the user if he/she really wants to sanitize the disk in question,
1320 and also if the default sanitize command timeout is acceptable.
1322 will not be asked about the timeout if a timeout is specified on the
1326 Put ATA device into IDLE state.
1329 specifies automatic standby timer value in seconds.
1330 Value 0 disables timer.
1332 Put ATA device into STANDBY state.
1335 specifies automatic standby timer value in seconds.
1336 Value 0 disables timer.
1338 Put ATA device into SLEEP state.
1339 Note that the only way get device out of
1340 this state may be reset.
1342 It optional parameter
1344 specified, enables and sets advanced power management level, where
1345 1 -- minimum power, 127 -- maximum performance with standby,
1346 128 -- minimum power without standby, 254 -- maximum performance.
1347 If not specified -- APM is disabled.
1349 It optional parameter
1351 specified, enables and sets automatic acoustic management level, where
1352 1 -- minimum noise, 254 -- maximum performance.
1353 If not specified -- AAM is disabled.
1355 Update or report security settings, using an ATA identify command (0xec).
1358 will print out the security support and associated settings of the device.
1361 command takes several arguments:
1365 Disable device security using the given password for the selected user according
1366 to the devices configured security level.
1369 Erase the device using the given password for the selected user.
1371 .Em WARNING! WARNING! WARNING!
1373 Issuing a secure erase will
1375 user data on the device and may take several hours to complete.
1377 When this command is used against an SSD drive all its cells will be marked as
1378 empty, restoring it to factory default write performance.
1379 For SSD's this action
1380 usually takes just a few seconds.
1383 Freeze the security configuration of the specified device.
1385 After command completion any other commands that update the device lock mode
1386 shall be command aborted.
1387 Frozen mode is disabled by power-off or hardware reset.
1390 Enhanced erase the device using the given password for the selected user.
1392 .Em WARNING! WARNING! WARNING!
1394 Issuing an enhanced secure erase will
1396 user data on the device and may take several hours to complete.
1398 An enhanced erase writes predetermined data patterns to all user data areas,
1399 all previously written user data shall be overwritten, including sectors that
1400 are no longer in use due to reallocation.
1403 Unlock the device using the given password for the selected user according to
1404 the devices configured security level.
1405 .It Fl l Ar high|maximum
1407 Specifies which security level to set when issuing a
1410 The security level determines device behavior when the master
1411 password is used to unlock the device.
1412 When the security level is set to high
1413 the device requires the unlock command and the master password to unlock.
1414 When the security level is set to maximum the device requires a secure erase
1415 with the master password to unlock.
1417 This option must be used in conjunction with one of the security action commands.
1423 Be quiet, do not print any status messages.
1424 This option will not disable the questions, however.
1425 To disable questions, use the
1430 Password the device (enable security) using the given password for the selected
1432 This option can be combined with other options such as
1435 A master password may be set in a addition to the user password. The purpose of
1436 the master password is to allow an administrator to establish a password that
1437 is kept secret from the user, and which may be used to unlock the device if the
1438 user password is lost.
1441 Setting the master password does not enable device security.
1443 If the master password is set and the drive supports a Master Revision Code
1444 feature the Master Password Revision Code will be decremented.
1447 Overrides the default timeout, specified in seconds, used for both
1451 this is useful if your system has problems processing long timeouts correctly.
1453 Usually the timeout is calculated from the information stored on the drive if
1454 present, otherwise it defaults to 2 hours.
1455 .It Fl U Ar user|master
1457 Specifies which user to set / use for the running action command, valid values
1458 are user or master and defaults to master if not set.
1460 This option must be used in conjunction with one of the security action commands.
1466 Confirm yes to dangerous options such as
1468 without prompting for confirmation.
1471 If the password specified for any action commands does not match the configured
1472 password for the specified user the command will fail.
1474 The password in all cases is limited to 32 characters, longer passwords will
1477 Update or report Host Protected Area details.
1480 will print out the HPA support and associated settings of the device.
1483 command takes several optional arguments:
1487 Freeze the HPA configuration of the specified device.
1489 After command completion any other commands that update the HPA configuration
1490 shall be command aborted.
1491 Frozen mode is disabled by power-off or hardware reset.
1494 Lock the HPA configuration of the device until a successful call to unlock or
1495 the next power-on reset occurs.
1498 Make the HPA max sectors persist across power-on reset or a hardware reset.
1499 This must be used in combination with
1500 .Fl s Ar max_sectors
1504 Set the HPA configuration password required for unlock calls.
1507 Be quiet, do not print any status messages.
1508 This option will not disable the questions.
1509 To disable questions, use the
1512 .It Fl s Ar max_sectors
1514 Configures the maximum user accessible sectors of the device.
1515 This will change the number of sectors the device reports.
1517 .Em WARNING! WARNING! WARNING!
1519 Changing the max sectors of a device using this option will make the data on
1520 the device beyond the specified value inaccessible.
1523 .Fl s Ar max_sectors
1524 call can be made without a power-on reset or a hardware reset of the device.
1527 Unlock the HPA configuration of the specified device using the given password.
1528 If the password specified does not match the password configured via
1530 the command will fail.
1532 After 5 failed unlock calls, due to password miss-match, the device will refuse
1533 additional unlock calls until after a power-on reset.
1536 Confirm yes to dangerous options such as
1538 without prompting for confirmation
1541 The password for all HPA commands is limited to 32 characters, longer passwords
1544 Program firmware of the named
1546 or ATA device using the image file provided.
1550 device and it provides a recommended timeout for the WRITE BUFFER command
1553 opcodes subcommand), that timeout will be used for the firmware download.
1554 The drive-recommended timeout value may be overridden on the command line
1559 Current list of supported vendors for SCSI/SAS drives:
1562 Tested with 4TB SAS drives, model number HUS724040ALS640.
1566 Tested with LTO-5 (ULTRIUM-HH5) and LTO-6 (ULTRIUM-HH6) tape drives.
1567 There is a separate table entry for hard drives, because the update method
1568 for hard drives is different than the method for tape drives.
1573 Tested with SM1625 SSDs.
1575 Tested with Constellation ES (ST32000444SS), ES.2 (ST33000651SS) and
1576 ES.3 (ST1000NM0023) drives.
1578 Tested with 400GB Optimus SSDs (TXA2D20400GA6001).
1581 .Em WARNING! WARNING! WARNING!
1583 Little testing has been done to make sure that different device models from
1584 each vendor work correctly with the fwdownload command.
1585 A vendor name appearing in the supported list means only that firmware of at
1586 least one device type from that vendor has successfully been programmed with
1587 the fwdownload command.
1588 Extra caution should be taken when using this command since there is no
1589 guarantee it will not break a device from the listed vendors.
1590 Ensure that you have a recent backup of the data on the device before
1591 performing a firmware update.
1595 protocol devices will not be programmed, since there is little chance of
1596 the firmware download succeeding.
1599 will currently attempt a firmware download to any
1603 device, since the standard
1605 DOWNLOAD MICROCODE command may work.
1606 Firmware downloads to
1610 devices are supported for devices connected
1615 controllers, and devices connected to SAS controllers
1620 translation capability.
1626 PASS-THROUGH command to send the
1628 DOWNLOAD MICROCODE command to the drive.
1633 translation implementations don't work fully when translating
1635 WRITE BUFFER commands to
1637 DOWNLOAD MICROCODE commands, but do support
1639 passthrough well enough to do a firmware download.
1641 .It Fl f Ar fw_image
1642 Path to the firmware image file to be downloaded to the specified device.
1644 Do not print informational messages, only print errors.
1645 This option should be used with the
1647 option to suppress all output.
1649 Run in simulation mode.
1650 Device checks are run and the confirmation dialog is shown, but no firmware
1651 download will occur.
1657 errors in the event of a failure.
1659 In simulation mode, print out the
1664 register values that would be used for the firmware download command.
1666 Do not ask for confirmation.
1669 Persistent reservation support.
1670 Persistent reservations are a way to reserve a particular
1672 LUN for use by one or more
1677 option is specified,
1681 PERSISTENT RESERVE IN
1682 command using the requested service action.
1685 option is specified,
1689 PERSISTENT RESERVE OUT
1690 command using the requested service action.
1691 One of those two options is required.
1693 Persistent reservations are complex, and fully explaining them is outside
1694 the scope of this manual.
1697 and download the latest SPC spec for a full explanation of persistent
1701 Specify the service action for the PERSISTENT RESERVE IN command.
1702 Supported service actions:
1705 Report the current persistent reservation generation (PRgeneration) and any
1707 .It read_reservation
1708 Report the persistent reservation, if any.
1709 .It report_capabilities
1710 Report the persistent reservation capabilities of the LUN.
1711 .It read_full_status
1712 Report the full status of persistent reservations on the LUN.
1715 Specify the service action for the PERSISTENT RESERVE OUT command.
1716 For service actions like register that are components of other service
1717 action names, the entire name must be specified.
1718 Otherwise, enough of the service action name must be specified to
1719 distinguish it from other possible service actions.
1720 Supported service actions:
1723 Register a reservation key with the LUN or unregister a reservation key.
1724 To register a key, specify the requested key as the Service Action
1726 To unregister a key, specify the previously registered key as the
1728 To change a key, specify the old key as the Reservation Key and the new
1729 key as the Service Action Reservation Key.
1731 This is similar to the register subcommand, except that the Reservation Key
1733 The Service Action Reservation Key will overwrite any previous key
1734 registered for the initiator.
1736 Create a reservation.
1737 A key must be registered with the LUN before the LUN can be reserved, and
1738 it must be specified as the Reservation Key.
1739 The type of reservation must also be specified.
1740 The scope defaults to LUN scope (LU_SCOPE), but may be changed.
1742 Release a reservation.
1743 The Reservation Key must be specified.
1745 Release a reservation and remove all keys from the device.
1746 The Reservation Key must be specified.
1748 Remove a reservation belonging to another initiator.
1749 The Reservation Key must be specified.
1750 The Service Action Reservation Key may be specified, depending on the
1751 operation being performed.
1753 Remove a reservation belonging to another initiator and abort all
1754 outstanding commands from that initiator.
1755 The Reservation Key must be specified.
1756 The Service Action Reservation Key may be specified, depending on the
1757 operation being performed.
1759 Register another initiator with the LUN, and establish a reservation on the
1760 LUN for that initiator.
1761 The Reservation Key and Service Action Reservation Key must be specified.
1763 Replace Lost Reservation information.
1766 Set the All Target Ports (ALL_TG_PT) bit.
1767 This requests that the key registration be applied to all target ports and
1768 not just the particular target port that receives the command.
1769 This only applies to the register and register_ignore actions.
1771 Specify a Transport ID.
1772 This only applies to the Register and Register and Move service actions for
1773 Persistent Reserve Out.
1774 Multiple Transport IDs may be specified with multiple
1777 With the Register service action, specifying one or more Transport IDs
1778 implicitly enables the
1780 option which turns on the SPEC_I_PT bit.
1781 Transport IDs generally have the format protocol,id.
1784 A SAS Transport ID consists of
1786 followed by a 64-bit SAS address.
1789 .Dl sas,0x1234567812345678
1791 A Fibre Channel Transport ID consists of
1793 followed by a 64-bit Fibre Channel World Wide Name.
1796 .Dl fcp,0x1234567812345678
1798 A Parallel SCSI address consists of
1800 followed by a SCSI target ID and a relative target port identifier.
1805 An IEEE 1394 (Firewire) Transport ID consists of
1807 followed by a 64-bit EUI-64 IEEE 1394 node unique identifier.
1810 .Dl sbp,0x1234567812345678
1812 A SCSI over RDMA Transport ID consists of
1814 followed by a 128-bit RDMA initiator port identifier.
1815 The port identifier must be exactly 32 or 34 (if the leading 0x is
1816 included) hexadecimal digits.
1817 Only hexadecimal (base 16) numbers are supported.
1820 .Dl srp,0x12345678123456781234567812345678
1822 An iSCSI Transport ID consists an iSCSI name and optionally a separator and
1824 For example, if only the iSCSI name is specified:
1826 .Dl iqn.2012-06.com.example:target0
1828 If the iSCSI separator and initiator session ID are specified:
1830 .Dl iqn.2012-06.com.example:target0,i,0x123
1832 A SCSI over PCIe Transport ID consists of
1834 followed by a PCIe Routing ID.
1835 The Routing ID consists of a bus, device and function or in the alternate
1836 form, a bus and function.
1837 The bus must be in the range of 0 to 255 inclusive and the device must be
1838 in the range of 0 to 31 inclusive.
1839 The function must be in the range of 0 to 7 inclusive if the standard form
1840 is used, and in the range of 0 to 255 inclusive if the alternate form is
1842 For example, if a bus, device and function are specified for the standard
1847 If the alternate Routing ID form is used:
1852 Specify the Reservation Key.
1853 This may be in decimal, octal or hexadecimal format.
1854 The value is zero by default if not otherwise specified.
1855 The value must be between 0 and 2^64 - 1, inclusive.
1857 Specify the Service Action Reservation Key.
1858 This may be in decimal, octal or hexadecimal format.
1859 The value is zero by default if not otherwise specified.
1860 The value must be between 0 and 2^64 - 1, inclusive.
1862 Enable the Activate Persist Through Power Loss bit.
1863 This is only used for the register and register_ignore actions.
1864 This requests that the reservation persist across power loss events.
1866 Specify the scope of the reservation.
1867 The scope may be specified by name or by number.
1868 The scope is ignored for register, register_ignore and clear.
1869 If the desired scope isn't available by name, you may specify the number.
1873 This encompasses the entire LUN.
1875 Extent scope (0x01).
1877 Element scope (0x02).
1880 Specify the Relative Target Port.
1881 This only applies to the Register and Move service action of the Persistent
1882 Reserve Out command.
1884 Enable the SPEC_I_PT bit.
1885 This only applies to the Register service action of Persistent Reserve Out.
1886 You must also specify at least one Transport ID with
1888 if this option is set.
1889 If you specify a Transport ID, this option is automatically set.
1890 It is an error to specify this option for any service action other than
1893 Specify the reservation type.
1894 The reservation type may be specified by name or by number.
1895 If the desired reservation type isn't available by name, you may specify
1897 Supported reservation type names:
1902 Write Exclusive mode.
1903 May also be specified as
1904 .Dq write_exclusive .
1906 Read Exclusive mode.
1907 May also be specified as
1908 .Dq read_exclusive .
1910 Exclusive access mode.
1911 May also be specified as
1912 .Dq exclusive_access .
1914 Write Exclusive Registrants Only mode.
1915 May also be specified as
1916 .Dq write_exclusive_reg_only .
1918 Exclusive Access Registrants Only mode.
1919 May also be specified as
1920 .Dq exclusive_access_reg_only .
1922 Write Exclusive All Registrants mode.
1923 May also be specified as
1924 .Dq write_exclusive_all_regs .
1926 Exclusive Access All Registrants mode.
1927 May also be specified as
1928 .Dq exclusive_access_all_regs .
1931 Specify that the target should unregister the initiator that sent
1932 the Register and Move request.
1933 By default, the target will not unregister the initiator that sends the
1934 Register and Move request.
1935 This option only applies to the Register and Move service action of the
1936 Persistent Reserve Out command.
1941 READ or WRITE ATTRIBUTE commands.
1942 These commands are used to read and write attributes in Medium Auxiliary
1944 The most common place Medium Auxiliary Memory is found is small flash chips
1945 included tape cartriges.
1953 option must be specified.
1956 Specify the READ ATTRIBUTE service action.
1959 Issue the ATTRIBUTE VALUES service action.
1960 Read and decode the available attributes and their values.
1962 Issue the ATTRIBUTE LIST service action.
1963 List the attributes that are available to read and write.
1965 Issue the LOGICAL VOLUME LIST service action.
1966 List the available logical volumes in the MAM.
1968 Issue the PARTITION LIST service action.
1969 List the available partitions in the MAM.
1971 Issue the SUPPORTED ATTRIBUTES service action.
1972 List attributes that are supported for reading or writing.
1973 These attributes may or may not be currently present in the MAM.
1976 Specify an attribute to write to the MAM.
1977 This option is not yet implemented.
1979 Specify the attribute number to display.
1980 This option only works with the attr_values, attr_list and supp_attr
1984 Display cached attributes.
1985 If the device supports this flag, it allows displaying attributes for the
1986 last piece of media loaded in the drive.
1988 Specify the element address.
1989 This is used for specifying which element number in a medium changer to
1990 access when reading attributes.
1991 The element number could be for a picker, portal, slot or drive.
1992 .It Fl F Ar form1,form2
1993 Specify the output format for the attribute values (attr_val) display as a
1994 comma separated list of options.
1995 The default output is currently set to field_all,nonascii_trim,text_raw.
1996 Once this code is ported to FreeBSD 10, any text fields will be converted
1997 from their codeset to the user's native codeset with
2000 The text options are mutually exclusive; if you specify more than one, you
2001 will get unpredictable results.
2002 The nonascii options are also mutually exclusive.
2003 Most of the field options may be logically ORed together.
2006 Print text fields with non-ASCII characters escaped.
2008 Print text fields natively, with no codeset conversion.
2010 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2011 escape the non-ASCII characters.
2013 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2014 omit the non-ASCII characters.
2016 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2017 print them as they are.
2019 Print all of the prefix fields: description, attribute number, attribute
2020 size, and the attribute's readonly status.
2021 If field_all is specified, specifying any other field options will not have
2024 Print none of the prefix fields, and only print out the attribute value.
2025 If field_none is specified, specifying any other field options will result
2026 in those fields being printed.
2028 Print out the attribute description.
2030 Print out the attribute number.
2032 Print out the attribute size.
2034 Print out the attribute's readonly status.
2037 Specify the partition.
2038 When the media has multiple partitions, specifying different partition
2039 numbers allows seeing the values for each individual partition.
2040 .It Fl s Ar start_num
2041 Specify the starting attribute number.
2042 This requests that the target device return attribute information starting
2043 at the given number.
2044 .It Fl T Ar elem_type
2045 Specify the element type.
2046 For medium changer devices, this allows specifying the type the element
2047 referenced in the element address (
2058 Specify the number of the logical volume to operate on.
2059 If the media has multiple logical volumes, this will allow displaying
2060 or writing attributes on the given logical volume.
2062 Issue the REPORT SUPPORTED OPCODES service action of the
2066 Without arguments, this command will return a list of all
2068 commands supported by the device, including service actions of commands
2069 that support service actions.
2070 It will also include the
2072 CDB (Command Data Block) length for each command, and the description of
2073 each command if it is known.
2076 Request information on a specific opcode instead of the list of supported
2078 If supported, the target will return a CDB-like structure that indicates
2079 the opcode, service action (if any), and a mask of bits that are supported
2081 .It Fl s Ar service_action
2082 For commands that support a service action, specify the service action to
2085 If a service action is specified for a given opcode, and the device does
2086 not support the given service action, the device should not return a
2088 error, but rather indicate in the returned parameter data that the command
2090 By default, if a service action is specified for an opcode, and service
2091 actions are not supported for the opcode in question, the device will
2094 Include timeout values.
2095 This option works with the default display, which includes all commands
2096 supported by the device, and with the
2100 options, which request information on a specific command and service
2102 This requests that the device report Nominal and Recommended timeout values
2103 for the given command or commands.
2104 The timeout values are in seconds.
2105 The timeout descriptor also includes a command-specific
2108 Print out verbose usage information.
2113 variable allows the user to specify an alternate mode page format file.
2117 variable determines which text editor
2119 starts when editing mode pages.
2121 .Bl -tag -width /usr/share/misc/scsi_modes -compact
2122 .It Pa /usr/share/misc/scsi_modes
2123 is the SCSI mode format database.
2125 is the transport layer device.
2127 are the CAM application passthrough devices.
2130 .Dl camcontrol eject -n cd -u 1 -v
2132 Eject the CD from cd1, and print SCSI sense information if the command
2135 .Dl camcontrol tur da0
2137 Send the SCSI test unit ready command to da0.
2140 utility will report whether the disk is ready, but will not display sense
2141 information if the command fails since the
2143 switch was not specified.
2144 .Bd -literal -offset indent
2145 camcontrol tur da1 -E -C 4 -t 50 -v
2148 Send a test unit ready command to da1.
2149 Enable kernel error recovery.
2150 Specify a retry count of 4, and a timeout of 50 seconds.
2154 flag) if the command fails.
2155 Since error recovery is turned on, the
2156 disk will be spun up if it is not currently spinning.
2159 utility will report whether the disk is ready.
2160 .Bd -literal -offset indent
2161 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
2162 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
2165 Issue a READ BUFFER command (0x3C) to cd1.
2166 Display the buffer size of cd1,
2167 and display the first 10 bytes from the cache on cd1.
2169 information if the command fails.
2170 .Bd -literal -offset indent
2171 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
2172 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
2175 Issue a WRITE BUFFER (0x3B) command to cd1.
2176 Write out 10 bytes of data,
2177 not including the (reserved) 4 byte header.
2178 Print out sense information if
2180 Be very careful with this command, improper use may
2181 cause data corruption.
2182 .Bd -literal -offset indent
2183 camcontrol modepage da3 -m 1 -e -P 3
2186 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
2187 settings on the drive.
2188 Mode page 1 contains a disk drive's auto read and
2189 write reallocation settings, among other things.
2191 .Dl camcontrol rescan all
2193 Rescan all SCSI busses in the system for devices that have been added,
2196 .Dl camcontrol rescan 0
2198 Rescan SCSI bus 0 for devices that have been added, removed or changed.
2200 .Dl camcontrol rescan 0:1:0
2202 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
2205 .Dl camcontrol tags da5 -N 24
2207 Set the number of concurrent transactions for da5 to 24.
2208 .Bd -literal -offset indent
2209 camcontrol negotiate -n da -u 4 -T disable
2212 Disable tagged queueing for da4.
2213 .Bd -literal -offset indent
2214 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
2217 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
2219 Test Unit Ready command to make the settings take effect.
2220 .Bd -literal -offset indent
2221 camcontrol smpcmd ses0 -v -r 4 "40 0 00 0" -R 1020 "s9 i1"
2224 Send the SMP REPORT GENERAL command to ses0, and display the number of PHYs
2226 Display SMP errors if the command fails.
2227 .Bd -literal -offset indent
2228 camcontrol security ada0
2231 Report security support and settings for ada0
2232 .Bd -literal -offset indent
2233 camcontrol security ada0 -U user -s MyPass
2236 Enable security on device ada0 with the password MyPass
2237 .Bd -literal -offset indent
2238 camcontrol security ada0 -U user -e MyPass
2241 Secure erase ada0 which has had security enabled with user password MyPass
2243 .Em WARNING! WARNING! WARNING!
2247 data from the device, so backup your data before using!
2249 This command can be used against an SSD drive to restoring it to
2250 factory default write performance.
2251 .Bd -literal -offset indent
2255 Report HPA support and settings for ada0 (also reported via
2257 .Bd -literal -offset indent
2258 camcontrol hpa ada0 -s 10240
2261 Enables HPA on ada0 setting the maximum reported sectors to 10240.
2263 .Em WARNING! WARNING! WARNING!
2267 to all data on the device beyond this limit until HPA is disabled by setting
2268 HPA to native max sectors of the device, which can only be done after a
2269 power-on or hardware reset!
2272 use this on a device which has an active filesystem!
2274 .Bd -literal -offset indent
2275 camcontrol persist da0 -v -i read_keys
2278 This will read any persistent reservation keys registered with da0, and
2279 display any errors encountered when sending the PERSISTENT RESERVE IN
2282 .Bd -literal -offset indent
2283 camcontrol persist da0 -v -o register -a -K 0x12345678
2286 This will register the persistent reservation key 0x12345678 with da0,
2287 apply that registration to all ports on da0, and display any errors that
2288 occur when sending the PERSISTENT RESERVE OUT command.
2289 .Bd -literal -offset indent
2290 camcontrol persist da0 -v -o reserve -s lun -k 0x12345678 -T ex_ac
2293 This will reserve da0 for the exlusive use of the initiator issuing the
2295 The scope of the reservation is the entire LUN.
2296 Any errors sending the PERSISTENT RESERVE OUT command will be displayed.
2297 .Bd -literal -offset indent
2298 camcontrol persist da0 -v -i read_full
2301 This will display the full status of all reservations on da0 and print out
2302 status if there are any errors.
2303 .Bd -literal -offset indent
2304 camcontrol persist da0 -v -o release -k 0x12345678 -T ex_ac
2307 This will release a reservation on da0 of the type ex_ac
2309 The Reservation Key for this registration is 0x12345678.
2310 Any errors that occur will be displayed.
2311 .Bd -literal -offset indent
2312 camcontrol persist da0 -v -o register -K 0x12345678 -S \e
2313 -I sas,0x1234567812345678 -I sas,0x8765432187654321
2316 This will register the key 0x12345678 with da0, specifying that it applies
2317 to the SAS initiators with SAS addresses 0x1234567812345678 and
2319 .Bd -literal -offset indent
2320 camcontrol persist da0 -v -o register_move -k 0x87654321 \e
2321 -K 0x12345678 -U -p -R 2 -I fcp,0x1234567812345678
2324 This will move the registration from the current initiator, whose
2325 Registration Key is 0x87654321, to the Fibre Channel initiator with the
2326 Fiber Channel World Wide Node Name 0x1234567812345678.
2327 A new registration key, 0x12345678, will be registered for the initiator
2328 with the Fibre Channel World Wide Node Name 0x1234567812345678, and the
2329 current initiator will be unregistered from the target.
2330 The reservation will be moved to relative target port 2 on the target
2332 The registration will persist across power losses.
2334 .Bd -literal -offset indent
2335 camcontrol attrib sa0 -v -i attr_values -p 1
2338 This will read and decode the attribute values from partition 1 on the tape
2339 in tape drive sa0, and will display any
2344 .Xr cam_cdbparse 3 ,
2351 utility first appeared in
2354 The mode page editing code and arbitrary SCSI command code are based upon
2359 library, written by Julian Elischer and Peter Dufault.
2362 program first appeared in
2364 and first appeared in
2369 .An Kenneth Merry Aq Mt ken@FreeBSD.org
2371 The code that parses the generic command line arguments does not know that
2372 some of the subcommands take multiple arguments.
2373 So if, for instance, you
2374 tried something like this:
2375 .Bd -literal -offset indent
2376 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
2379 The sense information from the test unit ready command would not get
2380 printed out, since the first
2384 bails out when it sees the second argument to
2388 Fixing this behavior would take some gross code, or changes to the
2391 The best way to circumvent this problem is to always make sure
2394 arguments before any command-specific arguments.
projects / FreeBSD / stable / 10.git / blob