xref: /freebsd/share/examples/ses/getencstat/getencstat.0 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
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.Dd February 21, 2000
33.Dt GETENCSTAT 8
34.Os
35.Sh NAME
36.Nm getencstat
37.Nd get SCSI Environmental Services Device enclosure status
38.Sh SYNOPSIS
39.Nm
40.Op Fl v
41.Ar device
42.Op Ar device ...
43.Sh DESCRIPTION
44.Nm
45gets summary and detailed SCSI Environmental Services (or SAF-TE) device
46enclosure status.
47The overall status is printed out.
48If the overall status
49is considered okay, nothing else is printed out (unless the
50.Fl v
51option is used).
52.Pp
53A SCSI Environmental Services device enclosure may be either in the state
54of being \fBOK\fR, or in one or more of the states of \fBINFORMATIONAL\fR,
55\fBNON-CRITICAL\fR, \fBCRITICAL\fB or \fBUNRECOVERABLE\fR states.
56These
57overall states reflect a summary of the states of each object within
58such a device (such as power supplies or disk drives).
59.Pp
60With the
61.Fl v
62option, the status of all objects within the device is printed, whether
63\fBOK\fR or not.
64Along with the status of each object is the object identifier.
65.Pp
66The user may then use
67.Xr setencstat 8
68to try and clear overall device status, or may use
69.Xr setobjstat 8
70to set specific object status.
71.Sh FILES
72.Bl -tag -width /dev/sesN -compact
73.It Pa /dev/ses\fIN\fR
74SCSI Environmental Services Devices
75.El
76.Sh SEE ALSO
77.Xr ses 4 ,
78.Xr sesd 8 ,
79.Xr setencstat 8 ,
80.Xr setobjstat 8
81.Sh BUGS
82