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

NAME

6       ipmctl-show-sensor - Shows sensor data for one or more PMem modules
7

SYNOPSIS

9           ipmctl show [OPTIONS] -sensor [SENSORS] [TARGETS]
10

DESCRIPTION

12       Shows sensor data for one or more PMem modules. This data includes PMem
13       module health, temperatures, percentage remaining, up-time and more.
14

OPTIONS

16       -a, -all
17           Shows all attributes.
18
19           Note
20           The all and display options are exclusive and may not be used
21           together.
22
23       -d (attributes), -display (attributes)
24           Filters the returned attributes by explicitly specifying a comma
25           separated list of any of the attributes defined in the Return Data
26           section.
27
28           Note
29           The all and display options are exclusive and may not be used
30           together.
31
32       -h, -help
33           Displays help for the command.
34
35       -ddrt
36           Used to specify DDRT as the desired transport protocol for the
37           current invocation of ipmctl.
38
39       -smbus
40           Used to specify SMBUS as the desired transport protocol for the
41           current invocation of ipmctl.
42
43           Note
44           The -ddrt and -smbus options are mutually exclusive and may not be
45           used together.
46
47       -o (text|nvmxml), -output (text|nvmxml)
48           Changes the output format. One of: "text" (default) or "nvmxml".
49

SENSORS

51       Health
52           (Default) The current PMem module health as reported in the SMART
53           log. Attributes include:
54
55           •   DimmID
56
57           •   Type
58
59           •   CurrentValue
60
61       MediaTemperature
62           (Default) The current PMem module media temperature in Celsius.
63           Attributes include:
64
65           •   DimmID
66
67           •   Type
68
69           •   CurrentValue
70
71           •   AlarmThreshold
72
73           •   AlarmEnabled
74
75           •   ThrottlingStopThreshold
76
77           •   ThrottlingStartThreshold
78
79           •   ShutdownThreshold
80
81           •   MaxTemperature
82
83       ControllerTemperature
84           (Default) The current PMem module controller temperature in
85           Celsius. Attributes include:
86
87           •   DimmID
88
89           •   Type
90
91           •   CurrentValue
92
93           •   AlarmThreshold
94
95           •   AlarmEnabled
96
97           •   ThrottlingStopThreshold
98
99           •   ThrottlingStartThreshold
100
101           •   ShutdownThreshold
102
103           •   MaxTemperature
104
105       PercentageRemaining
106           (Default) Remaining PMem module’s life as a percentage value of
107           factory expected life span. Attributes include:
108
109           •   DimmID
110
111           •   Type
112
113           •   CurrentValue
114
115           •   AlarmThreshold
116
117           •   AlarmEnabled
118
119       LatchedDirtyShutdownCount
120           (Default) The number of shutdowns without notification over the
121           lifetime of the PMem module. Attributes include:
122
123           •   DimmID
124
125           •   Type
126
127           •   CurrentValue
128
129       UnlatchedDirtyShutdownCount
130           (Default) The number of shutdowns without notification over the
131           lifetime of the PMem module. This counter is the same as
132           LatchedDirtyShutdownCount except it will always be incremented on a
133           dirty shutdown, even if Latch System Shutdown Status was not
134           enabled. Attributes include:
135
136           •   DimmID
137
138           •   Type
139
140           •   CurrentValue
141
142       PowerOnTime
143           (Default) The total power-on time over the lifetime of the PMem
144           module. Attributes include:
145
146           •   DimmID
147
148           •   Type
149
150           •   CurrentValue
151
152       UpTime
153           (Default) The total power-on time since the last power cycle of the
154           PMem module. Attributes include:
155
156           •   DimmID
157
158           •   Type
159
160           •   CurrentValue
161
162       PowerCycles
163           (Default) The number of power cycles over the lifetime of the PMem
164           module. Attributes include:
165
166           •   DimmID
167
168           •   Type
169
170           •   CurrentValue
171
172       FwErrorCount
173           (Default) The total number of firmware error log entries.
174           Attributes include:
175
176           •   DimmID
177
178           •   Type
179
180           •   CurrentValue
181

TARGETS

183       -dimm [DimmIDs]
184           Restricts output to the sensors on specific PMem modules by
185           supplying the DIMM target and one or more comma separated PMem
186           module identifiers. The default is to display sensors for all
187           manageable PMem modules.
188

EXAMPLES

190       Gets all sensor information for all PMem modules.
191
192           ipmctl show -sensor
193
194       Shows the media temperature sensor for the specified PMem module.
195
196           ipmctl show -sensor MediaTemperature -dimm 0x0001
197

LIMITATIONS

199       In order to successfully execute this command:
200
201       •   The caller must have the appropriate privileges.
202
203       •   The specified PMem modules must be manageable by the host software.
204

RETURN DATA

206       This command displays a table with a row for each sensor on each PMem
207       module. Applying a specific PMem module or sensor type target limits
208       the number of rows. Applying options can be used to expand or restrict
209       the output.
210
211           Note
212           Supported thresholds for a given sensor are listed as a part of the
213           return data when using the -all or -display flag. Only the alarm
214           threshold is settable.
215
216       DimmID
217           (Default) The PMem module identifier
218
219       Type
220           (Default) The sensor type. Refer to the sensor table above.
221
222       CurrentValue
223           (Default) The current reading followed by the units of measurement
224           (e.g., 57 °C or 25%)
225
226       AlarmThreshold
227           The threshold value at which an alarm for the respective sensor
228           will be triggered.
229
230       AlarmEnabled
231           Current state of the alarm threshold, where applicable. One of:
232
233           •   0: Disabled
234
235           •   1: Enabled
236
237           •   N/A
238
239       ThrottlingStopThreshold
240           The threshold value at which firmware will stop throttling to
241           reduce overall thermals and keep the PMem module within safe
242           operating temperatures.
243
244       ThrottlingStartThreshold
245           The threshold value at which firmware will start throttling to
246           reduce overall thermals and keep the PMem module within safe
247           operating temperatures.
248
249       ShutdownThreshold
250           The threshold value at which device shutdown will occur.
251
252       MaxTemperature
253           The highest temperature reported in degrees Celsius for a given
254           media or controller sensor. This value is persistent through Power
255           Loss and is read-only.
256
257
258
259ipmctl                            2023-07-20             IPMCTL-SHOW-SENSOR(1)