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.
616 Print out the grown defect list.
617 This is a list of bad blocks that have
618 been remapped since the disk left the factory.
620 Print out the primary defect list.
621 This is the list of defects that were present in the factory.
623 When printing status information with
625 only print the number of defects.
627 Just print the number of defects, not the list of defects.
629 Specify the starting offset into the defect list.
630 This implies using the
632 READ DEFECT DATA (12) command, as the 10 byte version of the command
633 doesn't support the address descriptor index field.
634 Not all drives support the 12 byte command, and some drives that support
635 the 12 byte command don't support the address descriptor index field.
637 Print out defects in hexadecimal (base 16) form instead of base 10 form.
646 will print out the number of defects given in the READ DEFECT DATA header
647 returned from the drive.
648 Some drives will report 0 defects if neither the primary or grown defect
651 Allows the user to display and optionally edit a SCSI mode page.
653 page formats are located in
654 .Pa /usr/share/misc/scsi_modes .
655 This can be overridden by specifying a different file in the
657 environment variable.
660 command takes several arguments:
663 Disable block descriptors for mode sense.
665 Displays mode page data in binary format.
667 This flag allows the user to edit values in the mode page.
669 either edit mode page values with the text editor pointed to by his
671 environment variable, or supply mode page values via standard input, using
674 uses to display mode page values.
675 The editor will be invoked if
677 detects that standard input is terminal.
679 Lists all available mode pages.
680 .It Fl m Ar mode_page
681 This specifies the number of the mode page the user would like to view
683 This argument is mandatory unless
687 This allows the user to specify the page control field.
689 .Bl -tag -width xxx -compact
701 Allows the user to send an arbitrary ATA or SCSI CDB to any device.
704 function requires the
706 argument to specify SCSI CDB or the
708 argument to specify ATA Command Block registers values.
709 Other arguments are optional, depending on
711 The command and data specification syntax is documented
714 NOTE: If the CDB specified causes data to be transferred to or from the
715 SCSI device in question, you MUST specify either
720 .It Fl a Ar cmd Op args
721 This specifies the content of 12 ATA Command Block registers (command,
722 features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp.
723 lba_high_exp, features_exp, sector_count, sector_count_exp).
724 .It Fl c Ar cmd Op args
725 This specifies the SCSI CDB.
726 SCSI CDBs may be 6, 10, 12 or 16 bytes.
728 Specifies DMA protocol to be used for ATA command.
730 Specifies FPDMA (NCQ) protocol to be used for ATA command.
731 .It Fl i Ar len Ar fmt
732 This specifies the amount of data to read, and how it should be displayed.
736 bytes of data will be read from the device and written to standard output.
737 .It Fl o Ar len Ar fmt Op args
738 This specifies the amount of data to be written to a device, and the data
739 that is to be written.
743 bytes of data will be read from standard input and written to the device.
745 This specifies that 11 result ATA Command Block registers should be displayed
746 (status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp,
747 lba_high_exp, sector_count, sector_count_exp), and how.
750 11 result registers will be written to standard output in hex.
753 Allows the user to send an arbitrary Serial
754 Management Protocol (SMP) command to a device.
757 function requires the
759 argument to specify the SMP request to be sent, and the
761 argument to specify the format of the SMP response.
762 The syntax for the SMP request and response arguments is documented in
765 Note that SAS adapters that support SMP passthrough (at least the currently
766 known adapters) do not accept CRC bytes from the user in the request and do
767 not pass CRC bytes back to the user in the response.
768 Therefore users should not include the CRC bytes in the length of the
769 request and not expect CRC bytes to be returned in the response.
771 .It Fl r Ar len Ar fmt Op args
772 This specifies the size of the SMP request, without the CRC bytes, and the
777 bytes of data will be read from standard input and written as the SMP
779 .It Fl R Ar len Ar fmt Op args
780 This specifies the size of the buffer allocated for the SMP response, and
781 the SMP response format.
785 bytes of data will be allocated for the response and the response will be
786 written to standard output.
789 Allows the user to send the Serial Management Protocol (SMP) Report General
792 will display the data returned by the Report General command.
793 If the SMP target supports the long response format, the additional data
794 will be requested and displayed automatically.
797 Request the long response format only.
798 Not all SMP targets support the long response format.
801 to skip sending the initial report general request without the long bit set
802 and only issue a report general request with the long bit set.
805 Allows the user to issue the Serial Management Protocol (SMP) PHY Control
807 This function should be used with some caution, as it can render devices
808 inaccessible, and could potentially cause data corruption as well.
811 argument is required to specify the PHY to operate on.
814 Specify the PHY to operate on.
815 This argument is required.
817 Request the long request/response format.
818 Not all SMP targets support the long response format.
819 For the PHY Control command, this currently only affects whether the
820 request length is set to a value other than 0.
821 .It Fl o Ar operation
822 Specify a PHY control operation.
825 operation may be specified.
826 The operation may be specified numerically (in decimal, hexadecimal, or octal)
827 or one of the following operation names may be specified:
831 It is not necessary to specify this argument.
833 Send the LINK RESET command to the phy.
835 Send the HARD RESET command to the phy.
837 Send the DISABLE command to the phy.
838 Note that the LINK RESET or HARD RESET commands should re-enable the phy.
840 Send the CLEAR ERROR LOG command.
841 This clears the error log counters for the specified phy.
843 Send the CLEAR AFFILIATION command.
844 This clears the affiliation from the STP initiator port with the same SAS
845 address as the SMP initiator that requests the clear operation.
847 Send the TRANSMIT SATA PORT SELECTION SIGNAL command to the phy.
848 This will cause a SATA port selector to use the given phy as its active phy
849 and make the other phy inactive.
851 Send the CLEAR STP I_T NEXUS LOSS command to the PHY.
853 Send the SET ATTACHED DEVICE NAME command to the PHY.
856 argument to specify the device name.
859 Specify the attached device name.
860 This option is needed with the
863 The name is a 64-bit number, and can be specified in decimal, hexadecimal
866 Set the minimum physical link rate for the phy.
867 This is a numeric argument.
868 Currently known link rates are:
871 Do not change current value.
880 Other values may be specified for newer physical link rates.
882 Set the maximum physical link rate for the phy.
883 This is a numeric argument.
886 argument description for known link rate arguments.
887 .It Fl T Ar pp_timeout
888 Set the partial pathway timeout value, in microseconds.
893 specification for more information on this field.
894 .It Fl a Ar enable|disable
895 Enable or disable SATA slumber phy power conditions.
896 .It Fl A Ar enable|disable
897 Enable or disable SATA partial power conditions.
898 .It Fl s Ar enable|disable
899 Enable or disable SAS slumber phy power conditions.
900 .It Fl S Ar enable|disable
901 Enable or disable SAS partial phy power conditions.
904 List phys attached to a SAS expander, the address of the end device
905 attached to the phy, and the inquiry data for that device and peripheral
906 devices attached to that device.
907 The inquiry data and peripheral devices are displayed if available.
910 Turn on the long response format for the underlying SMP commands used for
913 Only print out phys that are attached to a device in the CAM EDT (Existing
917 Send the SMP Report Manufacturer Information command to the device and
918 display the response.
921 Turn on the long response format for the underlying SMP commands used for
925 Turn on CAM debugging printfs in the kernel.
926 This requires options CAMDEBUG
927 in your kernel config file.
928 WARNING: enabling debugging printfs currently
929 causes an EXTREME number of kernel printfs.
930 You may have difficulty
931 turning off the debugging printfs once they start, since the kernel will be
932 busy printing messages and unable to service other requests quickly.
935 function takes a number of arguments:
938 Enable CAM_DEBUG_INFO printfs.
940 Enable CAM_DEBUG_PERIPH printfs.
942 Enable CAM_DEBUG_TRACE printfs.
944 Enable CAM_DEBUG_SUBTRACE printfs.
946 Enable CAM_DEBUG_XPT printfs.
948 Enable CAM_DEBUG_CDB printfs.
949 This will cause the kernel to print out the
950 SCSI CDBs sent to the specified device(s).
952 Enable CAM_DEBUG_PROBE printfs.
954 Enable debugging for all devices.
956 Turn off debugging for all devices
957 .It bus Ns Op :target Ns Op :lun
958 Turn on debugging for the given bus, target or lun.
960 and lun are not specified, they are wildcarded.
961 (i.e., just specifying a
962 bus turns on debugging printfs for all devices on that bus.)
965 Show or set the number of "tagged openings" or simultaneous transactions
966 we attempt to queue to a particular device.
969 command, with no command-specific arguments (i.e., only generic arguments)
970 prints out the "soft" maximum number of transactions that can be queued to
971 the device in question.
972 For more detailed information, use the
974 argument described below.
977 Set the number of tags for the given device.
978 This must be between the
979 minimum and maximum number set in the kernel quirk table.
981 most devices that support tagged queueing is a minimum of 2 and a maximum
983 The minimum and maximum values for a given device may be
984 determined by using the
991 subcommand is described below.
993 Be quiet, and do not report the number of tags.
994 This is generally used when
995 setting the number of tags.
997 The verbose flag has special functionality for the
1002 to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB:
1005 This is the amount of capacity for transactions queued to a given device.
1007 This is the number of transactions currently queued to a device.
1009 This is the kernel queue space for transactions.
1010 This count usually mirrors
1011 dev_openings except during error recovery operations when
1012 the device queue is frozen (device is not allowed to receive
1013 commands), the number of dev_openings is reduced, or transaction
1014 replay is occurring.
1016 This is the number of transactions waiting in the kernel queue for capacity
1018 This number is usually zero unless error recovery is in
1021 The held count is the number of CCBs held by peripheral drivers that have
1022 either just been completed or are about to be released to the transport
1023 layer for service by a device.
1024 Held CCBs reserve capacity on a given
1027 This is the current "hard" minimum number of transactions that can be
1028 queued to a device at once.
1031 value above cannot go below this number.
1032 The default value for
1034 is 2, although it may be set higher or lower for various devices.
1036 This is the "hard" maximum number of transactions that can be queued to a
1040 value cannot go above this number.
1041 The default value for
1043 is 255, although it may be set higher or lower for various devices.
1047 Show or negotiate various communication parameters.
1048 Some controllers may
1049 not support setting or changing some of these values.
1051 Adaptec 174x controllers do not support changing a device's sync rate or
1056 will not attempt to set the parameter if the controller indicates that it
1057 does not support setting the parameter.
1058 To find out what the controller
1066 command is described below.
1067 Also, some controller drivers do not support
1068 setting negotiation parameters, even if the underlying controller supports
1069 negotiation changes.
1070 Some controllers, such as the Advansys wide
1071 controllers, support enabling and disabling synchronous negotiation for
1072 a device, but do not support setting the synchronous negotiation rate.
1075 Attempt to make the negotiation settings take effect immediately by sending
1076 a Test Unit Ready command to the device.
1078 Show or set current negotiation settings.
1079 This is the default.
1080 .It Fl D Ar enable|disable
1081 Enable or disable disconnection.
1085 Set the command delay offset.
1087 Be quiet, do not print anything.
1088 This is generally useful when you want to
1089 set a parameter, but do not want any status information.
1090 .It Fl R Ar syncrate
1091 Change the synchronization rate for a device.
1092 The sync rate is a floating
1093 point value specified in MHz.
1096 is a legal value, as is
1098 .It Fl T Ar enable|disable
1099 Enable or disable tagged queueing for a device.
1101 Show or set user negotiation settings.
1102 The default is to show or set
1103 current negotiation settings.
1105 The verbose switch has special meaning for the
1110 to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the
1112 .It Fl W Ar bus_width
1113 Specify the bus width to negotiate with a device.
1116 The only useful values to specify are 8, 16, and 32
1118 The controller must support the bus width in question in order for
1119 the setting to take effect.
1122 In general, sync rate and offset settings will not take effect for a
1123 device until a command has been sent to the device.
1126 switch above will automatically send a Test Unit Ready to the device so
1127 negotiation parameters will take effect.
1131 FORMAT UNIT command to the named device.
1133 .Em WARNING! WARNING! WARNING!
1135 Low level formatting a disk will destroy ALL data on the disk.
1137 extreme caution when issuing this command.
1138 Many users low-level format
1139 disks that do not really need to be low-level formatted.
1141 relatively few scenarios that call for low-level formatting a disk.
1143 low-level formatting a disk is to initialize the disk after changing
1144 its physical sector size.
1145 Another reason for low-level formatting a disk
1146 is to revive the disk if you are getting "medium format corrupted" errors
1147 from the disk in response to read and write requests.
1149 Some disks take longer than others to format.
1150 Users should specify a
1151 timeout long enough to allow the format to complete.
1153 timeout is 3 hours, which should be long enough for most disks.
1155 disks will complete a format operation in a very short period of time
1156 (on the order of 5 minutes or less).
1157 This is often because the drive
1158 does not really support the FORMAT UNIT command -- it just accepts the
1159 command, waits a few minutes and then returns it.
1163 subcommand takes several arguments that modify its default behavior.
1168 arguments can be useful for scripts.
1171 Be quiet, do not print any status messages.
1172 This option will not disable
1173 the questions, however.
1174 To disable questions, use the
1181 This will report status on a format that is already running on the drive.
1183 Issue a non-immediate format command.
1186 issues the FORMAT UNIT command with the immediate bit set.
1188 device to immediately return the format command, before the format has
1194 sense information from the device every second to determine how far along
1195 in the format process it is.
1198 argument is specified,
1200 will issue a non-immediate format command, and will be unable to print any
1201 information to let the user know what percentage of the disk has been
1204 Do not ask any questions.
1207 will ask the user if he/she really wants to format the disk in question,
1208 and also if the default format command timeout is acceptable.
1210 will not be asked about the timeout if a timeout is specified on the
1216 SANITIZE command to the named device.
1218 .Em WARNING! WARNING! WARNING!
1220 ALL data in the cache and on the disk will be destroyed or made inaccessible.
1221 Recovery of the data is not possible.
1222 Use extreme caution when issuing this command.
1226 subcommand takes several arguments that modify its default behavior.
1231 arguments can be useful for scripts.
1233 .It Fl a Ar operation
1234 Specify the sanitize operation to perform.
1237 Perform an overwrite operation by writing a user supplied
1238 data pattern to the device one or more times.
1239 The pattern is given by the
1242 The number of times is given by the
1246 Perform a block erase operation.
1247 All the device's blocks are set to a vendor defined
1248 value, typically zero.
1250 Perform a cryptographic erase operation.
1251 The encryption keys are changed to prevent the decryption
1254 Exits a previously failed sanitize operation.
1255 A failed sanitize operation can only be exited if it was
1256 run in the unrestricted completion mode, as provided by the
1261 The number of passes when performing an
1264 Valid values are between 1 and 31.
1269 operation, the pattern is inverted between consecutive passes.
1271 Path to the file containing the pattern to use when
1275 The pattern is repeated as needed to fill each block.
1277 Be quiet, do not print any status messages.
1278 This option will not disable
1279 the questions, however.
1280 To disable questions, use the
1284 Perform the sanitize in the unrestricted completion mode.
1285 If the operation fails, it can later be exited with the
1292 This will report status on a sanitize that is already running on the drive.
1294 Issue a non-immediate sanitize command.
1297 issues the SANITIZE command with the immediate bit set.
1299 device to immediately return the sanitize command, before
1300 the sanitize has actually completed.
1305 sense information from the device every second to determine how far along
1306 in the sanitize process it is.
1309 argument is specified,
1311 will issue a non-immediate sanitize command, and will be unable to print any
1312 information to let the user know what percentage of the disk has been
1315 Do not ask any questions.
1318 will ask the user if he/she really wants to sanitize the disk in question,
1319 and also if the default sanitize command timeout is acceptable.
1321 will not be asked about the timeout if a timeout is specified on the
1325 Put ATA device into IDLE state.
1328 specifies automatic standby timer value in seconds.
1329 Value 0 disables timer.
1331 Put ATA device into STANDBY state.
1334 specifies automatic standby timer value in seconds.
1335 Value 0 disables timer.
1337 Put ATA device into SLEEP state.
1338 Note that the only way get device out of
1339 this state may be reset.
1341 It optional parameter
1343 specified, enables and sets advanced power management level, where
1344 1 -- minimum power, 127 -- maximum performance with standby,
1345 128 -- minimum power without standby, 254 -- maximum performance.
1346 If not specified -- APM is disabled.
1348 It optional parameter
1350 specified, enables and sets automatic acoustic management level, where
1351 1 -- minimum noise, 254 -- maximum performance.
1352 If not specified -- AAM is disabled.
1354 Update or report security settings, using an ATA identify command (0xec).
1357 will print out the security support and associated settings of the device.
1360 command takes several arguments:
1364 Disable device security using the given password for the selected user according
1365 to the devices configured security level.
1368 Erase the device using the given password for the selected user.
1370 .Em WARNING! WARNING! WARNING!
1372 Issuing a secure erase will
1374 user data on the device and may take several hours to complete.
1376 When this command is used against an SSD drive all its cells will be marked as
1377 empty, restoring it to factory default write performance.
1378 For SSD's this action
1379 usually takes just a few seconds.
1382 Freeze the security configuration of the specified device.
1384 After command completion any other commands that update the device lock mode
1385 shall be command aborted.
1386 Frozen mode is disabled by power-off or hardware reset.
1389 Enhanced erase the device using the given password for the selected user.
1391 .Em WARNING! WARNING! WARNING!
1393 Issuing an enhanced secure erase will
1395 user data on the device and may take several hours to complete.
1397 An enhanced erase writes predetermined data patterns to all user data areas,
1398 all previously written user data shall be overwritten, including sectors that
1399 are no longer in use due to reallocation.
1402 Unlock the device using the given password for the selected user according to
1403 the devices configured security level.
1404 .It Fl l Ar high|maximum
1406 Specifies which security level to set when issuing a
1409 The security level determines device behavior when the master
1410 password is used to unlock the device.
1411 When the security level is set to high
1412 the device requires the unlock command and the master password to unlock.
1413 When the security level is set to maximum the device requires a secure erase
1414 with the master password to unlock.
1416 This option must be used in conjunction with one of the security action commands.
1422 Be quiet, do not print any status messages.
1423 This option will not disable the questions, however.
1424 To disable questions, use the
1429 Password the device (enable security) using the given password for the selected
1431 This option can be combined with other options such as
1434 A master password may be set in a addition to the user password. The purpose of
1435 the master password is to allow an administrator to establish a password that
1436 is kept secret from the user, and which may be used to unlock the device if the
1437 user password is lost.
1440 Setting the master password does not enable device security.
1442 If the master password is set and the drive supports a Master Revision Code
1443 feature the Master Password Revision Code will be decremented.
1446 Overrides the default timeout, specified in seconds, used for both
1450 this is useful if your system has problems processing long timeouts correctly.
1452 Usually the timeout is calculated from the information stored on the drive if
1453 present, otherwise it defaults to 2 hours.
1454 .It Fl U Ar user|master
1456 Specifies which user to set / use for the running action command, valid values
1457 are user or master and defaults to master if not set.
1459 This option must be used in conjunction with one of the security action commands.
1465 Confirm yes to dangerous options such as
1467 without prompting for confirmation.
1470 If the password specified for any action commands does not match the configured
1471 password for the specified user the command will fail.
1473 The password in all cases is limited to 32 characters, longer passwords will
1476 Update or report Host Protected Area details.
1479 will print out the HPA support and associated settings of the device.
1482 command takes several optional arguments:
1486 Freeze the HPA configuration of the specified device.
1488 After command completion any other commands that update the HPA configuration
1489 shall be command aborted.
1490 Frozen mode is disabled by power-off or hardware reset.
1493 Lock the HPA configuration of the device until a successful call to unlock or
1494 the next power-on reset occurs.
1497 Make the HPA max sectors persist across power-on reset or a hardware reset.
1498 This must be used in combination with
1499 .Fl s Ar max_sectors
1503 Set the HPA configuration password required for unlock calls.
1506 Be quiet, do not print any status messages.
1507 This option will not disable the questions.
1508 To disable questions, use the
1511 .It Fl s Ar max_sectors
1513 Configures the maximum user accessible sectors of the device.
1514 This will change the number of sectors the device reports.
1516 .Em WARNING! WARNING! WARNING!
1518 Changing the max sectors of a device using this option will make the data on
1519 the device beyond the specified value inaccessible.
1522 .Fl s Ar max_sectors
1523 call can be made without a power-on reset or a hardware reset of the device.
1526 Unlock the HPA configuration of the specified device using the given password.
1527 If the password specified does not match the password configured via
1529 the command will fail.
1531 After 5 failed unlock calls, due to password miss-match, the device will refuse
1532 additional unlock calls until after a power-on reset.
1535 Confirm yes to dangerous options such as
1537 without prompting for confirmation
1540 The password for all HPA commands is limited to 32 characters, longer passwords
1543 Program firmware of the named
1545 or ATA device using the image file provided.
1549 device and it provides a recommended timeout for the WRITE BUFFER command
1552 opcodes subcommand), that timeout will be used for the firmware download.
1553 The drive-recommended timeout value may be overridden on the command line
1558 Current list of supported vendors for SCSI/SAS drives:
1561 Tested with 4TB SAS drives, model number HUS724040ALS640.
1565 Tested with LTO-5 (ULTRIUM-HH5) and LTO-6 (ULTRIUM-HH6) tape drives.
1566 There is a separate table entry for hard drives, because the update method
1567 for hard drives is different than the method for tape drives.
1572 Tested with SM1625 SSDs.
1574 Tested with Constellation ES (ST32000444SS), ES.2 (ST33000651SS) and
1575 ES.3 (ST1000NM0023) drives.
1577 Tested with 400GB Optimus SSDs (TXA2D20400GA6001).
1580 .Em WARNING! WARNING! WARNING!
1582 Little testing has been done to make sure that different device models from
1583 each vendor work correctly with the fwdownload command.
1584 A vendor name appearing in the supported list means only that firmware of at
1585 least one device type from that vendor has successfully been programmed with
1586 the fwdownload command.
1587 Extra caution should be taken when using this command since there is no
1588 guarantee it will not break a device from the listed vendors.
1589 Ensure that you have a recent backup of the data on the device before
1590 performing a firmware update.
1594 protocol devices will not be programmed, since there is little chance of
1595 the firmware download succeeding.
1598 will currently attempt a firmware download to any
1602 device, since the standard
1604 DOWNLOAD MICROCODE command may work.
1605 Firmware downloads to
1609 devices are supported for devices connected
1614 controllers, and devices connected to SAS controllers
1619 translation capability.
1625 PASS-THROUGH command to send the
1627 DOWNLOAD MICROCODE command to the drive.
1632 translation implementations don't work fully when translating
1634 WRITE BUFFER commands to
1636 DOWNLOAD MICROCODE commands, but do support
1638 passthrough well enough to do a firmware download.
1640 .It Fl f Ar fw_image
1641 Path to the firmware image file to be downloaded to the specified device.
1643 Do not print informational messages, only print errors.
1644 This option should be used with the
1646 option to suppress all output.
1648 Run in simulation mode.
1649 Device checks are run and the confirmation dialog is shown, but no firmware
1650 download will occur.
1656 errors in the event of a failure.
1658 In simulation mode, print out the
1663 register values that would be used for the firmware download command.
1665 Do not ask for confirmation.
1668 Persistent reservation support.
1669 Persistent reservations are a way to reserve a particular
1671 LUN for use by one or more
1676 option is specified,
1680 PERSISTENT RESERVE IN
1681 command using the requested service action.
1684 option is specified,
1688 PERSISTENT RESERVE OUT
1689 command using the requested service action.
1690 One of those two options is required.
1692 Persistent reservations are complex, and fully explaining them is outside
1693 the scope of this manual.
1696 and download the latest SPC spec for a full explanation of persistent
1700 Specify the service action for the PERSISTENT RESERVE IN command.
1701 Supported service actions:
1704 Report the current persistent reservation generation (PRgeneration) and any
1706 .It read_reservation
1707 Report the persistent reservation, if any.
1708 .It report_capabilities
1709 Report the persistent reservation capabilities of the LUN.
1710 .It read_full_status
1711 Report the full status of persistent reservations on the LUN.
1714 Specify the service action for the PERSISTENT RESERVE OUT command.
1715 For service actions like register that are components of other service
1716 action names, the entire name must be specified.
1717 Otherwise, enough of the service action name must be specified to
1718 distinguish it from other possible service actions.
1719 Supported service actions:
1722 Register a reservation key with the LUN or unregister a reservation key.
1723 To register a key, specify the requested key as the Service Action
1725 To unregister a key, specify the previously registered key as the
1727 To change a key, specify the old key as the Reservation Key and the new
1728 key as the Service Action Reservation Key.
1730 This is similar to the register subcommand, except that the Reservation Key
1732 The Service Action Reservation Key will overwrite any previous key
1733 registered for the initiator.
1735 Create a reservation.
1736 A key must be registered with the LUN before the LUN can be reserved, and
1737 it must be specified as the Reservation Key.
1738 The type of reservation must also be specified.
1739 The scope defaults to LUN scope (LU_SCOPE), but may be changed.
1741 Release a reservation.
1742 The Reservation Key must be specified.
1744 Release a reservation and remove all keys from the device.
1745 The Reservation Key must be specified.
1747 Remove a reservation belonging to another initiator.
1748 The Reservation Key must be specified.
1749 The Service Action Reservation Key may be specified, depending on the
1750 operation being performed.
1752 Remove a reservation belonging to another initiator and abort all
1753 outstanding commands from that initiator.
1754 The Reservation Key must be specified.
1755 The Service Action Reservation Key may be specified, depending on the
1756 operation being performed.
1758 Register another initiator with the LUN, and establish a reservation on the
1759 LUN for that initiator.
1760 The Reservation Key and Service Action Reservation Key must be specified.
1762 Replace Lost Reservation information.
1765 Set the All Target Ports (ALL_TG_PT) bit.
1766 This requests that the key registration be applied to all target ports and
1767 not just the particular target port that receives the command.
1768 This only applies to the register and register_ignore actions.
1770 Specify a Transport ID.
1771 This only applies to the Register and Register and Move service actions for
1772 Persistent Reserve Out.
1773 Multiple Transport IDs may be specified with multiple
1776 With the Register service action, specifying one or more Transport IDs
1777 implicitly enables the
1779 option which turns on the SPEC_I_PT bit.
1780 Transport IDs generally have the format protocol,id.
1783 A SAS Transport ID consists of
1785 followed by a 64-bit SAS address.
1788 .Dl sas,0x1234567812345678
1790 A Fibre Channel Transport ID consists of
1792 followed by a 64-bit Fibre Channel World Wide Name.
1795 .Dl fcp,0x1234567812345678
1797 A Parallel SCSI address consists of
1799 followed by a SCSI target ID and a relative target port identifier.
1804 An IEEE 1394 (Firewire) Transport ID consists of
1806 followed by a 64-bit EUI-64 IEEE 1394 node unique identifier.
1809 .Dl sbp,0x1234567812345678
1811 A SCSI over RDMA Transport ID consists of
1813 followed by a 128-bit RDMA initiator port identifier.
1814 The port identifier must be exactly 32 or 34 (if the leading 0x is
1815 included) hexadecimal digits.
1816 Only hexadecimal (base 16) numbers are supported.
1819 .Dl srp,0x12345678123456781234567812345678
1821 An iSCSI Transport ID consists an iSCSI name and optionally a separator and
1823 For example, if only the iSCSI name is specified:
1825 .Dl iqn.2012-06.com.example:target0
1827 If the iSCSI separator and initiator session ID are specified:
1829 .Dl iqn.2012-06.com.example:target0,i,0x123
1831 A SCSI over PCIe Transport ID consists of
1833 followed by a PCIe Routing ID.
1834 The Routing ID consists of a bus, device and function or in the alternate
1835 form, a bus and function.
1836 The bus must be in the range of 0 to 255 inclusive and the device must be
1837 in the range of 0 to 31 inclusive.
1838 The function must be in the range of 0 to 7 inclusive if the standard form
1839 is used, and in the range of 0 to 255 inclusive if the alternate form is
1841 For example, if a bus, device and function are specified for the standard
1846 If the alternate Routing ID form is used:
1851 Specify the Reservation Key.
1852 This may be in decimal, octal or hexadecimal format.
1853 The value is zero by default if not otherwise specified.
1854 The value must be between 0 and 2^64 - 1, inclusive.
1856 Specify the Service Action Reservation Key.
1857 This may be in decimal, octal or hexadecimal format.
1858 The value is zero by default if not otherwise specified.
1859 The value must be between 0 and 2^64 - 1, inclusive.
1861 Enable the Activate Persist Through Power Loss bit.
1862 This is only used for the register and register_ignore actions.
1863 This requests that the reservation persist across power loss events.
1865 Specify the scope of the reservation.
1866 The scope may be specified by name or by number.
1867 The scope is ignored for register, register_ignore and clear.
1868 If the desired scope isn't available by name, you may specify the number.
1872 This encompasses the entire LUN.
1874 Extent scope (0x01).
1876 Element scope (0x02).
1879 Specify the Relative Target Port.
1880 This only applies to the Register and Move service action of the Persistent
1881 Reserve Out command.
1883 Enable the SPEC_I_PT bit.
1884 This only applies to the Register service action of Persistent Reserve Out.
1885 You must also specify at least one Transport ID with
1887 if this option is set.
1888 If you specify a Transport ID, this option is automatically set.
1889 It is an error to specify this option for any service action other than
1892 Specify the reservation type.
1893 The reservation type may be specified by name or by number.
1894 If the desired reservation type isn't available by name, you may specify
1896 Supported reservation type names:
1901 Write Exclusive mode.
1902 May also be specified as
1903 .Dq write_exclusive .
1905 Read Exclusive mode.
1906 May also be specified as
1907 .Dq read_exclusive .
1909 Exclusive access mode.
1910 May also be specified as
1911 .Dq exclusive_access .
1913 Write Exclusive Registrants Only mode.
1914 May also be specified as
1915 .Dq write_exclusive_reg_only .
1917 Exclusive Access Registrants Only mode.
1918 May also be specified as
1919 .Dq exclusive_access_reg_only .
1921 Write Exclusive All Registrants mode.
1922 May also be specified as
1923 .Dq write_exclusive_all_regs .
1925 Exclusive Access All Registrants mode.
1926 May also be specified as
1927 .Dq exclusive_access_all_regs .
1930 Specify that the target should unregister the initiator that sent
1931 the Register and Move request.
1932 By default, the target will not unregister the initiator that sends the
1933 Register and Move request.
1934 This option only applies to the Register and Move service action of the
1935 Persistent Reserve Out command.
1940 READ or WRITE ATTRIBUTE commands.
1941 These commands are used to read and write attributes in Medium Auxiliary
1943 The most common place Medium Auxiliary Memory is found is small flash chips
1944 included tape cartriges.
1952 option must be specified.
1955 Specify the READ ATTRIBUTE service action.
1958 Issue the ATTRIBUTE VALUES service action.
1959 Read and decode the available attributes and their values.
1961 Issue the ATTRIBUTE LIST service action.
1962 List the attributes that are available to read and write.
1964 Issue the LOGICAL VOLUME LIST service action.
1965 List the available logical volumes in the MAM.
1967 Issue the PARTITION LIST service action.
1968 List the available partitions in the MAM.
1970 Issue the SUPPORTED ATTRIBUTES service action.
1971 List attributes that are supported for reading or writing.
1972 These attributes may or may not be currently present in the MAM.
1975 Specify an attribute to write to the MAM.
1976 This option is not yet implemented.
1978 Specify the attribute number to display.
1979 This option only works with the attr_values, attr_list and supp_attr
1983 Display cached attributes.
1984 If the device supports this flag, it allows displaying attributes for the
1985 last piece of media loaded in the drive.
1987 Specify the element address.
1988 This is used for specifying which element number in a medium changer to
1989 access when reading attributes.
1990 The element number could be for a picker, portal, slot or drive.
1991 .It Fl F Ar form1,form2
1992 Specify the output format for the attribute values (attr_val) display as a
1993 comma separated list of options.
1994 The default output is currently set to field_all,nonascii_trim,text_raw.
1995 Once this code is ported to FreeBSD 10, any text fields will be converted
1996 from their codeset to the user's native codeset with
1999 The text options are mutually exclusive; if you specify more than one, you
2000 will get unpredictable results.
2001 The nonascii options are also mutually exclusive.
2002 Most of the field options may be logically ORed together.
2005 Print text fields with non-ASCII characters escaped.
2007 Print text fields natively, with no codeset conversion.
2009 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2010 escape the non-ASCII characters.
2012 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2013 omit the non-ASCII characters.
2015 If any non-ASCII characters occur in fields that are supposed to be ASCII,
2016 print them as they are.
2018 Print all of the prefix fields: description, attribute number, attribute
2019 size, and the attribute's readonly status.
2020 If field_all is specified, specifying any other field options will not have
2023 Print none of the prefix fields, and only print out the attribute value.
2024 If field_none is specified, specifying any other field options will result
2025 in those fields being printed.
2027 Print out the attribute description.
2029 Print out the attribute number.
2031 Print out the attribute size.
2033 Print out the attribute's readonly status.
2036 Specify the partition.
2037 When the media has multiple partitions, specifying different partition
2038 numbers allows seeing the values for each individual partition.
2039 .It Fl s Ar start_num
2040 Specify the starting attribute number.
2041 This requests that the target device return attribute information starting
2042 at the given number.
2043 .It Fl T Ar elem_type
2044 Specify the element type.
2045 For medium changer devices, this allows specifying the type the element
2046 referenced in the element address (
2057 Specify the number of the logical volume to operate on.
2058 If the media has multiple logical volumes, this will allow displaying
2059 or writing attributes on the given logical volume.
2061 Issue the REPORT SUPPORTED OPCODES service action of the
2065 Without arguments, this command will return a list of all
2067 commands supported by the device, including service actions of commands
2068 that support service actions.
2069 It will also include the
2071 CDB (Command Data Block) length for each command, and the description of
2072 each command if it is known.
2075 Request information on a specific opcode instead of the list of supported
2077 If supported, the target will return a CDB-like structure that indicates
2078 the opcode, service action (if any), and a mask of bits that are supported
2080 .It Fl s Ar service_action
2081 For commands that support a service action, specify the service action to
2084 If a service action is specified for a given opcode, and the device does
2085 not support the given service action, the device should not return a
2087 error, but rather indicate in the returned parameter data that the command
2089 By default, if a service action is specified for an opcode, and service
2090 actions are not supported for the opcode in question, the device will
2093 Include timeout values.
2094 This option works with the default display, which includes all commands
2095 supported by the device, and with the
2099 options, which request information on a specific command and service
2101 This requests that the device report Nominal and Recommended timeout values
2102 for the given command or commands.
2103 The timeout values are in seconds.
2104 The timeout descriptor also includes a command-specific
2107 Print out verbose usage information.
2112 variable allows the user to specify an alternate mode page format file.
2116 variable determines which text editor
2118 starts when editing mode pages.
2120 .Bl -tag -width /usr/share/misc/scsi_modes -compact
2121 .It Pa /usr/share/misc/scsi_modes
2122 is the SCSI mode format database.
2124 is the transport layer device.
2126 are the CAM application passthrough devices.
2129 .Dl camcontrol eject -n cd -u 1 -v
2131 Eject the CD from cd1, and print SCSI sense information if the command
2134 .Dl camcontrol tur da0
2136 Send the SCSI test unit ready command to da0.
2139 utility will report whether the disk is ready, but will not display sense
2140 information if the command fails since the
2142 switch was not specified.
2143 .Bd -literal -offset indent
2144 camcontrol tur da1 -E -C 4 -t 50 -v
2147 Send a test unit ready command to da1.
2148 Enable kernel error recovery.
2149 Specify a retry count of 4, and a timeout of 50 seconds.
2153 flag) if the command fails.
2154 Since error recovery is turned on, the
2155 disk will be spun up if it is not currently spinning.
2158 utility will report whether the disk is ready.
2159 .Bd -literal -offset indent
2160 camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e
2161 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1"
2164 Issue a READ BUFFER command (0x3C) to cd1.
2165 Display the buffer size of cd1,
2166 and display the first 10 bytes from the cache on cd1.
2168 information if the command fails.
2169 .Bd -literal -offset indent
2170 camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e
2171 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8
2174 Issue a WRITE BUFFER (0x3B) command to cd1.
2175 Write out 10 bytes of data,
2176 not including the (reserved) 4 byte header.
2177 Print out sense information if
2179 Be very careful with this command, improper use may
2180 cause data corruption.
2181 .Bd -literal -offset indent
2182 camcontrol modepage da3 -m 1 -e -P 3
2185 Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the
2186 settings on the drive.
2187 Mode page 1 contains a disk drive's auto read and
2188 write reallocation settings, among other things.
2190 .Dl camcontrol rescan all
2192 Rescan all SCSI busses in the system for devices that have been added,
2195 .Dl camcontrol rescan 0
2197 Rescan SCSI bus 0 for devices that have been added, removed or changed.
2199 .Dl camcontrol rescan 0:1:0
2201 Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or
2204 .Dl camcontrol tags da5 -N 24
2206 Set the number of concurrent transactions for da5 to 24.
2207 .Bd -literal -offset indent
2208 camcontrol negotiate -n da -u 4 -T disable
2211 Disable tagged queueing for da4.
2212 .Bd -literal -offset indent
2213 camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a
2216 Negotiate a sync rate of 20MHz and an offset of 15 with da3.
2218 Test Unit Ready command to make the settings take effect.
2219 .Bd -literal -offset indent
2220 camcontrol smpcmd ses0 -v -r 4 "40 0 00 0" -R 1020 "s9 i1"
2223 Send the SMP REPORT GENERAL command to ses0, and display the number of PHYs
2225 Display SMP errors if the command fails.
2226 .Bd -literal -offset indent
2227 camcontrol security ada0
2230 Report security support and settings for ada0
2231 .Bd -literal -offset indent
2232 camcontrol security ada0 -U user -s MyPass
2235 Enable security on device ada0 with the password MyPass
2236 .Bd -literal -offset indent
2237 camcontrol security ada0 -U user -e MyPass
2240 Secure erase ada0 which has had security enabled with user password MyPass
2242 .Em WARNING! WARNING! WARNING!
2246 data from the device, so backup your data before using!
2248 This command can be used against an SSD drive to restoring it to
2249 factory default write performance.
2250 .Bd -literal -offset indent
2254 Report HPA support and settings for ada0 (also reported via
2256 .Bd -literal -offset indent
2257 camcontrol hpa ada0 -s 10240
2260 Enables HPA on ada0 setting the maximum reported sectors to 10240.
2262 .Em WARNING! WARNING! WARNING!
2266 to all data on the device beyond this limit until HPA is disabled by setting
2267 HPA to native max sectors of the device, which can only be done after a
2268 power-on or hardware reset!
2271 use this on a device which has an active filesystem!
2272 .Bd -literal -offset indent
2273 camcontrol persist da0 -v -i read_keys
2276 This will read any persistent reservation keys registered with da0, and
2277 display any errors encountered when sending the PERSISTENT RESERVE IN
2280 .Bd -literal -offset indent
2281 camcontrol persist da0 -v -o register -a -K 0x12345678
2284 This will register the persistent reservation key 0x12345678 with da0,
2285 apply that registration to all ports on da0, and display any errors that
2286 occur when sending the PERSISTENT RESERVE OUT command.
2287 .Bd -literal -offset indent
2288 camcontrol persist da0 -v -o reserve -s lun -k 0x12345678 -T ex_ac
2291 This will reserve da0 for the exlusive use of the initiator issuing the
2293 The scope of the reservation is the entire LUN.
2294 Any errors sending the PERSISTENT RESERVE OUT command will be displayed.
2295 .Bd -literal -offset indent
2296 camcontrol persist da0 -v -i read_full
2299 This will display the full status of all reservations on da0 and print out
2300 status if there are any errors.
2301 .Bd -literal -offset indent
2302 camcontrol persist da0 -v -o release -k 0x12345678 -T ex_ac
2305 This will release a reservation on da0 of the type ex_ac
2307 The Reservation Key for this registration is 0x12345678.
2308 Any errors that occur will be displayed.
2309 .Bd -literal -offset indent
2310 camcontrol persist da0 -v -o register -K 0x12345678 -S \e
2311 -I sas,0x1234567812345678 -I sas,0x8765432187654321
2314 This will register the key 0x12345678 with da0, specifying that it applies
2315 to the SAS initiators with SAS addresses 0x1234567812345678 and
2317 .Bd -literal -offset indent
2318 camcontrol persist da0 -v -o register_move -k 0x87654321 \e
2319 -K 0x12345678 -U -p -R 2 -I fcp,0x1234567812345678
2322 This will move the registration from the current initiator, whose
2323 Registration Key is 0x87654321, to the Fibre Channel initiator with the
2324 Fiber Channel World Wide Node Name 0x1234567812345678.
2325 A new registration key, 0x12345678, will be registered for the initiator
2326 with the Fibre Channel World Wide Node Name 0x1234567812345678, and the
2327 current initiator will be unregistered from the target.
2328 The reservation will be moved to relative target port 2 on the target
2330 The registration will persist across power losses.
2331 .Bd -literal -offset indent
2332 camcontrol attrib sa0 -v -i attr_values -p 1
2335 This will read and decode the attribute values from partition 1 on the tape
2336 in tape drive sa0, and will display any
2341 .Xr cam_cdbparse 3 ,
2348 utility first appeared in
2351 The mode page editing code and arbitrary SCSI command code are based upon
2356 library, written by Julian Elischer and Peter Dufault.
2359 program first appeared in
2361 and first appeared in
2366 .An Kenneth Merry Aq Mt ken@FreeBSD.org
2368 The code that parses the generic command line arguments does not know that
2369 some of the subcommands take multiple arguments.
2370 So if, for instance, you
2371 tried something like this:
2372 .Bd -literal -offset indent
2373 camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v
2376 The sense information from the test unit ready command would not get
2377 printed out, since the first
2381 bails out when it sees the second argument to
2385 Fixing this behavior would take some gross code, or changes to the
2388 The best way to circumvent this problem is to always make sure
2391 arguments before any command-specific arguments.
projects / FreeBSD / FreeBSD.git / blob