xref: /freebsd/share/examples/ses/setencstat/setencstat.0 (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
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 SETENCSTAT 8
36.Os
37.Sh NAME
38.Nm setencstat
39.Nd set SCSI Environmental Services Device enclosure status
40.Sh SYNOPSIS
41.Nm
42.Ar device enclosure_status
43.Sh DESCRIPTION
44.Nm
45sets summary status for a SCSI Environmental Services (or SAF-TE) device.
46The enclosure status argument may take on the values:
47.Bl -tag -width Ds
48.It 0
49Set the status to an \fBOK\fR state.
50.It 1
51Set the status to an \fBUNRECOVERABLE\fR state.
52.It 2
53Set the status to an \fBCRITICAL\fR state.
54.It 4
55Set the status to an \fBNON-CRITICAL\fR state.
56.It 8
57Set the status to an \fBINFORMATIONAL\fR state.
58.El
59.Pp
60All the non-zero options may be combined.
61.Pp
62Note that devices may simply and silently ignore the setting of these values.
63.Sh FILES
64.Bl -tag -width /dev/sesN -compact
65.It Pa /dev/ses\fIN\fR
66SCSI Environmental Services Devices
67.El
68.Sh SEE ALSO
69.Xr ses 4 ,
70.Xr getencstat 8 ,
71.Xr sesd 8 ,
72.Xr setobjstat 8
73.Sh BUGS
74