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 .\" $FreeBSD$
  26 .\"
  27 .Dd December 12, 2019
  28 .Dt SESUTIL 8
  29 .Os
  30 .Sh NAME
  31 .Nm sesutil
  32 .Nd Utility for managing SCSI Enclosure Services (SES) device
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Cm fault
  36 .Op Fl u Ar /dev/sesN
  37 .Aq Ar disk | Ar sesid | Li all
  38 .Op on | off
  39 .Nm
  40 .Cm locate
  41 .Op Fl u Ar /dev/sesN
  42 .Aq Ar disk | Ar sesid | Li all
  43 .Op on | off
  44 .Nm
  45 .Cm map
  46 .Op Fl -libxo Ar options
  47 .Op Fl u Ar /dev/sesN
  48 .Nm
  49 .Cm show
  50 .Op Fl -libxo Ar options
  51 .Op Fl u Ar /dev/sesN
  52 .Nm
  53 .Cm status
  54 .Op Fl -libxo Ar options
  55 .Op Fl u Ar /dev/sesN
  56 .Sh DESCRIPTION
  57 The
  58 .Nm
  59 utility can be used to query and modify various parameter of SCSI Enclosure
  60 Services (SES) devices.
  61 .Pp
  62 List of supported commands:
  63 .Bl -tag -width indent
  64 .It Fl -libxo
  65 Generate output via
  66 .Xr libxo 3
  67 in a selection of different human and machine readable formats.
  68 See
  69 .Xr xo_parse_args 3
  70 .It Cm fault Oo Fl u Ar /dev/sesN Oc Ao Ar disk | Li all Ac Op on | off
  71 Change the state of the external fault LED associated with
  72 .Ar disk .
  73 .Ar disk
  74 can be the device name of the disk, like
  75 .Cm da12 ,
  76 or
  77 .Ql all .
  78 to indicate all disks attached to SES controllers.
  79 .It Cm fault Fl u Ar /dev/sesN Ar sesid Op on | off
  80 Change the state of the external fault LED associated with an element
  81 connected to the SES controller.
  82 .Ar sesid
  83 must be the element ID of a valid item attached to the controller.
  84 Use the
  85 .Cm map
  86 command to list the elements attached to a controller.
  87 .It Cm locate Oo Fl u Ar /dev/sesN Oc Ao Ar disk | Li all Ac Op on | off
  88 Change the state of the external locate LED associated with
  89 .Ar disk .
  90 .Ar disk
  91 can be the device name of the disk, like
  92 .Cm da12 ,
  93 or
  94 .Ql all .
  95 to indicate all disks attached to SES controllers.
  96 .It Cm locate Fl u Ar /dev/sesN Ar sesid Op on | off
  97 Change the state of the external locate LED associated with an element
  98 connected to the SES controller.
  99 .Ar sesid
 100 must be the element ID of a valid item attached to the controller.
 101 Use the
 102 .Cm map
 103 command to list the elements attached to a controller.
 104 .It Cm show Op Fl u Ar /dev/sesN
 105 Display user-friendly summary of specified
 106 .Xr ses 4
 107 controller.
 108 If no controller is specified, all controllers are mapped.
 109 .It Cm map Op Fl u Ar /dev/sesN
 110 Display a map of all elements connected to the specified
 111 .Xr ses 4
 112 controller.
 113 If no controller is specified, all controllers are mapped.
 114 .It Cm status Op Fl u Ar /dev/sesN
 115 Display the status of the specified
 116 .Xr ses 4
 117 controller.
 118 If no controller is specified, the status of each controller is returned.
 119 .El
 120 .Sh EXAMPLES
 121 Turn off all locate LEDs:
 122 .Pp
 123 .Dl Nm Cm locate all off
 124 .Pp
 125 Turn on the locate LED for the drive bay corresponding to
 126 .Pa da15 :
 127 .Pp
 128 .Dl Nm Cm locate da15 on
 129 .Pp
 130 Turn on the fault LED for a drive bay not associated with a device:
 131 .Pp
 132 .Dl Nm Cm fault -u /dev/ses2 7 on
 133 .Sh SEE ALSO
 134 .Xr libxo 3 ,
 135 .Xr xo_parse_args 3 ,
 136 .Xr ses 4
 137 .Sh HISTORY
 138 The
 139 .Nm
 140 utility first appeared in
 141 .Fx 11.0 .
 142 .Sh AUTHORS
 143 .An -nosplit
 144 The
 145 .Nm
 146 utility was written by
 147 .An Baptiste Daroussin Aq Mt bapt@FreeBSD.org
 148 and
 149 .An Allan Jude Aq Mt allanjude@FreeBSD.org .