Patrick Welche <prlw1@cam.ac.uk>
[netbsd-mini2440.git] / usr.sbin / sesd / getencstat / getencstat.8
blobaac5953e0a529d5a69e4865a32879372c0083e89
1 .\"     $NetBSD: getencstat.8,v 1.4 2009/04/08 13:47:07 joerg Exp $
2 .\"     $OpenBSD: $
3 .\"     $FreeBSD: $
4 .\"
5 .\" Copyright (c) 2000 Matthew Jacob
6 .\" All rights reserved.
7 .\"
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
10 .\" are met:
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions, and the following disclaimer,
13 .\"    without modification, immediately at the beginning of the file.
14 .\" 2. The name of the author may not be used to endorse or promote products
15 .\"    derived from this software without specific prior written permission.
16 .\"
17 .\" Alternatively, this software may be distributed under the terms of the
18 .\" the GNU Public License ("GPL").
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
24 .\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\" Matthew Jacob
33 .\" Feral Software
34 .\" mjacob@feral.com
35 .Dd February 21, 2000
36 .Dt GETENCSTAT 8
37 .Os
38 .Sh NAME
39 .Nm getencstat
40 .Nd get SCSI Environmental Services Device enclosure status
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl v
44 .Ar device
45 .Op Ar device ...
46 .Sh DESCRIPTION
47 .Nm
48 gets summary and detailed SCSI Environmental Services (or SAF-TE) device
49 enclosure status.
50 The overall status is printed out.
51 If the overall status
52 is considered okay, nothing else is printed out (unless the
53 .Fl v
54 option is used).
55 .Pp
56 A SCSI Environmental Services device enclosure may be either in the state
57 of being
58 .Sy OK ,
59 or in one or more of the states of
60 .Sy INFORMATIONAL ,
61 .Sy NON-CRITICAL ,
62 .Sy CRITICAL ,
64 .Sy UNRECOVERABLE
65 states.
66 These overall states reflect a summary of the states of each object within
67 such a device (such as power supplies or disk drives).
68 .Pp
69 With the
70 .Fl v
71 option, the status of all objects within the device is printed, whether
72 .Sy OK
73 or not.
74 Along with the status of each object is the object identifier.
75 .Pp
76 The user may then use
77 .Xr setencstat 8
78 to try and clear overall device status, or may use
79 .Xr setobjstat 8
80 to set specific object status.
81 .Sh FILES
82 .Bl -tag -width /dev/sesN -compact
83 .It Pa /dev/ses Ns Ar N
84 SCSI Environmental Services Devices
85 .El
86 .Sh SEE ALSO
87 .Xr ses 4 ,
88 .Xr sesd 8 ,
89 .Xr setencstat 8 ,
90 .Xr setobjstat 8