share/examples/ses/getencstat/getencstat.0

   1 .\" Copyright (c) 2000 Matthew Jacob
   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 .\"    without modification, immediately at the beginning of the file.
  10 .\" 2. The name of the author may not be used to endorse or promote products
  11 .\"    derived from this software without specific prior written permission.
  12 .\"
  13 .\" Alternatively, this software may be distributed under the terms of the
  14 .\" the GNU Public License ("GPL").
  15 .\"
  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 FOR
  20 .\" 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 .\" Matthew Jacob
  29 .\" Feral Software
  30 .\" mjacob@feral.com
  31 .\"
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd February 21, 2000
  35 .Dt GETENCSTAT 8
  36 .Os
  37 .Sh NAME
  38 .Nm getencstat
  39 .Nd get SCSI Environmental Services Device enclosure status
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl v
  43 .Ar device
  44 .Op Ar device ...
  45 .Sh DESCRIPTION
  46 .Nm
  47 gets summary and detailed SCSI Environmental Services (or SAF-TE) device
  48 enclosure status.
  49 The overall status is printed out.
  50 If the overall status
  51 is considered okay, nothing else is printed out (unless the
  52 .Fl v
  53 option is used).
  54 .Pp
  55 A SCSI Environmental Services device enclosure may be either in the state
  56 of being \fBOK\fR, or in one or more of the states of \fBINFORMATIONAL\fR,
  57 \fBNON-CRITICAL\fR, \fBCRITICAL\fB or \fBUNRECOVERABLE\fR states.
  58 These
  59 overall states reflect a summary of the states of each object within
  60 such a device (such as power supplies or disk drives).
  61 .Pp
  62 With the
  63 .Fl v
  64 option, the status of all objects within the device is printed, whether
  65 \fBOK\fR or not.
  66 Along with the status of each object is the object identifier.
  67 .Pp
  68 The user may then use
  69 .Xr setencstat 8
  70 to try and clear overall device status, or may use
  71 .Xr setobjstat 8
  72 to set specific object status.
  73 .Sh FILES
  74 .Bl -tag -width /dev/sesN -compact
  75 .It Pa /dev/ses\fIN\fR
  76 SCSI Environmental Services Devices
  77 .El
  78 .Sh SEE ALSO
  79 .Xr ses 4 ,
  80 .Xr sesd 8 ,
  81 .Xr setencstat 8 ,
  82 .Xr setobjstat 8
  83 .Sh BUGS