File: ipmi-chassis.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 (196 lines) | stat: -rw-r--r-- 9,124 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
.TH IPMI-CHASSIS 8 "@ISODATE@" "ipmi-chassis @PACKAGE_VERSION@" "System Commands"
.SH "NAME"
ipmi-chassis \- IPMI chassis management utility
.SH "SYNOPSIS"
.B ipmi-chassis
[\fIOPTION\fR...]
.SH "DESCRIPTION"
.B Ipmi-chassis
is used for managing/monitoring an IPMI chassis, such as chassis
power, indentification (i.e. LED control), and status.  See OPTIONS
below for all chassis management options available.

#include <@top_srcdir@/man/manpage-common-table-of-contents.man>
To perform IPMI chassis configuration, please see
.B ipmi-config(8).
To perform some advanced chassis management, please see
.B bmc-device(8).
For a more powerful chassis power control utility, please see
.B ipmipower(8).

#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-CHASSIS OPTIONS"
The following options are specific to
.B Ipmi-chassis.
.TP
\fB\-\-get\-chassis\-capabilities\fR
Get chassis capabilities.  This command returns information on which
main chassis management functions are available.
.TP
\fB\-\-get\-chassis\-status\fR
Get chassis status.  This command returns high level status
information on the chassis.
.TP
\fB\-\-chassis\-control\fR=\fICONTROL\fR
Control the chassis. This command provides power-up, power-down, and
reset control.  Supported values: POWER\-DOWN, POWER\-UP,
POWER\-CYCLE, HARD\-RESET, DIAGNOSTIC\-INTERRUPT, SOFT\-SHUTDOWN.
.TP
\fB\-\-chassis\-identify\fR=\fIIDENTIFY\fR
Set chassis identification.  This command controls physical system
identification, typically a LED.  Supported values: TURN\-OFF to turn
off identification, <interval> to turn on identification for
"interval" seconds, FORCE to turn on indefinitely.
.\".TP
.\".\fB\-\-set\-power\-restore\-policy\fR=\fIPOLICY\fR
.\".Set power restore policy.  This command determines how the system or
.\".chassis behaves when AC power returns after an AC power loss.
.\".Supported values: LIST\-SUPPORTED\-POLICIES, ALWAYS\-ON, RESTORE,
.\".ALWAYS\-OFF.  See current power restore policy via the
.\".\fB\-\-get\-status\fR option.
.\"..TP
.\".\fB\-\-set\-power\-cycle\-interval\fR=\fISECONDS\fR
.\".Set power cycle interval in seconds.  This interval determines the
.\".time the system power will be powered down during a power cycle
.\".operation initiated by a chassis control command.
.TP
\fB\-\-get\-system\-restart\-cause\fR
Get system restart cause.
.TP
\fB\-\-get\-power\-on\-hours\-counter\fR
Get power on hours (POH) counter.
.\"..TP
.\".\fB\-\-get\-boot\-flags\fR
.\".Get system boot\-flags.  This command returns the current boot
.\".flag settings.
.\"..TP
.\".\fB\-\-set\-boot\-flags\fR
.\".Set system boot flags.  Must be specified to use the 
.\".\fB\-\-boot\-type\fR,
.\".\fB\-\-lock\-out\-reset\-button\fR,
.\".\fB\-\-blank\-screen\fR,
.\".A\fB\-\-boot\-device\fR,
.\".\fB\-\-lock\-keyboard\fR,
.\".\fB\-\-clear\-cmos\fR,
.\".\fB\-\-console\-redirection\fR,
.\".\fB\-\-user\-password\-bypass\fR,
.\".\fB\-\-force\-progress\-event\-traps\fR,
.\".and
.\".\fB\-\-firmware\-bios\-verbosity\fR
.\".options listed below.
.\"..TP
.\".\fB\-\-boot\-type\fR=\fIBOOT_TYPE\fR
.\".Set BIOS boot type to BOOT_TYPE.  Supported values:
.\".PC\-COMPATIBLE, EFI. Used with the
.\".\fB\-\-set\-boot\-flags\fR option.
.\"..TP
.\".\fB\-\-lock\-out\-reset\-button\fR=\fILOCK_OUT_RESET_BUTTON\fR
.\".Modify lock out reset button support. Supported values: YES/NO.
.\".Used with the \fB\-\-set\-boot\-flags\fR option.
.\"..TP
.\".\fB\-\-blank\-screen\fR=\fIBLANK_SCREEN\fR
.\".Modify blank screen support. Supported values: YES/NO.
.\".Used with the \fB\-\-set\-boot\-flags\fR option.
.\"..TP
.\".\fB\-\-boot\-device\fR=\fIBOOT_DEVICE\fR
.\".Set device to boot from to BOOT_DEVICE. Allowed
.\".values: NO-OVERRIDE, PXE, HARD-DRIVE, HARD\-DRIVE\-SAFE, DIAG, CD\-DVD,
.\".BIOS, FLOPPY. Used with the \fB\-\-set\-boot\-flags\fR option.
.\"..TP
.\".\fB\-\-lock\-keyboard\fR=\fILOCK_KEYBOARD\fR
.\".Modify lock keyboard support. Supported values: YES/NO. 
.\".Used with the \fB\-\-set\-boot\-flags\fR option.
.\"..TP
.\".\fB\-\-clear\-cmos\fR=\fICMOS_CLEAR\fR
.\".Modify clear CMOS support. Supported values: YES/NO. Used with the
.\".\fB\-\-set\-boot\-flags\fR option.
.\"..TP
.\".\fB\-\-console\-redirection\fR=\fICONSOLE_REDIRECTION\fR
.\".Set console redirection type. Supported values: DEFAULT,
.\".SUPPRESS, ENABLE. Used with the
.\".\fB\-\-set\-boot\-flags\fR option.
.\"..TP
.\".\fB\-\-user\-password\-bypass\fR=\fIUSER_PASSWORD_BYPASS\fR
.\".Modify user password bypass support.  When enabled, the managed
.\".client's BIOS boots the systema nd bypasses any user or boot password
.\".that might be set in teh system.  This option allows a system
.\".administrator to, for example, force a system boot via PXE in an
.\".unattended manner.  Supported values: YES/NO.  Used with the
.\".\fB\-\-set\-boot\-flags\fR option.
.\"..TP
.\".\fB\-\-force\-progress\-event\-traps\fR=\fIFORCE_PROGRESS_EVENT_TRAPS\fR
.\".Modify force progress event traps support. When enabled, the BMC
.\".transmits PET traps for BIOS progress events to the session that set
.\".the flag.  Supported values: YES/NO. Used with the
.\".\fB\-\-set\-boot\-flags\fR option.
.\"..TP
.\".\fB\-\-firmware\-bios\-verbosity\fR=\fIFIRMWARE_BIOS_VERBOSITY\fR
.\".Set firmware verbosity.  Directs what appears on POST display.
.\".Supported values: DEFAULT, QUIET, VERBOSE. Used with the
.\".\fB\-\-set\-boot\-flags\fR option.
#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>
.SH "EXAMPLES"
.B # ipmi-chassis --get-status
.PP
Get the chassis status of the local machine.
.PP
.B # ipmi-chassis -h ahost -u myusername -p mypassword --get-status
.PP
Get the chassis status of a remote machine using IPMI over LAN.
.PP
.B # ipmi-chassis -h mycluster[0-127] -u myusername -p mypassword --get-status
.PP
Get the chassis status across a cluster using IPMI over LAN.
.PP
.B # ipmi-chassis -h ahost -u myusername -p mypassword --chassis-control=POWER-UP
.PP
Power on a remote machine 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 2007-2014 FreeIPMI Core Team
#include <@top_srcdir@/man/manpage-common-gpl-program-text.man>
.SH "SEE ALSO"
freeipmi(7), bmc-device(8), ipmi-config(8), ipmipower(8)
#include <@top_srcdir@/man/manpage-common-homepage.man>