usr.sbin/sesutil/sesutil.8

   1 .\" Copyright (c) 2015 Baptiste Daroussin <bapt@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .Dd July 5, 2022
  26 .Dt SESUTIL 8
  27 .Os
  28 .Sh NAME
  29 .Nm sesutil
  30 .Nd Utility for managing SCSI Enclosure Services (SES) device
  31 .Sh SYNOPSIS
  32 .Nm
  33 .Cm fault
  34 .Op Fl u Ar /dev/sesN
  35 .Ar disk Ns | Ns Cm all
  36 .Cm on Ns | Ns Cm off
  37 .Nm
  38 .Cm fault
  39 .Fl u Ar /dev/sesN
  40 .Sm off
  41 .Ar sesid
  42 .Sm on
  43 .Cm on Ns | Ns Cm off
  44 .Nm
  45 .Cm locate
  46 .Op Fl u Ar /dev/sesN
  47 .Ar disk Ns | Ns Cm all
  48 .Cm on Ns | Ns Cm off
  49 .Nm
  50 .Cm locate
  51 .Fl u Ar /dev/sesN
  52 .Ar sesid
  53 .Cm on Ns | Ns Cm off
  54 .Nm
  55 .Cm map
  56 .Op Fl -libxo Ar options
  57 .Op Fl u Ar /dev/sesN
  58 .Nm
  59 .Cm show
  60 .Op Fl -libxo Ar options
  61 .Op Fl u Ar /dev/sesN
  62 .Nm
  63 .Cm status
  64 .Op Fl -libxo Ar options
  65 .Op Fl u Ar /dev/sesN
  66 .Sh DESCRIPTION
  67 The
  68 .Nm
  69 utility can be used to query and modify various parameter of SCSI Enclosure
  70 Services (SES) devices.
  71 .Pp
  72 List of supported commands:
  73 .Bl -tag -width indent
  74 .It Cm fault Oo Fl u Ar /dev/sesN Oc Ar disk Ns | Ns Cm all Cm on Ns | Ns Cm off
  75 Change the state of the external fault LED associated with
  76 .Ar disk .
  77 .Ar disk
  78 can be the device name of the disk, like
  79 .Ql da12 ,
  80 or
  81 .Cm all
  82 to indicate all disks attached to SES controllers.
  83 .It Cm fault Fl u Ar /dev/sesN Ar sesid Cm on Ns | Ns Cm off
  84 Change the state of the external fault LED associated with an element
  85 connected to the SES controller.
  86 .Ar sesid
  87 must be the element ID of a valid item attached to the controller.
  88 Use the
  89 .Cm map
  90 command to list the elements attached to a controller.
  91 .It Cm locate Oo Fl u Ar /dev/sesN Oc Ar disk Ns | Ns Cm all Cm on Ns | Ns Cm off
  92 Change the state of the external locate LED associated with
  93 .Ar disk .
  94 .Ar disk
  95 can be the device name of the disk, like
  96 .Ql da12 ,
  97 or
  98 .Cm all
  99 to indicate all disks attached to SES controllers.
 100 .It Cm locate Fl u Ar /dev/sesN Ar sesid Cm on Ns | Ns Cm off
 101 Change the state of the external locate LED associated with an element
 102 connected to the SES controller.
 103 .Ar sesid
 104 must be the element ID of a valid item attached to the controller.
 105 Use the
 106 .Cm map
 107 command to list the elements attached to a controller.
 108 .It Cm map Oo Fl -libxo Ar options Oc Op Fl u Ar /dev/sesN
 109 Display a map of all elements connected to the specified
 110 .Xr ses 4
 111 controller.
 112 If no controller is specified, all controllers are mapped.
 113 .It Cm show Oo Fl -libxo Ar options Oc Op Fl u Ar /dev/sesN
 114 Display user-friendly summary of specified
 115 .Xr ses 4
 116 controller.
 117 If no controller is specified, all controllers are mapped.
 118 .It Cm status Oo Fl -libxo Ar options Oc Op Fl u Ar /dev/sesN
 119 Display the status of the specified
 120 .Xr ses 4
 121 controller.
 122 If no controller is specified, the status of each controller is returned.
 123 .El
 124 .Pp
 125 Common options:
 126 .Bl -tag -width indent
 127 .It Fl -libxo Ar options
 128 Generate output via
 129 .Xr libxo 3
 130 in a selection of different human and machine readable formats.
 131 See
 132 .Xr xo_parse_args 3
 133 .El
 134 .Sh EXAMPLES
 135 Turn off all locate LEDs:
 136 .Pp
 137 .Dl Nm Cm locate all off
 138 .Pp
 139 Turn on the locate LED for the drive bay corresponding to
 140 .Pa da15 :
 141 .Pp
 142 .Dl Nm Cm locate da15 on
 143 .Pp
 144 Turn on the fault LED for a drive bay not associated with a device:
 145 .Pp
 146 .Dl Nm Cm fault -u /dev/ses2 7 on
 147 .Sh SEE ALSO
 148 .Xr libxo 3 ,
 149 .Xr xo_parse_args 3 ,
 150 .Xr ses 4
 151 .Sh HISTORY
 152 The
 153 .Nm
 154 utility first appeared in
 155 .Fx 11.0 .
 156 .Sh AUTHORS
 157 .An -nosplit
 158 The
 159 .Nm
 160 utility was written by
 161 .An Baptiste Daroussin Aq Mt bapt@FreeBSD.org
 162 and
 163 .An Allan Jude Aq Mt allanjude@FreeBSD.org .