1NDCTL-READ-INFOBLO(1)            ndctl Manual            NDCTL-READ-INFOBLO(1)
2
3
4

NAME

6       ndctl-read-infoblock - read and optionally parse the info-block a
7       namespace
8

SYNOPSIS

10       ndctl read-infoblock <namespace0.0> [<namespace1.0>..<namespaceN.Y>] [<options>]
11

DESCRIPTION

13       As described in the theory of operation section of ndctl-create-
14       namespace(1), the raw capacity of a namespace may encapsulate a
15       personality, or mode of operation. Specifically, the mode may be set to
16       one of "sector", "fsdax", and "devdax". Each of those modes is defined
17       by an info-block format that uniquely identifies the mode of operation.
18       The read-infoblock command knows the location (relative to the start of
19       the namespace) and field definition of those data structures.
20
21       Note that unlike a partition table info-block is not exposed by
22       default, so the namespace needs to be disabled before the info-block
23       can be accessed.
24

EXAMPLE

26           ndctl disable-namespace namespace0.0
27           disabled 1 namespace
28           ndctl read-infoblock -j namespace0.0
29           [
30             {
31               "dev":"namespace0.0",
32               "signature":"NVDIMM_PFN_INFO",
33               "uuid":"56b11990-66b1-4d91-9cac-ca084c051259",
34               "parent_uuid":"00000000-0000-0000-0000-000000000000",
35               "flags":0,
36               "version":"1.3",
37               "dataoff":69206016,
38               "npfns":1031680,
39               "mode":2,
40               "start_pad":0,
41               "end_trunc":0,
42               "align":2097152
43             }
44           ]
45

OPTIONS

47       <namespace(s)>
48           One or more namespaceX.Y device names. The keyword all can be
49           specified to operate on every namespace in the system, optionally
50           filtered by bus id (see --bus= option), or region id (see --region=
51           option).
52
53       -V, --verify
54           Attempt to validate that the info-block is self consistent by
55           validating the embedded checksum, and that info-block formats that
56           contain a parent-uuid attribute also match the base-uuid of the
57           namespace.
58
59       -o, --output
60           Output file
61
62       -j, --json
63           Parse the info-block data into json.
64
65       -u, --human
66           Enable json output and convert number formats to human readable
67           strings, for example show the size in terms of "KB", "MB", "GB",
68           etc instead of a signed 64-bit numbers per the JSON interchange
69           format (implies --json).
70
71       -r, --region=
72           A regionX device name, or a region id number. Restrict the
73           operation to the specified region(s). The keyword all can be
74           specified to indicate the lack of any restriction, however this is
75           the same as not supplying a --region option at all.
76

78       Copyright © 2016 - 2020, Intel Corporation. License GPLv2: GNU GPL
79       version 2 http://gnu.org/licenses/gpl.html. This is free software: you
80       are free to change and redistribute it. There is NO WARRANTY, to the
81       extent permitted by law.
82

SEE ALSO

84       ndctl-create-namespace(1), UEFI NVDIMM Label Protocol[1]
85

NOTES

87        1. UEFI NVDIMM Label Protocol
88           http://www.uefi.org/sites/default/files/resources/UEFI_Spec_2_7.pdf
89
90
91
92ndctl 71.1                        12/22/2020             NDCTL-READ-INFOBLO(1)
Impressum