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 DCPMM 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       -o (text|nvmxml), -output (text|nvmxml)
35           Changes the output format. One of: "text" (default) or "nvmxml".
36
37       -u (B|MB|MiB|GB|GiB|TB| TiB), -units (B|MB|MiB|GB|GiB|TB| TiB)
38           Changes the units that capacities are displayed in for this
39           command. One of: bytes (B), megabytes (MB), mebibytes (MiB),
40           gigabytes (GB), gibibytes (GiB), terabytes (TB) or tebibytes (TiB).
41

TARGETS

43       -region (RegionIDs)
44           Restricts output to specific persistent memory regions by providing
45           one or more comma separated region identifiers. The default is to
46           display the persistent memory regions across all manageable DCPMMs.
47
48       -socket (SocketIDs)
49           Restricts output to the persistent memory regions on specific
50           sockets by supplying the socket target and one or more
51           comma-separated socket identifiers. The default is to display all
52           sockets.
53

EXAMPLES

55       Shows all attributes of all persistent memory regions in the server.
56
57       ipmctl show -a -region
58
59       Shows all attributes for the specified persistent memory region.
60
61       ipmctl show -a -region 1
62

LIMITATIONS

64       All the underlying DCPMMs should be unlocked to accurately reflect the
65       available capacities. The specified DCPMM(s) must be manageable by the
66       host software.
67

RETURN DATA

69       The default behavior is to display a table with the default attributes
70       listed below; applying options changes the output to a more detailed
71       format.
72
73       ISetID
74           (Default) The region unique identifier. Also known as interleave
75           set cookie.
76
77       PersistentMemoryType
78           (Default) A comma-separated list of the underlying type(s) of
79           persistent memory capacity in the region. One or more of:
80
81           ·   AppDirect: App Direct capacity interleaved across two or more
82               DCPMMs that is fully mapped into the system physical address
83               space.
84
85           ·   AppDirectNotInterleaved: App Direct capacity wholly contained
86               on a single DCPMMs that is fully mapped into the system
87               physical address space.
88
89       Capacity
90           (Default) Total usable capacity, both allocated and unallocated
91
92       FreeCapacity
93           (Default) Remaining usable capacity
94
95       SocketID
96           (Default) Socket ID to which the region belongs
97
98       HealthState
99           The rolled up health of the underlying DCPMMs. One of:
100
101           ·   Unknown: The region health cannot be determined.
102
103           ·   Healthy: All underlying DCPMM persistent memory capacity is
104               available.
105
106           ·   Pending: A new memory allocation goal has been created but not
107               applied. Reboot or delete any existing memory allocation goals
108               before creating namespaces on the region.
109
110           ·   Error: There is an issue with some or all of the underlying
111               DCPMM capacity because the interleave set has failed.
112
113           ·   Locked: One or more of the of the underlying DCPMMs are locked.
114
115       DimmID
116           A list of all the DIMMs that are part of this reg.
117
118
119
120ipmctl                            2019-10-23             IPMCTL-SHOW-REGION(1)
Impressum