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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
.TH BMC-DEVICE 8 "@ISODATE@" "bmc-device @PACKAGE_VERSION@" "System Commands"
.SH "NAME"
bmc-device \- perform advanced BMC commands
.SH "SYNOPSIS"
.B bmc-device
[\fIOPTION\fR...]
.SH "DESCRIPTION"
.B bmc-device
supports a variety of IPMI commands to perform advanced BMC functions.
This tool is primarily used for development debugging, BMC error
recory, retrieving detailed technical information, and other advanced
purposes. Most IPMI users will not need to use this tool. Some of
the
.B bmc-device
commands are not supported on all motherboards.
#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-user.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 "BMC-DEVICE OPTIONS"
The following options are specific to
.B bmc-device.
.TP
\fB\-\-cold\-reset\fR
Perform a cold reset.
.TP
\fB\-\-warm\-reset\fR
Perform a warm reset.
.TP
\fB\-\-get\-self\-test\-results\fR
Output BMC self test results.
.TP
\fB\-\-get\-acpi\-power\-state\fR
Get ACPI system and device power state.
.TP
\fB\-\-set\-acpi\-power\-state\fR
Set ACPI power state. Must be specified to use the
\fB\-\-set\-acpi\-system\-power\-state\fR,
and
\fB\-\-set\-acpi\-device\-power\-state\fR
options listed below.
.TP
\fB\-\-set\-acpi\-system\-power\-state\fR=\fISYSTEM_POWER_STATE\fR
Set ACPI system power state. Allowed values:
S0_G0, S1, S2, S3, S4, S5_G2, S4_S5, G3, SLEEPING, G1_SLEEPING, OVERRIDE,
LEGACY_ON, LEGACY_OFF, UNKNOWN.
Used with the \fB\-\-set\-acpi\-power\-state\fR option.
.TP
\fB\-\-set\-acpi\-device\-power\-state\fR=\fIDEVICE_POWER_STATE\fR
Set ACPI device power state. Allowed values:
D0, D1, D2, D3, UNKNOWN.
Used with the \fB\-\-set\-acpi\-power\-state\fR option.
.TP
\fB\-\-get\-lan\-statistics\fR
Get IP, UDP, and RMCP statistics.
.TP
\fB\-\-clear\-lan\-statistics\fR
Clear IP, UDP, and RMCP statistics.
.TP
\fB\-\-rearm\-sensor\fR=\fI"<record_id> [<assertion_bitmask> <deassertion_bitmask>]"\fR
Re-arm a sensor. Re-arming a sensor informs the internal device to
reset and re-evaluate a sensor reading and events. Most sensors are
automatically re-armed, however a rare few do require manual
re-arming. This option may also be useful to reset a sensor reading
or event that may be stuck due to an internal hardware or firmware
error. If the \fIassertion_bitmask\fR and \fIdeassertion_bitmask\fR
are specified, only the specific events will be re-armed. If not
specified, all possible events will be re-armed. This command
requires the loading of the SDR.
.TP
\fB\-\-get\-sdr\-repository\-time\fR
Get SDR repository time.
.TP
\fB\-\-set\-sdr\-repository\-time\fR=\fITIME\fR
Set SDR repository time. Input format = "MM/DD/YYYY - HH:MM:SS".
Note that hours are input in 24 hour form. Alternatively, the local
system time can be specified with "now".
.TP
\fB\-\-get\-sel\-time\fR
Get SEL time.
.TP
\fB\-\-set\-sel\-time\fR=\fITIME\fR
Set SEL time. Input format = "MM/DD/YYYY - HH:MM:SS". Note that
hours are input in 24 hour form. Alternatively, the local
system time can be specified with "now".
.TP
\fB\-\-get\-sel\-time\-utc\-offset\fR
Get SEL time UTC offset.
.TP
\fB\-\-set\-sel\-time\-utc\-offset\fR=\fIMINUTES\fR
Set SEL time UTC offset. Input is in minutes difference from UTC
time, ranging from -1440 to 1440 minutes. A special case value of
"none" can be specified so no UTC offset is specified.
.TP
\fB\-\-platform\-event\fR=\fI"[generator_id] <event_message_format_version> <sensor_type> <sensor_number> <event_type> <event_direction> <event_data1> <event_data2> <event_data3>"\fR
Instruct the BMC to process the specified event data. Typically, this
data will be logged to the System Event Log (SEL), but depending on
implementation it may be processed by other subsystems such as
Platform Event Filtering (PEF). The keywords \fIassertion\fR or
\fIdeassertion\fR may be used for \fIevent_direction\fR, or the
numerical values may be used instead. The
\fIevent_message_format_version\fR is 0x03 for IPMI 1.0 and 0x04 for
IPMI 1.5. The \fIgenerator_id\fR above is optional, however it is
required if generating the event via a system interface (i.e. inband).
If generating the event via a system interface, the system management
software generator id range is 0x41 to 6Fh.
.TP
\fB\-\-set\-sensor\-reading\-and\-event\-status\fR=\fI"<sensor_number> <sensor_reading> <sensor_reading_operation> <assertion_bitmask> <assertion_bitmask_operation> <deassertion_bitmask> <deassertion_bitmask_operation> <event_data1> <event_data2> <event_data3> <event_data_operation>"\fR
Instruct the BMC to set a sensor reading and/or event status. How the
various fields are written depends on a set of operation instructions
specified. The \fIsensor_reading\fR can be written or not changed
with the respective operation \fIwrite\fR and \fInochange\fR. For the
\fIassertion_bitmask\fR and \fIdeassertion_bitmask\fR, the 0 bits of
the bitmask can clear the bits of the status, the 1 bits of the
bitmask can set the bits of the status, the entire bitmask can be
written as the status, or the status cannot be changed respecitvely
with the respective operations \fIclear0bits\fR, \fIset1bits\fR,
\fIwrite\fR, and \fInochange\fR. The \fIevent_data1\fR byte can be
written fully, written without the event offset (bits 3:0), or not be
changed via the \fIwrite\fR, \fInooffsetwrite\fR, or \fInochange\fR
operations.
.TP
\fB\-\-get\-mca\-auxiliary\-log\-status\fR
Get machine check architecture (MCA) auxiliary log status information.
.TP
\fB\-\-get\-ssif\-interface\-capabilities\fR
Get SSIF interface capabilities.
.TP
\fB\-\-get\-kcs\-interface\-capabilities\fR
Get KCS interface capabilities.
.TP
\fB\-\-get\-bt\-interface\-capabilities\fR
Get BT interface capabilities.
.TP
\fB\-\-get\-bmc\-global\-enables\fR
Get BMC Global Enables.
.TP
\fB\-\-set\-system\-firmware\-version\fR=\fISTRING\fR
Set System Firmware Version.
.TP
\fB\-\-set\-system\-name\fR=\fISTRING\fR
Set System Name.
.TP
\fB\-\-set\-primary\-operating\-system\-name\fR=\fISTRING\fR
Set Primary Operating System Name.
.TP
\fB\-\-set\-operating\-system\-name\fR=\fISTRING\fR
Set Operating System Name.
.TP
\fB\-\-set\-present\-os\-version\-number\fR=\fISTRING\fR
Set Present OS Version Number.
.TP
\fB\-\-set\-bmc\-url\fR=\fISTRING\fR
Set BMC URL.
.TP
\fB\-\-set\-base\-os\-hypervisor\-url\fR=\fISTRING\fR
Set Base OS/Hypervisor URL.
.TP
\fB\-\-verbose\fR
Increase verbosity in output.
#include <@top_srcdir@/man/manpage-common-sdr-cache-options-heading.man>
#include <@top_srcdir@/man/manpage-common-sdr-cache-options.man>
#include <@top_srcdir@/man/manpage-common-sdr-cache-file-directory.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-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-sdr-text.man>
#include <@top_srcdir@/man/manpage-common-workaround-extra-text.man>
.SH "EXAMPLES"
.B # bmc-device --cold-reset
.PP
Perform a cold reset.
.PP
.B # bmc-device -h ahost -u myusername -p mypassword --cold-reset
.PP
Perform a cold reset of a remote machine using IPMI over LAN.
.PP
.B # bmc-device -h mycluster[0-127] -u myusername -p mypassword --cold-reset
.PP
Perform a cold reset 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 \(co 2008-2014 FreeIPMI Core Team.
#include <@top_srcdir@/man/manpage-common-gpl-program-text.man>
.SH "SEE ALSO"
freeipmi.conf(5), freeipmi(7)
#include <@top_srcdir@/man/manpage-common-homepage.man>
|
