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
102 .Aq all | bus Ns Op :target:lun
105 .Aq all | bus Ns Op :target:lun
121 .Aq Fl m Ar page | Fl l
129 .Aq Fl a Ar cmd Op args
130 .Aq Fl c Ar cmd Op args
133 .Op Fl i Ar len Ar fmt
135 .Op Fl o Ar len Ar fmt Op args
142 .Aq Fl r Ar len Ar fmt Op args
143 .Aq Fl R Ar len Ar fmt Op args
155 .Op Fl o Ar operation
159 .Op Fl T Ar pp_timeout
160 .Op Fl a Ar enable|disable
161 .Op Fl A Ar enable|disable
162 .Op Fl s Ar enable|disable
163 .Op Fl S Ar enable|disable
184 .Aq all|off|bus Ns Op :target Ns Op :lun
197 .Op Fl D Ar enable|disable
202 .Op Fl T Ar enable|disable
204 .Op Fl W Ar bus_width
218 .Aq Fl a Ar overwrite | block | crypto | exitfailure
268 .Op Fl l Ar high|maximum
272 .Op Fl U Ar user|master
283 .Op Fl s Ar max_sectors
290 .Aq Fl i Ar action | Fl o Ar action
296 .Op Fl R Ar rel_tgt_port
305 .Aq Fl r Ar action | Fl w Ar attrib
308 .Op Fl e Ar elem_addr
309 .Op Fl F Ar form1,form2
311 .Op Fl s Ar start_addr
312 .Op Fl T Ar elem_type
319 .Op Fl s Ar service_action
327 utility is designed to provide a way for users to access and control the
334 can cause a loss of data and/or system crashes if used improperly.
336 expert users are encouraged to exercise caution when using this command.
337 Novice users should stay away from this utility.
341 utility has a number of primary functions, many of which support an optional
343 A device identifier can take one of three forms:
346 Specify a device name and unit number combination, like "da5" or "cd3".
348 Specify a bus number and target id.
349 The bus number can be determined from
351 .Dq camcontrol devlist .
352 The lun defaults to 0.
354 Specify the bus, target and lun for a device.
358 The device identifier, if it is specified,
360 come immediately after the function name, and before any generic or
361 function-specific arguments.
366 arguments described below will override any device name or unit number
367 specified beforehand.
374 override a specified bus:target or bus:target:lun, however.
378 primary functions support these generic arguments:
381 SCSI command retry count.
382 In order for this to work, error recovery
386 Instruct the kernel to perform generic SCSI error recovery for the given
388 This is needed in order for the retry count
391 Other than retrying commands, the generic error recovery in
392 the code will generally attempt to spin up drives that are not spinning.
393 It may take some other actions, depending upon the sense code returned from
396 Specify the device type to operate on, e.g.\& "da", "cd".
398 SCSI command timeout in seconds.
399 This overrides the default timeout for
401 .It Fl u Ar unit_number
402 Specify the device unit number, e.g.\& "1", "5".
404 Be verbose, print out sense information for failed SCSI commands.
407 Primary command functions:
408 .Bl -tag -width periphlist
410 List all physical devices (logical units) attached to the CAM subsystem.
411 This also includes a list of peripheral drivers attached to each device.
414 argument, SCSI bus number, adapter name and unit numbers are printed as
416 On the other hand, with the
418 argument, only the bus adapter, and unit information will be printed, and
419 device information will be omitted.
421 List all peripheral drivers attached to a given physical device (logical
424 Send the SCSI test unit ready (0x00) command to the given device.
427 utility will report whether the device is ready or not.
429 Send a SCSI inquiry command (0x12) to a device.
432 will print out the standard inquiry data, device serial number, and
433 transfer rate information.
434 The user can specify that only certain types of
435 inquiry data be printed:
438 Get the standard inquiry data.
440 Print out the serial number.
441 If this flag is the only one specified,
443 will not print out "Serial Number" before the value returned by the drive.
444 This is to aid in script writing.
446 Print out transfer rate information.
449 Send a ATA identify command (0xec) to a device.
451 Send the SCSI REPORT LUNS (0xA0) command to the given device.
454 will print out the list of logical units (LUNs) supported by the target device.
455 There are a couple of options to modify the output:
458 Just print out a count of LUNs, not the actual LUN numbers.
460 Just print out the LUNs, and do not print out the count.
461 .It Fl r Ar reporttype
462 Specify the type of report to request from the target:
463 .Bl -tag -width 012345678
465 Return the default report.
469 Most targets will support this report if they support the REPORT LUNS
472 Return only well known LUNs.
474 Return all available LUNs.
479 will try to print out LUN numbers in a reasonable format.
480 It can understand the peripheral, flat, LUN and extended LUN formats.
482 Send the SCSI READ CAPACITY command to the given device and display
484 If the device is larger than 2TB, the SCSI READ CAPACITY (16) service
485 action will be sent to obtain the full size of the device.
488 will print out the last logical block of the device, and the blocksize of
490 To modify the output format, use the following options:
493 Just print out the blocksize, not the last block or device size.
494 This cannot be used with
499 Print out the device size in human readable (base 2, 1K == 1024) format.
502 and cannot be used with
507 Print out the device size in human readable (base 10, 1K == 1000) format.
509 Print out the number of blocks in the device instead of the last logical
512 Quiet, print out the numbers only (separated by a comma if
518 Print out the last logical block or the size of the device only, and omit
522 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
525 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
528 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
529 start bit set and the load/eject bit set.
531 Send the SCSI Start/Stop Unit (0x1B) command to the given device with the
532 start bit cleared and the load/eject bit set.
534 Tell the kernel to scan all busses in the system (with the
536 argument), the given bus (XPT_SCAN_BUS), or bus:target:lun
537 (XPT_SCAN_LUN) for new devices or devices that have gone away.
539 may specify a scan of all busses, a single bus, or a lun.
541 on a target is not supported.
543 Tell the kernel to reset all busses in the system (with the
545 argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus
546 reset for that bus, or to reset the given bus:target:lun
547 (XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after
548 connecting to that device.
549 Note that this can have a destructive impact
554 READ DEFECT DATA (10) command (0x37) or the
556 READ DEFECT DATA (12) command (0xB7) to the given device, and
557 print out any combination of: the total number of defects, the primary
558 defect list (PLIST), and the grown defect list (GLIST).
561 Specify the requested format of the defect list.
562 The format argument is
564 Most drives support the physical sector format.
566 support the logical block format.
567 Many drives, if they do not support the
568 requested format, return the data in an alternate format, along with sense
569 information indicating that the requested data format is not supported.
573 attempts to detect this, and print out whatever format the drive returns.
574 If the drive uses a non-standard sense code to report that it does not
575 support the requested format,
577 will probably see the error as a failure to complete the request.
579 The format options are:
582 Print out the list as logical blocks.
583 This is limited to 32-bit block sizes, and isn't supported by many modern
586 Print out the list as logical blocks.
587 This option uses a 64-bit block size.
589 Print out the list in bytes from index format.
591 Print out the list in extended bytes from index format.
592 The extended format allows for ranges of blocks to be printed.
594 Print out the list in physical sector format.
595 Most drives support this format.
597 Print out the list in extended physical sector format.
598 The extended format allows for ranges of blocks to be printed.
602 Print out the grown defect list.
603 This is a list of bad blocks that have
604 been remapped since the disk left the factory.
606 Print out the primary defect list.
607 This is the list of defects that were present in the factory.
609 When printing status information with
611 only print the number of defects.
613 Just print the number of defects, not the list of defects.
615 Specify the starting offset into the defect list.
616 This implies using the
618 READ DEFECT DATA (12) command, as the 10 byte version of the command
619 doesn't support the address descriptor index field.
620 Not all drives support the 12 byte command, and some drives that support
621 the 12 byte command don't support the address descriptor index field.
623 Print out defects in hexadecimal (base 16) form instead of base 10 form.
632 will print out the number of defects given in the READ DEFECT DATA header
633 returned from the drive.
634 Some drives will report 0 defects if neither the primary or grown defect
637 Allows the user to display and optionally edit a SCSI mode page.
639 page formats are located in
640 .Pa /usr/share/misc/scsi_modes .
641 This can be overridden by specifying a different file in the
643 environment variable.
646 command takes several arguments:
649 Disable block descriptors for mode sense.
651 Displays mode page data in binary format.
653 This flag allows the user to edit values in the mode page.
655 either edit mode page values with the text editor pointed to by his
657 environment variable, or supply mode page values via standard input, using
660 uses to display mode page values.
661 The editor will be invoked if
663 detects that standard input is terminal.
665 Lists all available mode pages.
666 .It Fl m Ar mode_page
667 This specifies the number of the mode page the user would like to view
669 This argument is mandatory unless
673 This allows the user to specify the page control field.
675 .Bl -tag -width xxx -compact
687 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
690 function requires the
692 argument to specify SCSI CDB or the
694 argument to specify ATA Command Block registers values.
695 Other arguments are optional, depending on
697 The command and data specification syntax is documented
700 NOTE: If the CDB specified causes data to be transferred to or from the
701 SCSI device in question, you MUST specify either
706 .It Fl a Ar cmd Op args
707 This specifies the content of 12 ATA Command Block registers (command,
708 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
709 lba_high_exp, features_exp, sector_count, sector_count_exp).
710 .It Fl c Ar cmd Op args
711 This specifies the SCSI CDB.
712 SCSI CDBs may be 6, 10, 12 or 16 bytes.
714 Specifies DMA protocol to be used for ATA command.
716 Specifies FPDMA (NCQ) protocol to be used for ATA command.
717 .It Fl i Ar len Ar fmt
718 This specifies the amount of data to read, and how it should be displayed.
722 bytes of data will be read from the device and written to standard output.
723 .It Fl o Ar len Ar fmt Op args
724 This specifies the amount of data to be written to a device, and the data
725 that is to be written.
729 bytes of data will be read from standard input and written to the device.
731 This specifies that 11 result ATA Command Block registers should be displayed
732 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
733 lba_high_exp, sector_count, sector_count_exp), and how.
736 11 result registers will be written to standard output in hex.
739 Allows the user to send an arbitrary Serial
740 Management Protocol (SMP) command to a device.
743 function requires the
745 argument to specify the SMP request to be sent, and the
747 argument to specify the format of the SMP response.
748 The syntax for the SMP request and response arguments is documented in
751 Note that SAS adapters that support SMP passthrough (at least the currently
752 known adapters) do not accept CRC bytes from the user in the request and do
753 not pass CRC bytes back to the user in the response.
754 Therefore users should not include the CRC bytes in the length of the
755 request and not expect CRC bytes to be returned in the response.
757 .It Fl r Ar len Ar fmt Op args
758 This specifies the size of the SMP request, without the CRC bytes, and the
763 bytes of data will be read from standard input and written as the SMP
765 .It Fl R Ar len Ar fmt Op args
766 This specifies the size of the buffer allocated for the SMP response, and
767 the SMP response format.
771 bytes of data will be allocated for the response and the response will be
772 written to standard output.
775 Allows the user to send the Serial Management Protocol (SMP) Report General
778 will display the data returned by the Report General command.
779 If the SMP target supports the long response format, the additional data
780 will be requested and displayed automatically.
783 Request the long response format only.
784 Not all SMP targets support the long response format.
787 to skip sending the initial report general request without the long bit set
788 and only issue a report general request with the long bit set.
791 Allows the user to issue the Serial Management Protocol (SMP) PHY Control
793 This function should be used with some caution, as it can render devices
794 inaccessible, and could potentially cause data corruption as well.
797 argument is required to specify the PHY to operate on.
800 Specify the PHY to operate on.
801 This argument is required.
803 Request the long request/response format.
804 Not all SMP targets support the long response format.
805 For the PHY Control command, this currently only affects whether the
806 request length is set to a value other than 0.
807 .It Fl o Ar operation
808 Specify a PHY control operation.
811 operation may be specified.
812 The operation may be specified numerically (in decimal, hexadecimal, or octal)
813 or one of the following operation names may be specified:
817 It is not necessary to specify this argument.
819 Send the LINK RESET command to the phy.
821 Send the HARD RESET command to the phy.
823 Send the DISABLE command to the phy.
824 Note that the LINK RESET or HARD RESET commands should re-enable the phy.
826 Send the CLEAR ERROR LOG command.
827 This clears the error log counters for the specified phy.
829 Send the CLEAR AFFILIATION command.
830 This clears the affiliation from the STP initiator port with the same SAS
831 address as the SMP initiator that requests the clear operation.
833 Send the TRANSMIT SATA PORT SELECTION SIGNAL command to the phy.
834 This will cause a SATA port selector to use the given phy as its active phy
835 and make the other phy inactive.
837 Send the CLEAR STP I_T NEXUS LOSS command to the PHY.
839 Send the SET ATTACHED DEVICE NAME command to the PHY.
842 argument to specify the device name.
845 Specify the attached device name.
846 This option is needed with the
849 The name is a 64-bit number, and can be specified in decimal, hexadecimal
852 Set the minimum physical link rate for the phy.
853 This is a numeric argument.
854 Currently known link rates are:
857 Do not change current value.
866 Other values may be specified for newer physical link rates.
868 Set the maximum physical link rate for the phy.
869 This is a numeric argument.
872 argument description for known link rate arguments.
873 .It Fl T Ar pp_timeout
874 Set the partial pathway timeout value, in microseconds.
879 specification for more information on this field.
880 .It Fl a Ar enable|disable
881 Enable or disable SATA slumber phy power conditions.
882 .It Fl A Ar enable|disable
883 Enable or disable SATA partial power conditions.
884 .It Fl s Ar enable|disable
885 Enable or disable SAS slumber phy power conditions.
886 .It Fl S Ar enable|disable
887 Enable or disable SAS partial phy power conditions.
890 List phys attached to a SAS expander, the address of the end device
891 attached to the phy, and the inquiry data for that device and peripheral
892 devices attached to that device.
893 The inquiry data and peripheral devices are displayed if available.
896 Turn on the long response format for the underlying SMP commands used for
899 Only print out phys that are attached to a device in the CAM EDT (Existing
903 Send the SMP Report Manufacturer Information command to the device and
904 display the response.
907 Turn on the long response format for the underlying SMP commands used for
911 Turn on CAM debugging printfs in the kernel.
912 This requires options CAMDEBUG
913 in your kernel config file.
914 WARNING: enabling debugging printfs currently
915 causes an EXTREME number of kernel printfs.
916 You may have difficulty
917 turning off the debugging printfs once they start, since the kernel will be
918 busy printing messages and unable to service other requests quickly.
921 function takes a number of arguments:
924 Enable CAM_DEBUG_INFO printfs.
926 Enable CAM_DEBUG_PERIPH printfs.
928 Enable CAM_DEBUG_TRACE printfs.
930 Enable CAM_DEBUG_SUBTRACE printfs.
932 Enable CAM_DEBUG_XPT printfs.
934 Enable CAM_DEBUG_CDB printfs.
935 This will cause the kernel to print out the
936 SCSI CDBs sent to the specified device(s).
938 Enable CAM_DEBUG_PROBE printfs.
940 Enable debugging for all devices.
942 Turn off debugging for all devices
943 .It bus Ns Op :target Ns Op :lun
944 Turn on debugging for the given bus, target or lun.
946 and lun are not specified, they are wildcarded.
947 (i.e., just specifying a
948 bus turns on debugging printfs for all devices on that bus.)
951 Show or set the number of "tagged openings" or simultaneous transactions
952 we attempt to queue to a particular device.
955 command, with no command-specific arguments (i.e., only generic arguments)
956 prints out the "soft" maximum number of transactions that can be queued to
957 the device in question.
958 For more detailed information, use the
960 argument described below.
963 Set the number of tags for the given device.
964 This must be between the
965 minimum and maximum number set in the kernel quirk table.
967 most devices that support tagged queueing is a minimum of 2 and a maximum
969 The minimum and maximum values for a given device may be
970 determined by using the
977 subcommand is described below.
979 Be quiet, and do not report the number of tags.
980 This is generally used when
981 setting the number of tags.
983 The verbose flag has special functionality for the
988 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
991 This is the amount of capacity for transactions queued to a given device.
993 This is the number of transactions currently queued to a device.
995 This is the kernel queue space for transactions.
996 This count usually mirrors
997 dev_openings except during error recovery operations when
998 the device queue is frozen (device is not allowed to receive
999 commands), the number of dev_openings is reduced, or transaction
1000 replay is occurring.
1002 This is the number of transactions waiting in the kernel queue for capacity
1004 This number is usually zero unless error recovery is in
1007 The held count is the number of CCBs held by peripheral drivers that have
1008 either just been completed or are about to be released to the transport
1009 layer for service by a device.
1010 Held CCBs reserve capacity on a given
1013 This is the current "hard" minimum number of transactions that can be
1014 queued to a device at once.
1017 value above cannot go below this number.
1018 The default value for
1020 is 2, although it may be set higher or lower for various devices.
1022 This is the "hard" maximum number of transactions that can be queued to a
1026 value cannot go above this number.
1027 The default value for
1029 is 255, although it may be set higher or lower for various devices.
1033 Show or negotiate various communication parameters.
1034 Some controllers may
1035 not support setting or changing some of these values.
1037 Adaptec 174x controllers do not support changing a device's sync rate or
1042 will not attempt to set the parameter if the controller indicates that it
1043 does not support setting the parameter.
1044 To find out what the controller
1052 command is described below.
1053 Also, some controller drivers do not support
1054 setting negotiation parameters, even if the underlying controller supports
1055 negotiation changes.
1056 Some controllers, such as the Advansys wide
1057 controllers, support enabling and disabling synchronous negotiation for
1058 a device, but do not support setting the synchronous negotiation rate.
1061 Attempt to make the negotiation settings take effect immediately by sending
1062 a Test Unit Ready command to the device.
1064 Show or set current negotiation settings.
1065 This is the default.
1066 .It Fl D Ar enable|disable
1067 Enable or disable disconnection.
1071 Set the command delay offset.
1073 Be quiet, do not print anything.
1074 This is generally useful when you want to
1075 set a parameter, but do not want any status information.
1076 .It Fl R Ar syncrate
1077 Change the synchronization rate for a device.
1078 The sync rate is a floating
1079 point value specified in MHz.
1082 is a legal value, as is
1084 .It Fl T Ar enable|disable
1085 Enable or disable tagged queueing for a device.
1087 Show or set user negotiation settings.
1088 The default is to show or set
1089 current negotiation settings.
1091 The verbose switch has special meaning for the
1096 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
1098 .It Fl W Ar bus_width
1099 Specify the bus width to negotiate with a device.
1102 The only useful values to specify are 8, 16, and 32
1104 The controller must support the bus width in question in order for
1105 the setting to take effect.
1108 In general, sync rate and offset settings will not take effect for a
1109 device until a command has been sent to the device.
1112 switch above will automatically send a Test Unit Ready to the device so
1113 negotiation parameters will take effect.
1117 FORMAT UNIT command to the named device.
1119 .Em WARNING! WARNING! WARNING!
1121 Low level formatting a disk will destroy ALL data on the disk.
1123 extreme caution when issuing this command.
1124 Many users low-level format
1125 disks that do not really need to be low-level formatted.
1127 relatively few scenarios that call for low-level formatting a disk.
1129 low-level formatting a disk is to initialize the disk after changing
1130 its physical sector size.
1131 Another reason for low-level formatting a disk
1132 is to revive the disk if you are getting "medium format corrupted" errors
1133 from the disk in response to read and write requests.
1135 Some disks take longer than others to format.
1136 Users should specify a
1137 timeout long enough to allow the format to complete.
1139 timeout is 3 hours, which should be long enough for most disks.
1141 disks will complete a format operation in a very short period of time
1142 (on the order of 5 minutes or less).
1143 This is often because the drive
1144 does not really support the FORMAT UNIT command -- it just accepts the
1145 command, waits a few minutes and then returns it.
1149 subcommand takes several arguments that modify its default behavior.
1154 arguments can be useful for scripts.
1157 Be quiet, do not print any status messages.
1158 This option will not disable
1159 the questions, however.
1160 To disable questions, use the
1167 This will report status on a format that is already running on the drive.
1169 Issue a non-immediate format command.
1172 issues the FORMAT UNIT command with the immediate bit set.
1174 device to immediately return the format command, before the format has
1180 sense information from the device every second to determine how far along
1181 in the format process it is.
1184 argument is specified,
1186 will issue a non-immediate format command, and will be unable to print any
1187 information to let the user know what percentage of the disk has been
1190 Do not ask any questions.
1193 will ask the user if he/she really wants to format the disk in question,
1194 and also if the default format command timeout is acceptable.
1196 will not be asked about the timeout if a timeout is specified on the
1202 SANITIZE command to the named device.
1204 .Em WARNING! WARNING! WARNING!
1206 ALL data in the cache and on the disk will be destroyed or made inaccessible.
1207 Recovery of the data is not possible.
1208 Use extreme caution when issuing this command.
1212 subcommand takes several arguments that modify its default behavior.
1217 arguments can be useful for scripts.
1219 .It Fl a Ar operation
1220 Specify the sanitize operation to perform.
1223 Perform an overwrite operation by writing a user supplied
1224 data pattern to the device one or more times.
1225 The pattern is given by the
1228 The number of times is given by the
1232 Perform a block erase operation.
1233 All the device's blocks are set to a vendor defined
1234 value, typically zero.
1236 Perform a cryptographic erase operation.
1237 The encryption keys are changed to prevent the decryption
1240 Exits a previously failed sanitize operation.
1241 A failed sanitize operation can only be exited if it was
1242 run in the unrestricted completion mode, as provided by the
1247 The number of passes when performing an
1250 Valid values are between 1 and 31.
1255 operation, the pattern is inverted between consecutive passes.
1257 Path to the file containing the pattern to use when
1261 The pattern is repeated as needed to fill each block.
1263 Be quiet, do not print any status messages.
1264 This option will not disable
1265 the questions, however.
1266 To disable questions, use the
1270 Perform the sanitize in the unrestricted completion mode.
1271 If the operation fails, it can later be exited with the
1278 This will report status on a sanitize that is already running on the drive.
1280 Issue a non-immediate sanitize command.
1283 issues the SANITIZE command with the immediate bit set.
1285 device to immediately return the sanitize command, before
1286 the sanitize has actually completed.
1291 sense information from the device every second to determine how far along
1292 in the sanitize process it is.
1295 argument is specified,
1297 will issue a non-immediate sanitize command, and will be unable to print any
1298 information to let the user know what percentage of the disk has been
1301 Do not ask any questions.
1304 will ask the user if he/she really wants to sanitize the disk in question,
1305 and also if the default sanitize command timeout is acceptable.
1307 will not be asked about the timeout if a timeout is specified on the
1311 Put ATA device into IDLE state.
1314 specifies automatic standby timer value in seconds.
1315 Value 0 disables timer.
1317 Put ATA device into STANDBY state.
1320 specifies automatic standby timer value in seconds.
1321 Value 0 disables timer.
1323 Put ATA device into SLEEP state.
1324 Note that the only way get device out of
1325 this state may be reset.
1327 It optional parameter
1329 specified, enables and sets advanced power management level, where
1330 1 -- minimum power, 127 -- maximum performance with standby,
1331 128 -- minimum power without standby, 254 -- maximum performance.
1332 If not specified -- APM is disabled.
1334 It optional parameter
1336 specified, enables and sets automatic acoustic management level, where
1337 1 -- minimum noise, 254 -- maximum performance.
1338 If not specified -- AAM is disabled.
1340 Update or report security settings, using an ATA identify command (0xec).
1343 will print out the security support and associated settings of the device.
1346 command takes several arguments:
1350 Disable device security using the given password for the selected user according
1351 to the devices configured security level.
1354 Erase the device using the given password for the selected user.
1356 .Em WARNING! WARNING! WARNING!
1358 Issuing a secure erase will
1360 user data on the device and may take several hours to complete.
1362 When this command is used against an SSD drive all its cells will be marked as
1363 empty, restoring it to factory default write performance.
1364 For SSD's this action
1365 usually takes just a few seconds.
1368 Freeze the security configuration of the specified device.
1370 After command completion any other commands that update the device lock mode
1371 shall be command aborted.
1372 Frozen mode is disabled by power-off or hardware reset.
1375 Enhanced erase the device using the given password for the selected user.
1377 .Em WARNING! WARNING! WARNING!
1379 Issuing an enhanced secure erase will
1381 user data on the device and may take several hours to complete.
1383 An enhanced erase writes predetermined data patterns to all user data areas,
1384 all previously written user data shall be overwritten, including sectors that
1385 are no longer in use due to reallocation.
1388 Unlock the device using the given password for the selected user according to
1389 the devices configured security level.
1390 .It Fl l Ar high|maximum
1392 Specifies which security level to set when issuing a
1395 The security level determines device behavior when the master
1396 password is used to unlock the device.
1397 When the security level is set to high
1398 the device requires the unlock command and the master password to unlock.
1399 When the security level is set to maximum the device requires a secure erase
1400 with the master password to unlock.
1402 This option must be used in conjunction with one of the security action commands.
1408 Be quiet, do not print any status messages.
1409 This option will not disable the questions, however.
1410 To disable questions, use the
1415 Password the device (enable security) using the given password for the selected
1417 This option can be combined with other options such as
1420 A master password may be set in a addition to the user password. The purpose of
1421 the master password is to allow an administrator to establish a password that
1422 is kept secret from the user, and which may be used to unlock the device if the
1423 user password is lost.
1426 Setting the master password does not enable device security.
1428 If the master password is set and the drive supports a Master Revision Code
1429 feature the Master Password Revision Code will be decremented.
1432 Overrides the default timeout, specified in seconds, used for both
1436 this is useful if your system has problems processing long timeouts correctly.
1438 Usually the timeout is calculated from the information stored on the drive if
1439 present, otherwise it defaults to 2 hours.
1440 .It Fl U Ar user|master
1442 Specifies which user to set / use for the running action command, valid values
1443 are user or master and defaults to master if not set.
1445 This option must be used in conjunction with one of the security action commands.
1451 Confirm yes to dangerous options such as
1453 without prompting for confirmation.
1456 If the password specified for any action commands does not match the configured
1457 password for the specified user the command will fail.
1459 The password in all cases is limited to 32 characters, longer passwords will
1462 Update or report Host Protected Area details.
1465 will print out the HPA support and associated settings of the device.
1468 command takes several optional arguments:
1472 Freeze the HPA configuration of the specified device.
1474 After command completion any other commands that update the HPA configuration
1475 shall be command aborted.
1476 Frozen mode is disabled by power-off or hardware reset.
1479 Lock the HPA configuration of the device until a successful call to unlock or
1480 the next power-on reset occurs.
1483 Make the HPA max sectors persist across power-on reset or a hardware reset.
1484 This must be used in combination with
1485 .Fl s Ar max_sectors
1489 Set the HPA configuration password required for unlock calls.
1492 Be quiet, do not print any status messages.
1493 This option will not disable the questions.
1494 To disable questions, use the
1497 .It Fl s Ar max_sectors
1499 Configures the maximum user accessible sectors of the device.
1500 This will change the number of sectors the device reports.
1502 .Em WARNING! WARNING! WARNING!
1504 Changing the max sectors of a device using this option will make the data on
1505 the device beyond the specified value inaccessible.
1508 .Fl s Ar max_sectors
1509 call can be made without a power-on reset or a hardware reset of the device.
1512 Unlock the HPA configuration of the specified device using the given password.
1513 If the password specified does not match the password configured via
1515 the command will fail.
1517 After 5 failed unlock calls, due to password miss-match, the device will refuse
1518 additional unlock calls until after a power-on reset.
1521 Confirm yes to dangerous options such as
1523 without prompting for confirmation
1526 The password for all HPA commands is limited to 32 characters, longer passwords
1529 Program firmware of the named
1531 or ATA device using the image file provided.
1535 device and it provides a recommended timeout for the WRITE BUFFER command
1538 opcodes subcommand), that timeout will be used for the firmware download.
1539 The drive-recommended timeout value may be overridden on the command line
1544 Current list of supported vendors for SCSI/SAS drives:
1547 Tested with 4TB SAS drives, model number HUS724040ALS640.
1551 Tested with LTO-5 (ULTRIUM-HH5) and LTO-6 (ULTRIUM-HH6) tape drives.
1552 There is a separate table entry for hard drives, because the update method
1553 for hard drives is different than the method for tape drives.
1558 Tested with SM1625 SSDs.
1560 Tested with Constellation ES (ST32000444SS), ES.2 (ST33000651SS) and
1561 ES.3 (ST1000NM0023) drives.
1563 Tested with 400GB Optimus SSDs (TXA2D20400GA6001).
1566 .Em WARNING! WARNING! WARNING!
1568 Little testing has been done to make sure that different device models from
1569 each vendor work correctly with the fwdownload command.
1570 A vendor name appearing in the supported list means only that firmware of at
1571 least one device type from that vendor has successfully been programmed with
1572 the fwdownload command.
1573 Extra caution should be taken when using this command since there is no
1574 guarantee it will not break a device from the listed vendors.
1575 Ensure that you have a recent backup of the data on the device before
1576 performing a firmware update.
1580 protocol devices will not be programmed, since there is little chance of
1581 the firmware download succeeding.
1584 will currently attempt a firmware download to any
1588 device, since the standard
1590 DOWNLOAD MICROCODE command may work.
1591 Firmware downloads to
1595 devices are supported for devices connected
1600 controllers, and devices connected to SAS controllers
1605 translation capability.
1611 PASS-THROUGH command to send the
1613 DOWNLOAD MICROCODE command to the drive.
1618 translation implementations don't work fully when translating
1620 WRITE BUFFER commands to
1622 DOWNLOAD MICROCODE commands, but do support
1624 passthrough well enough to do a firmware download.
1626 .It Fl f Ar fw_image
1627 Path to the firmware image file to be downloaded to the specified device.
1629 Do not print informational messages, only print errors.
1630 This option should be used with the
1632 option to suppress all output.
1634 Run in simulation mode.
1635 Device checks are run and the confirmation dialog is shown, but no firmware
1636 download will occur.
1642 errors in the event of a failure.
1644 In simulation mode, print out the
1649 register values that would be used for the firmware download command.
1651 Do not ask for confirmation.
1654 Persistent reservation support.
1655 Persistent reservations are a way to reserve a particular
1657 LUN for use by one or more
1662 option is specified,
1666 PERSISTENT RESERVE IN
1667 command using the requested service action.
1670 option is specified,
1674 PERSISTENT RESERVE OUT
1675 command using the requested service action.
1676 One of those two options is required.
1678 Persistent reservations are complex, and fully explaining them is outside
1679 the scope of this manual.
1682 and download the latest SPC spec for a full explanation of persistent
1686 Specify the service action for the PERSISTENT RESERVE IN command.
1687 Supported service actions:
1690 Report the current persistent reservation generation (PRgeneration) and any
1692 .It read_reservation
1693 Report the persistent reservation, if any.
1694 .It report_capabilities
1695 Report the persistent reservation capabilities of the LUN.
1696 .It read_full_status
1697 Report the full status of persistent reservations on the LUN.
1700 Specify the service action for the PERSISTENT RESERVE OUT command.
1701 For service actions like register that are components of other service
1702 action names, the entire name must be specified.
1703 Otherwise, enough of the service action name must be specified to
1704 distinguish it from other possible service actions.
1705 Supported service actions:
1708 Register a reservation key with the LUN or unregister a reservation key.
1709 To register a key, specify the requested key as the Service Action
1711 To unregister a key, specify the previously registered key as the
1713 To change a key, specify the old key as the Reservation Key and the new
1714 key as the Service Action Reservation Key.
1716 This is similar to the register subcommand, except that the Reservation Key
1718 The Service Action Reservation Key will overwrite any previous key
1719 registered for the initiator.
1721 Create a reservation.
1722 A key must be registered with the LUN before the LUN can be reserved, and
1723 it must be specified as the Reservation Key.
1724 The type of reservation must also be specified.
1725 The scope defaults to LUN scope (LU_SCOPE), but may be changed.
1727 Release a reservation.
1728 The Reservation Key must be specified.
1730 Release a reservation and remove all keys from the device.
1731 The Reservation Key must be specified.
1733 Remove a reservation belonging to another initiator.
1734 The Reservation Key must be specified.
1735 The Service Action Reservation Key may be specified, depending on the
1736 operation being performed.
1738 Remove a reservation belonging to another initiator and abort all
1739 outstanding commands from that initiator.
1740 The Reservation Key must be specified.
1741 The Service Action Reservation Key may be specified, depending on the
1742 operation being performed.
1744 Register another initiator with the LUN, and establish a reservation on the
1745 LUN for that initiator.
1746 The Reservation Key and Service Action Reservation Key must be specified.
1748 Replace Lost Reservation information.
1751 Set the All Target Ports (ALL_TG_PT) bit.
1752 This requests that the key registration be applied to all target ports and
1753 not just the particular target port that receives the command.
1754 This only applies to the register and register_ignore actions.
1756 Specify a Transport ID.
1757 This only applies to the Register and Register and Move service actions for
1758 Persistent Reserve Out.
1759 Multiple Transport IDs may be specified with multiple
1762 With the Register service action, specifying one or more Transport IDs
1763 implicitly enables the
1765 option which turns on the SPEC_I_PT bit.
1766 Transport IDs generally have the format protocol,id.
1769 A SAS Transport ID consists of
1771 followed by a 64-bit SAS address.
1774 .Dl sas,0x1234567812345678
1776 A Fibre Channel Transport ID consists of
1778 followed by a 64-bit Fibre Channel World Wide Name.
1781 .Dl fcp,0x1234567812345678
1783 A Parallel SCSI address consists of
1785 followed by a SCSI target ID and a relative target port identifier.
1790 An IEEE 1394 (Firewire) Transport ID consists of
1792 followed by a 64-bit EUI-64 IEEE 1394 node unique identifier.
1795 .Dl sbp,0x1234567812345678
1797 A SCSI over RDMA Transport ID consists of
1799 followed by a 128-bit RDMA initiator port identifier.
1800 The port identifier must be exactly 32 or 34 (if the leading 0x is
1801 included) hexadecimal digits.
1802 Only hexadecimal (base 16) numbers are supported.
1805 .Dl srp,0x12345678123456781234567812345678
1807 An iSCSI Transport ID consists an iSCSI name and optionally a separator and
1809 For example, if only the iSCSI name is specified:
1811 .Dl iqn.2012-06.com.example:target0
1813 If the iSCSI separator and initiator session ID are specified:
1815 .Dl iqn.2012-06.com.example:target0,i,0x123
1817 A SCSI over PCIe Transport ID consists of
1819 followed by a PCIe Routing ID.
1820 The Routing ID consists of a bus, device and function or in the alternate
1821 form, a bus and function.
1822 The bus must be in the range of 0 to 255 inclusive and the device must be
1823 in the range of 0 to 31 inclusive.
1824 The function must be in the range of 0 to 7 inclusive if the standard form
1825 is used, and in the range of 0 to 255 inclusive if the alternate form is
1827 For example, if a bus, device and function are specified for the standard
1832 If the alternate Routing ID form is used:
1837 Specify the Reservation Key.
1838 This may be in decimal, octal or hexadecimal format.
1839 The value is zero by default if not otherwise specified.
1840 The value must be between 0 and 2^64 - 1, inclusive.
1842 Specify the Service Action Reservation Key.
1843 This may be in decimal, octal or hexadecimal format.
1844 The value is zero by default if not otherwise specified.
1845 The value must be between 0 and 2^64 - 1, inclusive.
1847 Enable the Activate Persist Through Power Loss bit.
1848 This is only used for the register and register_ignore actions.
1849 This requests that the reservation persist across power loss events.
1851 Specify the scope of the reservation.
1852 The scope may be specified by name or by number.
1853 The scope is ignored for register, register_ignore and clear.
1854 If the desired scope isn't available by name, you may specify the number.
1858 This encompasses the entire LUN.
1860 Extent scope (0x01).
1862 Element scope (0x02).
1865 Specify the Relative Target Port.
1866 This only applies to the Register and Move service action of the Persistent
1867 Reserve Out command.
1869 Enable the SPEC_I_PT bit.
1870 This only applies to the Register service action of Persistent Reserve Out.
1871 You must also specify at least one Transport ID with
1873 if this option is set.
1874 If you specify a Transport ID, this option is automatically set.
1875 It is an error to specify this option for any service action other than
1878 Specify the reservation type.
1879 The reservation type may be specified by name or by number.
1880 If the desired reservation type isn't available by name, you may specify
1882 Supported reservation type names:
1887 Write Exclusive mode.
1888 May also be specified as
1889 .Dq write_exclusive .
1891 Read Exclusive mode.
1892 May also be specified as
1893 .Dq read_exclusive .
1895 Exclusive access mode.
1896 May also be specified as
1897 .Dq exclusive_access .
1899 Write Exclusive Registrants Only mode.
1900 May also be specified as
1901 .Dq write_exclusive_reg_only .
1903 Exclusive Access Registrants Only mode.
1904 May also be specified as
1905 .Dq exclusive_access_reg_only .
1907 Write Exclusive All Registrants mode.
1908 May also be specified as
1909 .Dq write_exclusive_all_regs .
1911 Exclusive Access All Registrants mode.
1912 May also be specified as
1913 .Dq exclusive_access_all_regs .
1916 Specify that the target should unregister the initiator that sent
1917 the Register and Move request.
1918 By default, the target will not unregister the initiator that sends the
1919 Register and Move request.
1920 This option only applies to the Register and Move service action of the
1921 Persistent Reserve Out command.
1926 READ or WRITE ATTRIBUTE commands.
1927 These commands are used to read and write attributes in Medium Auxiliary
1929 The most common place Medium Auxiliary Memory is found is small flash chips
1930 included tape cartriges.
1938 option must be specified.
1941 Specify the READ ATTRIBUTE service action.
1944 Issue the ATTRIBUTE VALUES service action.
1945 Read and decode the available attributes and their values.
1947 Issue the ATTRIBUTE LIST service action.
1948 List the attributes that are available to read and write.
1950 Issue the LOGICAL VOLUME LIST service action.
1951 List the available logical volumes in the MAM.
1953 Issue the PARTITION LIST service action.
1954 List the available partitions in the MAM.
1956 Issue the SUPPORTED ATTRIBUTES service action.
1957 List attributes that are supported for reading or writing.
1958 These attributes may or may not be currently present in the MAM.
1961 Specify an attribute to write to the MAM.
1962 This option is not yet implemented.
1964 Specify the attribute number to display.
1965 This option only works with the attr_values, attr_list and supp_attr
1969 Display cached attributes.
1970 If the device supports this flag, it allows displaying attributes for the
1971 last piece of media loaded in the drive.
1973 Specify the element address.
1974 This is used for specifying which element number in a medium changer to
1975 access when reading attributes.
1976 The element number could be for a picker, portal, slot or drive.
1977 .It Fl F Ar form1,form2
1978 Specify the output format for the attribute values (attr_val) display as a
1979 comma separated list of options.
1980 The default output is currently set to field_all,nonascii_trim,text_raw.
1981 Once this code is ported to FreeBSD 10, any text fields will be converted
1982 from their codeset to the user's native codeset with
1985 The text options are mutually exclusive; if you specify more than one, you
1986 will get unpredictable results.
1987 The nonascii options are also mutually exclusive.
1988 Most of the field options may be logically ORed together.
1991 Print text fields with non-ASCII characters escaped.
1993 Print text fields natively, with no codeset conversion.
1995 If any non-ASCII characters occur in fields that are supposed to be ASCII,
1996 escape the non-ASCII characters.
1998 If any non-ASCII characters occur in fields that are supposed to be ASCII,
1999 omit the non-ASCII characters.
2001 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2002 print them as they are.
2004 Print all of the prefix fields: description, attribute number, attribute
2005 size, and the attribute's readonly status.
2006 If field_all is specified, specifying any other field options will not have
2009 Print none of the prefix fields, and only print out the attribute value.
2010 If field_none is specified, specifying any other field options will result
2011 in those fields being printed.
2013 Print out the attribute description.
2015 Print out the attribute number.
2017 Print out the attribute size.
2019 Print out the attribute's readonly status.
2022 Specify the partition.
2023 When the media has multiple partitions, specifying different partition
2024 numbers allows seeing the values for each individual partition.
2025 .It Fl s Ar start_num
2026 Specify the starting attribute number.
2027 This requests that the target device return attribute information starting
2028 at the given number.
2029 .It Fl T Ar elem_type
2030 Specify the element type.
2031 For medium changer devices, this allows specifying the type the element
2032 referenced in the element address (
2043 Specify the number of the logical volume to operate on.
2044 If the media has multiple logical volumes, this will allow displaying
2045 or writing attributes on the given logical volume.
2047 Issue the REPORT SUPPORTED OPCODES service action of the
2051 Without arguments, this command will return a list of all
2053 commands supported by the device, including service actions of commands
2054 that support service actions.
2055 It will also include the
2057 CDB (Command Data Block) length for each command, and the description of
2058 each command if it is known.
2061 Request information on a specific opcode instead of the list of supported
2063 If supported, the target will return a CDB-like structure that indicates
2064 the opcode, service action (if any), and a mask of bits that are supported
2066 .It Fl s Ar service_action
2067 For commands that support a service action, specify the service action to
2070 If a service action is specified for a given opcode, and the device does
2071 not support the given service action, the device should not return a
2073 error, but rather indicate in the returned parameter data that the command
2075 By default, if a service action is specified for an opcode, and service
2076 actions are not supported for the opcode in question, the device will
2079 Include timeout values.
2080 This option works with the default display, which includes all commands
2081 supported by the device, and with the
2085 options, which request information on a specific command and service
2087 This requests that the device report Nominal and Recommended timeout values
2088 for the given command or commands.
2089 The timeout values are in seconds.
2090 The timeout descriptor also includes a command-specific
2093 Print out verbose usage information.
2098 variable allows the user to specify an alternate mode page format file.
2102 variable determines which text editor
2104 starts when editing mode pages.
2106 .Bl -tag -width /usr/share/misc/scsi_modes -compact
2107 .It Pa /usr/share/misc/scsi_modes
2108 is the SCSI mode format database.
2110 is the transport layer device.
2112 are the CAM application passthrough devices.
2115 .Dl camcontrol eject -n cd -u 1 -v
2117 Eject the CD from cd1, and print SCSI sense information if the command
2120 .Dl camcontrol tur da0
2122 Send the SCSI test unit ready command to da0.
2125 utility will report whether the disk is ready, but will not display sense
2126 information if the command fails since the
2128 switch was not specified.
2129 .Bd -literal -offset indent
2130 camcontrol tur da1 -E -C 4 -t 50 -v
2133 Send a test unit ready command to da1.
2134 Enable kernel error recovery.
2135 Specify a retry count of 4, and a timeout of 50 seconds.
2139 flag) if the command fails.
2140 Since error recovery is turned on, the
2141 disk will be spun up if it is not currently spinning.
2144 utility will report whether the disk is ready.
2145 .Bd -literal -offset indent
2146 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
2147 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
2150 Issue a READ BUFFER command (0x3C) to cd1.
2151 Display the buffer size of cd1,
2152 and display the first 10 bytes from the cache on cd1.
2154 information if the command fails.
2155 .Bd -literal -offset indent
2156 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
2157 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
2160 Issue a WRITE BUFFER (0x3B) command to cd1.
2161 Write out 10 bytes of data,
2162 not including the (reserved) 4 byte header.
2163 Print out sense information if
2165 Be very careful with this command, improper use may
2166 cause data corruption.
2167 .Bd -literal -offset indent
2168 camcontrol modepage da3 -m 1 -e -P 3
2171 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
2172 settings on the drive.
2173 Mode page 1 contains a disk drive's auto read and
2174 write reallocation settings, among other things.
2176 .Dl camcontrol rescan all
2178 Rescan all SCSI busses in the system for devices that have been added,
2181 .Dl camcontrol rescan 0
2183 Rescan SCSI bus 0 for devices that have been added, removed or changed.
2185 .Dl camcontrol rescan 0:1:0
2187 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
2190 .Dl camcontrol tags da5 -N 24
2192 Set the number of concurrent transactions for da5 to 24.
2193 .Bd -literal -offset indent
2194 camcontrol negotiate -n da -u 4 -T disable
2197 Disable tagged queueing for da4.
2198 .Bd -literal -offset indent
2199 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
2202 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
2204 Test Unit Ready command to make the settings take effect.
2205 .Bd -literal -offset indent
2206 camcontrol smpcmd ses0 -v -r 4 "40 0 00 0" -R 1020 "s9 i1"
2209 Send the SMP REPORT GENERAL command to ses0, and display the number of PHYs
2211 Display SMP errors if the command fails.
2212 .Bd -literal -offset indent
2213 camcontrol security ada0
2216 Report security support and settings for ada0
2217 .Bd -literal -offset indent
2218 camcontrol security ada0 -U user -s MyPass
2221 Enable security on device ada0 with the password MyPass
2222 .Bd -literal -offset indent
2223 camcontrol security ada0 -U user -e MyPass
2226 Secure erase ada0 which has had security enabled with user password MyPass
2228 .Em WARNING! WARNING! WARNING!
2232 data from the device, so backup your data before using!
2234 This command can be used against an SSD drive to restoring it to
2235 factory default write performance.
2236 .Bd -literal -offset indent
2240 Report HPA support and settings for ada0 (also reported via
2242 .Bd -literal -offset indent
2243 camcontrol hpa ada0 -s 10240
2246 Enables HPA on ada0 setting the maximum reported sectors to 10240.
2248 .Em WARNING! WARNING! WARNING!
2252 to all data on the device beyond this limit until HPA is disabled by setting
2253 HPA to native max sectors of the device, which can only be done after a
2254 power-on or hardware reset!
2257 use this on a device which has an active filesystem!
2259 .Bd -literal -offset indent
2260 camcontrol persist da0 -v -i read_keys
2263 This will read any persistent reservation keys registered with da0, and
2264 display any errors encountered when sending the PERSISTENT RESERVE IN
2267 .Bd -literal -offset indent
2268 camcontrol persist da0 -v -o register -a -K 0x12345678
2271 This will register the persistent reservation key 0x12345678 with da0,
2272 apply that registration to all ports on da0, and display any errors that
2273 occur when sending the PERSISTENT RESERVE OUT command.
2274 .Bd -literal -offset indent
2275 camcontrol persist da0 -v -o reserve -s lun -k 0x12345678 -T ex_ac
2278 This will reserve da0 for the exlusive use of the initiator issuing the
2280 The scope of the reservation is the entire LUN.
2281 Any errors sending the PERSISTENT RESERVE OUT command will be displayed.
2282 .Bd -literal -offset indent
2283 camcontrol persist da0 -v -i read_full
2286 This will display the full status of all reservations on da0 and print out
2287 status if there are any errors.
2288 .Bd -literal -offset indent
2289 camcontrol persist da0 -v -o release -k 0x12345678 -T ex_ac
2292 This will release a reservation on da0 of the type ex_ac
2294 The Reservation Key for this registration is 0x12345678.
2295 Any errors that occur will be displayed.
2296 .Bd -literal -offset indent
2297 camcontrol persist da0 -v -o register -K 0x12345678 -S \e
2298 -I sas,0x1234567812345678 -I sas,0x8765432187654321
2301 This will register the key 0x12345678 with da0, specifying that it applies
2302 to the SAS initiators with SAS addresses 0x1234567812345678 and
2304 .Bd -literal -offset indent
2305 camcontrol persist da0 -v -o register_move -k 0x87654321 \e
2306 -K 0x12345678 -U -p -R 2 -I fcp,0x1234567812345678
2309 This will move the registration from the current initiator, whose
2310 Registration Key is 0x87654321, to the Fibre Channel initiator with the
2311 Fiber Channel World Wide Node Name 0x1234567812345678.
2312 A new registration key, 0x12345678, will be registered for the initiator
2313 with the Fibre Channel World Wide Node Name 0x1234567812345678, and the
2314 current initiator will be unregistered from the target.
2315 The reservation will be moved to relative target port 2 on the target
2317 The registration will persist across power losses.
2319 .Bd -literal -offset indent
2320 camcontrol attrib sa0 -v -i attr_values -p 1
2323 This will read and decode the attribute values from partition 1 on the tape
2324 in tape drive sa0, and will display any
2329 .Xr cam_cdbparse 3 ,
2336 utility first appeared in
2339 The mode page editing code and arbitrary SCSI command code are based upon
2344 library, written by Julian Elischer and Peter Dufault.
2347 program first appeared in
2349 and first appeared in
2354 .An Kenneth Merry Aq ken@FreeBSD.org
2356 The code that parses the generic command line arguments does not know that
2357 some of the subcommands take multiple arguments.
2358 So if, for instance, you
2359 tried something like this:
2360 .Bd -literal -offset indent
2361 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
2364 The sense information from the test unit ready command would not get
2365 printed out, since the first
2369 bails out when it sees the second argument to
2373 Fixing this behavior would take some gross code, or changes to the
2376 The best way to circumvent this problem is to always make sure
2379 arguments before any command-specific arguments.
projects / FreeBSD / releng / 10.3.git / blob