sg_safte(8)

1SG_SAFTE(8)                        SG3_UTILS                       SG_SAFTE(8)
2
3
4

NAME

6       sg_safte  -  Fetch status from a SCSI Accessed Fault-Tolerant Enclosure
7       (SAF-TE) device
8

SYNOPSIS

10       sg_safte  [--config]  [--devstatus]  [--encstatus]  [--flags]  [--help]
11       [--hex] [--insertions] [--raw] [--usage] [--verbose] [--version] DEVICE
12

DESCRIPTION

14       Fetches  enclosure status (via a SCSI READ BUFFER command).  The DEVICE
15       should be a SAF-TE device which  may  be  a  storage  array  controller
16       (INQUIRY  peripheral  device  type  0xc)  or a generic processor device
17       (INQUIRY peripheral device type 0x3).
18
19       If no options are given (only the DEVICE  argument)  then  the  overall
20       enclosure status as reported by the option --config ®is reported.
21

OPTIONS

23       Arguments to long options are mandatory for short options as well.  The
24       options are arranged in alphabetical order based  on  the  long  option
25       name.
26
27       -c, --config
28              will  issues  a Read Enclosure Configuration ®(READ BUFFER ID 0)
29              cdb to the device, which returns a list of the  enclosure  hard‐
30              ware resources.
31
32       -d, --devstatus
33              will  issue a Read Device Slot Status ®(READ BUFFER ID 4) cdb to
34              the device, which returns information about the current state of
35              each drive or slot.
36
37       -s, --encstatus
38              will  issue  a  Read Enclosure Status ®(READ BUFFER ID 1) cdb to
39              the device, which returns the operational state  of  the  compo‐
40              nents.
41
42       -f, --flags
43              will  issue  a  Read Global Flags ®(READ BUFFER ID 5) cdb to the
44              device, which read the most recent state of the global flags  of
45              the RAID processor device.
46
47       -h, --help
48              output the usage message then exit.
49
50       -H, --hex
51              output  the  response  to  a READ BUFFER command in ASCII hex to
52              stdout. If used once, output the response to the first READ BUF‐
53              FER  command  (i.e. with buffer_id=0). This should be the enclo‐
54              sure configuration. If used twice (or more often), the  response
55              to subsequent READ BUFFER commands is output.
56
57       -i, --insertions
58              will  issue  a Read Device Insertions ®(READ BUFFER ID 3) cdb to
59              the device, which returns information about the number of  times
60              devices  have  been  inserted whilst the RAID system was powered
61              on.
62
63       -r, --raw
64              output the response to a READ BUFFER command in binary  to  std‐
65              out.  If used once, output the response to the first READ BUFFER
66              command (i.e. with buffer_id=0). This should  be  the  enclosure
67              configuration.  If  used  twice (or more often), the response to
68              subsequent READ BUFFER commands is output.
69
70       -u, --usage
71              will issue a Read Usage Statistics ®(READ BUFFER ID  2)  cdb  to
72              the  device,  which  returns the information on total usage time
73              and number of power-on cycles of the RAID device.
74
75       -v, --verbose
76              increase the level of verbosity, (i.e. debug output).
77
78       -V, --version
79              print the version string and then exit.
80

NOTES

82       The implementation is based on the intermediate review document  eg  as
83       found at
84
85       http://www.intel.com/design/servers/ipmi/saf-te.htm
86
87       As  the  specification  was never finalized this document serves as the
88       de-facto standard.
89
90       Similar functionality is provided  by  SPC-4  SCSI  Enclosure  Services
91       devices  (Peripheral  device  type  0xd), which can be queried with the
92       sg_ses utility.
93

EXAMPLES

95       To view the configuration:
96
97          sg_safte /dev/sg1
98
99       To view the device slot status:
100
101          sg_safte --devstatus /dev/sg1
102

EXIT STATUS

104       The exit status of sg_safte is 0 when it is successful.  Otherwise  see
105       the sg3_utils(8) man page.
106

AUTHORS

108       Written by Hannes Reinecke and Douglas Gilbert.
109

REPORTING BUGS

111       Report bugs to <dgilbert at interlog dot com>.
112

COPYRIGHT

114       Copyright © 2004-2007 Hannes Reinecke and Douglas Gilbert
115       This  software is distributed under a FreeBSD license. There is NO war‐
116       ranty; not even for MERCHANTABILITY or FITNESS FOR  A  PARTICULAR  PUR‐
117       POSE.
118