Deleted Added
full compact
camcontrol.8 (237452) camcontrol.8 (249115)
1.\"
2.\" Copyright (c) 1998, 1999, 2000, 2002, 2005, 2006, 2007 Kenneth D. Merry.
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright

--- 11 unchanged lines hidden (view full) ---

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
26.\" SUCH DAMAGE.
27.\"
1.\"
2.\" Copyright (c) 1998, 1999, 2000, 2002, 2005, 2006, 2007 Kenneth D. Merry.
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright

--- 11 unchanged lines hidden (view full) ---

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
26.\" SUCH DAMAGE.
27.\"
28.\" $FreeBSD: head/sbin/camcontrol/camcontrol.8 237452 2012-06-22 18:57:06Z ken $
28.\" $FreeBSD: head/sbin/camcontrol/camcontrol.8 249115 2013-04-04 23:19:51Z smh $
29.\"
30.Dd June 4, 2012
31.Dt CAMCONTROL 8
32.Os
33.Sh NAME
34.Nm camcontrol
35.Nd CAM control program
36.Sh SYNOPSIS

--- 186 unchanged lines hidden (view full) ---

223.Nm
224.Ic fwdownload
225.Op device id
226.Op generic args
227.Aq Fl f Ar fw_image
228.Op Fl y
229.Op Fl s
230.Nm
29.\"
30.Dd June 4, 2012
31.Dt CAMCONTROL 8
32.Os
33.Sh NAME
34.Nm camcontrol
35.Nd CAM control program
36.Sh SYNOPSIS

--- 186 unchanged lines hidden (view full) ---

223.Nm
224.Ic fwdownload
225.Op device id
226.Op generic args
227.Aq Fl f Ar fw_image
228.Op Fl y
229.Op Fl s
230.Nm
231.Ic security
232.Op device id
233.Op generic args
234.Op Fl d Ar pwd
235.Op Fl e Ar pwd
236.Op Fl f
237.Op Fl h Ar pwd
238.Op Fl k Ar pwd
239.Op Fl l Ar high|maximum
240.Op Fl q
241.Op Fl s Ar pwd
242.Op Fl T Ar timeout
243.Op Fl U Ar user|master
244.Op Fl y
245.Nm
231.Ic help
232.Sh DESCRIPTION
233The
234.Nm
235utility is designed to provide a way for users to access and control the
236.Fx
237CAM subsystem.
238.Pp

--- 828 unchanged lines hidden (view full) ---

1067specifies automatic standby timer value in seconds. Value 0 disables timer.
1068.It Ic standby
1069Put ATA device into STANDBY state. Optional parameter
1070.Pq Fl t
1071specifies automatic standby timer value in seconds. Value 0 disables timer.
1072.It Ic sleep
1073Put ATA device into SLEEP state. Note that the only way get device out of
1074this state may be reset.
246.Ic help
247.Sh DESCRIPTION
248The
249.Nm
250utility is designed to provide a way for users to access and control the
251.Fx
252CAM subsystem.
253.Pp

--- 828 unchanged lines hidden (view full) ---

1082specifies automatic standby timer value in seconds. Value 0 disables timer.
1083.It Ic standby
1084Put ATA device into STANDBY state. Optional parameter
1085.Pq Fl t
1086specifies automatic standby timer value in seconds. Value 0 disables timer.
1087.It Ic sleep
1088Put ATA device into SLEEP state. Note that the only way get device out of
1089this state may be reset.
1090.It Ic security
1091Update or report security settings, using an ATA identify command (0xec).
1092By default,
1093.Nm
1094will print out the security support and associated settings of the device.
1095The
1096.Ic security
1097command takes several arguments:
1098.Bl -tag -width 0n
1099.It Fl d Ar pwd
1100.Pp
1101Disable device security using the given password for the selected user according
1102to the devices configured security level.
1103.It Fl e Ar pwd
1104.Pp
1105Erase the device using the given password for the selected user.
1106.Pp
1107.Em WARNING! WARNING! WARNING!
1108.Pp
1109Issuing a secure erase will
1110.Em ERASE ALL
1111user data on the device and may take several hours to complete.
1112.Pp
1113When this command is used against an SSD drive all its cells will be marked as
1114empty, restoring it to factory default write performance. For SSD's this action
1115usually takes just a few seconds.
1116.It Fl f
1117.Pp
1118Freeze the security configuration of the specified device.
1119.Pp
1120After command completion any other commands that update the device lock mode
1121shall be command aborted. Frozen mode is disabled by power-off or hardware reset.
1122.It Fl h Ar pwd
1123.Pp
1124Enhanced erase the device using the given password for the selected user.
1125.Pp
1126.Em WARNING! WARNING! WARNING!
1127.Pp
1128Issuing an enhanced secure erase will
1129.Em ERASE ALL
1130user data on the device and may take several hours to complete.
1131.Pp
1132An enhanced erase writes predetermined data patterns to all user data areas,
1133all previously written user data shall be overwritten, including sectors that
1134are no longer in use due to reallocation.
1135.It Fl k Ar pwd
1136.Pp
1137Unlock the device using the given password for the selected user according to
1138the devices configured security level.
1139.It Fl l Ar high|maximum
1140.Pp
1141Specifies which security level to set when issuing a
1142.Fl s Ar pwd
1143command. The security level determines device behavior when the master
1144password is used to unlock the device. When the security level is set to high
1145the device requires the unlock command and the master password to unlock.
1146When the security level is set to maximum the device requires a secure erase
1147with the master password to unlock.
1148.Pp
1149This option must be used in conjunction with one of the security action commands.
1150.Pp
1151Defaults to
1152.Em high
1153.It Fl q
1154.Pp
1155Be quiet, do not print any status messages.
1156This option will not disable the questions, however.
1157To disable questions, use the
1158.Fl y
1159argument, below.
1160.It Fl s Ar pwd
1161.Pp
1162Password the device (enable security) using the given password for the selected
1163user. This option can be combined with other options such as
1164.Fl e Em pwd
1165.Pp
1166A master password may be set in a addition to the user password. The purpose of
1167the master password is to allow an administrator to establish a password that
1168is kept secret from the user, and which may be used to unlock the device if the
1169user password is lost.
1170.Pp
1171.Em Note:
1172Setting the master password does not enable device security.
1173.Pp
1174If the master password is set and the drive supports a Master Revision Code
1175feature the Master Password Revision Code will be decremented.
1176.It Fl T Ar timeout
1177.Pp
1178Overrides the default timeout, specified in seconds, used for both
1179.Fl e
1180and
1181.Fl h
1182this is useful if your system has problems processing long timeouts correctly.
1183.Pp
1184Usually the timeout is calculated from the information stored on the drive if
1185present, otherwise it defaults to 2 hours.
1186.It Fl U Ar user|master
1187.Pp
1188Specifies which user to set / use for the running action command, valid values
1189are user or master and defaults to master if not set.
1190.Pp
1191This option must be used in conjunction with one of the security action commands.
1192.Pp
1193Defaults to
1194.Em master
1195.It Fl y
1196.Pp
1197Confirm yes to dangerous options such as
1198.Fl e
1199without prompting for confirmation.
1200.Pp
1201.El
1202If the password specified for any action commands doesn't match the configured
1203password for the specified user the command will fail.
1204.Pp
1205The password in all cases is limited to 32 characters, longer passwords will
1206fail.
1075.It Ic fwdownload
1076Program firmware of the named SCSI device using the image file provided.
1077.Pp
1078Current list of supported vendors:
1079.Bl -bullet -offset indent -compact
1080.It
1081HITACHI
1082.It

--- 152 unchanged lines hidden (view full) ---

1235Test Unit Ready command to make the settings take effect.
1236.Bd -literal -offset indent
1237camcontrol smpcmd ses0 -v -r 4 "40 0 00 0" -R 1020 "s9 i1"
1238.Ed
1239.Pp
1240Send the SMP REPORT GENERAL command to ses0, and display the number of PHYs
1241it contains.
1242Display SMP errors if the command fails.
1207.It Ic fwdownload
1208Program firmware of the named SCSI device using the image file provided.
1209.Pp
1210Current list of supported vendors:
1211.Bl -bullet -offset indent -compact
1212.It
1213HITACHI
1214.It

--- 152 unchanged lines hidden (view full) ---

1367Test Unit Ready command to make the settings take effect.
1368.Bd -literal -offset indent
1369camcontrol smpcmd ses0 -v -r 4 "40 0 00 0" -R 1020 "s9 i1"
1370.Ed
1371.Pp
1372Send the SMP REPORT GENERAL command to ses0, and display the number of PHYs
1373it contains.
1374Display SMP errors if the command fails.
1375.Pp
1376.Bd -literal -offset indent
1377camcontrol security ada0
1378.Ed
1379.Pp
1380Report security support and settings for ada0
1381.Pp
1382.Bd -literal -offset indent
1383camcontrol security ada0 -u user -s MyPass
1384.Ed
1385.Pp
1386Enable security on device ada0 with the password MyPass
1387.Pp
1388.Bd -literal -offset indent
1389camcontrol security ada0 -u user -e MyPass
1390.Ed
1391.Pp
1392Secure erase ada0 which has had security enabled with user password MyPass
1393.Pp
1394.Em WARNING! WARNING! WARNING!
1395.Pp
1396This will
1397.Em ERASE ALL
1398data from the device, so backup your data before using!
1399.Pp
1400This command can be used used against an SSD drive to restoring it to
1401factory default write performance.
1243.Sh SEE ALSO
1244.Xr cam 3 ,
1245.Xr cam_cdbparse 3 ,
1246.Xr cam 4 ,
1247.Xr pass 4 ,
1248.Xr xpt 4
1249.Sh HISTORY
1250The

--- 45 unchanged lines hidden ---
1402.Sh SEE ALSO
1403.Xr cam 3 ,
1404.Xr cam_cdbparse 3 ,
1405.Xr cam 4 ,
1406.Xr pass 4 ,
1407.Xr xpt 4
1408.Sh HISTORY
1409The

--- 45 unchanged lines hidden ---