1NDCTL-LIST(1) ndctl Manual NDCTL-LIST(1)
2
6 ndctl-list - dump the platform nvdimm device topology and attributes in
7 json
8
10 ndctl list [<options>]
11 Walk all the nvdimm buses in the system and list all attached devices
13 along with some of their major attributes.
14 Options can be specified to limit the output to devices of a certain
16 class. Where the classes are buses, dimms, regions, and namespaces. By
17 default, ndctl list with no options is equivalent to:
18 ndctl list --namespaces --bus=all --region=all
20
22 # ndctl list --buses --namespaces
23 {
25 "provider":"nfit_test.1",
26 "dev":"ndbus2",
27 "namespaces":[
28 {
29 "dev":"namespace9.0",
30 "mode":"raw",
31 "size":33554432,
32 "blockdev":"pmem9"
33 }
34 ]
35 }
36 {
37 "provider":"nfit_test.0",
38 "dev":"ndbus1"
39 }
40 {
41 "provider":"e820",
42 "dev":"ndbus0",
43 "namespaces":[
44 {
45 "dev":"namespace0.0",
46 "mode":"fsdax",
47 "size":8589934592,
48 "blockdev":"pmem0"
49 }
50 ]
51 }
52
54 -r, --region=
55 A 'regionX' device name, or a region id number. The keyword 'all' can
57 be specified to carry out the operation on every region in the system,
58 optionally filtered by bus id (see --bus= option).
59 -b, --bus=
61 Enforce that the operation only be carried on devices that are
62 attached to the given bus. Where bus can be a provider name or a
63 bus id number.
64 -d, --dimm=
66 An nmemX device name, or dimm id number. The dimm id number here is
67 X in nmemX. Filter listing by devices that reference the given
68 dimm. For example to see all namespaces comprised of storage
69 capacity on nmem0:
70 # ndctl list --dimm=nmem0 --namespaces
72 -n, --namespace=
74 An namespaceX.Y device name, or namespace region plus id tuple X.Y.
75 Limit the namespace list to the single identified device if
76 present.
77 -t, --type=
79 Filter listing by region type (pmem or blk)
80 -m, --mode=
82 Filter listing by the mode (raw, fsdax, sector or devdax) of the
83 namespace(s).
84 -U, --numa-node=
86 Filter listing by numa node
87 -B, --buses
89 Include bus info in the listing
90 -D, --dimms
92 Include dimm info in the listing
93 {
95 "dev":"nmem0",
96 "id":"cdab-0a-07e0-ffffffff",
97 "handle":0,
98 "phys_id":0,
99 "security:":"disabled"
100 }
101 -H, --health
103 Include dimm health info in the listing. For example:
104 {
106 "dev":"nmem0",
107 "health":{
108 "health_state":"non-critical",
109 "temperature_celsius":23,
110 "spares_percentage":75,
111 "alarm_temperature":true,
112 "alarm_spares":true,
113 "temperature_threshold":40,
114 "spares_threshold":5,
115 "life_used_percentage":5,
116 "shutdown_state":"clean"
117 }
118 }
119 -F, --firmware
121 Include dimm firmware info in the listing. For example:
122 {
124 "dev":"nmem0",
125 "firmware":{
126 "current_version":0,
127 "next_version":1,
128 "need_powercycle":true
129 }
130 }
131 -X, --device-dax
133 Include device-dax ("daxregion") details when a namespace is in
134 "devdax" mode.
135 {
137 "dev":"namespace0.0",
138 "mode":"devdax",
139 "size":4225761280,
140 "uuid":"18ae1bbb-bb62-4efc-86df-4a5caacb5dcc",
141 "daxregion":{
142 "id":0,
143 "size":4225761280,
144 "align":2097152,
145 "devices":[
146 {
147 "chardev":"dax0.0",
148 "size":4225761280
149 }
150 ]
151 }
152 }
153 -R, --regions
155 Include region info in the listing
156 -N, --namespaces
158 Include namespace info in the listing. Namespace info is listed by
159 default if no other options are specified to the command.
160 -i, --idle
162 Include idle (not enabled) devices in the listing
163 -C, --capabilities
165 Include region capabilities in the listing, i.e. supported
166 namespace modes and variable properties like sector sizes and
167 alignments.
168 -M, --media-errors
170 Include media errors (badblocks) in the listing. Note that the
171 badblock_count property is included in the listing by default when
172 the count is non-zero, otherwise it is hidden. Also, if the
173 namespace is in sector mode the badblocks listing is not included
174 and badblock_count property may include blocks that are located in
175 metadata, or unused capacity in the namespace. Convert a sector
176 namespace into raw mode to list precise badblocks offsets.
177 {
179 "dev":"namespace7.0",
180 "mode":"raw",
181 "size":33554432,
182 "blockdev":"pmem7",
183 "badblock_count":17,
184 "badblocks":[
185 {
186 "offset":4,
187 "length":1
188 },
189 {
190 "offset":32768,
191 "length":8
192 },
193 {
194 "offset":65528,
195 "length":8
196 }
197 ]
198 }
199 -v, --verbose
201 Increase verbosity of the output. This can be specified multiple
202 times to be even more verbose on the informational and
203 miscellaneous output, and can be used to override omitted flags for
204 showing specific information.
205 · -v In addition to the enabled namespaces default output, show
207 the numa_node, raw_uuid, and bad block media errors.
208 · -vv Everything -v provides, plus automatically enable --dimms,
210 --buses, and --regions.
211 · -vvv Everything -vv provides, plus --health, --capabilities,
213 --idle, and --firmware.
214 -u, --human
216 Format numbers representing storage sizes, or offsets as human
217 readable strings with units instead of the default machine-friendly
218 raw-integer data. Convert other numeric fields into hexadecimal
219 strings.
220 # ndctl list --region=7
222 {
223 "dev":"region7",
224 "size":67108864,
225 "available_size":67108864,
226 "type":"pmem",
227 "iset_id":-6382611090938810793,
228 "badblock_count":8
229 }
230 # ndctl list --human --region=7
232 {
233 "dev":"region7",
234 "size":"64.00 MiB (67.11 MB)",
235 "available_size":"64.00 MiB (67.11 MB)",
236 "type":"pmem",
237 "iset_id":"0xa76c6907811fae57",
238 "badblock_count":8
239 }
240
242 Copyright (c) 2016 - 2019, Intel Corporation. License GPLv2: GNU GPL
243 version 2 <http://gnu.org/licenses/gpl.html>. This is free software:
244 you are free to change and redistribute it. There is NO WARRANTY, to
245 the extent permitted by law.
246
248 ndctl-create-namespace(1)
249ndctl 2019-05-10 NDCTL-LIST(1)