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. Restrict the
56 operation to the specified region(s). The keyword all can be
57 specified to indicate the lack of any restriction, however this is
58 the same as not supplying a --region option at all.
59 -b, --bus=
61 A bus id number, or a provider string (e.g. "ACPI.NFIT"). Restrict
62 the operation to the specified bus(es). The keyword all can be
63 specified to indicate the lack of any restriction, however this is
64 the same as not supplying a --bus option at all.
65 -d, --dimm=
67 An nmemX device name, or dimm id number. The dimm id number here is
68 X in nmemX. Filter listing by devices that reference the given
69 dimm. For example to see all namespaces comprised of storage
70 capacity on nmem0:
71 # ndctl list --dimm=nmem0 --namespaces
73 -n, --namespace=
75 An namespaceX.Y device name, or namespace region plus id tuple X.Y.
76 Limit the namespace list to the single identified device if
77 present.
78 -t, --type=
80 Filter listing by region type (pmem or blk)
81 -m, --mode=
83 Filter listing by the mode (raw, fsdax, sector or devdax) of the
84 namespace(s).
85 -U, --numa-node=
87 Filter listing by numa node
88 -B, --buses
90 Include bus info in the listing
91 -D, --dimms
93 Include dimm info in the listing
94 {
96 "dev":"nmem0",
97 "id":"cdab-0a-07e0-ffffffff",
98 "handle":0,
99 "phys_id":0,
100 "security:":"disabled"
101 }
102 -H, --health
104 Include dimm health info in the listing. For example:
105 {
107 "dev":"nmem0",
108 "health":{
109 "health_state":"non-critical",
110 "temperature_celsius":23,
111 "spares_percentage":75,
112 "alarm_temperature":true,
113 "alarm_spares":true,
114 "temperature_threshold":40,
115 "spares_threshold":5,
116 "life_used_percentage":5,
117 "shutdown_state":"clean"
118 }
119 }
120 -F, --firmware
122 Include dimm firmware info in the listing. For example:
123 {
125 "dev":"nmem0",
126 "firmware":{
127 "current_version":0,
128 "next_version":1,
129 "need_powercycle":true
130 }
131 }
132 -X, --device-dax
134 Include device-dax ("daxregion") details when a namespace is in
135 "devdax" mode.
136 {
138 "dev":"namespace0.0",
139 "mode":"devdax",
140 "size":4225761280,
141 "uuid":"18ae1bbb-bb62-4efc-86df-4a5caacb5dcc",
142 "daxregion":{
143 "id":0,
144 "size":4225761280,
145 "align":2097152,
146 "devices":[
147 {
148 "chardev":"dax0.0",
149 "size":4225761280
150 }
151 ]
152 }
153 }
154 -R, --regions
156 Include region info in the listing
157 -N, --namespaces
159 Include namespace info in the listing. Namespace info is listed by
160 default if no other options are specified to the command.
161 -i, --idle
163 Include idle (not enabled) devices in the listing
164 -C, --capabilities
166 Include region capabilities in the listing, i.e. supported
167 namespace modes and variable properties like sector sizes and
168 alignments.
169 -M, --media-errors
171 Include media errors (badblocks) in the listing. Note that the
172 badblock_count property is included in the listing by default when
173 the count is non-zero, otherwise it is hidden. Also, if the
174 namespace is in sector mode the badblocks listing is not included
175 and badblock_count property may include blocks that are located in
176 metadata, or unused capacity in the namespace. Convert a sector
177 namespace into raw mode to list precise badblocks offsets.
178 {
180 "dev":"namespace7.0",
181 "mode":"raw",
182 "size":33554432,
183 "blockdev":"pmem7",
184 "badblock_count":17,
185 "badblocks":[
186 {
187 "offset":4,
188 "length":1
189 },
190 {
191 "offset":32768,
192 "length":8
193 },
194 {
195 "offset":65528,
196 "length":8
197 }
198 ]
199 }
200 -v, --verbose
202 Increase verbosity of the output. This can be specified multiple
203 times to be even more verbose on the informational and
204 miscellaneous output, and can be used to override omitted flags for
205 showing specific information.
206 · -v In addition to the enabled namespaces default output, show
208 the numa_node, raw_uuid, and bad block media errors.
209 · -vv Everything -v provides, plus automatically enable --dimms,
211 --buses, and --regions.
212 · -vvv Everything -vv provides, plus --health, --capabilities,
214 --idle, and --firmware.
215 -u, --human
217 Format numbers representing storage sizes, or offsets as human
218 readable strings with units instead of the default machine-friendly
219 raw-integer data. Convert other numeric fields into hexadecimal
220 strings.
221 # ndctl list --region=7
223 {
224 "dev":"region7",
225 "size":67108864,
226 "available_size":67108864,
227 "type":"pmem",
228 "iset_id":-6382611090938810793,
229 "badblock_count":8
230 }
231 # ndctl list --human --region=7
233 {
234 "dev":"region7",
235 "size":"64.00 MiB (67.11 MB)",
236 "available_size":"64.00 MiB (67.11 MB)",
237 "type":"pmem",
238 "iset_id":"0xa76c6907811fae57",
239 "badblock_count":8
240 }
241
243 Copyright (c) 2016 - 2019, Intel Corporation. License GPLv2: GNU GPL
244 version 2 <http://gnu.org/licenses/gpl.html>. This is free software:
245 you are free to change and redistribute it. There is NO WARRANTY, to
246 the extent permitted by law.
247
249 ndctl-create-namespace(1)
250ndctl 2019-10-28 NDCTL-LIST(1)