1IPMCTL-SHOW-REGION(1) ipmctl IPMCTL-SHOW-REGION(1)
2
3
4
6 ipmctl-show-region - Retrieves a list of persistent memory regions.
7
9 ipmctl show [OPTIONS] -region [TARGETS]
10
12 Retrieves a list of persistent memory regions of PMem module capacity.
13
15 -a, -all
16 Shows all attributes.
17
18 Note
19 The all and display options are exclusive and may not be used
20 together.
21
22 -d (attributes), -display (attributes)
23 Filters the returned attributes by explicitly specifying a comma
24 separated list of any of the attributes defined in the Return Data
25 section.
26
27 Note
28 The all and display options are exclusive and may not be used
29 together.
30
31 -h, -help
32 Displays help for the command.
33
34 -ddrt
35 Used to specify DDRT as the desired transport protocol for the
36 current invocation of ipmctl.
37
38 -smbus
39 Used to specify SMBUS as the desired transport protocol for the
40 current invocation of ipmctl.
41
42 Note
43 The -ddrt and -smbus options are mutually exclusive and may not be
44 used together.
45
46 -lpmb
47 Used to specify large transport payload size for the current
48 invocation of ipmctl.
49
50 -spmb
51 Used to specify small transport payload size for the current
52 invocation of ipmctl.
53
54 Note
55 The -lpmb and -spmb options are mutually exclusive and may not be
56 used together.
57
58 -nfit
59 Used to specify NFIT table as the source instead of PCD (default)
60 for the current invocation of ipmctl.
61
62 -o (text|nvmxml), -output (text|nvmxml)
63 Changes the output format. One of: "text" (default) or "nvmxml".
64
65 -u (B|MB|MiB|GB|GiB|TB| TiB), -units (B|MB|MiB|GB|GiB|TB| TiB)
66 Changes the units that capacities are displayed in for this
67 command. One of: bytes (B), megabytes (MB), mebibytes (MiB),
68 gigabytes (GB), gibibytes (GiB), terabytes (TB) or tebibytes (TiB).
69
71 -socket [SocketIDs]
72 Restricts output to the persistent memory regions on specific
73 sockets by supplying the socket target and one or more comma
74 separated socket identifiers. The default is to display all
75 sockets.
76
78 Shows all attributes of all persistent memory regions in the server.
79
80 ipmctl show -a -region
81
83 In order to successfully execute this command:
84
85 • The caller must have the appropriate privileges.
86
87 • All the underlying PMem modules should be unlocked to accurately
88 reflect the available capacities. The specified PMem modules must
89 be manageable by the host software.
90
92 The default behavior is to display a table with the default attributes
93 listed below; applying options changes the output to a more detailed
94 format.
95
96 ISetID
97 (Default) The region unique identifier. Also known as interleave
98 set cookie.
99
100 PersistentMemoryType
101 (Default) A comma separated list of the underlying types of
102 persistent memory capacity in the region. One or more of:
103
104 • AppDirect: App Direct capacity interleaved across two or more
105 PMem modules that is fully mapped into the system physical
106 address space.
107
108 • AppDirectNotInterleaved: App Direct capacity wholly contained
109 on a single PMem modules that is fully mapped into the system
110 physical address space.
111
112 Capacity
113 (Default) Total usable capacity, both allocated and unallocated
114
115 FreeCapacity
116 (Default) Remaining usable capacity
117
118 SocketID
119 (Default) Socket ID to which the region belongs
120
121 HealthState
122 The rolled up health of the underlying PMem modules. One of:
123
124 • Unknown: The region health cannot be determined.
125
126 • Healthy: All underlying PMem module persistent memory capacity
127 is available.
128
129 • Pending: A new memory allocation goal has been created but not
130 applied. Reboot or delete any existing memory allocation goals
131 before creating namespaces on the region.
132
133 • Error: There is an issue with some or all of the underlying
134 PMem module capacity because the interleave set has failed. One
135 of:
136
137 • PMem module missing (serial number of PMem module from the
138 Platform Config Data not found in the PMem module list)
139
140 • PMem module not configured
141
142 • Failure to retrieve AppDirect I/O structures from NFIT
143 (system physical address missing)
144
145 • Interleave set or PMem module region initialization failure
146 (out of memory)
147
148 • Locked: One or more of the of the underlying PMem modules are
149 locked.
150
151 DimmID
152 A list of all the PMem modules that are part of this reg.
153
154
155
156ipmctl 2023-07-20 IPMCTL-SHOW-REGION(1)