'\" t
.\"     Title: ipmctl-change-sensor
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.10
.\"      Date: 2019-12-15
.\"    Manual: ipmctl
.\"    Source: ipmctl
.\"  Language: English
.\"
.TH "IPMCTL\-CHANGE\-SENSOR" "1" "2019-12-15" "ipmctl" "ipmctl"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
ipmctl\-change\-sensor \- Changes the threshold or enabled state for DCPMMs sensors
.SH "SYNOPSIS"
.sp
.sp
.nf
ipmctl set [OPTIONS] \-sensor (SENSORS) [TARGETS]
AlarmThreshold=(temperature) AlarmEnabled=(0|1)
.fi
.br
.SH "DESCRIPTION"
.sp
Changes the alarm threshold or enabled state for one or more DCPMMs sensors.
Use the command Show Sensor to view the current settings.
.SH "OPTIONS"
.sp
\-f, \-force
.RS 4
Changing the sensor settings is a potentially destructive operation which
requires confirmation from the user for each DCPMM. This option suppresses the
confirmation.
.RE
.sp
\-h, \-help
.RS 4
Displays help for the command.
.RE
.sp
\-ddrt
.RS 4
Used to specify DDRT as the desired transport protocol for the current invocation of ipmctl.
.RE
.sp
\-smbus
.RS 4
Used to specify SMBUS as the desired transport protocol for the current invocation of ipmctl.
.RE
.if n .sp
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
.B Note
.ps -1
.br
.sp
The \-ddrt and \-smbus options are mutually exclusive and may not be used together.
.sp .5v
.RE
.sp
\-o (text|nvmxml), \-output (text|nvmxml)
.RS 4
Changes the output format. One of: "text" (default) or "nvmxml".
.RE
.SH "SENSORS"
.sp
MediaTemperature
.RS 4
The current DCPMM media temperature in Celsius.
.br
Valid values: 0\-2047
.RE
.sp
ControllerTemperature
.RS 4
The current DCPMM controller temperature in Celsius.
.br
Valid values 0\-2047
.RE
.sp
PercentageRemaining
.RS 4
Remaining DCPMM’s life as a percentage value of factory expected
life span.
.br
Valid values: 1\-99
.RE
.SH "TARGETS"
.sp
\-dimm [DimmIDs]
.RS 4
Restricts output to the sensors on specific DCPMMs by optionally supplying the DIMM
target and one or more comma\-separated DCPMM identifiers. The default is to
display sensors for all manageable DCPMMs.
.RE
.SH "PROPERTIES"
.sp
AlarmThreshold
.RS 4
The threshold value at which an alarm for the respective sensor will be triggered.
The upper (for temperatures) or lower (for spare capacity) alarm
threshold of the sensor. Temperatures may be specified in degrees
Celsius to a precision of 1/16 a degree.
.RE
.sp
AlarmEnabled
.RS 4
Enable or disable the alarm threshold, where applicable.
One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"0": Disable
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"1": Enable
.RE
.RE
.SH "EXAMPLES"
.sp
Changes the media temperature threshold to 51 on the specified DCPMM and enable
the alarm.
.sp
.sp
.nf
ipmctl set \-sensor MediaTemperature –dimm 0x0001 AlarmThreshold=51
AlarmEnabled=1
.fi
.br
.SH "LIMITATIONS"
.sp
In order to successfully execute this command:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
The caller must have the appropriate privileges.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
The specified DCPMM(s) must be manageable by the host software.
.RE
.SH "RETURN DATA"
.sp
For each DCPMM, the CLI will indicate the status of the operation. If a failure occurs
when modifying multiple DCPMMs, the process will exit and not continue modifying the
remaining DCPMMs.
.SH "SAMPLE OUTPUT"
.sp
.sp
.nf
Modify (Sensor) settings on DIMM (DimmID): Success
.fi
.br
.sp
.sp
.nf
Modify (Sensor) settings on DIMM (DimmID): Error (Code) \-
(Description)
.fi
.br