1IPMCTL-INJECT-ERROR(1) ipmctl IPMCTL-INJECT-ERROR(1)
2
6 ipmctl-inject-error - Injects an error or clears a previously injected
7 error
8
10 ipmctl set [OPTIONS] -dimm (DimmIDs) [PROPERTIES]
11
13 Injects an error or clears a previously injected error on one or more
14 DCPMM for testing purposes.
15
17 -h, -help
18 Displays help for the command.
19 -o (text|nvmxml), -output (text|nvmxml)
21 Changes the output format. One of: "text" (default) or "nvmxml".
22
24 -dimm (DimmIDS)
25 Injects or clears an error on specific DCPMMs by supplying one or
26 more comma separated DCPMM identifiers. The default is to inject
27 the error on all manageable DCPMMs.
28
30 This command only supports setting or clearing one type of error at a
31 time.
32 Clear
34 · "1": Clears a previously injected error. This property must be
36 combined with one of the other properties indicating the
37 previously injected error to clear.
38 Temperature
40 Injects an artificial media temperature in degrees Celsius into the
41 DCPMM. The firmware that is monitoring the temperature of the DCPMM
42 will then be alerted and take necessary precautions to preserve the
43 DCPMM. The value is injected immediately and will override the
44 firmware from reading the actual media temperature of the device
45 and use this value instead which may cause adverse reactions by the
46 firmware and result in an alert or log.
47 Note: The injected temperature value will remain until the next
48 reboot or it is cleared. The media temperature is an artificial
49 temperature and will not cause harm to the part. Although firmware
50 actions due to improper temperature injections may cause adverse
51 effects on the DCPMM. If the Critical Shutdown Temperature, or
52 higher, is passed in, this may cause the DCPMM firmware to perform
53 a shutdown in order to preserve the part and data. The temperature
54 value will be ignored on clear.
55 Poison
57 The physical address to poison.
58 Note: The address must be 256 byte aligned (e.g., 0x10000000,
59 0x10000100, 0x10000200...).
60 Poison is not possible for any address in the PM region if the PM
61 region is locked. Injected poison errors are only triggered on a
62 subsequent read of the poisoned address in which case an error log
63 will be generated by the firmware, but no alerts will be sent.
64 This command can be used to clear non-injected poison errors. The
65 data will be zero’d after clearing. There is no requirement to
66 enable error injection prior to request to clear poison errors.
67 The caller is responsible for keeping a list of injected poison
68 errors, in order to properly clear the injected errors afterwards.
69 Simply disabling injection does not clear injected poison errors.
70 Injected poison errors are persistent across power cycles and
71 system resets.
72 PoisonType
74 The type of memory to poison. One of:
75 · "PatrolScrub": Injects a poison error at the specified address
77 simulating an error found during a patrol scrub operation
78 indifferent to how the memory is currently allocated, This is
79 the default.
80 · "MemoryMode": Injects a poison error at the specified address
82 currently allocated in Memory Mode.
83 · "AppDirect": Injects a poison error at the specified address
85 currently allocated as App Direct.
86 Note: If the address to poison is not currently allocated as
87 the specified memory type, an error is returned.
88 PackageSparing
90 · "1": Triggers an artificial package sparing. If package sparing
92 is enabled and the DCPMM still has spares remaining, this will
93 cause the firmware to report that there are no spares
94 remaining.
95 PercentageRemaining
97 Injects an artificial module life remaining percentage into the
98 DCPMM. This will cause the firmware to take appropriate action
99 based on the value and if necessary generate an error log and an
100 alert and update the health status.
101 FatalMediaError
103 · "1": Injects a fake media fatal error which will cause the
105 firmware to generate an error log and an alert.
106 NOTE: When media fatal error is injected, BSR Media Disabled status
108 bit will be set indicating media error, until the fatal error is
109 cleared using disable trigger input parameter to clear this injected
110 fatal error.
111 NOTE: Injecting a Fatal Media error is unsupported on Windows. Please
113 contact Microsoft for assistance in performing this action.
114 DirtyShutdown
116 · "1": Injects an ADR failure resulting in dirty shutdown upon
118 reboot.
119
121 Sets the media temperature on all manageable DCPMMs to 100 degrees
122 Celsius.
123 ipmctl set -dimm Temperature=100
125 Clears the injected media temperature on all manageable DCPMMs.
127 ipmctl set -dimm Clear=1 Temperature=1
129 Poison address 0x10000200 on DCPMM 1234.
131 ipmctl set -dimm 1234 Poison=0x10000200
133 Clears the injected poison of address 0x10000200 on DCPMM 1234.
135 ipmctl set -dimm 1234 Poison=0x10000200 Clear=1
137 Triggers an artificial package sparing on all manageable DCPMMs.
139 ipmctl set -dimm PackageSparing=1
141 Sets the life remaining percentage on all manageable DCPMMs to 10%.
143 ipmctl set -dimm PercentageRemaining=10
145 Clears the injected remaining life percentage on all manageable DCPMMs.
147 The value of PercentageRemaining is irrelevant.
148 ipmctl set -dimm PercentageRemaining=10 Clear=1
150 Triggers an artificial ADR failure on all manageable DCPMM s resulting
152 in a dirty shutdown on each DCPMM on the next reboot.
153 ipmctl set -dimm DirtyShutdown=1
155
157 This command is available only when error injection is enabled on the
158 DCPMM(s) in the BIOS. To successfully execute this command, the
159 specified DCPMM(s) must be manageable by the host software.
160
162 For each DCPMM, the CLI will indicate the status of the operation. If a
163 failure occurs when injecting an error on multiple DCPMMs, the process
164 will continue with the remaining DCPMMs.
165
167 Set temperature on DCPMM (DimmID): Success|Error (Code) -
168 (Description)
169 Clear injected temperature on DCPMM (DimmID): Success|Error
170 (Code) - (Description)
171 Poison address (Address) on DCPMM (DimmID): Success|Error
172 (Code) - (Description)
173 Clear injected poison of address (Address) on DCPMM
174 (DimmID): Success|Error (Code) - (Description)
175 Trigger package sparing on DCPMM (DimmID): Success|Error
176 (Code) - (Description)
177 Clear injected package sparing on DCPMM (DimmID):
178 Success|Error (Code) - (Description)
179 Trigger a spare capacity alarm on DCPMM (DimmID):
180 Success|Error (Code) - (Description)
181 Clear injected spare capacity alarm on DCPMM (DimmID):
182 Success|Error (Code) - (Description)
183 Create a media fatal error on DCPMM (DimmID): Success|Error
184 (Code) - (Description)
185 Clear injected media fatal error on DCPMM (DimmID):
186 Success|Error (Code) - (Description)
187ipmctl 2019-10-23 IPMCTL-INJECT-ERROR(1)