1IPMCTL-SHOW-MEMORY-RESOURCES(1)     ipmctl     IPMCTL-SHOW-MEMORY-RESOURCES(1)
2
3
4

NAME

6       ipmctl-show-memory-resources - Shows the total DCPMM memory resource
7       allocation
8

SYNOPSIS

10       ipmctl show [OPTIONS] -memoryresources
11

DESCRIPTION

13       Shows the total DCPMM memory resource allocation across the host
14       server.
15

OPTIONS

17       -h, -help
18           Displays help for the command.
19
20       -o (text|nvmxml), -output (text|nvmxml)
21           Changes the output format. One of: "text" (default) or "nvmxml".
22
23       -u (B|MB|MiB|GB|GiB|TB| TiB), -units (B|MB|MiB|GB|GiB|TB| TiB)
24           Changes the units that capacities are displayed in for this
25           command. One of: bytes (B), megabytes (MB), mebibytes (MiB),
26           gigabytes (GB), gibibytes (GiB), terabytes (TB) or tebibytes (TiB).
27

EXAMPLES

29       Shows the DCPMM memory resource allocation.
30
31       ipmctl show -memoryresources
32

RETURN DATA

34       Returns the default attributes listed below.
35
36           Note
37           Capacities from unmanageable DCPMMs are not included in the
38           following aggregated totals.
39
40       Capacity
41           Total system DCPMM capacity.
42
43       MemoryCapacity
44           Total usable system DCPMM Memory Mode capacity.
45
46       AppDirectCapacity
47           Total usable system DCPMM App Direct capacity.
48
49       UnconfiguredCapacity
50           Total system DCPMM capacity that is unusable because it has not
51           been configured.
52
53       ReservedCapacity
54           Total system DCPMM persistent memory capacity that is reserved.
55           This capacity is the persistent memory partition capacity (rounded
56           down for alignment) less any App Direct capacity. Reserved capacity
57           typically results from a Memory Allocation Goal request that
58           specified the Reserved property. This capacity is not mapped to
59           system physical address (SPA) space.
60
61       InaccessibleCapacity
62           Total system DCPMM capacity that is inaccessible due any of:
63
64           ·   Platform configuration prevents accessing this capacity. e.g.
65               MemoryCapacity is configured but MemoryMode is not enabled by
66               platform FW (current Memory Mode is 1LM).
67
68           ·   Capacity is inaccessible because it is not mapped into the
69               system physical address space (SPA). This is usually due to
70               platform firmware memory alignment requirements.
71
72           ·   DCPMM configured capacity but SKU prevents usage. e.g.
73               AppDirectCapcity but DCPMM SKU is MemoryMode only.
74

DETAILS

76       DCPMMs are partitioned into Memory and Persistent partitions. ipmctl
77       will align the Memory partition on a 1 GiB boundary with the Persistent
78       partition consuming the remaining capacity. An exception: if DCPMM is
79       configured for 100% Memory Mode then Memory partition will consume 100%
80       of the capacity, while Persistent partition will be 0 length. Any
81       capacity that falls outside the Memory and Persistent partitions is
82       InaccessibleCapacity and is not useable.
83
84       Platform firmware alignment restrictions may result in some capacity
85       from the Memory and Persistent partitions not mapped to system physical
86       address (SPA) space. This memory is considered InaccessibleCapacity and
87       is not usable.
88
89       Definitions:
90
91       Total Capacity (TC)
92           Raw Capacity (total usable) reported by DCPMM DIMM Partition Info
93
94       Memory Partition Capacity (MPC)
95           Volatile Capacity reported by DCPMM DIMM Partition Info
96
97       Persistent Partition Capacity (PPC)
98           Persistent Capacity reported by DCPMM DIMM Partition Info
99
100       Volatile Memory Size (VMS)
101           Usable volatile memory capacity as reported by platform FW via
102           Intel NVDIMM Current Config→Volatile Memory Size Mapped into SPA
103           field
104
105       Persistent Memory Size (PMS)
106           Usable persistent memory capacity as reported by platform FW via
107           Intel NVDIMM Current Config→Persistent Memory Size Mapped into SPA
108           field
109
110       DCPMM DIMM Partition Info
111           DIMM Partition Info provided by DCPMM firmware. See Intel® Optane™
112           DC Persistent Memory Module Firmware Interface Specification for
113           details.
114
115       Intel NVDIMM Current Config
116           See Intel® NVM Dimm Management Software-Firmware Interface
117           Specification for details.
118
119       Calculations:
120
121       MemoryCapacity = Volatile Memory Size
122
123       AppDirectCapacity = Persistent Memory Size
124
125       ReservedCapacity = PPC (rounded down for PM alignment) - PMS
126
127       InaccessibleCapacity =
128         + (TC - MPC - PPC)
129         + (TC - PMS - ReservedCapacity)
130        if (CurrentMode == 1LM) then
131         + VMS (rounded down for alignment)
132
133
134
135ipmctl                            2019-04-10   IPMCTL-SHOW-MEMORY-RESOURCES(1)