File: ipmi-dcmi.8.pre.in

package info (click to toggle)
freeipmi 1.4.11-1.1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 21,952 kB
  • ctags: 18,990
  • sloc: ansic: 299,490; sh: 11,087; makefile: 1,958; perl: 1,078
file content (197 lines) | stat: -rw-r--r-- 8,940 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
.\"#############################################################################
.\"$Id: ipmi-dcmi.8.pre.in,v 1.8 2010-02-08 22:02:30 chu11 Exp $
.\"#############################################################################
.\"  Copyright (C) 2009-2014 Lawrence Livermore National Security, LLC.
.\"  Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
.\"  Written by Albert Chu <chu11@llnl.gov>
.\"  LLNL-CODE-413270
.\"  
.\"  This file is part of Ipmi-Dcmi, tools and libraries to support the data center
.\"  manageability interface (DCMI).  For details, see http://www.llnl.gov/linux/.
.\"
.\"  Ipmi-Dcmi is free software; you can redistribute it and/or modify it under
.\"  the terms of the GNU General Public License as published by the Free
.\"  Software Foundation; either version 3 of the License, or (at your option)
.\"  any later version.
.\"  
.\"  Ipmi-Dcmi is distributed in the hope that it will be useful, but WITHOUT 
.\"  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
.\"  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License 
.\"  for more details.
.\"  
.\"  You should have received a copy of the GNU General Public License along
.\"  with Ipmi-Dcmi.  If not, see <http://www.gnu.org/licenses/>.
.\"############################################################################
.TH IPMI-DCMI 8 "@ISODATE@" "ipmi-dcmi @PACKAGE_VERSION@" "System Commands"
.SH "NAME"
ipmi-dcmi \- IPMI DCMI utility
.SH "SYNOPSIS"
.B ipmi-dcmi
[\fIOPTION\fR...]
.SH "DESCRIPTION"
.B Ipmi-dcmi
is used to execute Data Center Manageability Interface (often referred
to as DCM or DCMI) IPMI extension commands.  DCMI extensions include
support for asset management and power usage management.  Most will be
interested in DCMI for its power management features.  By configuring
an exception action, power limit, and correction time limit, power
usage in a data center can be managed more affectively.  Please see
\fB\-\-set\-power\-limit\fR option below for more information.

DCMI can also be configured using the \fIdcmi\fR category in
.B ipmi-config(8).

The DCMI specification encompasses many traditional IPMI features that
are not implemented directly in this tool.  Please see
.B ipmiconsole(8)
for Serial-over-LAN (SOL) support,
.B ipmi-chassis(8)
for power status, power control, identification, and ACPI power state information,
.B ipmipower(8)
for power status and power control,
.B ipmi-sel(8)
for System Event Log (SEL) information,
.B bmc-info(8)
for device and globally unique ID (guid) information,
.B ipmi-sensors(8)
for sensor readings,
and
.B ipmi-config(8)
for configuration.

#include <@top_srcdir@/man/manpage-common-table-of-contents.man>
#include <@top_srcdir@/man/manpage-common-general-options-header.man>
#include <@top_srcdir@/man/manpage-common-driver.man>
#include <@top_srcdir@/man/manpage-common-inband.man>
#include <@top_srcdir@/man/manpage-common-outofband-hostname-hostranged.man>
#include <@top_srcdir@/man/manpage-common-outofband-username-admin.man>
#include <@top_srcdir@/man/manpage-common-outofband-password.man>
#include <@top_srcdir@/man/manpage-common-outofband-k-g.man>
#include <@top_srcdir@/man/manpage-common-outofband-session-timeout.man>
#include <@top_srcdir@/man/manpage-common-outofband-retransmission-timeout.man>
#include <@top_srcdir@/man/manpage-common-authentication-type.man>
#include <@top_srcdir@/man/manpage-common-cipher-suite-id-main.man>
#include <@top_srcdir@/man/manpage-common-cipher-suite-id-details.man>
#include <@top_srcdir@/man/manpage-common-privilege-level-admin.man>
#include <@top_srcdir@/man/manpage-common-config-file.man>
#include <@top_srcdir@/man/manpage-common-workaround-flags.man>
#include <@top_srcdir@/man/manpage-common-debug.man>
#include <@top_srcdir@/man/manpage-common-misc.man>
.SH "IPMI-DCMI OPTIONS"
The following options are specific to
.B Ipmi-dcmi.
.TP
\fB\-\-get\-dcmi\-capability\-info\fR
Get DCMI capability information.
.TP
\fB\-\-get\-asset\-tag\fR
Get asset tag.
.TP
\fB\-\-set\-asset\-tag\fR=\fISTRING\fR
Set asset tag.
.TP
\fB\-\-get\-management\-controller\-identifier\-string\fR
Get management controller identifier string tag.
.TP
\fB\-\-set\-management\-controller\-identifier\-string\fR=\fISTRING\fR
Set management controller identifier string tag.
.TP
\fB\-\-get\-dcmi\-sensor\-info\fR
Get DCMI sensor information.
.TP
\fB\-\-get\-system\-power\-statistics\fR
Get system power statistics.
.TP
\fB\-\-get\-enhanced\-system\-power\-statistics\fR
Get enhanced system power statistics.
.TP
\fB\-\-get\-power\-limit\fR
Get power limit information.
.TP
\fB\-\-set\-power\-limit\fR
Set power limit configuration.  Can specify configuration via 
the
\fB\-\-exception\-actions\fR,
\fB\-\-power\-limit\-requested\fR,
\fB\-\-correction\-time\-limit\fR,
and
\fB\-\-correction\-time\-limit\fR
options
listed below.  If one or more options below are not specified, current
configuration will be utilized.
.TP
\fB\-\-exception\-actions\fR=\fIBITMASK\fR
Specify exception actions for set power limit configuration.  Special
case allowable values: NO_ACTION, HARD_POWER_OFF_SYSTEM,
LOG_EVENT_TO_SEL_ONLY.  Other values (e.g. 0x02 through 0x10) are OEM
dependent.  Used with the \fB\-\-set\-power\-limit\fR option.
.TP
\fB\-\-power\-limit\-requested\fR=\fIWATTS\fR
Specify power limit for set power limit configuration.  Input is
specified in watts.  Used with the \fB\-\-set\-power\-limit\fR option.
.TP
\fB\-\-correction\-time\-limit\fR=\fIMILLISECONDS\fR
Specify correction time limit for set power limit configuration.
Input is specified in milliseconds.  Used with the
\fB\-\-set\-power\-limit\fR option.
.TP
\fB\-\-statistics\-sampling\-period\fR=\fISECONDS\fR
Specify management application statistics sampling period for set
power limit configuration.  Input is specified in seconds.  Used with
the \fB\-\-set\-power\-limit\fR option.
.TP
\fB\-\-activate\-deactivate\-power\-limit\fR=\fIOPERATION\fR
Activate or deactivate power limit.  Allowed values: ACTIVATE, DEACTIVATE.
#include <@top_srcdir@/man/manpage-common-interpret-oem-data.man>
#include <@top_srcdir@/man/manpage-common-time-options-heading.man>
#include <@top_srcdir@/man/manpage-common-time-options.man>
#include <@top_srcdir@/man/manpage-common-hostranged-options-header.man>
#include <@top_srcdir@/man/manpage-common-hostranged-buffer.man>
#include <@top_srcdir@/man/manpage-common-hostranged-consolidate.man>
#include <@top_srcdir@/man/manpage-common-hostranged-fanout.man>
#include <@top_srcdir@/man/manpage-common-hostranged-eliminate.man>
#include <@top_srcdir@/man/manpage-common-hostranged-always-prefix.man>
#include <@top_srcdir@/man/manpage-common-hostranged-text-main.man>
#include <@top_srcdir@/man/manpage-common-hostranged-text-threads.man>
#include <@top_srcdir@/man/manpage-common-hostranged-text-options.man>
#include <@top_srcdir@/man/manpage-common-hostranged-text-localhost.man>
#include <@top_srcdir@/man/manpage-common-troubleshooting-heading-start.man>
#include <@top_srcdir@/man/manpage-common-troubleshooting-heading-outofband.man>
#include <@top_srcdir@/man/manpage-common-troubleshooting-heading-inband.man>
#include <@top_srcdir@/man/manpage-common-troubleshooting-heading-end.man>
#include <@top_srcdir@/man/manpage-common-troubleshooting-outofband.man>
#include <@top_srcdir@/man/manpage-common-troubleshooting-inband.man>
#include <@top_srcdir@/man/manpage-common-troubleshooting-inband-outofband.man>
#include <@top_srcdir@/man/manpage-common-workaround-heading-text.man>
#include <@top_srcdir@/man/manpage-common-workaround-inband-text.man>
#include <@top_srcdir@/man/manpage-common-workaround-outofband-common-text.man>
#include <@top_srcdir@/man/manpage-common-workaround-outofband-15-text.man>
#include <@top_srcdir@/man/manpage-common-workaround-outofband-20-text.man>
#include <@top_srcdir@/man/manpage-common-workaround-extra-text.man>
#include <@top_srcdir@/man/manpage-common-oem-interpretation.man>
.LP
Currently None
.SH "EXAMPLES"
.B # ipmi-dcmi --get-power-limit
.PP
Get power limit of the local machine.
.PP
.B # ipmi-dcmi -h ahost -u myusername -p mypassword --get-power-limit
.PP
Get power limit of a remote machine using IPMI over LAN.
.PP
.B # ipmi-dcmi -h mycluster[0-127] -u myusername -p mypassword --get-power-limit
.PP
Get power limit across a cluster using IPMI over LAN.
.PP
#include <@top_srcdir@/man/manpage-common-diagnostics.man>
#include <@top_srcdir@/man/manpage-common-diagnostics-hostranged-text.man>
#include <@top_srcdir@/man/manpage-common-known-issues.man>
#include <@top_srcdir@/man/manpage-common-reporting-bugs.man>
.SH "COPYRIGHT"
Copyright (C) 2009-2014 Lawrence Livermore National Security, LLC.
#include <@top_srcdir@/man/manpage-common-gpl-program-text.man>
.SH "SEE ALSO"
freeipmi(7), ipmi-chassis(8), ipmi-config(8), ipmi-sel(8),
ipmi-sensors(8), ipmiconsole(8), ipmipower(8)
#include <@top_srcdir@/man/manpage-common-homepage.man>