-
Notifications
You must be signed in to change notification settings - Fork 388
/
Copy pathipmitool.1.in
3861 lines (3266 loc) · 92.3 KB
/
ipmitool.1.in
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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
.TH "ipmitool" "1" "" "Duncan Laurie" ""
.SH "NAME"
ipmitool \- utility for controlling IPMI\-enabled devices
.SH "SYNOPSIS"
.BR ipmitool
[ <options> ] <command> [ <sub-commands and sub-options> ]
<options> := [ <general-options> | <conditional-opts> ]
Any recognized option is accepted. Conditional options may be ignored or it's
usage postponed until shell or exec processes relevant command.
<general\-options> := [ \-h | \-V | \-v | \-I <interface> | \-H <address> |
\-d <N> | \-p <port> | \-c | \-U <username> |
\-L <privlvl> | \-l <lun> | \-m <local_address> |
\-N <sec> | \-R <count> | <password\-option> |
<oem-option> | <bridge-options> ]
<conditional\-opts> := [ <lan\-options> | <lanplus\-options> |
<command\-options> ]
.br
Bridging:
.br
<bridge\-options> := \-t <target_address> [ \-b <channel> |
[ \-T <address> | \-B <channel> ] ]
.br
Options used with \-I lan:
.br
<lan\-options> := [ \-A <authtype> ]
.br
Options used with \-I lanplus:
.br
<lanplus\-options> := [ \-C <ciphersuite> | <key\-option> ]
.br
Option groups setting same value:
.br
<key\-option> := [ \-k <key> | \-K | \-y <hex_key> | \-Y ]
.br
<password\-option> := [ \-f <password_file> | \-a | \-P <password> | \-E ]
.br
<oem\-option> := [ \-o <oemtype> | \-g | \-s ]
.br
Options used with specific command <command-options>:
.br
<options\-sdr> := [ \-S <sdr_cache_file> ]
.br
<options\-sel> := [ \-O <sel_oem> ]
.br
<options\-sol> := [ \-e <sol_escape_char> ]
.SH "DESCRIPTION"
This program lets you manage Intelligent Platform Management Interface
(IPMI) functions of either the local system, via a kernel device driver,
or a remote system, using IPMI v1.5 and IPMI v2.0. These functions include
printing FRU information, LAN configuration, sensor readings, and remote
chassis power control.
IPMI management of a local system interface requires a compatible IPMI
kernel driver to be installed and configured. On Linux this driver is
called \fIOpenIPMI\fP and it is included in standard distributions.
On Solaris this driver is called \fIBMC\fP and is included in Solaris 10.
Management of a remote station requires the IPMI\-over\-LAN interface to be
enabled and configured. Depending on the particular requirements of each
system it may be possible to enable the LAN interface using
.BR ipmitool
over the system interface.
.SH "OPTIONS"
.TP
\fB\-a\fR
Prompt for the remote server password.
.TP
\fB\-A\fR <\fIauthtype\fP>
Specify an authentication type to use during IPMIv1.5 \fIlan\fP
session activation. Supported types are NONE, PASSWORD, MD2, MD5, or OEM.
.TP
\fB\-b\fR <\fIchannel\fP>
Set destination channel for bridged request.
.TP
\fB\-B\fR <\fIchannel\fP>
Set transit channel for bridged request (dual bridge).
.TP
\fB\-b\fR <\fIchannel\fP>
Set destination channel for bridged request.
.TP
\fB\-B\fR <\fIchannel\fP>
Set transit channel for bridged request. (dual bridge)
.TP
\fB\-c\fR
Present output in CSV (comma separated variable) format.
This is not available with all commands.
.TP
\fB\-C\fR <\fIciphersuite\fP>
The remote server authentication, integrity, and encryption algorithms
to use for IPMIv2.0 \fIlanplus\fP connections. See table 22\-20 in the
IPMI v2.0 specification. The default is 17 which specifies RAKP\-HMAC\-SHA256
authentication, HMAC\-SHA256\-128 integrity, and AES\-CBC\-128 encryption algorithms.
NOTE: In
.BR ipmitool
1.8.18 and earlier the default was 3, which was insecure and was not supported
by some more recent BMC implementations.
.TP
\fB\-d \fIN\fP\fR
Use device number N to specify the /dev/ipmiN (or
/dev/ipmi/N or /dev/ipmidev/N) device to use for in-band
BMC communication. Used to target a specific BMC on a
multi-node, multi-BMC system through the ipmi device
driver interface. Default is 0.
.TP
\fB\-e\fR <\fIsol_escape_char\fP>
Use supplied character for SOL session escape character. The default
is to use \fI~\fP but this can conflict with ssh sessions.
.TP
\fB\-E\fR
The remote server password is specified by the environment
variable \fIIPMI_PASSWORD\fP or \fIIPMITOOL_PASSWORD\fP. The \fIIPMITOOL_PASSWORD\fP takes precedence.
.TP
\fB\-f\fR <\fIpassword_file\fP>
Specifies a file containing the remote server password. If this
option is absent, or if password_file is empty, the password
will default to NULL.
.TP
\fB\-g\fR
Deprecated. Use: \-o intelplus
.TP
\fB\-h\fR
Get basic usage help from the command line.
.TP
\fB\-H\fR <\fIaddress\fP>
Remote server address, can be IP address or hostname. This
option is required for \fIlan\fP and \fIlanplus\fP interfaces.
.TP
\fB\-I\fR <\fIinterface\fP>
Selects IPMI interface to use. Supported interfaces that are
compiled in are visible in the usage help output.
.TP
\fB\-k\fR <\fIkey\fP>
Use supplied Kg key for IPMIv2.0 authentication. The default is not to
use any Kg key.
.TP
\fB\-K\fR
Read Kg key from IPMI_KGKEY environment variable.
.TP
\fB\-l\fR <\fIlun\fP>
Set destination lun for raw commands.
.TP
\fB\-L\fR <\fIprivlvl\fP>
Force session privilege level. Can be CALLBACK, USER,
OPERATOR, ADMINISTRATOR. Default is ADMINISTRATOR.
This value is ignored and always set to ADMINISTRATOR when
combined with \fI-t target address\fP.
.TP
\fB\-m\fR <\fIlocal_address\fP>
Set the local IPMB address. The local address defaults to 0x20
or is auto discovered on PICMG platforms when \-m is not specified.
There should be no need to change the local address for normal operation.
.TP
\fB\-N\fR <\fIsec\fP>
Specify nr. of seconds between retransmissions of lan/lanplus messages.
Defaults are 2 seconds for lan and 1 second for lanplus interfaces.
Command \fIraw\fP uses fixed value of 15 seconds.
Command \fIsol\fP uses fixed value of 1 second.
.TP
\fB\-o\fR <\fIoemtype\fP>
Select OEM type to support. This usually involves minor hacks
in place in the code to work around quirks in various BMCs from
various manufacturers. Use \fI\-o list\fP to see a list of
current supported OEM types.
.TP
\fB\-O\fR <\fIsel oem\fP>
Open selected file and read OEM SEL event descriptions to be used
during SEL listings. See examples in contrib dir for file format.
.TP
\fB\-p\fR <\fIport\fP>
Remote server UDP port to connect to. Default is 623.
.TP
\fB\-P\fR <\fIpassword\fP>
Remote server password is specified on the command line.
If supported it will be obscured in the process list.
\fBNote!\fR Specifying the password as a command line
option is not recommended.
.TP
\fB\-R\fR <\fIcount\fP>
Set the number of retries for lan/lanplus interface (default=4).
Command \fIraw\fP uses fixed value of one try (no retries).
Command \fIhpm\fP uses fixed value of 10 retries.
.TP
\fB\-s\fR
Deprecated. Use: \-o supermicro
.TP
\fB\-S\fR <\fIsdr_cache_file\fP>
Use local file for remote SDR cache. Using a local SDR cache
can drastically increase performance for commands that require
knowledge of the entire SDR to perform their function. Local
SDR cache from a remote system can be created with the
\fIsdr dump\fP command.
.TP
\fB\-t\fR <\fItarget_address\fP>
Bridge IPMI requests to the remote target address. Default is 32.
The \fI-L privlvl\fP option is always ignored and value set to ADMINISTRATOR.
.TP
\fB\-T\fR <\fIaddress\fP>
Set transit address for bridge request (dual bridge).
.TP
\fB\-T\fR <\fItransmit_address\fP>
Set transit address for bridge request. (dual bridge)
.TP
\fB\-U\fR <\fIusername\fP>
Remote server username, default is NULL user.
.TP
\fB\-v\fR
Increase verbose output level. This option may be specified
multiple times to increase the level of debug output. If given
three times you will get hexdumps of all incoming and
outgoing packets. Using it five times provides details
on request and expected reply processing. The \fIhpm\fP commands
\fItargetcap\fP \fIcompprop\fP \fIabort\fP \fIupgstatus\fP
\fIrollback\fP \fIrollbackstatus\fP \fIselftestresult\fP increases
the verbosity level
.TP
\fB\-V\fR
Display version information.
.TP
\fB\-y\fR <\fIhex key\fP>
Use supplied Kg key for IPMIv2.0 authentication. The key is expected in
hexadecimal format and can be used to specify keys with non-printable
characters. E.g. '\-k PASSWORD' and '\-y 50415353574F5244' are
equivalent.
The default is not to use any Kg key.
.TP
\fB\-Y\fR
Prompt for the Kg key for IPMIv2.0 authentication.
.TP
\fB\-z\fR <\fIsize\fP>
Change Size of Communication Channel. (OEM)
.LP
If no password method is specified then
.BR ipmitool
will prompt the user for a password. If no password is entered at the prompt,
the remote server password will default to NULL.
.SH "SECURITY"
There are several security issues be be considered before enabling the
IPMI LAN interface. A remote station has the ability to control a system's power
state as well as being able to gather certain platform information. To reduce
vulnerability it is strongly advised that the IPMI LAN interface only be
enabled in 'trusted' environments where system security is not an issue or
where there is a dedicated secure 'management network'.
Further it is strongly advised that you should not enable IPMI for
remote access without setting a password, and that that password should
not be the same as any other password on that system.
When an IPMI password is changed on a remote machine with the IPMIv1.5
\fIlan\fP interface the new password is sent across the network
as clear text. This could be observed and then used to attack the remote
system. It is thus recommended that IPMI password management only be done
over IPMIv2.0 \fIlanplus\fP interface or the system interface on the
local station.
For IPMI v1.5, the maximum password length is 16 characters; longer
passwords might be truncated or rejected by the server, or rejected
by
.BR ipmitool .
For IPMI v2.0, the maximum password length is 20 characters; longer
passwords will be rejected by
.BR ipmitool .
.SH "COMMANDS"
.TP
\fIhelp\fP
This can be used to get command\-line help on
.BR ipmitool
commands. It may also be placed at the end of commands to get option usage help.
> ipmitool help
.br
Commands:
bmc Deprecated. Use mc
channel Configure Management Controller channels
chassis Get chassis status and set power state
dcmi Data Center Management Interface
delloem Manage Dell OEM Extensions.
echo Used to echo lines to stdout in scripts
ekanalyzer run FRU-Ekeying analyzer using FRU files
event Send events to MC
exec Run list of commands from file
firewall Configure Firmware Firewall
fru Print built\-in FRU and scan for FRU locators
fwum Update IPMC using Kontron OEM Firmware Update Manager
gendev Read/Write Device associated with Generic Device locators sdr
hpm Update HPM components using PICMG HPM.1 file
i2c Send an I2C Master Write-Read command and print response
ime Upgrade/Query Intel ME firmware
isol Configure and connect Intel IPMIv1.5 Serial\-over\-LAN
kontronoem Manage Kontron OEM Extensions
lan Configure LAN Channels
mc Management Controller status and global enables
nm Node Manager
pef Configure Platform Event Filtering (PEF)
picmg Run a PICMG/ATA extended command
power Shortcut to chassis power commands
raw Send a RAW IPMI request and print response
sdr Print Sensor Data Repository entries and readings
sel Print System Event Log (SEL)
sensor Print detailed sensor information
session Print session information
set Set runtime variable for shell and exec
shell Launch interactive IPMI shell
sol Configure and connect IPMIv2.0 Serial\-over\-LAN
spd Print SPD info from remote I2C device
sunoem Manage Sun OEM Extensions
tsol Configure and connect Tyan IPMIv1.5 Serial\-over\-LAN
user Configure Management Controller users
.TP
\fIchannel\fP
.RS
.TP
\fIauthcap\fP <\fBchannel number\fR> <\fBmax priv\fR>
Displays information about the authentication capabilities of
the selected channel at the specified privilege level.
.RS
.TP
Possible privilege levels are:
.br
\fI1\fP Callback level
.br
\fI2\fP User level
.br
\fI3\fP Operator level
.br
\fI4\fP Administrator level
.br
\fI5\fP OEM Proprietary level
.br
\fI15\fP No access
.RE
.TP
\fIinfo\fP [\fBchannel number\fR]
Displays information about the selected channel. If no channel
is given it will display information about the currently used channel.
.RS
.PP
> ipmitool channel info
.br
Channel 0xf info:
.br
Channel Medium Type : System Interface
.br
Channel Protocol Type : KCS
.br
Session Support : session\-less
.br
Active Session Count : 0
.br
Protocol Vendor ID : 7154
.RE
.TP
\fIgetaccess\fP <\fBchannel number\fR> [<\fBuserid\fR>]
.RS
Configure the given userid as the default on the given channel number.
When the given channel is subsequently used, the user is identified
implicitly by the given userid.
.TP
\fIsetaccess\fP <\fBchannel number\fR> <\fBuserid\fR> [<\fIcallin\fP=\fBon\fR|\fBoff\fR>]
[<\fIipmi\fP=\fBon\fR|\fBoff\fR>] [<\fIlink\fP=\fBon\fR|\fBoff\fR>] [<\fIprivilege\fP=\fBlevel\fR>]
.br
Configure user access information on the given channel for the given userid.
.TP
\fIgetciphers\fP <\fIipmi\fP|\fIsol\fP> [<\fBchannel\fR>]
.br
Displays the list of cipher suites supported for the given
application (ipmi or sol) on the given channel.
.RE
.RE
.TP
\fIchassis\fP
.RS
.TP
\fIstatus\fP
Status information related to power, buttons, cooling, drives and faults.
.TP
\fIpower\fP
.RS
.TP
\fIstatus\fP
.TP
\fIon\fP
.TP
\fIoff\fP
.TP
\fIcycle\fP
.TP
\fIreset\fP
.TP
\fIdiag\fP
.TP
\fIsoft\fP
.RE
.TP
\fIidentify\fP [<seconds>|force]
Identify interval.
.br
Default is 15 seconds.
.br
0 - Off
.br
force - To turn on indefinitely
.TP
\fIpolicy\fP
What to do when power is restored.
.RS
.TP
\fIlist\fP
Show available options.
.TP
\fIalways-on\fP
.TP
\fIprevious\fP
.TP
\fIalways-off\fP
.RE
.TP
\fIrestart_cause\fP
Last restart cause.
.TP
\fIpoh\fP
Get power on hours.
.TP
\fIbootdev\fP
.RS
.TP
\fInone\fP
Do not change boot device order.
.TP
\fIpxe\fP
Force PXE boot.
.TP
\fIdisk\fP
Force boot from default Hard-drive.
.TP
\fIsafe\fP
Force boot from default Hard-drive, request Safe Mode.
.TP
\fIdiag\fP
Force boot from Diagnostic Partition.
.TP
\fIcdrom\fP
Force boot from CD/DVD.
.TP
\fIbios\fP
Force boot into BIOS Setup.
.TP
\fIfloppy\fP
Force boot from Floppy/primary removable media.
.RE
.TP
\fIbootmbox\fP \fIget\fP [text] [block <\fBblock#\fP>]
Read the Boot Initiator Mailbox in hex dump or in text mode.
By default the whole mailbox is read. If block number is specified,
that particular block is read. For block 0 or when the whole
mailbox is read, the Boot Initiator IANA Enterprise Number and
the corresponding enterprise name are printed.
.TP
\fIbootmbox\fP \fIset\fP text [block <\fBblock#\fP>] <\fBIANA_PEN\fP> "<\fBdata_string\fP>"
Write the specified <block> or the entire Boot Initiator Mailbox in text mode.
It is required to specify a decimal IANA Enterprise Number recognized
by the boot initiator on the target system. Refer to your target system
manufacturer for details. The rest of the arguments are a text string.
When single block write is requested, the total length of <data> may not
exceed 13 bytes for block 0, or 16 bytes otherwise.
.TP
\fIbootmbox\fP \fIset\fP [block <\fBblock#\fP>] <\fBIANA_PEN\fP> <\fBdata_byte\fP> [<\fBdata_byte\fP> ...]
Same as above, but the arguments after IANA PEN are separate
data byte values separated by spaces.
.TP
\fIbootparam\fP \fIget\fP <\fBopt_id\fR> [<\fBopt_param\fR>]
Get value of system boot option number <\fBopt_id\fR>. Some boot
options (e.g. option 7) can also take an optional numeric parameter.
.TP
\fIbootparam\fP \fIset\fP bootflag <\fBdevice\fR> [options=...]
Set a boot flag. Valid devices are:
.RS
.IP \fIforce_pxe\fP
Force PXE boot
.IP \fIforce_disk\fP
Force boot from default Hard-drive
.IP \fIforce_safe\fP
Force boot from default Hard-drive, request Safe Mode
.IP \fIforce_diag\fP
Force boot from Diagnostic Partition
.IP \fIforce_cdrom\fP
Force boot from CD/DVD
.IP \fIforce_bios\fP
Force boot into BIOS Setup
.PP
Valid options are:
.IP \fIPEF\fP
Clear valid bit on reset/power cycle cause by PEF
.IP \fItimeout\fP
Automatically clear boot flag valid bit on timeout
.IP \fIwatchdog\fP
Clear valid bit on reset/power cycle cause by watchdog
.IP \fIreset\fP
Clear valid bit on push button reset/soft reset
.IP \fIpower\fP
Clear valid bit on power up via power push button or wake event
.RE
.TP
\fIselftest\fP
Get the chassis self-test results
.RE
.TP
\fIdcmi\fP
.RS
.TP
\fIdiscover\fP
.br
This command is used to discover supported capabilities in DCMI.
.TP
\fIpower\fP <\fBcommand\fR>
.br
Platform power limit command options are:
.RS
.TP
\fIreading\fP
.br
Get power related readings from the system.
.TP
\fIget_limit\fP
.br
Get the configured power limits.
.TP
\fIset_limit\fP <\fBparameter\fR> <\fBvalue\fR>
.br
Set a power limit option.
.br
.RS
.TP
Possible parameters/values are:
.TP
\fIaction\fP <\fBNo Action | Hard Power Off & Log Event to SEL | Log Event to SEL\fR>
.br
Exception Actions are taken as "No Action", "Hard Power Off system and log events to SEL", or "Log event to SEL only".
.TP
\fIlimit\fP <\fBnumber in Watts\fR>
.br
Power Limit Requested in Watts.
.TP
\fIcorrection\fP <\fBnumber in milliseconds\fR>
.br
Correction Time Limit in milliseconds.
.TP
\fIsample\fP <\fBnumber in seconds\fR>
.br
Statistics Sampling period in seconds.
.RE
.TP
\fIactivate\fP
.br
Activate the set power limit.
.TP
\fIdeactivate\fP
.br
Deactivate the set power limit.
.RE
.TP
\fIsensors\fP
.br
Prints the available DCMI sensors.
.TP
\fIasset_tag\fP
.br
Prints the platforms asset tag.
.TP
\fIset_asset_tag\fP <\fBstring\fR>
.br
Sets the platforms asset tag
.TP
\fIget_mc_id_string\fP
.br
Get management controller identifier string.
.TP
\fIset_mc_id_string\fP <\fBstring\fR>
.br
Set management controller identifier string. The maximum length is 64 bytes including a null terminator.
.TP
\fIthermalpolicy\fP [<\fBget\fR | \fBset\fR>]
.br
Thermal Limit policy get/set.
.br
.RS
.TP
The commands are:
.TP
\fIGet\fP <\fBentityID\fR> <\fBinstanceID\fR>
.br
Get Thermal Limit values.
\fBentityID\fR is the physical entity that a sensor or device is associated with.
\fBinstanceID\fR is a particular instance of an entity. Entity Instance can be in one of two ranges, system-relative or device-relative. For example, a system with four processors could use an Entity Instance value of "0" to identify the first processor.
.TP
\fISet\fP <\fBentityID\fR> <\fBinstanceID\fR>
.br
Set Thermal Limit values.
\fBentityID\fR is the physical entity that a sensor or device is associated with.
\fBinstanceID\fR is a particular instance of an entity. Entity Instance can be in one of two ranges, system-relative or device-relative. For example, a system with four processors could use an Entity Instance value of "0" to identify the first processor.
.RE
.TP
\fIget_temp_reading\fP
.br
Get Temperature Sensor Readings.
.TP
\fIget_conf_param\fP
.br
Get DCMI Configuration Parameters.
.TP
\fIset_conf_param\fP <\fBparameters\fR>
.br
Set DCMI Configuration Parameters.
.RS
.TP
The Configuration Parameters are:
.TP
\fIactivate_dhcp\fP
.br
Activate/restart DHCP
.TP
\fIdhcp_config\fP
.br
Discover DHCP Configuration.
.TP
\fIinit\fP
.br
Set DHCP Initial timeout interval, in seconds. The recommended default is four seconds.
.TP
\fItimeout\fP
.br
Set DHCP Server contact timeout interval, in seconds. The recommended default timeout is two minutes.
.TP
\fIretry\fP
.br
Set DHCP Server contact retry interval, in seconds. The recommended default timeout is sixty-four seconds.
.RE
.TP
\fIoob_discover\fP
.br
Ping/Pong Message for DCMI Discovery.
.RE
.RE
.RE
.TP
\fIdelloem\fP
.RS
.br
The delloem commands provide information on Dell-specific features.
.TP
\fIsetled {b:d.f} {state..}\fP
.RS
.br
Sets the drive backplane LEDs for a device.
.br
{b:d.f} = PCI Address of device (eg. 06:00.0)
.br
{state} = one or more of the following:
.RS
\fIonline | present | hotspare | identify | rebuilding | fault | predict | critical | failed\fP
.br
.RE
.RE
.TP
\fIlcd\fP
.RS
.br
\fIset {mode}\fP|\fI{lcdqualifier}\fP|\fI{errordisplay}\fP
.RS
.br
Allows you to set the LCD mode and user-defined string.
.RE
.TP
\fIlcd set mode\fP
.RS
.br
\fI{none}\fP|\fI{modelname}\fP|\fI{ipv4address}\fP|\fI{macaddress}\fP|
.br
\fI{systemname}\fP|\fI{servicetag}\fP|\fI{ipv6address}\fP|
.br
\fI{ambienttemp}\fP|\fI{systemwatt}\fP|\fI{assettag}\fP|
.br
\fI{userdefined}<text>\fP
.br
Allows you to set the LCD display mode to any of the preceding parameters.
.RE
.TP
\fIlcd set lcdqualifier\fP
.RS
.br
\fI{watt}\fP|\fI{btuphr}\fP|
.br
\fI{celsius}\fP|\fI{fahrenheit}\fP
.br
Allows you to set the unit for the system ambient temperature mode.
.RE
.TP
\fIlcd set errordisplay\fP
.RS
.br
\fI{sel}\fP|\fI{simple}\fP
.br
Allows you to set the error display.
.RE
.TP
\fIlcd info\fP
.RS
.br
Displays the LCD screen information.
.RE
.TP
\fIlcd set vkvm\fP
.RS
\fI{active}\fP|\fI{inactive}\fP
.br
Allows you to set the vKVM status to active or inactive. When it is active and session is in progress, a message appears on LCD.
.RE
.TP
\fIlcd status\fP
.RS
.br
Displays the LCD status for vKVM display active or inactive and Front Panel access mode (viewandmodify, view-only or disabled).
.RE
.RE
.TP
\fImac\fP
.RS
.br
Displays the information about the system NICs.
.TP
\fImac list\fP
.br
Displays the NIC MAC address and status of all NICs. It also displays the DRAC/iDRAC MAC address.
.TP
\fImac get\fP
.RS
\fI<NIC number>\fP
.br
Displays the selected NICs MAC address and status.
.RE
.RE
.TP
\fIlan\fP
.RS
.br
Displays the information of Lan.
.TP
\fIlan set\fP
.RS
\fI<Mode>\fP
.br
Sets the NIC selection mode (dedicated, shared with lom1, shared with lom2,shared with lom3,shared with lom4,shared with failover lom1,shared with failover lom2,shared with failover lom3,shared with failover lom4,shared with Failover all loms, shared with Failover None).
.RE
.TP
\fIlan get\fP
.br
Returns the current NIC selection mode (dedicated, shared with lom1, shared with lom2, shared with lom3, shared with lom4,shared with failover lom1, shared with failover lom2,shared with failover lom3,shared with failover lom4,shared with Failover all loms,shared with Failover None).
.TP
\fIlan get active\fP
.br
Returns the current active NIC (dedicated, LOM1, LOM2, LOM3 or LOM4).
.RE
.TP
\fIpowermonitor\fP
.RS
.br
Displays power tracking statistics.
.TP
\fIpowermonitor clear cumulativepower\fP
.RS
.br
Reset cumulative power reading.
.RE
.TP
\fIpowermonitor clear peakpower\fP
.RS
.br
Reset peak power reading.
.RE
.TP
\fIpowermonitor powerconsumption\fP
.RS
\fI<watt>\fP|\fI<btuphr>\fP
.br
Displays the power consumption in watt or btuphr.
.RE
.TP
\fIpowermonitor powerconsumptionhistory\fP
.RS
\fI<watt>\fP|\fI<btuphr>\fP
.br
Displays the power consumption history in watt or btuphr.
.RE
.TP
\fIpowermonitor getpowerbudget\fP
.RS
\fI<watt>\fP|\fI<btuphr>\fP
.br
Displays the power cap in watt or btuphr.
.RE
.TP
\fIpowermonitor setpowerbudget\fP
.RS
\fI<val>\fP\fI<watt\fP|\fIbtuphr\fP|\fIpercent>\fP
.br
Allows you to set the power cap in watt, BTU/hr or percentage.
.RE
.TP
\fIpowermonitor enablepowercap\fP
.RS
.br
Enables set power cap.
.RE
.TP
\fIpowermonitor disablepowercap\fP
.RS
.br
Disables set power cap.
.RE
.RE
.RE
.RS
.TP
\fIvFlash info Card\fP
.RS
.br
Shows Extended SD Card information.
.RE
.RE
.TP
\fIecho\fP
For echoing lines to stdout in scripts.
.TP
\fIekanalyzer\fP <\fBcommand\fR> <\fBxx=filename1\fR> <\fBxx=filename2\fR> [<\fBrc=filename3\fR>] \fB...\fR
.RS
.TP
.br
\fINOTE\fP : This command can support a maximum of 8 files per command line
.TP
.br
\fIfilename1\fP : binary file that stores FRU data of a Carrier or an AMC module
.TP
.br
\fIfilename2\fP : binary file that stores FRU data of an AMC module.
These binary files can be generated from command:
\fIipmitool fru read <id> <filename>\fP
.TP
.br
\fIfilename3\fP : configuration file used for configuring On-Carrier Device ID
or OEM GUID. This file is optional.
.TP
.br
\fIxx\fP : indicates the type of the file. It can take the following value:
.RS
.TP
.br
\fIoc\fP : On-Carrier device
.TP
.br
\fIa1\fP : AMC slot A1
.TP
.br
\fIa2\fP : AMC slot A2
.TP
.br
\fIa3\fP : AMC slot A3