'\" t
.\"     Title: ipmctl-modify-device
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.12
.\"      Date: 2021-08-16
.\"    Manual: ipmctl
.\"    Source: ipmctl
.\"  Language: English
.\"
.TH "IPMCTL\-MODIFY\-DEVICE" "1" "2021-08-16" "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\-modify\-device \- Changes the configurable setting(s) on one or more DCPMMs
.SH "SYNOPSIS"
.sp
.sp
.nf
ipmctl set [OPTIONS] \-dimm (DimmIDs) AveragePowerReportingTimeConstant=(100\-12000)
.fi
.br
.SH "DESCRIPTION"
.sp
Changes the configurable setting(s) on one or more DCPMMs.
.SH "OPTIONS"
.sp
\-f, \-force
.RS 4
Changing DCPMM setting(s) 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
\-o (text|nvmxml), \-output (text|nvmxml)
.RS 4
Changes the output format. One of: "text" (default) or "nvmxml".
.RE
.SH "TARGETS"
.sp
\-dimm (DimmIDs)
.RS 4
Modifies specific DCPMMs by supplying one or more comma\-separated DCPMM
identifiers. However, this is not recommended as it may put the system in an
undesirable state. The default is to modify all manageable DCPMMs.
.RE
.SH "PROPERTIES"
.sp
AveragePowerReportingTimeConstantMultiplier
.RS 4
The value that is used to multiply the base time value used for average power
consumption measurements. Can be set to a value between 0 and 32. The default
value is 0.
.RE
.sp
AveragePowerReportingTimeConstant
.RS 4
The value, in milliseconds, used to determine the time constant for reporting
the average power consumption measurements. Can be set to a value between 100
and 12000, by increments of 100. The default value is 1000.
.RE
.SH "EXAMPLES"
.sp
Sets average power reporting time constant multiplier to 1 on all manageable DCPMMs
.sp
.sp
.nf
set \-dimm AveragePowerReportingTimeConstant=1500
.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 DIMM (DimmID): Success
Modify DIMM (DimmID): Error (Code)\-(Description)
.fi
.br