1IPMCTL-SHOW-REGION(1)               ipmctl               IPMCTL-SHOW-REGION(1)
2
3
4

NAME

6       ipmctl-show-region - Retrieves a list of persistent memory regions.
7

SYNOPSIS

9           ipmctl show [OPTIONS] -region [TARGETS]
10

DESCRIPTION

12       Retrieves a list of persistent memory regions of PMem module capacity.
13

OPTIONS

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
24           comma-separated list of any of the attributes defined in the Return
25           Data 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

TARGETS

71       -region [RegionIDs]
72           Restricts output to specific persistent memory regions by providing
73           one or more comma separated region identifiers. The default is to
74           display the persistent memory regions across all manageable PMem
75           modules.
76
77       -socket [SocketIDs]
78           Restricts output to the persistent memory regions on specific
79           sockets by supplying the socket target and one or more
80           comma-separated socket identifiers. The default is to display all
81           sockets.
82

EXAMPLES

84       Shows all attributes of all persistent memory regions in the server.
85
86           ipmctl show -a -region
87
88       Shows all attributes for the specified persistent memory region.
89
90           ipmctl show -a -region 1
91

LIMITATIONS

93       In order to successfully execute this command:
94
95       ·   The caller must have the appropriate privileges.
96
97       ·   All the underlying PMem modules should be unlocked to accurately
98           reflect the available capacities. The specified PMem modules must
99           be manageable by the host software.
100

RETURN DATA

102       The default behavior is to display a table with the default attributes
103       listed below; applying options changes the output to a more detailed
104       format.
105
106       ISetID
107           (Default) The region unique identifier. Also known as interleave
108           set cookie.
109
110       PersistentMemoryType
111           (Default) A comma-separated list of the underlying types of
112           persistent memory capacity in the region. One or more of:
113
114           ·   AppDirect: App Direct capacity interleaved across two or more
115               PMem modules that is fully mapped into the system physical
116               address space.
117
118           ·   AppDirectNotInterleaved: App Direct capacity wholly contained
119               on a single PMem modules that is fully mapped into the system
120               physical address space.
121
122       Capacity
123           (Default) Total usable capacity, both allocated and unallocated
124
125       FreeCapacity
126           (Default) Remaining usable capacity
127
128       SocketID
129           (Default) Socket ID to which the region belongs
130
131       HealthState
132           The rolled up health of the underlying PMem modules. One of:
133
134           ·   Unknown: The region health cannot be determined.
135
136           ·   Healthy: All underlying PMem module persistent memory capacity
137               is available.
138
139           ·   Pending: A new memory allocation goal has been created but not
140               applied. Reboot or delete any existing memory allocation goals
141               before creating namespaces on the region.
142
143           ·   Error: There is an issue with some or all of the underlying
144               PMem module capacity because the interleave set has failed. One
145               of: + PMem module missing (serial number of PMem module from
146               the Platform Config Data not found in the PMem module list) +
147               PMem module not configured + Failure to retrieve AppDirect I/O
148               structures from NFIT (system physical address missing) +
149               Interleave set or PMem module region initialization failure
150               (out of memory) + Locked: One or more of the of the underlying
151               Pmem moduless are locked.
152
153       DimmID
154           A list of all the PMem modules that are part of this reg.
155
156
157
158ipmctl                            2020-05-01             IPMCTL-SHOW-REGION(1)