Skip to content

Commit 5d2a2c5

Browse files
thiellthiell
committed
README: update with newer examples
1 parent 4c57215 commit 5d2a2c5

File tree

1 file changed

+153
-20
lines changed

1 file changed

+153
-20
lines changed

‎README.rst

Lines changed: 153 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
sasutils is a set of command-line tools and a Python library to ease the administration of Serial Attached SCSI (SAS) fabrics.
1+
sasutils is a set of command-line tools and a Python library to ease the administration of Serial Attached SCSI (SAS) storage networks.
22

33
.. image:: https://img.shields.io/pypi/v/sasutils.svg
44
:target: https://pypi.python.org/pypi/sasutils/
@@ -54,25 +54,132 @@ sas_discover
5454
------------
5555

5656
Display SAS topology. By default, **sas_discover** tries to fold common devices (like disks). Use ``-v``, ``-vv`` or ``-vvv`` and ``--addr`` to display more details.
57+
Below is an example with a large topology with multiple SAS HBAs, SAS switches and SAS JBODs.
5758

5859
.. code-block::
5960
6061
$ sas_discover -v
61-
oak-io1-s1
62-
|--host35 SAS9300-8e
63-
| `--8x--expander-35:0 ASTEK
64-
| |--1x--end_device-35:0:0
65-
| | `--enclosure io1-sassw1 ASTEK
66-
| `--4x--expander-35:1 QCT
67-
| |-- 60 x end_device -- disk
68-
| `-- 1 x end_device -- enclosure io1-jbod1-0 QCT
69-
`--host36 SAS9300-8e
70-
`--8x--expander-36:0 ASTEK
71-
|--1x--end_device-36:0:0
72-
| `--enclosure io1-sassw2 ASTEK
73-
`--4x--expander-36:1 QCT
74-
|-- 60 x end_device -- disk
75-
`-- 1 x end_device -- enclosure io1-jbod1-1 QCT
62+
oak-io8-s2
63+
|--host1 HBA 9500-16e
64+
| `--8x--expander-1:0 ASTEK
65+
| |--1x--end_device-1:0:0
66+
| | `--enclosure io8-sassw2 ASTEK
67+
| |--4x--expander-1:1 HGST
68+
| | |--1x--end_device-1:1:0
69+
| | | `--enclosure io8-jbod1 HGST
70+
| | |--10x--expander-1:9 HGST
71+
| | | `-- 50 x end_device -- disk
72+
| | `--10x--expander-1:10 HGST
73+
| | `-- 51 x end_device -- disk
74+
| |--4x--expander-1:2 HGST
75+
| | |--1x--end_device-1:2:0
76+
| | | `--enclosure io8-jbod2 HGST
77+
| | |--10x--expander-1:11 HGST
78+
| | | `-- 51 x end_device -- disk
79+
| | `--10x--expander-1:12 HGST
80+
| | `-- 51 x end_device -- disk
81+
| |--4x--expander-1:3 HGST
82+
| | |--1x--end_device-1:3:0
83+
| | | `--enclosure io8-jbod3 HGST
84+
| | |--10x--expander-1:13 HGST
85+
| | | `-- 51 x end_device -- disk
86+
| | `--10x--expander-1:14 HGST
87+
| | `-- 51 x end_device -- disk
88+
| |--4x--expander-1:4 HGST
89+
| | |--1x--end_device-1:4:0
90+
| | | `--enclosure io8-jbod4 HGST
91+
| | |--10x--expander-1:15 HGST
92+
| | | `-- 51 x end_device -- disk
93+
| | `--10x--expander-1:16 HGST
94+
| | `-- 51 x end_device -- disk
95+
| |--4x--expander-1:5 HGST
96+
| | |--1x--end_device-1:5:0
97+
| | | `--enclosure io8-jbod5 HGST
98+
| | |--10x--expander-1:17 HGST
99+
| | | `-- 51 x end_device -- disk
100+
| | `--10x--expander-1:18 HGST
101+
| | `-- 51 x end_device -- disk
102+
| |--4x--expander-1:6 HGST
103+
| | |--1x--end_device-1:6:0
104+
| | | `--enclosure io8-jbod6 HGST
105+
| | |--10x--expander-1:19 HGST
106+
| | | `-- 51 x end_device -- disk
107+
| | `--10x--expander-1:20 HGST
108+
| | `-- 51 x end_device -- disk
109+
| |--4x--expander-1:7 HGST
110+
| | |--1x--end_device-1:7:0
111+
| | | `--enclosure io8-jbod7 HGST
112+
| | |--10x--expander-1:21 HGST
113+
| | | `-- 51 x end_device -- disk
114+
| | `--10x--expander-1:22 HGST
115+
| | `-- 51 x end_device -- disk
116+
| `--4x--expander-1:8 HGST
117+
| |--1x--end_device-1:8:0
118+
| | `--enclosure io8-jbod8 HGST
119+
| |--10x--expander-1:23 HGST
120+
| | `-- 51 x end_device -- disk
121+
| `--10x--expander-1:24 HGST
122+
| `-- 51 x end_device -- disk
123+
`--host10 HBA 9500-16e
124+
`--8x--expander-10:0 ASTEK
125+
|--1x--end_device-10:0:0
126+
| `--enclosure io8-sassw1 ASTEK
127+
|--4x--expander-10:1 HGST
128+
| |--1x--end_device-10:1:0
129+
| | `--enclosure io8-jbod1 HGST
130+
| |--10x--expander-10:9 HGST
131+
| | `-- 50 x end_device -- disk
132+
| `--10x--expander-10:10 HGST
133+
| `-- 51 x end_device -- disk
134+
|--4x--expander-10:2 HGST
135+
| |--1x--end_device-10:2:0
136+
| | `--enclosure io8-jbod2 HGST
137+
| |--10x--expander-10:11 HGST
138+
| | `-- 51 x end_device -- disk
139+
| `--10x--expander-10:12 HGST
140+
| `-- 51 x end_device -- disk
141+
|--4x--expander-10:3 HGST
142+
| |--1x--end_device-10:3:0
143+
| | `--enclosure io8-jbod3 HGST
144+
| |--10x--expander-10:13 HGST
145+
| | `-- 51 x end_device -- disk
146+
| `--10x--expander-10:14 HGST
147+
| `-- 51 x end_device -- disk
148+
|--4x--expander-10:4 HGST
149+
| |--1x--end_device-10:4:0
150+
| | `--enclosure io8-jbod4 HGST
151+
| |--10x--expander-10:15 HGST
152+
| | `-- 51 x end_device -- disk
153+
| `--10x--expander-10:16 HGST
154+
| `-- 51 x end_device -- disk
155+
|--4x--expander-10:5 HGST
156+
| |--1x--end_device-10:5:0
157+
| | `--enclosure io8-jbod5 HGST
158+
| |--10x--expander-10:17 HGST
159+
| | `-- 51 x end_device -- disk
160+
| `--10x--expander-10:18 HGST
161+
| `-- 51 x end_device -- disk
162+
|--4x--expander-10:6 HGST
163+
| |--1x--end_device-10:6:0
164+
| | `--enclosure io8-jbod6 HGST
165+
| |--10x--expander-10:19 HGST
166+
| | `-- 51 x end_device -- disk
167+
| `--10x--expander-10:20 HGST
168+
| `-- 51 x end_device -- disk
169+
|--4x--expander-10:7 HGST
170+
| |--1x--end_device-10:7:0
171+
| | `--enclosure io8-jbod7 HGST
172+
| |--10x--expander-10:21 HGST
173+
| | `-- 51 x end_device -- disk
174+
| `--10x--expander-10:22 HGST
175+
| `-- 51 x end_device -- disk
176+
`--4x--expander-10:8 HGST
177+
|--1x--end_device-10:8:0
178+
| `--enclosure io8-jbod8 HGST
179+
|--10x--expander-10:23 HGST
180+
| `-- 51 x end_device -- disk
181+
`--10x--expander-10:24 HGST
182+
`-- 51 x end_device -- disk
76183
77184
78185
sas_devices
@@ -82,20 +189,46 @@ Zeroconf tool that scans SAS devices and resolves associated enclosures. Useful
82189

83190
When used with -v, **sas_devices** will also display all disk devices with serial numbers.
84191

85-
The following example shows a proper detection of a 60-disk JBOD with 2 SIMs (an "enclosure group").
192+
The following example shows a proper detection of a 60-disk JBOD with 2 SIMs/IOMs (an "enclosure group").
86193

87194
.. code-block::
88195
89196
$ sas_devices
90197
Found 2 SAS hosts
91198
Found 4 SAS expanders
92199
Found 1 enclosure groups
93-
Enclosure group: [io1-jbod1-0][io1-jbod1-1]
94-
NUM VENDOR MODEL REV PATHS
95-
60 x SEAGATE ST8000NM0075 E002 2
200+
Enclosure group: [io1-jbod1-0][io1-jbod1-1]
201+
NUM VENDOR MODEL REV SIZE PATHS
202+
60 x SEAGATE ST8000NM0075 E004 8.0TB 2
96203
Total: 60 block devices in enclosure group
97204

98205

206+
The following example shows a proper detection of four Seagate Exos E JBOFs with 15.4TB SSDs. Note that 2 IOMs are detected for each JBOF and they have the same SES-2 nickname (this is normal with this hardware).
207+
208+
.. code-block::
209+
210+
$ sas_devices
211+
Found 2 SAS hosts
212+
Found 8 SAS expanders
213+
Found 4 enclosure groups
214+
Enclosure group: [io1-jbof4][io1-jbof4]
215+
NUM VENDOR MODEL REV SIZE PATHS
216+
24 x SEAGATE XS15360SE70084 0003 15.4TB 2
217+
Total: 24 block devices in enclosure group
218+
Enclosure group: [io1-jbof2][io1-jbof2]
219+
NUM VENDOR MODEL REV SIZE PATHS
220+
24 x SEAGATE XS15360SE70084 0003 15.4TB 2
221+
Total: 24 block devices in enclosure group
222+
Enclosure group: [io1-jbof3][io1-jbof3]
223+
NUM VENDOR MODEL REV SIZE PATHS
224+
24 x SEAGATE XS15360SE70084 0003 15.4TB 2
225+
Total: 24 block devices in enclosure group
226+
Enclosure group: [io1-jbof1][io1-jbof1]
227+
NUM VENDOR MODEL REV SIZE PATHS
228+
24 x SEAGATE XS15360SE70084 0003 15.4TB 2
229+
Total: 24 block devices in enclosure group
230+
231+
99232
ses_report
100233
----------
101234

0 commit comments

Comments
 (0)