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

NAME

6       ipmctl-set-sensor - Sets the threshold or enabled state for PMem
7       modules sensors
8

SYNOPSIS

10           ipmctl set [OPTIONS] -sensor (SENSORS) [TARGETS]
11           AlarmThreshold=(temperature) AlarmEnabled=(0|1)
12

DESCRIPTION

14       Changes the alarm threshold or enabled state for one or more PMem
15       modules sensors. Use the command Show Sensor to view the current
16       settings.
17

OPTIONS

19       -f, -force
20           Changing the sensor settings is a potentially destructive operation
21           which requires confirmation from the user for each PMem module.
22           This option suppresses the confirmation.
23
24       -h, -help
25           Displays help for the command.
26
27       -ddrt
28           Used to specify DDRT as the desired transport protocol for the
29           current invocation of ipmctl.
30
31       -smbus
32           Used to specify SMBUS as the desired transport protocol for the
33           current invocation of ipmctl.
34
35           Note
36           The -ddrt and -smbus options are mutually exclusive and may not be
37           used together.
38
39       -o (text|nvmxml), -output (text|nvmxml)
40           Changes the output format. One of: "text" (default) or "nvmxml".
41

SENSORS

43       MediaTemperature
44           The PMem module media temperature in Celsius.
45
46       ControllerTemperature
47           The PMem module controller temperature in Celsius.
48
49       PercentageRemaining
50           Remaining PMem module’s life as a percentage value of factory
51           expected life span.
52

TARGETS

54       -dimm [DimmIDs]
55           Update specified sensors on specific PMem modules by optionally
56           supplying the PMem module target and one or more comma separated
57           PMem module identifiers. The default is to update the specified
58           sensors for all manageable PMem modules.
59

PROPERTIES

61       AlarmThreshold
62           The threshold value at which an alarm for the respective sensor
63           will be triggered. The upper (for temperatures) or lower (for
64           percentage remaining) alarm threshold of the sensor. Temperatures
65           may be specified to a precision of 1 degree Celsius.
66
67           Table 1. Allowed AlarmThreshold
68           ┌──────────────────────┬────────────────┬─────────┐
69           │                      │                │         │
70           │Sensor                │ Allowed        │ Units   │
71           │                      │ AlarmThreshold │         │
72           │                      │ values         │         │
73           ├──────────────────────┼────────────────┼─────────┤
74           │                      │                │         │
75           │MediaTemperature      │ 0-85           │ Celsius │
76           ├──────────────────────┼────────────────┼─────────┤
77           │                      │                │         │
78           │ControllerTemperature │ 0-102          │ Celsius │
79           ├──────────────────────┼────────────────┼─────────┤
80           │                      │                │         │
81           │PercentageRemaining   │ 1-99           │ %       │
82           └──────────────────────┴────────────────┴─────────┘
83
84       AlarmEnabled
85           Enable or disable the alarm threshold, where applicable. One of:
86
87           •   "0": Disable
88
89           •   "1": Enable
90

EXAMPLES

92       Changes the media temperature alarm threshold to 51C on the specified
93       PMem module and enables the alarm.
94
95           ipmctl set -sensor MediaTemperature -dimm 0x0001 AlarmThreshold=51 AlarmEnabled=1
96

LIMITATIONS

98       In order to successfully execute this command:
99
100       •   The caller must have the appropriate privileges.
101
102       •   The specified PMem modules must be manageable by the host software.
103

RETURN DATA

105       For each PMem module, the CLI will indicate the status of the
106       operation. If a failure occurs when modifying multiple PMem modules,
107       the process will exit and not continue modifying the remaining PMem
108       modules.
109

SAMPLE OUTPUT

111           Modify (Sensor) settings on DIMM (DimmID): Success
112
113           Modify (Sensor) settings on DIMM (DimmID): Error (Code) -
114           (Description)
115
116
117
118ipmctl                            2023-07-20              IPMCTL-SET-SENSOR(1)
Impressum